本文是基於Laravel 5.4 版本的Auth模組程式碼進行分析書寫;
#模組組成
Auth模組從功能上分為使用者認證和權限管理兩個部分;從檔案組成上,Illuminate\Auth\Passwords目錄下是密碼重設或忘記密碼處理的小模組,Illuminate\Auth是負責使用者認證和權限管理的模組,Illuminate\Foundation\Auth提供了登入、修改密碼、重設密碼等一系統列具體邏輯實現;下圖展示了Auth模組各個文件的關係,並進行簡要說明;
##用戶認證
HTTP本身是無狀態,通常在系統互動的過程中,使用帳號或Token識別來決定認證使用者;設定檔解讀return [ 'defaults' => [ 'guard' => 'web', ... ], 'guards' => [ 'web' => [ 'driver' => 'session', 'provider' => 'users', ], 'api' => [ 'driver' => 'token', 'provider' => 'users', ], ], 'providers' => [ 'users' => [ 'driver' => 'eloquent', 'model' => App\User::class, ], ], ], ];
認證
##Session綁定認證資訊:
// $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 = [])
只在目前會話中認證, session中不記錄認證資訊:
public function once(array $credentials = []) public function onceUsingId($id) public function onceBasic($field = 'email', $extraConditions = [])
認證過程中(包含註冊、忘記密碼),定義的事件有這些:Attempting 嘗試驗證事件
Authenticated 驗證透過事件
Failed 驗證失敗事件
Lockout 失敗次數超過限制,鎖定該請求再次存取事件
Logi 透過'remember_token'成功登入時,呼叫的事件
Logout 用戶退出事件
Registered 用戶註冊事件
還有一些其他的認證方法:
檢查是否有認證使用者:Auth::check() 取得目前認證使用者:Auth::user()
退出系統:Auth::logout()
密碼處理
設定解讀
return [ 'defaults' => [ 'passwords' => 'users', ... ], 'passwords' => [ 'users' => [ 'provider' => 'users', 'table' => 'password_resets', 'expire' => 60, ], ], ]
從下往上,看設定;
passwords陣列是重置密碼的設定;users是設定方案的別名,包含三個元素:provider(提供使用者的方案,是上面providers陣列)、table(存放重設密碼token的表)、expire(token過期時間)
default 項目會設定預設的passwords 重設方案;
##重設密碼的呼叫與實作
先看看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; }
// 暴露的重置密码 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); }
$abilities = array( '定义的动作名,比如以路由的 as 名(common.dashboard.list)' => function($user) { // 方法的参数,第一位是 $user, 当前 user, 后面的参数可以自行决定 return true; // 返回 true 意味有权限, false 意味没有权限 }, ...... );
class PostPolicy { // update 权限,文章作者才可以修改 public function update(User $user, Post $post) { return $user->id === $post->user_id; } }
protected $policies = [ Post::class => PostPolicy::class, ];
指定用户是否具备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中文網其他相關文章!