PHP

Evan Sims 著

このガイドでは、Auth0 PHP SDK を使用して、PHP アプリケーションに Auth0 を統合する方法を説明します。アカウント用に設定された例を使いながらこの Quickstart を進められるよう、あらかじめログインしておくことをおすすめします。

Authは初めてですか？ Auth0 の仕組み、従来型Webアプリケーションとの統合方法、および使用するプロトコルについてご覧ください。

Auth0 を設定する

アプリケーションのキーを取得する

Auth0 にサインアップすると、新しいアプリケーションが 1 つ作成されます。あるいは、自分で新しく作成している場合もあります。Auth0 と通信するには、そのアプリケーションに関するいくつかの情報が必要です。これらの情報は、Auth0 Dashboard の Application Settings セクションで確認できます。

必要な情報は次のとおりです。

• Domain
• Client ID
• Client Secret

このページ上部のサンプルをダウンロードした場合は、これらの情報はあらかじめ入力されています。

コールバック URL を設定する

コールバック URL とは、ユーザーの認証完了後に Auth0 がそのユーザーをリダイレクトするアプリケーション内の URL のことです。アプリのコールバック URL は、Application Settings の Allowed Callback URLs フィールドに追加する必要があります。このフィールドが設定されていないと、ユーザーはアプリケーションにログインできず、エラーが表示されます。

このページ上部からダウンロードしたサンプルプロジェクトを使っている場合、Allowed Callback URLs フィールドに追加するコールバック URL は http://127.0.0.1:3000/ です。

Logout URLを設定する

ログアウト URL とは、ユーザーが認可サーバーからログアウトした後に Auth0 がリダイレクトできる、アプリケーション内の URL です。これは returnTo クエリパラメータで指定します。アプリケーションのログアウト URL は、Application Settings の Allowed Logout URLs フィールドに追加する必要があります。このフィールドが設定されていない場合、ユーザーはアプリケーションからログアウトできず、エラーが表示されます。

このページ上部からダウンロードしたサンプルプロジェクトを使って進めている場合は、Allowed Logout URLs フィールドに http://127.0.0.1:3000 をログアウト URL として追加してください。

PHPアプリケーションを統合する

PHPアプリケーションでユーザーを認証するサンプルアプリケーションを作成してみましょう。ここでは、ドキュメント向けにシンプルな方法を採用します。より本格的な例については、GitHub 上の Quickstart アプリ もご覧ください。

HTTPクライアントとメッセージファクトリーのインストール

Auth0 PHP SDK は、アーキテクチャに応じた相互運用性を実現できるよう、多くの PHP-FIG 標準をサポートしています。特に重要なのが、PSR-17 と PSR-18 です。これらの標準を利用すると、メッセージ処理やリクエストを扱うネットワークコンポーネントを自由に組み込めます。SDK で利用するには、互換性のあるライブラリをプロジェクトにインストールする必要があります。

PHP で最も広く使われているネットワークライブラリは Guzzle ですが、PHP コミュニティにはほかにも多くの選択肢があります。このサンプルアプリケーションでは Guzzle を使いましょう。今回も、プロジェクトのディレクトリで次のシェルコマンドを実行してください。

composer require guzzlehttp/guzzle guzzlehttp/psr7 http-interop/http-factory-guzzle

PHP SDK のインストール

Auth0 PHP SDK を利用するには、PHP の依存関係を管理するツールである Composer が必要です。Composer を使うと、プロジェクトに必要なライブラリを宣言し、それらをインストールできます。先に進む前に、Composer がインストールされており、シェルから利用できることを確認してください。

Auth0 PHP SDK をインストールするには、プロジェクトのディレクトリで次のシェルコマンドを実行してください。

composer require auth0/auth0-php

これにより、プロジェクト内にvendorフォルダーが作成され、Auth0 PHP SDKの使用に必要な依存関係がすべてダウンロードされます。さらに、サンプル内で使用されるvendor/autoload.phpファイルも作成されます。このファイルは、アプリケーションの動作に必要なすべてのクラスを読み込むためのものです。SDKを正しく動作させるには、プロジェクト内でこのオートロードファイルを必ずrequireしてください。

