Laravel 開発: Laravel Passport で OAuth2 を管理する方法?

Web アプリケーション開発では、ユーザーがサードパーティのサービスを安全に使用できるように、ユーザーの認証と認可に OAuth2 プロトコルを使用することが必要になることがよくあります。 Laravel Passport を使用すると、OAuth2 プロトコルを簡単に処理して、Laravel アプリケーションに認証と認可を実装できます。

Laravel Passport は、トークン生成、トークン管理、スコープ、その他の機能を含む完全な OAuth2 サーバー実装を提供するオープンソース ソフトウェア パッケージで、Laravel アプリケーションでの OAuth2 プロトコルの実装を非常に簡単にします。

この記事では、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 ファイルで、Laravel が Passport を使用してユーザーの認証と認可を処理できるように、api ドライバーを 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 が提供する職人コマンド 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 リクエストを送信し、アクセス トークンを認証ヘッダーとして送信できます。

use GuzzleHttpClient;

$client = new Client();

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

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

リクエストごとに、有効なアクセス トークンを送信する必要があることに注意してください。これは、指定されたユーザー ID を有効な認証トークンに置き換える

Passport::actingAs メソッドを使用することで実現できます。

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 呼び出しを簡単に行うことができます。 Laravel Passport は、OAuth2 プロトコルを使用して Web アプリケーションを開発する場合に非常に良い選択肢です。

以上がLaravel 開発: Laravel Passport で OAuth2 を管理する方法?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。