Laravel中的Auth模块详解


Posted in PHP onAugust 17, 2017

前言

本文主要给大家介绍的是关于Laravel中Auth模块的相关内容,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧。

本文是基于Laravel 5.4 版本的本地化模块代码进行分析书写;

模块组成

Auth模块从功能上分为用户认证和权限管理两个部分;从文件组成上,Illuminate\Auth\Passwords目录下是密码重置或忘记密码处理的小模块,Illuminate\Auth是负责用户认证和权限管理的模块,Illuminate\Foundation\Auth提供了登录、修改密码、重置密码等一系统列具体逻辑实现;

下图展示了Auth模块各个文件的关系,并进行简要说明;

Laravel中的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中不记录认证信息:

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;
}

再看看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));

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

PHP 相关文章推荐
DedeCMS dede_channeltype表字段注释
Apr 07 PHP
php读取mysql乱码,用set names XXX解决的原理分享
Dec 29 PHP
PHP写的获取各搜索蜘蛛爬行记录代码
Aug 21 PHP
php存储过程调用实例代码
Feb 03 PHP
深入PHP curl参数的详解
Jun 17 PHP
php采用file_get_contents代替使用curl实例
Nov 07 PHP
php使用fputcsv()函数csv文件读写数据的方法
Jan 06 PHP
PHP的Yii框架使用中的一些错误解决方法与建议
Aug 21 PHP
WordPress开发中短代码的实现及相关函数使用技巧
Jan 05 PHP
php resizeimage 部分jpg文件 生成缩略图失败的原因分析及解决办法
Mar 23 PHP
PHP+Mysql无刷新问答评论系统(源码)
Dec 20 PHP
php array_map()函数实例用法
Mar 03 PHP
PHP实现基于回溯法求解迷宫问题的方法详解
Aug 17 #PHP
PHP基于Closure类创建匿名函数的方法详解
Aug 17 #PHP
PHP编译configure时常见错误的总结
Aug 17 #PHP
基于PHP常用文件函数和目录函数整理
Aug 17 #PHP
PHP实现的堆排序算法详解
Aug 17 #PHP
基于php编程规范(详解)
Aug 17 #PHP
PHP数据库操作四:mongodb用法分析
Aug 16 #PHP
You might like
PHP中PDO的错误处理
2011/09/04 PHP
PHP提取字符串中的图片地址[正则表达式]
2011/11/12 PHP
解决php接收shell返回的结果中文乱码问题
2014/01/23 PHP
php利用curl抓取新浪微博内容示例
2014/04/27 PHP
PHP类和对象相关系统函数与运算符小结
2016/09/28 PHP
PHP实现的同步推荐操作API接口案例分析
2016/11/30 PHP
关于图片验证码设计的思考
2007/01/29 Javascript
FireFox JavaScript全局Event对象
2009/06/14 Javascript
Jquery中获取iframe的代码
2011/01/11 Javascript
js取得url地址参数实例
2013/02/22 Javascript
$.getJSON在IE下失效的原因分析及解决方法
2013/06/16 Javascript
基于jquery编写的放大镜插件
2016/03/23 Javascript
jQuery动态添加可拖动元素完整实例(附demo源码下载)
2016/06/21 Javascript
JS实现iframe自适应高度的方法示例
2017/01/07 Javascript
AngularJS中ng-class用法实例分析
2017/07/06 Javascript
使用Nodejs连接mongodb数据库的实现代码
2017/08/21 NodeJs
Node.js文件编码格式的转换的方法
2018/04/27 Javascript
详解vuejs2.0 select 动态绑定下拉框支持多选
2019/04/25 Javascript
Node.js API详解之 repl模块用法实例分析
2020/05/25 Javascript
webpack 如何同时输出压缩和未压缩的文件的实现步骤
2020/06/05 Javascript
Python基于递归实现电话号码映射功能示例
2018/04/13 Python
解决pandas read_csv 读取中文列标题文件报错的问题
2018/06/15 Python
python opencv对图像进行旋转且不裁剪图片的实现方法
2019/07/09 Python
python logging添加filter教程
2019/12/24 Python
Python实现敏感词过滤的4种方法
2020/09/12 Python
快速创建python 虚拟环境
2020/11/28 Python
详解如何修改jupyter notebook的默认目录和默认浏览器
2021/01/24 Python
英国女鞋购物网站:Moda in Pelle
2019/02/18 全球购物
法国女性内衣购物网站:Glamuse
2019/05/13 全球购物
逻辑链路控制协议
2016/10/01 面试题
新入职员工的自我介绍演讲稿
2014/01/02 职场文书
学校关爱留守儿童活动方案
2014/08/27 职场文书
85句关于理想的名言警句大全
2019/08/22 职场文书
python实现简易自习室座位预约系统
2021/06/30 Python
React Fragment介绍与使用详解
2021/11/11 Javascript
Java中Dijkstra(迪杰斯特拉)算法
2022/05/20 Java/Android