SDKの設定

まず、サンプルアプリケーションの設定を保存するため、プロジェクトのルートディレクトリに .env ファイルを作成し、環境変数を入力しましょう。

PHP は .env ファイルを単体では読み取れないため、そのためのライブラリをインストールします。サンプルアプリケーションでは特定のライブラリを使用しますが、実際のアプリケーションでは好みの dotenv ローダーであればどれを使っても問題ありません。プロジェクトディレクトリで、次のシェルコマンドを実行してライブラリをインストールしましょう。

composer require vlucas/phpdotenv

次に、これらのコードサンプルで使う PHP のソースファイル index.php を作成し、サンプルアプリケーション向けに Auth0 PHP SDK のインスタンスを設定しましょう。

<?php

// Composer AutoloaderをインポートしてSDKクラスを使用できるようにする:
require 'vendor/autoload.php';

// .envファイルから環境変数を読み込む:
(Dotenv\Dotenv::createImmutable(__DIR__))->load();

// Auth0クラスを設定でインスタンス化する:
$auth0 = new \Auth0\SDK\Auth0([
    'domain' => $_ENV['AUTH0_DOMAIN'],
    'clientId' => $_ENV['AUTH0_CLIENT_ID'],
    'clientSecret' => $_ENV['AUTH0_CLIENT_SECRET'],
    'cookieSecret' => $_ENV['AUTH0_COOKIE_SECRET']
]);

アプリケーションのルートを設定する

最近のPHPアプリケーションでは、ルーティングを使って受信したHTTPリクエストを処理用のコードに渡し、ユーザーがアプリ内の特定の “ページ” にアクセスしたときに何が起こるかを決定します。アプリケーションにルーティングを実装する方法は1つではなく、利用できるライブラリも数多くあります。ここではサンプルアプリケーションの都合上、特定のライブラリを使用しますが、実際のアプリケーションでは自由に別のものを選んでください。

それでは、プロジェクトのディレクトリで、ルーティングライブラリをインストールするために次のシェルコマンドを実行しましょう。

composer require steampixel/simple-php-router

次に、index.php を再度開いて、アプリケーションに実際の機能を持たせましょう。まず、ルーティングライブラリを読み込み、後でサンプルアプリケーション内のいくつかの箇所から参照できるように、各ルートの完全な URL を便宜上名前付き定数として定義します。

// 👆 上記の手順から続きます。以下をindex.phpファイルに追記してください。

// ルーターライブラリをインポートします:
use Steampixel\Route;

// ルート定数を定義します:
define('ROUTE_URL_INDEX', rtrim($_ENV['AUTH0_BASE_URL'], '/'));
define('ROUTE_URL_LOGIN', ROUTE_URL_INDEX . '/login');
define('ROUTE_URL_CALLBACK', ROUTE_URL_INDEX . '/callback');
define('ROUTE_URL_LOGOUT', ROUTE_URL_INDEX . '/logout');

これで、アプリケーションのルート処理ロジックと SDK 連携の追加に進みます。

セッションを確認する

Auth0 PHP SDK には、ユーザーが認証済みかどうかを確認し、そのプロファイルを取得できる便利なメソッド getCredentials() があります。これを index ルートに追加して、ログインしていればユーザープロファイルを表示し、そうでなければログインが必要であることを知らせましょう。

// 👆 上記の手順からの続きです。index.php ファイルに以下を追記してください。

Route::add('/', function() use ($auth0) {
  $session = $auth0->getCredentials();

  if ($session === null) {
    // ユーザーはログインしていません。
    echo '<p>Please <a href="/docs/login">log in</a>.</p>';
    return;
  }

  // ユーザーはログインしています。
  echo '<pre>';
  print_r($session->user);
  echo '</pre>';

  echo '<p>You can now <a href="/docs/logout">log out</a>.</p>';
});

