如何在Laravel5.5中使用Passport实现一个Auth认证功能

这篇文章将为大家详细讲解有关如何在Laravel5.5中使用Passport实现一个Auth认证功能，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。

安装

安装 Passport

1.在你的 Shell 中执行以下命令

composer require laravel/passport

如果你使用的 Laravel 版本是 5.5 以下，你需要手动在 config/app.php 文件 providers 数组中加入如下代码

Laravel\Passport\PassportServiceProvider::class,

2.运行迁移文件

在你的 Shell 中执行如下命令

php artisan migrate

Passport 服务提供器使用框架注册自己的迁移目录，因此在注册服务后，你可以直接运行 php artisan migrate 来为 Passport 生成所需的数据表

3.生成加密密钥

在你的 Shell 中执行如下命令

php artisan passport:install

此命令会创建生成安全访问令牌时所需的加密密钥，同时，这条命令也会创建用于生成访问令牌的「个人访问」客户端和「密码授权」。

4.添加 Trait

将 LaravelPassportHasApiTokens Trait 添加到 AppUser 模型中

<?php namespace App; use Laravel\Passport\HasApiTokens; use Illuminate\Notifications\Notifiable; use Illuminate\Foundation\Auth\User as Authenticatable; class User extends Authenticatable {  use HasApiTokens, Notifiable; }

5.注册路由

在 AuthServiceProvider 的 boot 方法中调用 Passport::routes 函数。

class AuthServiceProvider extends ServiceProvider {  public function boot()  {   $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 返回数据方便，我封装了几个函数

function respond($status, $respond) {  return response()->json(['status' => $status, is_string($respond) ? 'message' : 'data' => $respond]); } function succeed($respond = 'Request success!') {  return respond(true, $respond); } function failed($respond = 'Request failed!') {  return respond(false, $respond); }

respond 函数可以做基本返回，succeed 和 failed 是在 respond 函数上做的再次封装，用以返回请求成功和请求失败数据。

然后我们需要使用一层代理。

先说一下使用代理的原因，Passport 认证的流程是 从属应用带着 主应用

生成的 Client Token 和 用户输入的账号密码去请求主应用的 Passport Token 路由，以获得 access token （访问令牌） 和 refresh token （刷新令牌），然后带着得到的 access token 就可以访问 auth:api 下的路由了。但是我们并没有从属应用，是由前后端分离的前端来请求这个token，如果从前端想来拉取这个 access token 就需要把 Client token 写死在前端里，这样是很不合理的，所以我们可以在内部写一个代理，由应用自身带着 Client token 去请求自身以获取 access token，这样说可能有一点绕，大概请求过程是下面这个样子

1.前端带着用户输入的账号密码请求服务端

2.服务端带着从前端接收到账号与密码，并在其中添加 Client_id 与 Client_token，然后带着这些参数请求自身的 Passport 认证路由，然后返回认证后的 Access token 与 refresh token

下面是代码实现,我在 AppHttpControllersTraits 下新建了一个 ProxyHelpers 的 Trait，当然，这个函数是我根据我的业务逻辑自己封装的，如果不适合你的业务逻辑你可以自行调整。

<?php namespace App\Http\Controllers\Traits; use GuzzleHttp\Client; use App\Exceptions\UnauthorizedException; use GuzzleHttp\Exception\RequestException; trait ProxyHelpers {  public function authenticate()  {   $client = new Client();   try {    $url = request()->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) {    throw new UnauthorizedException('请求失败，服务器错误');   }   if ($respond->getStatusCode() !== 401) {    return json_decode($respond->getBody()->getContents(), true);   }   throw new UnauthorizedException('账号或密码错误');  } }

config/passport.php 内容如下

<?php return [  'proxy' => [   '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=*

我们需要用到的 client token 是 id 为 2 的 client token，不要搞错了哟～

然后我们只需要在控制器中 use 这个 Trait，然后调用 $this->authenticate() 就可以得到认证成功的 token，如果请求失败的话，你可以使用 catch 来捕捉错误抛出异常。

 public function login(Request $request) {   $needs = $this->validate($request, rules('login'));   $user = User::where('email', $needs['email'])->first();   if (!$user) {    throw new UnauthorizedException('此用户不存在');   }   $tokens = $this->authenticate();   return succeed(['token' => $tokens, 'user' => new UserResource($user)]); }

得到的 tokens 返回如以下格式

{  "token_type": "Bearer",  "expires_in": 31536000,  "access_token": "token_str",  "refresh_token": "token_str" }

做完这一切后你就可以在前端向这样子请求服务端了

axios.post('yourdomain/login',login_form).then(resource => {  })

如果请求成功，那么你将会得到 用户的信息和 access token，refresh token。

然后在你的前端 http 请求 header 里需要加入一个参数 Authorization

axios.defaults.headers.common['Authorization'] = token.token_type + ' ' + token.access_token

然后在你需要使用到 auth 认证的路由里使用中间件 auth:api，一切就大功告成啦～

关于如何在Laravel5.5中使用Passport实现一个Auth认证功能就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。