Laravel 5.5 使用 Passport 實現 Auth 認證

最近在寫一個先後端分離項目，原本想用 Jwt-auth + Dingo 開發的，可是略感笨重，因而想到了 Laravel 的 Passport 和 5.5 新出的 Api Resource。Laravel Passport 是一套已經封裝好的 OAuth2 服務端實現，關於 OAuth2 我之後我會單獨寫一篇文章，因此這裏就不細說了，先來看看怎麼安裝它吧。

安裝

安裝 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，一切就大功告成啦～