Laravel開発: Laravel Passportを使用してAPI OAuth2認証を実装するにはどうすればよいですか?

API の使用がますます一般的になるにつれて、API のセキュリティとスケーラビリティの保護がますます重要になってきます。 OAuth2 は、アプリケーションが認可を通じて保護されたリソースにアクセスできるようにする API セキュリティ プロトコルとして広く採用されています。 OAuth2 認証を実装するために、Laravel Passport はシンプルで柔軟な方法を提供します。この記事では、Laravel Passport を使用して API OAuth2 認証を実装する方法を学びます。

Laravel Passport は、Laravel アプリケーションに OAuth2 認証を簡単に追加できる、公式に提供されている OAuth2 サーバー ライブラリです。 Laravel フレームワークのクライアントに API 認証を提供し、API を保護し、トークンを介したリソース アクセスを制限します。いくつかの構成手順を行うだけで、安全な OAuth2 サーバーを作成し、API に認証と認可を提供できます。

Laravel Passport の使用を開始するには、Laravel Passport をインストールする必要があります。 Composer パッケージ マネージャーを通じてインストールできます:

composer require laravel/passport

Laravel Passport をインストールしたら、移行を実行して必要なデータベース テーブルを作成する必要があります:

php artisan migrate

Laravel Passport を有効にするには、 ServiceProviderとミドルウェアを登録する必要があります。次の ServiceProvider とミドルウェアを config/app.php ファイルに追加します。

'providers' => [
    // ...
    LaravelPassportPassportServiceProvider::class,
],

'middleware' => [
    // ...
    LaravelPassportHttpMiddlewareCreateFreshApiToken::class,
],

Laravel Passport には、アクセス トークンとリフレッシュ トークンを発行するための「キー」テーブルが必要です。次のコマンドを実行すると、このテーブルが生成されます:

php artisan passport:install

これにより、トークンの署名と検証のための暗号化された RSA キー ペア、および「personal_access_client」という名前のクライアントと「password_client」という名前のクライアントが作成されます。これら 2 つのクライアントは、さまざまなタイプのトークンを作成するために使用されます。最初のクライアントは、クライアントが OAuth2 認証で保護された API エンドポイントにアクセスできるようにする個人アクセス トークンを生成するために使用されます。 2 番目のクライアントは、クライアントがユーザー名とパスワードを介してアクセス トークンを取得できるようにするパスワード認証トークンを作成するために使用されます。

このプロセスでは、config/auth.php ファイルで Laravel Passport を構成する必要もあります。 Laravel Passport が OAuth2 に関連するすべてを処理できるように、パスポートドライバーを API ガードに追加する必要があります。例は次のとおりです。

'guards' => [
    // ...
    'api' => [
        'driver' => 'passport',
        'provider' => 'users',
    ],
],

セットアップが完了したので、API ルートとコントローラーの作成を開始できます。

まず、API ルートを定義する必要があります。たとえば、タスクのリストを取得する API エンドポイントがあるとします。

Route::get('/tasks', 'TaskController@index')->middleware('auth:api');

次に、リクエストを処理し、タスクに応答するコントローラーを作成する必要があります。

class TaskController extends Controller
{
    public function index()
    {
        $tasks = Task::all();

        return response()->json([
            'tasks' => $tasks,
        ]);
    }
}

Inミドルウェア メソッドは「auth:api」パラメータを追加して、ルートを保護するために API ガードを使用するように指示します。

次に、OAuth2 認証を実行してアクセス トークンを取得する方法を見てみましょう。アクセス トークンを取得するには、パスワードを使用して OAuth2 フローを承認するクライアントを作成する必要があります。これにより、API リクエストを使用して API エンドポイントで認証を行うことができます。

Laravel Passport のクライアント リストに新しいクライアントを作成することも、コード内で Passport::client() メソッドを使用して、クライアントのランダムなクライアント ID とクライアント シークレットを生成することもできます。クライアント ID とクライアント シークレットを .env ファイルに保存することも、Passport::client() メソッドで直接指定することもできます。このメソッドは新しいクライアントを作成し、クライアント ID とクライアント シークレットを返します:

use LaravelPassportClient;
use IlluminateSupportFacadesDB;

$client = $this->createClient();

public function createClient()
{
    $client = Client::forceCreate([
        'user_id' => null,
        'name' => 'Test Client',
        'secret' => str_random(40),
        'redirect' => '',
        'personal_access_client' => false,
        'password_client' => true,
        'revoked' => false,
    ]);

    DB::table('oauth_client_grants')->insert([
        'client_id' => $client->id,
        'grant_id' => 1,
    ]);

    return $client;
}

クライアントを作成したので、コントローラーで Laravel Passport を使用してアクセス トークンを取得し、それを使用して保護されたアクセス トークンを取得する必要があります。 API エンドポイント。次のコードを使用して、コントローラーに OAuth2 認証を実装する必要があります。

use IlluminateSupportFacadesAuth;
use LaravelPassportClientRepository;

class TaskController extends Controller
{
    protected $clients;
    
    public function __construct(ClientRepository $clients)
    {
        $this->clients = $clients;
    }

    public function index()
    {
        $client = $this->clients->find(2);

        $response = $this->actingAsClient($client, function () {
            return $this->get('/api/tasks');
        });

        return $response->getContent();
    }

    protected function actingAsClient($client, $callback, $scopes = [])
    {
        $proxy = new LaravelPassportHttpControllersAccessTokenController();

        $token = $proxy->issueToken(
            $this->getPersonalAccessTokenRequest($client, $scopes)
        );

        Auth::guard('web')->loginUsingId($client->user_id);

        $callback($token);

        return $this->app->make(IlluminateHttpRequest::class);
    }

    protected function getPersonalAccessTokenRequest($client, $scopes = [])
    {
        $data = [
            'grant_type' => 'client_credentials',
            'client_id' => $client->id,
            'client_secret' => $client->secret,
            'scope' => implode(' ', $scopes),
        ];

        return IlluminateHttpRequest::create('/oauth/token', 'POST', $data);
    }
}

ActingAsClient() メソッドを使用すると、クライアントとしてリクエストの実行をシミュレートでき、コントローラー内のどのメソッドでもこのメソッドを OAuth2 認証に使用できます。クライアント オブジェクト、API リクエストを実行するコールバック関数、およびオプションでリクエストに追加する権限を渡す必要があります。

Laravel Passport の OAuth2 認証構成が完了したので、上記のコード パターンを使用して API エンドポイントに安全な OAuth2 認証を簡単に実装できます。パスポートは比較的新しいプロジェクトです。ただし、Laravel と完全に統合されており、複数の OAuth2 認証サービスを提供するため、API に認証と認可を簡単に追加できます。 Laravel アプリケーションを実行していて、OAuth2 認証を追加する必要がある場合、Laravel Passport はこの目的に最適です。

以上がLaravel開発: Laravel Passportを使用してAPI OAuth2認証を実装するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。