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.產生加密金鑰
php artisan passport:install
4.新增Trait
#
<?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.註冊路由
Passport::routes 函數。
class AuthServiceProvider extends ServiceProvider { public function boot() { $this->registerPolicies(); Passport::routes(); } }
Passport::routes(function(RouteRegistrar $router) { $router->forAccessTokens(); },['prefix' => 'api/oauth']);
6.更改看守器驅動程式
'guards' => [ 'web' => [ 'driver' => 'session', 'provider' => 'users', ], 'api' => [ 'driver' => 'passport', 'provider' => 'users', ], ],
使用
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 認證的流程是從屬應用程式帶著主應用程式
#
下面是代码实现,我在 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中的Package Auto Discovery详情介绍
以上是Laravel5.5中利用Passport實現Auth認證的方法的詳細內容。更多資訊請關注PHP中文網其他相關文章!