コードでわかるLaravelのブラウザ認証

fireAttemptEvent

初めにfireAttemptEvent()メソッドが呼ばれ、Attemptingイベントが発行されます。

/**
 * Fire the attempt event with the arguments.
 *
 * @param  array  $credentials
 * @param  bool  $remember
 * @return void
 */protected function fireAttemptEvent(array $credentials, $remember = false)
{
    if (isset($this->events)) {
        $this->events->dispatch(new Attempting(
            $this->name, $credentials, $remember
        ));
    }
}

retrieveByCredentials

login

ここでは、(1)セッションストレージのIDを更新し、$rememberがtrueかつ、RememberTokenが空の場合、(2)新しいRememberTokenを発行して、(3)クッキーが更新されます。その後、(4)Loginイベントが発行されて、認証されたユーザーがセットされ、Authenticatedイベントが発行されます。

/**
 * Log a user into the application.
 *
 * @param  \Illuminate\Contracts\Auth\Authenticatable  $user
 * @param  bool  $remember
 * @return void
 */public function login(AuthenticatableContract $user, $remember = false)
{
    // (1)
    $this->updateSession($user->getAuthIdentifier());

    // If the user should be permanently "remembered" by the application we will
    // queue a permanent cookie that contains the encrypted copy of the user
    // identifier. We will then decrypt this later to retrieve the users.
    if ($remember) {
        // (2)
        $this->ensureRememberTokenIsSet($user);

        // (3)
        $this->queueRecallerCookie($user);
    }

    // (4)
    // If we have an event dispatcher instance set we will fire an event so that
    // any listeners will hook into the authentication events and run actions
    // based on the login and logout events fired from the guard instances.
    $this->fireLoginEvent($user, $remember);

    // (5)
    $this->setUser($user);
}

EloquentUserProvider

retrieveByCredentials

SessionGuardクラスのattempt()メソッドから呼ばれます。渡されたcredentialsをもとにユーザーを取得し、modelを返却します。

(1)渡されたcredentialsをチェックし、問題があればnullを返却します。(2)認証用のmodelを返却します。(3)認証のためのクエリを組み立てます。(4)最初に見つかったユーザーを返却します。

/**
 * Retrieve a user by the given credentials.
 *
 * @param  array  $credentials
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */public function retrieveByCredentials(array $credentials)
{
    // (1)
    if (empty($credentials) ||
        (count($credentials) === 1 &&
        Str::contains($this->firstCredentialKey($credentials), 'password'))) {
        return;
    }

    // (2)
    // First we will add each credential element to the query as a where clause.
    // Then we can execute the query and, if we found a user, return it in a
    // Eloquent User "model" that will be utilized by the Guard instances.
    $query = $this->newModelQuery();

    foreach ($credentials as $key => $value) {
        if (Str::contains($key, 'password')) {
            continue;
        }

        // (3)
        if (is_array($value) || $value instanceof Arrayable) {
            $query->whereIn($key, $value);
        } else {
            $query->where($key, $value);
        }
    }

    // (4)
    return $query->first();
}

retrieveByToken

SessionGuardクラスのuserFromRecallerメソッドから呼ばれます。渡されたユーザーを識別する値をもとにユーザーを取得し、そのユーザーのRememberTokenとユーザーを比較して、modelまたはnullを返却します。

(1)認証用のmodelを返却します。(2)認証のためのクエリを組み立て、最初に見つかったユーザーを返却します。(3)ユーザーが見つからなければnullを返却します。(4)見つかったユーザーのRememberTokenを取得します。(5)渡されたRememberTokenとユーザーのRememberTokenを比較し、一致すればユーザーを、一致しなければnullを返却します。

/**
 * Retrieve a user by their unique identifier and "remember me" token.
 *
 * @param  mixed  $identifier
 * @param  string  $token
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */public function retrieveByToken($identifier, $token)
{
    // (1)
    $model = $this->createModel();

    // (2)
    $retrievedModel = $this->newModelQuery($model)->where(
        $model->getAuthIdentifierName(), $identifier
    )->first();

    // (3)
    if (! $retrievedModel) {
        return;
    }

    // (4)
    $rememberToken = $retrievedModel->getRememberToken();

    // (5)
    return $rememberToken && hash_equals($rememberToken, $token)
                    ? $retrievedModel : null;
}

DatabaseUserProvider

EloquentUserProviderと同じく、データベースなどの永続ストレージからユーザーを取得する機能を提供します。EloquentUserProviderでは、ユーザーの取得にEloquentを使っていましたが、こちらはクエリビルダーを使います。

/**
 * Retrieve a user by the given credentials.
 *
 * @param  array  $credentials
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */public function retrieveByCredentials(array $credentials)
{
    // (1)
    if (empty($credentials) ||
        (count($credentials) === 1 &&
        array_key_exists('password', $credentials))) {
        return;
    }

    // (2)
    // First we will add each credential element to the query as a where clause.
    // Then we can execute the query and, if we found a user, return it in a
    // generic "user" object that will be utilized by the Guard instances.
    $query = $this->conn->table($this->table);

    foreach ($credentials as $key => $value) {
        if (Str::contains($key, 'password')) {
            continue;
        }

        // (3)
        if (is_array($value) || $value instanceof Arrayable) {
            $query->whereIn($key, $value);
        } else {
            $query->where($key, $value);
        }
    }

    // (4)
    // Now we are ready to execute the query to see if we have an user matching
    // the given credentials. If not, we will just return nulls and indicate
    // that there are no matching users for these given credential arrays.
    $user = $query->first();

    // (5)
    return $this->getGenericUser($user);
}

/**
 * Retrieve a user by their unique identifier and "remember me" token.
 *
 * @param  mixed  $identifier
 * @param  string  $token
 * @return \Illuminate\Contracts\Auth\Authenticatable|null
 */public function retrieveByToken($identifier, $token)
{
    // (1)
    $user = $this->getGenericUser(
        $this->conn->table($this->table)->find($identifier)
    );

    // (2)
    return $user && $user->getRememberToken() && hash_equals($user->getRememberToken(), $token)
                ? $user : null;
}