首頁 > 後端開發 > php教程 > 詳解Laravel框架中的Auth模組

詳解Laravel框架中的Auth模組

巴扎黑
發布: 2023-03-15 11:40:01
原創
3255 人瀏覽過

最近在工作中遇到了Auth模組,但是對Auth模組一知半解,透過查找相關的資料來了解學習,所以下面這篇文章主要給大家介紹了關於Laravel中Auth模組的相關資料,文中透過範例程式碼介紹的非常詳細,需要的朋友可以參考借鑒,下面來一起看看吧。

前言

本文主要介紹給大家的是關於Laravel中Auth模組的相關內容,分享出來供大家參考學習,下面話不多說了,來一起看看詳細的介紹吧。

本文是基於Laravel 5.4 版本的本地化模組程式碼進行分析書寫;

#模組組成


## 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,
     ], 
     ],
    ], 
    ];
    登入後複製
  • 從下往上,理解;

providers是提供用戶資料的接口,要標註驅動對象和目標對象;此處,鍵名users是一套provider的名字,採用eloquent驅動,modal是App\User::class;

guards部分針對認證管理部分進行配置;有兩種認證方式,一種叫web,還有一種是api;web認證是基於Session交互,根據sessionId獲取用戶id,在users這個provider查詢出此用戶;api認證是基於token值交互,也採用users這個provider;

defaults項顯示預設使用web認證;

#認證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中不記錄認證資訊:認證過程中(包含註冊、忘記密碼),定義的事件有這些:嘗試驗證事件驗證透過事件##驗證失敗事件#Lockout失敗次數超過限制,鎖住該請求再次存取事件Logi透過'remember_token'成功登錄時,呼叫的事件
public function once(array $credentials = [])

public function onceUsingId($id)

public function onceBasic($field = 'email', $extraConditions = [])
登入後複製
事件名稱描述
#Attempting
Authenticated
Failed
###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;
}
登入後複製

再看看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);
}
登入後複製

“忘记密码 => 发邮件 => 重置密码” 的大体流程如下:

  • 点击“忘记密码”,通过路由配置,跳到“忘记密码”页面,页面上有“要发送的邮箱”这个字段要填写;

  • 验证“要发送的邮箱”是否是数据库中存在的,如果存在,即向该邮箱发送重置密码邮件;

  • 重置密码邮件中有一个链接(点击后会携带 token 到修改密码页面),同时数据库会保存这个 token 的哈希加密后的值;

  • 填写“邮箱”,“密码”,“确认密码”三个字段后,携带 token 访问重置密码API,首页判断邮箱、密码、确认密码这三个字段,然后验证 token是否有效;如果是,则重置成功;

权限管理

权限管理是依靠内存空间维护的一个数组变量abilities来维护,结构如下:

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

但只用 $abilities,会使用定义的那部分代码集中在一起太烦索,所以有policy策略类的出现;

policy策略类定义一组实体及实体权限类的对应关系,比如以文章举例:

有一个 Modal实体类叫 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,
];
登入後複製

怎么调用呢?

对于定义在abilities数组的权限:

  • 当前用户是否具备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框架中的Auth模組的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板