yii2/rest-authentication.md at master · yiisoft/yii2 · GitHub

Контроль доступа на основе ролей (rbac) ¶

Управление доступом на основе ролей (RBAC) обеспечивает простой, но мощный централизованный контроль доступа.
Пожалуйста, обратитесь к Wikipedia
для получения информации о сравнении RBAC с другими, более традиционными, системами контроля доступа.

Yii реализует общую иерархическую RBAC, следуя NIST RBAC model.
Обеспечивается функциональность RBAC через компонент приложенияauthManager.

Использование RBAC состоит из двух частей. Первая часть — это создание RBAC данных авторизации, и вторая часть — это
использование данных авторизации для проверки доступа в том месте, где это нужно.

Для облегчения последующего описания, мы сначала введём некоторые основные понятия RBAC.

Основные концепции ¶

Роль представляет собой набор разрешений (permissions) (например, создание сообщения, обновление сообщения).
Роль может быть назначена на одного или многих пользователей. Чтобы проверить, имеет ли пользователь указанные
разрешения, мы должны проверить, назначена ли пользователю роль, которая содержит данное разрешение.

С каждой ролью или разрешением может быть связано правило (rule). Правило представляет собой кусок кода, который будет
выполняться в ходе проверки доступа для определения может ли быть применена соответствующая роль или разрешение
к текущему пользователю.

Например, разрешение “обновление поста” может иметь правило, которое проверяет является ли
текущий пользователь автором поста. Во время проверки доступа, если пользователь не является автором поста, он/она будет
считаться не имеющими разрешения “обновление поста”.

И роли, и разрешения могут быть организованы в иерархию. В частности, роль может содержать другие роли или разрешения; и
разрешения могут содержать другие разрешения. Yii реализует частично упорядоченную иерархию, которая включает в себя
специальные деревья иерархии. Роль может содержать разрешение, но обратное не верно.

Building authorization data ¶

Building authorization data is all about the following tasks:

Depending on authorization flexibility requirements the tasks above could be done in different ways.
If your permissions hierarchy is meant to be changed by developers only, you can use either migrations
or a console command. Migration pro is that it could be executed along with other migrations.

Either way in the end you’ll get the following RBAC hierarchy:

In case you need permissions hierarchy to be formed dynamically you need a UI or a console command. API used to
build the hierarchy itself won’t be different.

Configuring rbac ¶

Before we set off to define authorization data and perform access checking, we need to configure the
authManager application component. Yii provides two types of authorization managers:
yiirbacPhpManager and yiirbacDbManager.

Role based access control (rbac) ¶

Role-Based Access Control (RBAC) provides a simple yet powerful centralized access control. Please refer to
the Wikipedia for details about comparing RBAC
with other more traditional access control schemes.

Yii implements a General Hierarchical RBAC, following the NIST RBAC model.
It provides the RBAC functionality through the authManagerapplication component.

Using RBAC involves two parts of work. The first part is to build up the RBAC authorization data, and the second
part is to use the authorization data to perform access check in places where it is needed.

To facilitate our description next, we will first introduce some basic RBAC concepts.

Step by step authentication and authorization in yii2 framework (basic template)