user プロパティのレスポンスは配列なので、ユーザーのプロファイルに含まれるすべてのプロパティにアクセスできます。たとえば、ユーザーのニックネームは $session->user<a href="https://auth0.com/docs/users/user-profile-structure" target="_blank" rel="noreferrer">nickname から、メールアドレスは $session->useremail から取得できます。この構造は正規化されたユーザープロファイルです。詳しくはこちらをご覧ください。

ユーザープロファイルの内容は、使用するソーシャルプロバイダーによって異なるため、このアプリケーションのロジック内で特定の値が常に存在すると決めつけてはいけません。たとえば、PHP の isset や null 合体演算子などを使って、値が存在する場合もしない場合も適切に処理してください。

// ✋ これはサンプルアプリケーションに含める必要はありません。あくまで例示です。
$name = $session->user['name'] ?? $session->user['nickname'] ?? $session->user['email'] ?? 'Unknown';

ログイン

それでは、/login ルートを作成しましょう。このルートでは Auth0 PHP SDK の login() メソッドを使ってユーザーセッションを設定し、このユーザーがログインするための Auth0 の Universal Login ページへのカスタマイズ済み URL を返します。

// 👆 上記の手順から続きます。以下をindex.phpファイルに追記してください。

Route::add('/login', function() use ($auth0) {
    // ネットワークの問題やその他のトラブルで以前のログインプロセスが中断された際に「invalid state」エラーが発生しないよう、ログインのたびにユーザーセッションをリセットしておくことをお勧めします。
    $auth0->clear();

    // 最後に、ローカルのアプリケーションセッションを設定し、ユーザーをAuth0 Universal Loginページにリダイレクトして認証を行います。
    header("Location: " . $auth0->login(ROUTE_URL_CALLBACK));
    exit;
});

認証コールバックの処理

ユーザーが Auth0 の Universal Login ページでの認証を終えると、サンプルアプリケーションのコールバックルート /callback に戻ります。このステップでは、その処理を行います。

Auth0 からユーザーが戻される際、HTTPリクエストのクエリにはいくつかの重要なパラメーターが含まれます。Auth0 PHP SDK の exchange() メソッドがそれらを処理してくれるため、認証フローの完了は簡単です。

// 👆 上記の手順からの続きです。以下をindex.phpファイルに追記してください。

Route::add('/callback', function() use ($auth0) {
    // SDKで認証フローを完了します:
    $auth0->exchange(ROUTE_URL_CALLBACK);

    // 最後に、ユーザープロファイルを表示するため、エンドユーザーを / インデックスルートにリダイレクトします:
    header("Location: " . ROUTE_URL_INDEX);
    exit;
});

ログアウト

最後になりますが、ユーザーのログアウトを適切に処理しましょう。Auth0 PHP SDK の logout() メソッドは、サンプルアプリケーションのセッションクッキーを削除し、ユーザーを Auth0 の /logout エンドポイント にリダイレクトします (これにより Auth0 セッションと、ID プロバイダーのセッションがあればそれらもログアウトされます) 。その後、ユーザーは / index ルートに戻ります。

// 👆 上記の手順から続きます。以下をindex.phpファイルに追記してください。

Route::add('/logout', function() use ($auth0) {
    // アプリのローカルセッションをクリアし、Auth0のLogoutエンドポイントへリダイレクトしてAuth0 セッションをクリアします。
    header("Location: " . $auth0->logout(ROUTE_URL_INDEX));
    exit;
});

アプリを実行しましょう！

最後に、ルーティングミドルウェアが実際にリクエストをルーティングするよう設定する必要があります。

// 👆 上記の手順からの続きです。以下をindex.phpファイルに追記してください。

// これにより、ルートの設定が完了し、受信するHTTPリクエストのルーティングを開始する準備ができたことをrouterに伝えます:
Route::run('/');

これで完了です！新しいアプリケーションを実行する準備が整いました。もう一度、プロジェクトのディレクトリで次のシェルコマンドを実行してください：

php -S 127.0.0.1:3000 index.php

ブラウザーで http://127.0.0.1:3000 を開いて、試してみてください。

次にできることは？

他のアイデンティティプロバイダーを設定する	多要素認証を有効にする
攻撃対策について学ぶ	ルールについて学ぶ
GitHub で編集する