Class yii\filters\auth\HttpBasicAuth

HttpBasicAuth is an action filter that supports the HTTP Basic authentication method.

You may use HttpBasicAuth by attaching it as a behavior to a controller or module, like the following:

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

The default implementation of HttpBasicAuth uses the loginByAccessToken() method of the user application component and only passes the user name. This implementation is used for authenticating API clients.

If you want to authenticate users using username and password, you should provide the $auth function for example like the following:

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;
            },
        ],
    ];
}

Tip: In case authentication does not work like expected, make sure your web server passes username and password to $_SERVER['PHP_AUTH_USER'] and $_SERVER['PHP_AUTH_PW'] variables. If you are using Apache with PHP-CGI, you might need to add this line to your .htaccess file: RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]