CREATE TABLE IF NOT EXISTS `auth_assignment` (
  `item_name` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  `user_id` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  `created_at` int(11) DEFAULT NULL,
  PRIMARY KEY (`item_name`,`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

CREATE TABLE IF NOT EXISTS `auth_item` (
  `name` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  `type` int(11) NOT NULL,
  `description` text COLLATE utf8_unicode_ci,
  `rule_name` varchar(64) COLLATE utf8_unicode_ci DEFAULT NULL,
  `data` text COLLATE utf8_unicode_ci,
  `created_at` int(11) DEFAULT NULL,
  `updated_at` int(11) DEFAULT NULL,
  PRIMARY KEY (`name`),
  KEY `rule_name` (`rule_name`),
  KEY `idx-auth_item-type` (`type`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

CREATE TABLE IF NOT EXISTS `auth_item_child` (
  `parent` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  `child` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  PRIMARY KEY (`parent`,`child`),
  KEY `child` (`child`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;


CREATE TABLE IF NOT EXISTS `auth_rule` (
  `name` varchar(64) COLLATE utf8_unicode_ci NOT NULL,
  `data` text COLLATE utf8_unicode_ci,
  `created_at` int(11) DEFAULT NULL,
  `updated_at` int(11) DEFAULT NULL,
  PRIMARY KEY (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

CREATE TABLE IF NOT EXISTS `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(300) NOT NULL,
  `password` varchar(300) NOT NULL,
  `authKey` varchar(300) NOT NULL,
  `accessToken` varchar(300) NOT NULL,
  `email` varchar(300) NOT NULL,
  `money` float NOT NULL,
  `podpis` varchar(300) NOT NULL,
  `pechat` varchar(300) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=cp1251 AUTO_INCREMENT=18 ;

ALTER TABLE `auth_assignment`
  ADD CONSTRAINT `auth_assignment_ibfk_1` FOREIGN KEY (`item_name`) REFERENCES `auth_item` (`name`) ON DELETE CASCADE ON UPDATE CASCADE;

ALTER TABLE `auth_item`
  ADD CONSTRAINT `auth_item_ibfk_1` FOREIGN KEY (`rule_name`) REFERENCES `auth_rule` (`name`) ON DELETE SET NULL ON UPDATE CASCADE;

ALTER TABLE `auth_item_child`
  ADD CONSTRAINT `auth_item_child_ibfk_1` FOREIGN KEY (`parent`) REFERENCES `auth_item` (`name`) ON DELETE CASCADE ON UPDATE CASCADE,
  ADD CONSTRAINT `auth_item_child_ibfk_2` FOREIGN KEY (`child`) REFERENCES `auth_item` (`name`) ON DELETE CASCADE ON UPDATE CASCADE;

public function behaviors()
{
    return [
        'access' => [
            'class' => AccessControl::className(),
            'rules' => [
                [
                    'actions' => ['index', 'update', 'view', 'delete'],
                    'allow' => true,
                    'roles' => ['admin'],
                ],
            ],
        ],

if (isset(Yii::$app->authManager->getRolesByUser(Yii::$app->user->getId())['admin'])) echo "do something";

Using dbmanager¶

The following code shows how to configure the authManager in the application configuration using the yiirbacDbManager class:

return [
    'components' => [
        'authManager' => [
            'class' => 'yiirbacDbManager',
            
        ],
        
    ],
];

Note: If you are using yii2-basic-app template, there is a config/console.php configuration file where the
authManager needs to be declared additionally to config/web.php.
In case of yii2-advanced-app the authManager should be declared only once in common/config/main.php.

DbManager uses four database tables to store its data:

Before you can go on you need to create those tables in the database. To do this, you can use the migration stored in @yii/rbac/migrations:

yii migrate –migrationPath=@yii/rbac/migrations

Read more about working with migrations from different namespaces in
Separated Migrations section.

The authManager can now be accessed via Yii::$app->authManager.

Using migrations ¶

You can use migrations
to initialize and modify hierarchy via APIs offered by authManager.

Create new migration using ./yii migrate/create init_rbac then implement creating a hierarchy:

Using phpmanager¶

The following code shows how to configure the authManager in the application configuration using the yiirbacPhpManager class:

return [
    'components' => [
        'authManager' => [
            'class' => 'yiirbacPhpManager',
        ],
        
    ],
];

The authManager can now be accessed via Yii::$app->authManager.

By default, yiirbacPhpManager stores RBAC data in files under @app/rbac directory. Make sure the directory
and all the files in it are writable by the Web server process if permissions hierarchy needs to be changed online.

Yii2 basic, авторизация из коробки во всплывающем (модальном) окне

Пример описанный выше подойдет и для авторизации имеющейся в Yii2 basic из коробки с небольшими правками.

Yii2/rest-authentication.md at master · yiisoft/yii2

Использование правил ¶

Как упомянуто выше, правила добавляют дополнительные ограничения на роли и разрешения. Правила — это классы, расширяющие
yiirbacRule. Они должны реализовывать метод execute(). В иерархии, созданной нами ранее,
автор не может редактировать свой пост. Давайте исправим это. Сначала мы должны создать правило, проверяющее
что пользователь является автором поста:

Использование роли по умолчанию ¶

Роль по умолчанию — это роль, которая неявно присваивается всем пользователям. Вызов метода
yiirbacManagerInterface::assign() не требуется, и авторизационные данные не содержат информации о назначении.

Роль по умолчанию обычно связывают с правилом, определяющим к какой роли принадлежит каждый пользователь.

Роли по умолчанию обычно используются в приложениях, которые уже имеют какое-то описание ролей. Для примера, приложение
может иметь столбец “group” в таблице пользователей, и каждый пользователь принадлежит к какой-то группе. Если каждая
группа может быть сопоставлена роли в модели RBAC, вы можете использовать роль по умолчанию для автоматического назначения
каждому пользователю роли RBAC. Давайте используем пример, чтобы понять как это можно сделать.

Настройка authmanager с помощью dbmanager¶

Следующий код показывает как настроить в конфигурации приложения authManager с использованием класса yiirbacDbManager:

return [
    'components' => [
        'authManager' => [
            'class' => 'yiirbacDbManager',
        ],
        
    ],
];

Примечание: Если вы используете шаблон проекта basic, компонент authManager необходимо настроить как в config/web.php, так и в
конфигурации консольного приложенияconfig/console.php.
При использовании шаблона проекта advanced authManager достаточно настроить единожды в common/config/main.php.

DbManager использует четыре таблицы для хранения данных:

Прежде чем вы начнёте использовать этот менеджер, вам нужно создать таблицы в базе данных. Чтобы сделать это,
вы можете использовать миграцию хранящуюся в файле @yii/rbac/migrations:

yii migrate –migrationPath=@yii/rbac/migrations

Теперь authManager может быть доступен через Yii::$app->authManager.

Настройка authmanager с помощью phpmanager¶

Следующий код показывает как настроить в конфигурации приложения authManager с использованием класса yiirbacPhpManager:

return [
    'components' => [
        'authManager' => [
            'class' => 'yiirbacPhpManager',
        ],
        
    ],
];

Теперь authManager может быть доступен через Yii::$app->authManager.

Замечание: По умолчанию, yiirbacPhpManager сохраняет данные RBAC в файлах в директории @app/rbac/. Убедитесь
что данная директория и файлы в них доступны для записи Web серверу, если иерархия разрешений должна меняться онлайн.

Настройка rbac manager ¶

Перед определением авторизационных данных и проверкой прав доступа, мы должны настроить компонент приложения
yiibaseApplication::authManager. Yii предоставляет два типа менеджеров авторизации:
yiirbacPhpManager и yiirbacDbManager.

Создание данных авторизации ¶

Для создания данных авторизации нужно выполнить следующие задачи:

• определение ролей и разрешений;
• установка отношений между ролями и правами доступа;
• определение правил;
• связывание правил с ролями и разрешениями;
• назначение ролей пользователям.

В зависимости от требований к гибкости авторизации перечисленные задачи могут быть выполнены разными путями.

Если иерархия прав не меняется, и количество пользователей зафиксировано, вы можете создать
консольную команду, которая будет единожды инициализировать данные
через APIs, предоставляемое authManager:

Фильтры контроля доступа ¶

Фильтры контроля доступа (ACF) являются простым методом, который лучше всего использовать в приложениях с простым
контролем доступа. Как видно из их названия, ACF — это фильтры, которые могут присоединяться к контроллеру
или модулю как поведение. ACF проверяет набор правил доступа, чтобы убедиться,
что пользователь имеет доступ к запрошенному действию.

Код ниже показывает, как использовать ACF фильтр, реализованный в yiifiltersAccessControl:

useyiifiltersAccessControl;

classSiteControllerextendsController{
    publicfunctionbehaviors(){
        return [
            'access' => [
                'class' => AccessControl::className(),
                'only' => ['login', 'logout', 'signup'],
                'rules' => [
                    [
                        'allow' => true,
                        'actions' => ['login', 'signup'],
                        'roles' => ['?'],
                    ],
                    [
                        'allow' => true,
                        'actions' => ['logout'],
                        'roles' => ['@'],
                    ],
                ],
            ],
        ];
    }
    
}

Код выше показывает ACF фильтр, связанный с контроллером site через поведение. Это типичный способ использования фильтров действий.
Параметр only указывает, что фильтр ACF нужно применять только к действиям login, logout и signup.
Параметр rules задаёт правила доступа, которые означают следующее:

• Разрешить всем гостям (ещё не прошедшим авторизацию) доступ к действиям login и signup.
  Опция roles содержит знак вопроса ?, это специальный токен обозначающий “гостя”.
• Разрешить аутентифицированным пользователям доступ к действию logout. Символ @ — это другой специальный токен,
  обозначающий аутентифицированного пользователя.

Когда фильтр ACF проводит проверку авторизации, он проверяет правила по одному сверху вниз, пока не найдёт совпадение.
Значение опции allow выбранного правила указывает, авторизовывать пользователя или нет. Если ни одно из правил
не совпало, то пользователь считается НЕавторизованным, и фильтр ACF останавливает дальнейшее выполнение действия.

По умолчанию, когда у пользователя отсутствует доступ к текущему действию, ACF делает следующее:

Вы можете переопределить это поведение, настроив свойство yiifiltersAccessControl::$denyCallback:

[
    'class' => AccessControl::className(),
    'denyCallback' => function($rule, $action){
        thrownew Exception('У вас нет доступа к этой странице');
    }
]

Правила доступа поддерживают набор свойств. Ниже дано краткое описание поддерживаемых опций.
Вы также можете расширить yiifiltersAccessRule, чтобы создать свой собственный класс правил доступа.

Шаг 1

Открываем существующий проект на Yii2 advanced или устанавливаем новый (Как установить Yii 2 advanced, краткая инструкция). И используем инструкцию описанную выше с некоторыми изменениями.

Шаг 1 пропускаем из основного примера.

Шаг 2

Для шага 2 из основного примера, меняем путь к каталогу хранения виджета и его представления на frontend/widgets и frontend/widgets/views соответственно.

В классе виджета frontend/widgets/LoginFormWidget.php меняем namespace c:

namespace appwidgets;

на:

namespace frontendwidgets;

Также меняем путь к LoginForm c:

use appmodelsLoginForm;

на:

use commonmodelsLoginForm;

В представление виджета frontend/widgets/views/loginFormWidget.php заменяем:

Шаг 3

Шаг 3 из предыдущего примера выполняем полностью.

В итоге actionAjaxLogin в app/controllers/SiteController.php примет вид:

Шаг 4

Шаг 4 из основного примера имеет небольшие отличия. Открываем основной макет frontend/views/layouts/main.php, в блок use добавляем виджет с модальным окном и формой авторизации:

use frontendwidgetsLoginFormWidget;

Остальное остается как описано в шаге 4 из основного примера.

В итоге frontend/views/layouts/main.php примет вид: