Laravel5.5中利用Passport實現Auth認證的方法講解

Laravel5.3 開始使用Passport作為API授權,Passport 是基於 OAuth2 的，下面這篇文章主要給大家介紹了關於Laravel5.5中利用Passport實現Auth認證的方法，文中通過範例程式碼介紹介紹的非常詳細，需要的朋友可以參考借鑒，下面來一起看看吧。

前言

最近在寫一個前後端分離項目，本來想用 Jwt-auth + Dingo 開發的，但是略感笨重，於是想到了 Laravel 的 Passport 和 5.5 新出的 Api Resource。Laravel Passport 是一套已經封裝好的 OAuth2 服務端實現

OAuth是一個關於授權（authorization）的開放網路標準，在全世界得到廣泛應用，目前的版本是2.0版。

OAuth 2.0 是目前比較流行的做法，它率先被Google, Yahoo, Microsoft, Facebook等使用。之所以標註為 2.0，是因為最初有一個1.0協議，但這個1.0協議被弄得太複雜，易用性差，所以沒有得到普及。2.0是一個新的設計，協議簡單清晰，但它並不相容1.0，可以說與1.0沒什麼關係。

所以這裡就不細說了，先來看看怎麼安裝它吧。

安裝

安裝 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 模型中

<?phpnamespace 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，當然，這個函數是我根據我的商務邏輯自己封裝的，如果不適合你的商務邏輯你可以自行調整。

<?phpnamespace 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 內容如下

<?phpreturn [ '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=passwordOAUTH_CLIENT_ID=2OAUTH_CLIENT_SECRET=2HaTQJF33Sx98HjcKDiSVWZjrhVYGgkHGP8XLG1OOAUTH_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，一切就大功告成啦～

總結

您可能感興趣的文章:

PHP中你可能忽略的效能最佳化利器：產生器的相關內容

Laravel架構中composer自動載入的實現詳解

PHP服務端環境搭建的圖文教程