Laravel开发：如何使用Laravel Passport管理OAuth2？

在Web应用程序开发中，常常需要使用OAuth2协议进行用户身份验证和授权，以便用户可以安全地使用第三方服务。通过使用Laravel Passport，你可以方便地处理OAuth2协议，实现在Laravel应用程序中的身份验证和授权。

Laravel Passport是一个开源软件包，提供了一个完整的OAuth2服务器实现，包括Token生成、Token管理、作用域等功能，使得OAuth2协议在Laravel应用程序中的实现变得非常容易。

本文将向你介绍如何使用Laravel Passport来管理OAuth2协议。

使用Laravel Passport生成API密钥

在使用OAuth2协议之前，我们需要生成API密钥。API密钥将作为OAuth2客户端ID和密钥使用，并用于获取访问令牌。我们可以使用Laravel Passport提供的artisan命令生成API密钥。

首先，使用composer安装Laravel Passport：

composer require laravel/passport

然后，运行迁移命令：

php artisan migrate

接下来，使用Passport的client:secret命令生成API密钥：

php artisan passport:client --password

这将生成一个客户端ID和一个客户端密钥。

配置OAuth2服务

在生成API密钥之后，我们需要配置OAuth2服务。Laravel Passport提供了一些配置选项，可以通过修改Laravel应用程序的config/auth.php文件来配置这些选项。

在auth.php文件中，我们需要设置api驱动程序为Passport驱动程序，这样Laravel就会使用Passport来处理用户身份验证和授权。

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
        'hash' => false,
    ],
],

创建OAuth2路由

接下来，我们需要在应用程序中创建一些OAuth2路由，这些路由将用于处理OAuth2请求。我们可以使用Laravel Passport提供的自动生成路由的artisan命令来创建这些路由。

php artisan passport:routes

这将自动生成以下路由：

+-----------+------------------------+-------------------------------------------------+---------------------------------+------------------------------------------------------------------+------------------------+
| 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                                      |
+-----------+------------------------+-------------------------------------------------+---------------------------------+------------------------------------------------------------------+------------------------+

这些路由都是Passport内置的路由，并使用passport.前缀名称。

定义OAuth2客户端

现在我们已经准备好了，可以开始定义OAuth2客户端了。我们可以使用先前生成的API密钥来创建OAuth2客户端。

在数据库中创建一个新的OAuth2客户端。我们可以手动创建它，或使用Laravel Passport提供的artisan命令passport:client来创建它。

在创建过程中，我们需要指定客户端的名称、密钥、回调URL等。

手动创建：

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');

用artisan创建：

php artisan passport:client --client --name="My Client"

运行此命令后，它将自动生成OAuth2客户端，并显示客户端ID和密钥。

生成OAuth2访问令牌

现在我们已经准备好了OAuth2客户端，并定义了OAuth2路由，我们可以开始使用OAuth2协议来生成访问令牌。

我们可以使用passport:client命令生成访问令牌：

php artisan passport:client --client --password

运行此命令后，它将生成一个OAuth2客户端并自动为该客户端生成一个访问令牌。

使用OAuth2访问令牌进行API调用

最后一步是使用OAuth2访问令牌进行API调用。我们可以使用Laravel自带的Guzzle来发送HTTP请求，并将访问令牌作为Authorization Header发送。

use GuzzleHttpClient;

$client = new Client();

$response = $client->request('GET', 'http://localhost/api/user', [
    'headers' => [
        'Authorization' => 'Bearer '.$accessToken,
    ],
]);

$body = $response->getBody()->getContents();

需要注意的是，对于每个请求，我们都需要发送有效的访问令牌。这可以通过使用Passport::actingAs方法来实现，该方法将指定的用户ID替换为有效的授权令牌。

use LaravelPassportPassport;

Passport::actingAs($user);

$response = $client->request('GET', 'http://localhost/api/user', [
    'headers' => [
        'Authorization' => 'Bearer '.$accessToken,
    ],
]);

结论

在本文中，我们介绍了如何使用Laravel Passport来管理OAuth2协议。使用Laravel Passport可以轻松地生成API密钥、配置OAuth2服务、创建OAuth2路由、定义OAuth2客户端、生成OAuth2访问令牌以及使用它们来进行API调用。在开发Web应用程序时使用OAuth2协议，Laravel Passport是一个非常好的选择。

以上是Laravel开发：如何使用Laravel Passport管理OAuth2？的详细内容。更多信息请关注PHP中文网其他相关文章！