PHPでOAuth2を使用するにはどうすればよいですか?

OAuth2 は、ユーザー名とパスワードを Google、Facebook、Twitter などのソーシャル ネットワークなどのサードパーティ アプリケーションに直接送信することなく、ユーザー リソースへのアクセスを承認するために広く使用されているオープン標準プロトコルです。

PHP では、既製の OAuth2 ライブラリを使用して OAuth2 フローを簡単に実装することも、独自のライブラリを構築して実装することもできます。

この記事では、既成の OAuth2 ライブラリの使用方法、OAuth2 プロトコルを使用してユーザーの承認を取得し、そのリソースにアクセスする方法に焦点を当てます。

1. OAuth2 ライブラリのインストール

まず、利用可能な OAuth2 ライブラリをインストールする必要があります。現在、php-oauth2-client、thephpleague/oauth2-client、bshaffer/oauth2-server-php など、PHP 開発に使用できるいくつかの異なる OAuth2 ライブラリがあります。この記事では、phpleague/oauth2-client を OAuth2 ライブラリとして使用します。

このライブラリをインストールするには、Composer を使用できます。ターミナルで次のコマンドを実行するだけです:

composer require league/oauth2-client

2. Create OAuth2 Client Object

## OAuth2 ライブラリをインストールしたので、OAuth2 クライアント オブジェクトを作成できるようになりました。このクライアントは、OAuth2 プロトコルに従ってサービス プロバイダーと通信し、当社とサービス プロバイダーの間のセッション状態を維持します。

この例では、OAuth2 プロバイダーとして GitHub を使用します。クライアント オブジェクトを作成するには、次のコードを使用します。

$clientId = 'your_client_id'; // Your GitHub Client ID
$clientSecret = 'your_client_secret'; // Your GitHub Client Secret
$redirectUri = 'http://example.com/oauth2callback'; // Your redirect URI

$provider = new LeagueOAuth2ClientProviderGithub([
    'clientId'          => $clientId,
    'clientSecret'      => $clientSecret,
    'redirectUri'       => $redirectUri,
]);

上記のコードは、$provider という名前の OAuth2 クライアント オブジェクトを作成します。これは、GitHub 上の OAuth2 プロバイダーにアクセスするために使用されます。その中で、GitHub によって割り当てられたクライアント ID、クライアント シークレット、コールバック URI を指定する必要があります。

認可 URL の取得

OAuth2 では、認可 URL は、OAuth2 認可プロセスをユーザーにガイドするために使用されます。アプリケーションが必要とする GitHub リソースにアクセスする前に、ユーザーがアプリケーションを認証できるように、ユーザーを認証 URL にリダイレクトする必要があります。

認可 URL を取得するには、次のコードを使用します。

$authorizationUrl = $provider->getAuthorizationUrl();

上記のコードは、ユーザーをリダイレクトする必要がある認可 URL を返します。

header('Location: ' . $authorizationUrl);
exit;

アクセス トークンの取得

ユーザーが GitHub で OAuth2 を承認すると、アプリケーションによって提供されるコールバック URL にリダイレクトされます。この時点で、承認が必要な GitHub リソースに後でアクセスするために、アクセス トークンを取得する必要があります。

次に、次のコードを使用してアクセス トークンを取得できます。

$accessToken = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code']
]);

上記のコードは、認可コードを使用してアクセス トークンを要求し、$accessToken オブジェクトを返します。この $accessToken オブジェクトには、アクセス トークンとその関連プロパティ (有効期限やリフレッシュ トークンなど) が含まれています。

アクセス トークンを使用して GitHub リソースにアクセスする

アクセス トークンを取得したので、それを使用して、ユーザーの取得など、承認が必要な GitHub リソースにアクセスできます。情報 またはそのリポジトリ リストを参照してください。

次のコードを使用してユーザー情報を取得します。

$user = $provider->getResourceOwner($accessToken);
echo 'Hello, ' . $user->getName();

上記のコードは、アクセス トークンを使用して GitHub 上のリソース所有者 API を呼び出し、$user オブジェクトを返します。

上記のコードの $user オブジェクトは、ユーザーの名前とその他の関連プロパティを返します。これらのプロパティは、ユーザーおよび他の GitHub リソースに関する情報を取得するために使用できます。

アクセス トークンの更新

アクセス トークンは期限切れになるか無効になる可能性があります。実行時にステータスを確認し、必要に応じてトークンを再更新する必要があります。

次のコードを使用して、アクセス トークンを確認して更新します:

if ($accessToken->hasExpired()) {
    $newAccessToken = $provider->getAccessToken('refresh_token', [
        'refresh_token' => $accessToken->getRefreshToken()
    ]);
}

// Use $newAccessToken to access protected resources

上記のコードは、アクセス トークンの有効期限が切れているかどうかを確認し、refresh_token 属性を使用して新しい $accessToken オブジェクトを要求します。更新されたアクセス トークンとその他の関連プロパティが含まれます。

これまで、phpleague/oauth2-client ライブラリを使用して OAuth2 プロセスを実装する方法を学習しました。これを使用して、Google、Facebook、Twitter、GitHub などのさまざまな OAuth2 プロバイダーにアクセスできるようになりました。

概要

この記事では、OAuth2 ライブラリを使用して OAuth2 クライアントを構築し、そのクライアントを使用して認可を取得し、保護されたリソースにアクセスする方法を学びました。また、必要なリソースに常にアクセスできるようにするために、アクセス トークンをチェックして更新する方法も学びました。

OAuth2 プロトコルには複雑な認証プロセスと実装の詳細があるため、OAuth2 クライアントを開発する際には細心の注意が必要であることに注意してください。ただし、既製の OAuth2 ライブラリを使用すると、このプロセスを比較的シンプルかつ簡単に行うことができます。

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