LaravelのAuthモジュールの使用法

この記事は、Laravel 5.4 バージョンの Auth モジュール コードの分析と記述に基づいています;

モジュール構成

Auth モジュールは機能的に 2 つに分かれています部分: ユーザー認証と権限管理 ファイル構成の観点から見ると、Illuminate\Auth\Passwords ディレクトリは、パスワードのリセットまたは忘れたパスワードの処理のための小さなモジュールです。Illuminate\Auth は、ユーザー認証と権限管理を担当するモジュールです。Illuminate\Foundation\ Auth は、ログインおよび変更機能を提供します。パスワードやパスワードのリセットなど、システムの特定のロジック実装。次の図は、Auth モジュールのさまざまなファイル間の関係と簡単な説明を示しています。

#ユーザー認証##HTTP 自体はステートレスです。通常、システム対話のプロセスで、認証されたユーザーを決定するためにアカウントまたはトークン ID が使用されます。設定ファイルの解釈

return [
    'defaults' => [
        'guard' => 'web',
        ...
    ],
    'guards' => [  
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [    
            'driver' => 'token', 
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\User::class,
        ], 
    ],
], 
];

下から上に進んで理解してください。

providers はユーザー データを提供するインターフェイスであり、ドライバー オブジェクトとターゲット オブジェクトをマークする必要があります。ここで、キー名 users はeloquent によって駆動される一連のプロバイダーの名前、モーダルは App\User: :class;

ガード部分は認証管理部分用に構成されており、2 つの認証方法があり、1 つは Web と呼ばれます。もう 1 つは API です。Web 認証はセッション インタラクションに基づいており、ユーザー ID は sessionId に従って取得されます。ユーザーでは、このプロバイダーはユーザーにクエリを実行します。API 認証はトークン値インタラクションに基づいており、ユーザー プロバイダーも使用します。

defaults 項目は、Web 認証がデフォルトで使用されることを示します;

Authentication

セッション バインディング認証情報:

// $credentials数组存放认证条件，比如邮箱或者用户名、密码
// $remember 表示是否要记住，生成 `remember_token`
public function attempt(array $credentials = [], $remember = false) 
 
public function login(AuthenticatableContract $user, $remember = false)
 
public function loginUsingId($id, $remember = false)

HTTP 基本認証、認証情報はリクエスト ヘッダーに配置されます。後続のリクエストは sessionId を通じてアクセスされます。

public function basic($field = 'email', $extraConditions = [])

は現在のセッションでのみ認証され、認証情報はセッションに記録されません:

public function once(array $credentials = [])
public function onceUsingId($id)
public function onceBasic($field = 'email', $extraConditions = [])

認証プロセス (登録、パスワードを忘れた場合を含む) で定義されるイベントは次のとおりです。

Attempting イベントの検証を試みる

Authenticated 検証に合格したイベント

Failed 検証に失敗したイベント

ロックアウト失敗回数が制限を超えたので、再度アクセスするリクエストをロックします。イベント

「remember_token」を介して正常にログインしたときに呼び出されるLogiイベント

ログアウト ユーザー終了イベント

Registered ユーザー登録イベント

他にもいくつかの認証方法があります:

認証されたユーザーが存在するかどうかを確認します: Auth::check()

Get現在認証されているユーザー: Auth::user()

システムを終了します: Auth::logout()

パスワード処理

設定の解釈

return [
    'defaults' => [
        'passwords' => 'users',
        ...
    ],
    
    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
        ],
    ],
]

Look設定では下から上に;

passwords 配列は、パスワードをリセットするための設定です; users は、次の 3 つの要素を含む設定スキームのエイリアスです: プロバイダー (上記のユーザーのスキームを提供します)プロバイダー 配列)、テーブル (リセット パスワード トークンを保存するテーブル)、Expiry (トークンの有効期限)

デフォルト項目は、デフォルトのパスワード リセット スキームを設定します。

パスワードのリセットの呼び出しと実装

最初に、Laravel のパスワードリセット機能がどのように実装されているかを見てください:

public function reset(array $credentials, Closure $callback) {
    // 验证用户名、密码和 token 是否有效
    $user = $this->validateReset($credentials);
    if (! $user instanceof CanResetPasswordContract) {
         return $user;
    }    
    
    $password = $credentials['password'];
    // 回调函数执行修改密码，及持久化存储
    $callback($user, $password);
    // 删除重置密码时持久化存储保存的 token
    $this->tokens->delete($user);
    return static::PASSWORD_RESET;
}

次に、Foundation\Auth モジュールによってカプセル化されたパスワードリセットモジュールがどのように呼び出されるかを見てください:

