在Web應(yīng)用程序開發(fā)中,常常需要使用OAuth2協(xié)議進(jìn)行用戶身份驗(yàn)證和授權(quán),以便用戶可以安全地使用第三方服務(wù)。通過使用Laravel Passport,你可以方便地處理OAuth2協(xié)議,實(shí)現(xiàn)在Laravel應(yīng)用程序中的身份驗(yàn)證和授權(quán)。
Laravel Passport是一個(gè)開源軟件包,提供了一個(gè)完整的OAuth2服務(wù)器實(shí)現(xiàn),包括Token生成、Token管理、作用域等功能,使得OAuth2協(xié)議在Laravel應(yīng)用程序中的實(shí)現(xiàn)變得非常容易。
本文將向你介紹如何使用Laravel Passport來管理OAuth2協(xié)議。
使用Laravel Passport生成API密鑰
在使用OAuth2協(xié)議之前,我們需要生成API密鑰。API密鑰將作為OAuth2客戶端ID和密鑰使用,并用于獲取訪問令牌。我們可以使用Laravel Passport提供的artisan命令生成API密鑰。
首先,使用composer安裝Laravel Passport:
composer require laravel/passport
登錄后復(fù)制
然后,運(yùn)行遷移命令:
php artisan migrate
登錄后復(fù)制
接下來,使用Passport的client:secret命令生成API密鑰:
php artisan passport:client --password
登錄后復(fù)制
這將生成一個(gè)客戶端ID和一個(gè)客戶端密鑰。
配置OAuth2服務(wù)
在生成API密鑰之后,我們需要配置OAuth2服務(wù)。Laravel Passport提供了一些配置選項(xiàng),可以通過修改Laravel應(yīng)用程序的config/auth.php文件來配置這些選項(xiàng)。
在auth.php文件中,我們需要設(shè)置api驅(qū)動(dòng)程序?yàn)镻assport驅(qū)動(dòng)程序,這樣Laravel就會(huì)使用Passport來處理用戶身份驗(yàn)證和授權(quán)。
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'passport',
'provider' => 'users',
'hash' => false,
],
],
登錄后復(fù)制
創(chuàng)建OAuth2路由
接下來,我們需要在應(yīng)用程序中創(chuàng)建一些OAuth2路由,這些路由將用于處理OAuth2請(qǐng)求。我們可以使用Laravel Passport提供的自動(dòng)生成路由的artisan命令來創(chuàng)建這些路由。
php artisan passport:routes
登錄后復(fù)制
這將自動(dòng)生成以下路由:
+-----------+------------------------+-------------------------------------------------+---------------------------------+------------------------------------------------------------------+------------------------+
| Method | URI | Name | Action | Middleware | In |
+-----------+------------------------+-------------------------------------------------+---------------------------------+------------------------------------------------------------------+------------------------+
| GET|HEAD | oauth/authorize | passport.authorizations.authorize | LaravelPassportHttpControllersAuthorizationController@show | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:view-authorizations |
| POST | oauth/authorize | passport.authorizations.approve | LaravelPassportHttpControllersApproveAuthorizationController | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:approve-authorizations |
| DELETE | oauth/authorize | passport.authorizations.deny | LaravelPassportHttpControllersDenyAuthorizationController | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:deny-authorizations |
| POST | oauth/clients | passport.clients.store | LaravelPassportHttpControllersClientController@store | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:create-clients |
| GET|HEAD | oauth/clients | passport.clients.index | LaravelPassportHttpControllersClientController@forUser | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:view-clients |
| PUT | oauth/clients/{client} | passport.clients.update | LaravelPassportHttpControllersClientController@update | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:update-clients |
| DELETE | oauth/clients/{client} | passport.clients.destroy | LaravelPassportHttpControllersClientController@destroy | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:delete-clients |
| POST | oauth/token | passport.token | LaravelPassportHttpControllersAccessTokenController@issueToken| throttle | LaravelPassportHttpMiddlewareCheckClientCredentials,can:issue-tokens |
| POST | oauth/token/refresh | passport.token.refresh | LaravelPassportHttpControllersTransientTokenController@refresh | throttle | LaravelPassportHttpMiddlewareCheckClientCredentials,can:refresh-tokens |
| DELETE | oauth/tokens/{token} | passport.tokens.destroy | LaravelPassportHttpControllersAuthorizedAccessTokenController@destroy | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,throttle:60,1,oauth |
| GET|HEAD | oauth/tokens | passport.tokens.index | LaravelPassportHttpControllersAuthorizedAccessTokenController@forUser | web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:view-tokens |
| DELETE | oauth/tokens | passport.tokens.destroy.all | LaravelPassportHttpControllersAuthorizedAccessTokenController@destroyAll| web,auth | LaravelPassportHttpMiddlewareCheckClientCredentials,can:delete-tokens |
+-----------+------------------------+-------------------------------------------------+---------------------------------+------------------------------------------------------------------+------------------------+
登錄后復(fù)制
這些路由都是Passport內(nèi)置的路由,并使用passport.前綴名稱。
定義OAuth2客戶端
現(xiàn)在我們已經(jīng)準(zhǔn)備好了,可以開始定義OAuth2客戶端了。我們可以使用先前生成的API密鑰來創(chuàng)建OAuth2客戶端。
在數(shù)據(jù)庫中創(chuàng)建一個(gè)新的OAuth2客戶端。我們可以手動(dòng)創(chuàng)建它,或使用Laravel Passport提供的artisan命令passport:client來創(chuàng)建它。
在創(chuàng)建過程中,我們需要指定客戶端的名稱、密鑰、回調(diào)URL等。
手動(dòng)創(chuàng)建:
INSERT INTO `oauth_clients` (`id`, `user_id`, `name`, `secret`, `redirect`, `revoked`, `personal_access_client`, `password_client`, `updated_at`, `created_at`) VALUES (1, NULL, 'My Client', 'my-client-secret', 'http://localhost/callback', 0, 0, 1, '2021-10-01 00:00:00', '2021-10-01 00:00:00');
登錄后復(fù)制
用artisan創(chuàng)建:
php artisan passport:client --client --name="My Client"
登錄后復(fù)制
運(yùn)行此命令后,它將自動(dòng)生成OAuth2客戶端,并顯示客戶端ID和密鑰。
生成OAuth2訪問令牌
現(xiàn)在我們已經(jīng)準(zhǔn)備好了OAuth2客戶端,并定義了OAuth2路由,我們可以開始使用OAuth2協(xié)議來生成訪問令牌。
我們可以使用passport:client命令生成訪問令牌:
php artisan passport:client --client --password
登錄后復(fù)制
運(yùn)行此命令后,它將生成一個(gè)OAuth2客戶端并自動(dòng)為該客戶端生成一個(gè)訪問令牌。
使用OAuth2訪問令牌進(jìn)行API調(diào)用
最后一步是使用OAuth2訪問令牌進(jìn)行API調(diào)用。我們可以使用Laravel自帶的Guzzle來發(fā)送HTTP請(qǐng)求,并將訪問令牌作為Authorization Header發(fā)送。
use GuzzleHttpClient;
$client = new Client();
$response = $client->request('GET', 'http://localhost/api/user', [
'headers' => [
'Authorization' => 'Bearer '.$accessToken,
],
]);
$body = $response->getBody()->getContents();
登錄后復(fù)制
需要注意的是,對(duì)于每個(gè)請(qǐng)求,我們都需要發(fā)送有效的訪問令牌。這可以通過使用Passport::actingAs方法來實(shí)現(xiàn),該方法將指定的用戶ID替換為有效的授權(quán)令牌。
use LaravelPassportPassport;
Passport::actingAs($user);
$response = $client->request('GET', 'http://localhost/api/user', [
'headers' => [
'Authorization' => 'Bearer '.$accessToken,
],
]);
登錄后復(fù)制
結(jié)論
在本文中,我們介紹了如何使用Laravel Passport來管理OAuth2協(xié)議。使用Laravel Passport可以輕松地生成API密鑰、配置OAuth2服務(wù)、創(chuàng)建OAuth2路由、定義OAuth2客戶端、生成OAuth2訪問令牌以及使用它們來進(jìn)行API調(diào)用。在開發(fā)Web應(yīng)用程序時(shí)使用OAuth2協(xié)議,Laravel Passport是一個(gè)非常好的選擇。
以上就是Laravel開發(fā):如何使用Laravel Passport管理OAuth2?的詳細(xì)內(nèi)容,更多請(qǐng)關(guān)注www.xfxf.net其它相關(guān)文章!






