Класс yii\filters\auth\HttpBasicAuth

HttpBasicAuth — это фильтр действий, который поддерживает метод HTTP Basic аутентификации.

Вы можете использовать HttpBasicAuth, прикрепив его как поведение к контроллеру или модулю, как показано ниже:

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpBasicAuth::className(),
        ],
    ];
}

Стандартная реализация HttpBasicAuth использует метод loginByAccessToken() компонента приложения user и передает только имя пользователя. Эта реализация используется для аутентификации API-клиентов.

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

public function behaviors()
{
    return [
        'basicAuth' => [
            'class' => \yii\filters\auth\HttpBasicAuth::className(),
            'auth' => function ($username, $password) {
                $user = User::find()->where(['username' => $username])->one();
                if ($user->verifyPassword($password)) {
                    return $user;
                }
                return null;
            },
        ],
    ];
}

Общественные свойства

Общественные методы

Защищенные методы

Подробное описание свойств

$auth общественное свойство

PHP вызываемый объект, который будет аутентифицировать пользователя с помощью информации HTTP basic auth. Вызываемый объект получает имя пользователя и пароль в качестве параметров. Он должен вернуть объект идентификации, соответствующий имени пользователя и паролю. Null должен быть возвращён, если такой объект не найден.

Следующий код является типичной реализацией этого вызываемого объекта:

function ($username, $password) {
    return \app\models\User::findOne([
        'username' => $username,
        'password' => $password,
    ]);
}

Если это свойство не установлено, информация о имени пользователя будет рассматриваться как токен доступа, а информация о пароле будет проигнорирована. Будет вызван метод yii\web\User::loginByAccessToken() для аутентификации и входа пользователя.

public callable $auth = null

$realm общественное свойство

Область HTTP аутентификации

public string $realm = 'api'

Подробное описание методов