Yii - Autenticação

O processo de verificação da identidade de um usuário é denominado authentication. Geralmente usa um nome de usuário e uma senha para julgar se o usuário é aquele que ele afirma ser.

Para usar o framework de autenticação Yii, você precisa -

  • Configure o componente de aplicativo do usuário.
  • Implemente a interface yii \ web \ IdentityInterface.

O modelo de aplicativo básico vem com um sistema de autenticação integrado. Ele usa o componente de aplicativo do usuário, conforme mostrado no código a seguir -

<?php
   $params = require(__DIR__ . '/params.php'); $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this
               //is required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         //other components...
         'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params, ]; if (YII_ENV_DEV) { // configuration adjustments for 'dev' environment $config['bootstrap'][] = 'debug';
      $config['modules']['debug'] = [ 'class' => 'yii\debug\Module', ]; $config['bootstrap'][] = 'gii';
      $config['modules']['gii'] = [ 'class' => 'yii\gii\Module', ]; } return $config;
?>

Na configuração acima, a classe de identidade do usuário é configurada como app \ models \ User.

A classe de identidade deve implementar o yii\web\IdentityInterface com os seguintes métodos -

  • findIdentity() - Procura uma instância da classe de identidade usando o ID de usuário especificado.

  • findIdentityByAccessToken() - Procura uma instância da classe de identidade usando o token de acesso especificado.

  • getId() - Retorna o ID do usuário.

  • getAuthKey() - Retorna uma chave usada para verificar o login baseado em cookie.

  • validateAuthKey() - Implementa a lógica para verificar a chave de login baseada em cookie.

O modelo de usuário do modelo de aplicativo básico implementa todas as funções acima. Os dados do usuário são armazenados no$users propriedade -

<?php
   namespace app\models;
   class User extends \yii\base\Object implements \yii\web\IdentityInterface {
      public $id;
      public $username; public $password;
      public $authKey; public $accessToken;
      private static $users = [ '100' => [ 'id' => '100', 'username' => 'admin', 'password' => 'admin', 'authKey' => 'test100key', 'accessToken' => '100-token', ], '101' => [ 'id' => '101', 'username' => 'demo', 'password' => 'demo', 'authKey' => 'test101key', 'accessToken' => '101-token', ], ]; /** * @inheritdoc */ public static function findIdentity($id) {
         return isset(self::$users[$id]) ? new static(self::$users[$id]) : null;
      }
      /**
      * @inheritdoc
      */
      public static function findIdentityByAccessToken($token, $type = null) {
         foreach (self::$users as $user) {
            if ($user['accessToken'] === $token) {
               return new static($user); } } return null; } /** * Finds user by username * * @param string $username
      * @return static|null
      */
      public static function findByUsername($username) { foreach (self::$users as $user) { if (strcasecmp($user['username'], $username) === 0) { return new static($user);
            }
         }
         return null;
      }
      /**
      * @inheritdoc
      */
      public function getId() {
         return $this->id; } /** * @inheritdoc */ public function getAuthKey() { return $this->authKey;
      }
      /**
      * @inheritdoc
      */
      public function validateAuthKey($authKey) { return $this->authKey === $authKey; } /** * Validates password * * @param string $password password to validate
      * @return boolean if password provided is valid for current user
      */
      public function validatePassword($password) { return $this->password === $password;
      }
   }
?>

Step 1 - Vá para o URL http://localhost:8080/index.php?r=site/login e faça login no site usando admin para um login e uma senha.

Step 2 - Em seguida, adicione uma nova função chamada actionAuth() para o SiteController.

public function actionAuth(){
   // the current user identity. Null if the user is not authenticated.
   $identity = Yii::$app->user->identity; var_dump($identity);
   // the ID of the current user. Null if the user not authenticated.
   $id = Yii::$app->user->id;
   var_dump($id); // whether the current user is a guest (not authenticated) $isGuest = Yii::$app->user->isGuest; var_dump($isGuest);
}

Step 3 - Digite o endereço http://localhost:8080/index.php?r=site/auth no navegador da web, você verá as informações detalhadas sobre admin do utilizador.

Step 4 - Para fazer o login e logou, ta usuário pode utilizar o seguinte código.

public function actionAuth() {
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest); // find a user identity with the specified username. // note that you may want to check the password if needed $identity = User::findByUsername("admin");
   // logs in the user
   Yii::$app->user->login($identity);
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest); Yii::$app->user->logout();
   // whether the current user is a guest (not authenticated)
   var_dump(Yii::$app->user->isGuest);
}

Primeiramente, verificamos se o usuário está logado. Se o valor retorna false, então, logamos um usuário por meio do Yii::$app → user → login() ligue e desconecte-o usando o Yii::$app → user → logout() método.

Step 5 - Vá para o URL http://localhost:8080/index.php?r=site/auth, você verá o seguinte.

o yii\web\User classe levanta os seguintes eventos -

  • EVENT_BEFORE_LOGIN- Gerado no início de yii \ web \ User :: login ()

  • EVENT_AFTER_LOGIN - Gerado após um login bem-sucedido

  • EVENT_BEFORE_LOGOUT- Gerado no início de yii \ web \ User :: logout ()

  • EVENT_AFTER_LOGOUT - Criado após um logout bem-sucedido