Laravel5.5中利用Passport实现Auth认证的方法
前言
最近在写一个前后端分离项目,本来想用Jwt-auth+Dingo开发的,但是略感笨重,于是想到了Laravel的Passport和5.5新出的ApiResource。LaravelPassport是一套已经封装好的OAuth2服务端实现
OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版。
OAuth2.0是目前比较流行的做法,它率先被Google,Yahoo,Microsoft,Facebook等使用。之所以标注为2.0,是因为最初有一个1.0协议,但这个1.0协议被弄得太复杂,易用性差,所以没有得到普及。2.0是一个新的设计,协议简单清晰,但它并不兼容1.0,可以说与1.0没什么关系。
所以这里就不细说了,先来看看怎么安装它吧。
安装
安装Passport
1.在你的Shell中执行以下命令
composerrequirelaravel/passport
如果你使用的Laravel版本是5.5以下,你需要手动在config/app.php文件providers数组中加入如下代码
Laravel\Passport\PassportServiceProvider::class,
2.运行迁移文件
在你的Shell中执行如下命令
phpartisanmigrate
Passport服务提供器使用框架注册自己的迁移目录,因此在注册服务后,你可以直接运行phpartisanmigrate来为Passport生成所需的数据表
3.生成加密密钥
在你的Shell中执行如下命令
phpartisanpassport:install
此命令会创建生成安全访问令牌时所需的加密密钥,同时,这条命令也会创建用于生成访问令牌的「个人访问」客户端和「密码授权」。
4.添加Trait
将LaravelPassportHasApiTokensTrait添加到AppUser模型中
5.注册路由
在AuthServiceProvider的boot方法中调用Passport::routes函数。
classAuthServiceProviderextendsServiceProvider { publicfunctionboot() { $this->registerPolicies(); Passport::routes(); } }如果你的程序是需要前后端分离形式的OAuth认证而不是多平台认证那么你可以在routers()方法中传递一个匿名函数来自定定义自己需要注册的路由,我这里是前后端分离的认证形式,因此我只需要对我的前端一个Client提供Auth的认证,所以我只注册了获取Token的路由,同时我还为它自定义了前缀名。
Passport::routes(function(RouteRegistrar$router){ $router->forAccessTokens(); },['prefix'=>'api/oauth']);6.更改看守器驱动
将配置文件config/auth.php中授权看守器guards的api的driver选项改为passport。此调整会让你的应用程序在在验证传入的API的请求时使用Passport的TokenGuard来处理
'guards'=>[ 'web'=>[ 'driver'=>'session', 'provider'=>'users', ], 'api'=>[ 'driver'=>'passport', 'provider'=>'users', ], ],至此Passport已经安装完成,剩下的文档里所讲到的前端部分的话,由于我是只需要使用它做Auth的认证,并不需要实现完整的OAuth功能,所以我们完全可以不使用前端页面。
使用
为了Api返回数据方便,我封装了几个函数
functionrespond($status,$respond) { returnresponse()->json(['status'=>$status,is_string($respond)?'message':'data'=>$respond]); } functionsucceed($respond='Requestsuccess!') { returnrespond(true,$respond); } functionfailed($respond='Requestfailed!') { returnrespond(false,$respond); }respond函数可以做基本返回,succeed和failed是在respond函数上做的再次封装,用以返回请求成功和请求失败数据。
然后我们需要使用一层代理。
先说一下使用代理的原因,Passport认证的流程是从属应用带着主应用
生成的ClientToken和用户输入的账号密码去请求主应用的PassportToken路由,以获得accesstoken(访问令牌)和refreshtoken(刷新令牌),然后带着得到的accesstoken就可以访问auth:api下的路由了。但是我们并没有从属应用,是由前后端分离的前端来请求这个token,如果从前端想来拉取这个accesstoken就需要把Clienttoken写死在前端里,这样是很不合理的,所以我们可以在内部写一个代理,由应用自身带着Clienttoken去请求自身以获取accesstoken,这样说可能有一点绕,大概请求过程是下面这个样子
1.前端带着用户输入的账号密码请求服务端
2.服务端带着从前端接收到账号与密码,并在其中添加Client_id与Client_token,然后带着这些参数请求自身的Passport认证路由,然后返回认证后的Accesstoken与refreshtoken
下面是代码实现,我在AppHttpControllersTraits下新建了一个ProxyHelpers的Trait,当然,这个函数是我根据我的业务逻辑自己封装的,如果不适合你的业务逻辑你可以自行调整。
root().'/api/oauth/token'; $params=array_merge(config('passport.proxy'),[ 'username'=>request('email'), 'password'=>request('password'), ]); $respond=$client->request('POST',$url,['form_params'=>$params]); }catch(RequestException$exception){ thrownewUnauthorizedException('请求失败,服务器错误'); } if($respond->getStatusCode()!==401){ returnjson_decode($respond->getBody()->getContents(),true); } thrownewUnauthorizedException('账号或密码错误'); } }config/passport.php内容如下
[ 'grant_type'=>env('OAUTH_GRANT_TYPE'), 'client_id'=>env('OAUTH_CLIENT_ID'), 'client_secret'=>env('OAUTH_CLIENT_SECRET'), 'scope'=>env('OAUTH_SCOPE','*'), ], ];env文件内容如下
OAUTH_GRANT_TYPE=password OAUTH_CLIENT_ID=2 OAUTH_CLIENT_SECRET=2HaTQJF33Sx98HjcKDiSVWZjrhVYGgkHGP8XLG1O OAUTH_SCOPE=*我们需要用到的clienttoken是id为2的clienttoken,不要搞错了哟~
然后我们只需要在控制器中use这个Trait,然后调用$this->authenticate()就可以得到认证成功的token,如果请求失败的话,你可以使用catch来捕捉错误抛出异常。
publicfunctionlogin(Request$request) { $needs=$this->validate($request,rules('login')); $user=User::where('email',$needs['email'])->first(); if(!$user){ thrownewUnauthorizedException('此用户不存在'); } $tokens=$this->authenticate(); returnsucceed(['token'=>$tokens,'user'=>newUserResource($user)]); }得到的tokens返回如以下格式
{ "token_type":"Bearer", "expires_in":31536000, "access_token":"token_str", "refresh_token":"token_str" }做完这一切后你就可以在前端向这样子请求服务端了
axios.post('yourdomain/login',login_form).then(resource=>{ })如果请求成功,那么你将会得到用户的信息和accesstoken,refreshtoken。
然后在你的前端http请求header里需要加入一个参数Authorization
axios.defaults.headers.common['Authorization']=token.token_type+''+token.access_token然后在你需要使用到auth认证的路由里使用中间件auth:api,一切就大功告成啦~
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对毛票票的支持。