// 暴露的重置密码 API
public function reset(Request $request)   {
    // 验证请求参数 token、email、password、password_confirmation
    $this->validate($request, $this->rules(), $this->validationErrorMessages());
    // 调用重置密码的方法，第二个参数是回调，做一些持久化存储工作
    $response = $this->broker()->reset(
        $this->credentials($request), function ($user, $password) {
        $this->resetPassword($user, $password);
        }
    );
    // 封装 Response
    return $response == Password::PASSWORD_RESET
        ? $this->sendResetResponse($response)
        : $this->sendResetFailedResponse($request, $response);
}
// 获取重置密码时的请求参数
protected function credentials(Request $request)  {
    return $request->only(
        'email', 'password', 'password_confirmation', 'token'
    );
}
// 重置密码的真实性验证后，进行的持久化工作
protected function resetPassword($user, $password) {
    // 修改后的密码、重新生成 remember_token
    $user->forceFill([
        'password' => bcrypt($password),
        'remember_token' => Str::random(60),
    ])->save();
    // session 中的用户信息也进行重新赋值                                     
    $this->guard()->login($user);
}

「パスワードを忘れた場合=> メールを送信=> パスワードをリセット」の一般的なプロセスは次のとおりです:

「パスワードを忘れた場合」をクリックし、ルーティング設定ページから「パスワードを忘れた場合」にジャンプします。ページ上の「送信するメール」フィールドに入力します。

「送信するメール」がデータベースに存在するかどうかを確認します。存在する場合は、パスワード リセットのメールをメールボックスに送信します。

パスワード リセットの電子メールにはリンクがあり (クリックするとトークンがパスワード変更ページに移動します)、このトークンのハッシュ暗号化された値がデータベースに保存されます。

記入してください。 「メール」、「パスワード」と「パスワードの確認」の 3 つのフィールドの後に、トークンを持ってパスワードリセット API にアクセスします。ホームページは、メール、パスワード、パスワードの確認の 3 つのフィールドを決定し、トークンが正しいかどうかを検証します。は有効です; そうであれば、リセットは成功です;

アクセス許可管理

アクセス許可管理は、メモリ空間に維持される配列変数の機能に依存して維持されます。その構造は次のとおりです。次のように:

$abilities = array(
    '定义的动作名，比如以路由的 as 名(common.dashboard.list)' => function($user) {
        // 方法的参数，第一位是 $user, 当前 user, 后面的参数可以自行决定
        return true;  // 返回 true 意味有权限， false 意味没有权限
    },
    ......
);

ただし、$abilities を使用するだけで済みますコードの定義された部分を使用してまとめるのはあまりにも面倒なので、ポリシー戦略クラスが表示されます;

ポリシー戦略クラスは以下を定義しますエンティティのグループとエンティティのアクセス許可クラスの間の対応関係。たとえば、この記事を例に挙げます:

Post というモーダル エンティティ クラスがあります。このエンティティ クラスに対して PostPolicy アクセス許可クラスを定義できます。この権限クラスのメソッド名としていくつかのアクションを定義します。

class PostPolicy {
    // update 权限，文章作者才可以修改
    public function update(User $user, Post $post) {
        return $user->id === $post->user_id;
    }
}

次に、それを ServiceProvider に登録して、チェックするクラスが Post オブジェクトであるかどうかをシステムが認識できるように、指定したアクション名を加えます。システムは PostPolicy クラスの対応するメソッドを見つけます;

protected $policies = [
    Post::class => PostPolicy::class,
];

それを呼び出す方法は?

能力配列で定義された権限の場合:

現在のユーザーが common.dashboard.list 権限を持っているかどうか: Gate::allows('common.dashboard.list')

現在のユーザーが common.dashboard.list 権限を持っているかどうか:! Gate::denies('common.dashboard.list')

現在のユーザーが common.dashboard.list 権限を持っているかどうか: $request-> user() ->can('common.dashboard.list')

現在のユーザーが common.dashboard.list 権限を持っているかどうか:! $request->user()->cannot('common .dashboard.list ')

指定用户是否具备common.dashboard.list权限：Gate::forUser($user)->allows('common.dashboard.list')

对于policy策略类调用的权限：

当前用户是否可以修改文章（Gate 调用）：Gate::allows('update', $post)

当前用户是否可以修改文章（user 调用）：$user->can('update', $post)

当前用户是否可以修改文章（用帮助函数）：policy($post)->update($user, $post)

当前用户是否可以修改文章（Controller 类方法中调用）：$this->authorize('update', $post);

当前用户是否可以修改文章（Controller 类同名方法中调用）：$this->authorize($post);

指定用户是否可以修改文章（Controller 类方法中调用）：$this->authorizeForUser($user, 'update', $post);

有用的技巧

获取当前系统注册的权限，包括两部分abilities和policies数组内容，代码如下：

$gate = app(\Illuminate\Contracts\Auth\Access\Gate::class);
$reflection_gate = new ReflectionClass($gate);
$policies = $reflection_gate->getProperty('policies');
$policies->setAccessible(true);
// 获取当前注册的 policies 数组
dump($policies->getValue($gate));
                                                                                                        
$abilities = $reflection_gate->getProperty('abilities');                                       
$abilities->setAccessible(true);
// 获取当前注册的 abilities 数组
dump($abilities->getValue($gate));

推荐教程：《Laravel教程》

以上がLaravelのAuthモジュールの使用法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。