Développement Laravel : Comment gérer OAuth2 avec Laravel Passport ?

Dans le développement d'applications Web, il est souvent nécessaire d'utiliser le protocole OAuth2 pour l'authentification et l'autorisation des utilisateurs afin que les utilisateurs puissent utiliser des services tiers en toute sécurité. En utilisant Laravel Passport, vous pouvez facilement gérer le protocole OAuth2 pour implémenter l'authentification et l'autorisation dans les applications Laravel.

Laravel Passport est un progiciel open source qui fournit une implémentation complète du serveur OAuth2, y compris la génération de jetons, la gestion des jetons, la portée et d'autres fonctions, rendant très facile la mise en œuvre du protocole OAuth2 dans les applications Laravel.

Cet article vous présentera comment utiliser Laravel Passport pour gérer le protocole OAuth2.

Générer une clé API à l'aide de Laravel Passport

Avant d'utiliser le protocole OAuth2, nous devons générer une clé API. La clé API sera utilisée comme ID client et secret OAuth2 et utilisée pour obtenir le jeton d'accès. Nous pouvons générer des clés API à l'aide de la commande artisanale fournie par Laravel Passport.

Tout d'abord, installez Laravel Passport à l'aide de composer :

composer require laravel/passport

Ensuite, exécutez la commande de migration :

php artisan migrate

Ensuite, générez la clé API à l'aide de la commande client:secret de 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

use LaravelPassportPassport;

Passport::actingAs($user);

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

Cela générera un ID client et secret client.

Configurer le service OAuth2

Après avoir généré la clé API, nous devons configurer le service OAuth2. Laravel Passport fournit quelques options de configuration, qui peuvent être configurées en modifiant le fichier config/auth.php de l'application Laravel. 🎜🎜Dans le fichier auth.php, nous devons définir le pilote api sur le pilote Passport afin que Laravel utilise Passport pour gérer l'authentification et l'autorisation des utilisateurs. 🎜rrreee🎜Création de routes OAuth2🎜🎜Ensuite, nous devons créer des routes OAuth2 dans l'application qui seront utilisées pour gérer les requêtes OAuth2. Nous pouvons créer ces itinéraires à l'aide de la commande artisan qui génère automatiquement les itinéraires fournis par Laravel Passport. 🎜rrreee🎜Cela générera automatiquement les routes suivantes : 🎜rrreee🎜Ces routes sont des routes intégrées à Passport et utilisent le nom de préfixe passport.. 🎜🎜Définissez le client OAuth2🎜🎜Nous sommes maintenant prêts à commencer à définir le client OAuth2. Nous pouvons utiliser la clé API générée précédemment pour créer un client OAuth2. 🎜🎜Créez un nouveau client OAuth2 dans la base de données. Nous pouvons le créer manuellement ou utiliser la commande artisanale passport:client fournie par Laravel Passport pour le créer. 🎜🎜Lors du processus de création, nous devons spécifier le nom du client, la clé, l'URL de rappel, etc. 🎜🎜Créer manuellement : 🎜rrreee🎜Créer avec artisan : 🎜rrreee🎜Après avoir exécuté cette commande, elle générera automatiquement le client OAuth2 et affichera l'ID client et le secret. 🎜🎜Générer un jeton d'accès OAuth2🎜🎜Maintenant que le client OAuth2 est prêt et que les routes OAuth2 sont définies, nous pouvons commencer à utiliser le protocole OAuth2 pour générer des jetons d'accès. 🎜🎜Nous pouvons générer un jeton d'accès à l'aide de la commande passport:client : 🎜rrreee🎜Après avoir exécuté cette commande, elle générera un client OAuth2 et générera automatiquement un jeton d'accès pour le client. 🎜🎜Utilisez le jeton d'accès OAuth2 pour effectuer un appel API🎜🎜La dernière étape consiste à utiliser le jeton d'accès OAuth2 pour effectuer un appel API. Nous pouvons utiliser le propre Guzzle de Laravel pour envoyer des requêtes HTTP et envoyer le jeton d'accès comme en-tête d'autorisation. 🎜rrreee🎜Une chose à noter est que pour chaque demande, nous devons envoyer un jeton d'accès valide. Ceci peut être réalisé en utilisant la méthode Passport::actingAs, qui remplace l'ID utilisateur spécifié par un jeton d'autorisation valide. 🎜rrreee🎜Conclusion🎜🎜Dans cet article, nous avons présenté comment utiliser Laravel Passport pour gérer le protocole OAuth2. Laravel Passport facilite la génération de clés API, la configuration des services OAuth2, la création de routes OAuth2, la définition de clients OAuth2, la génération de jetons d'accès OAuth2 et leur utilisation pour effectuer des appels API. Laravel Passport est un très bon choix lors du développement d'applications Web utilisant le protocole OAuth2. 🎜

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!