AWS SES Email パスワードレスサインインを PHP で構築する方法

新しい友達のために:

Logto は、モダンなアプリや SaaS 製品向けに設計された Auth0 の代替です。 Cloud とオープンソースの両方のサービスを提供し、アイデンティティと管理 (IAM) システムを迅速に立ち上げるのをサポートします。認証 (Authentication)、認可 (Authorization)、マルチテナント管理をすべて一つにまとめて楽しめます。

Logto Cloud で無料の開発テナントから始めることをお勧めします。これにより、すべての機能を簡単に探索できます。

この記事では、PHP と Logto を使用して、AWS SES サインイン体験（ユーザー認証 (Authentication)）を迅速に構築する手順を説明します。

前提条件

実行中の Logto インスタンス。始めるには紹介ページをご覧ください。
PHP の基本的な知識。
使用可能な AWS SES アカウント。

Logto にアプリケーションを作成する

Logto は OpenID Connect (OIDC) 認証 (Authentication) と OAuth 2.0 認可 (Authorization) に基づいています。複数のアプリケーション間でのフェデレーテッドアイデンティティ管理をサポートしており、一般的にシングルサインオン (SSO) と呼ばれます。

あなたの Traditional web アプリケーションを作成するには、次の手順に従ってください：

Logto コンソールを開きます。「Get started」セクションで「View all」リンクをクリックしてアプリケーションフレームワークのリストを開きます。あるいは、Logto Console > Applications に移動し、「Create application」ボタンをクリックします。
開いたモーダルで、左側のクイックフィルターチェックボックスを使用して、すべての利用可能な "Traditional web" フレームワークをフィルタリングするか、"Traditional web" セクションをクリックします。"Laravel" フレームワークカードをクリックして、アプリケーションの作成を開始します。
アプリケーション名を入力します。例：「Bookstore」と入力し、「Create application」をクリックします。

🎉 タダーン！Logto で最初のアプリケーションを作成しました。詳細な統合ガイドを含むお祝いページが表示されます。ガイドに従って、アプリケーションでの体験がどのようになるかを確認してください。

Logto SDK を統合する

このガイドでは、Logto を PHP ウェブアプリケーションに統合する方法を示します。

ヒント:

例は Laravel を使用していますが、他のフレームワークでも概念は同じです。

インストール

composer require logto/sdk

LogtoClient の初期化

まず、Logto の設定を作成します：

index.php
use Logto\Sdk\LogtoClient;
use Logto\Sdk\LogtoConfig;

$client = new LogtoClient(
  new LogtoConfig(
    endpoint: "https://you-logto-endpoint.app",
    appId: "replace-with-your-app-id",
    appSecret: "replace-with-your-app-secret",
  ),
);

ヒント:

「App Secret」は管理コンソールのアプリケーション詳細ページから見つけてコピーできます：

デフォルトでは、SDK は組み込みの PHP セッションを使用して Logto データを保存します。他のストレージを使用したい場合は、カスタムストレージオブジェクトを 2 番目のパラメーターとして渡すことができます：

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...
  ),
  new YourCustomStorage(),
);

詳細については、Storage を参照してください。

リダイレクト URI の設定

詳細に入る前に、エンドユーザーの体験について簡単に説明します。サインインプロセスは次のように簡略化できます：

あなたのアプリがサインインメソッドを呼び出します。
ユーザーは Logto のサインインページにリダイレクトされます。ネイティブアプリの場合、システムブラウザが開かれます。
ユーザーがサインインし、あなたのアプリにリダイレクトされます（リダイレクト URI として設定されています）。

この認証 (Authentication) プロセスは OpenID Connect (OIDC) プロトコルに従い、Logto はユーザーのサインインを保護するために厳格なセキュリティ対策を講じています。
複数のアプリがある場合、同じアイデンティティプロバイダー (Logto) を使用できます。ユーザーがあるアプリにサインインすると、Logto は別のアプリにアクセスした際に自動的にサインインプロセスを完了します。

リダイレクトベースのサインインの理論と利点について詳しく知るには、Logto サインイン体験の説明を参照してください。

注記:

以下のコードスニペットでは、あなたのアプリが http://localhost:3000/ で実行されていると仮定しています。

リダイレクト URI を設定する

Logto Console のアプリケーション詳細ページに移動します。リダイレクト URI http://localhost:3000/callback を追加します。

サインインと同様に、ユーザーは共有セッションからサインアウトするために Logto にリダイレクトされるべきです。完了したら、ユーザーをあなたのウェブサイトに戻すと良いでしょう。例えば、http://localhost:3000/ をサインアウト後のリダイレクト URI セクションとして追加します。

その後、「保存」をクリックして変更を保存します。

コールバックの処理

ユーザーがサインインした後、Logto はユーザーを Logto コンソールで設定したコールバック URL にリダイレクトします。この例では、/callback をコールバック URL として使用します：

Route::get('/callback', function () {
  try {
    $client->handleSignInCallback(); // 多くの処理を行います
  } catch (\Throwable $exception) {
    return $exception; // これをエラーハンドリングロジックに変更してください
  }
  return redirect('/'); // サインインが成功した後、ユーザーをホームページにリダイレクトします
});

あなたの Web アプリケーションで、ユーザーからのサインインリクエストを適切に処理するためのルートを追加します。例えば：

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback'));
});

このアプリケーションのために Logto コンソールで設定したコールバック URL に http://localhost:3000/callback を置き換えてください。

最初の画面にサインアップページを表示したい場合は、interactionMode を signUp に設定できます：

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback', InteractionMode::signUp));
});

これで、ユーザーが http://localhost:3000/sign-in を訪れるたびに、新しいサインイン試行が開始され、ユーザーは Logto のサインインページにリダイレクトされます。

注意サインインルートを作成することは、サインイン試行を開始する唯一の方法ではありません。常に signIn メソッドを使用してサインイン URL を取得し、ユーザーをそれにリダイレクトすることができます。

サインアウトルートの実装

ユーザーがサインアウトリクエストを行った後、Logto はセッション内のすべてのユーザー認証 (Authentication) 情報をクリアします。

PHP セッションと Logto セッションをクリーンアップするために、次のようにサインアウトルートを実装できます：

Route::get('/sign-out', function () {
return redirect(
  // サインアウトが成功した後、ユーザーをホームページにリダイレクトします
  $client->signOut('http://localhost:3000/')
);
});

postLogoutRedirectUri はオプションであり、提供されない場合、ユーザーはサインアウトが成功した後に Logto のデフォルトページにリダイレクトされます（あなたのアプリケーションに戻るリダイレクトは行われません）。

注 > postLogoutRedirectUri という名前は、OpenID Connect RP-Initiated Logout 仕様から来ています。Logto は「サインアウト」を「ログアウト」の代わりに使用していますが、概念は同じです。

認証 (Authentication) ステータスの処理

Logto SDK では、$client->isAuthenticated() を使用して認証 (Authentication) ステータスを確認できます。ユーザーがサインインしている場合、この値は true になります。そうでない場合、この値は false になります。

デモ用にホームページを実装する必要があります：

ユーザーがサインインしていない場合、サインインボタンを表示します。
ユーザーがサインインしている場合、サインアウトボタンを表示します。

Route::get('/', function () {
  if ($client->isAuthenticated() === false) {
    return "Not authenticated <a href='/sign-in'>Sign in</a>";
  }

  return "<a href='/sign-out'>Sign out</a>";
});

チェックポイント: アプリケーションをテストする

これで、アプリケーションをテストできます：

アプリケーションを実行すると、サインインボタンが表示されます。
サインインボタンをクリックすると、SDK がサインインプロセスを初期化し、Logto のサインインページにリダイレクトされます。
サインインすると、アプリケーションに戻り、サインアウトボタンが表示されます。
サインアウトボタンをクリックして、トークンストレージをクリアし、サインアウトします。

AWS SES コネクターを追加する

Email コネクターは、認証 (Authentication) のためにワンタイムパスワード (OTP) を送信するための方法です。これにより、メールアドレスの認証が可能になり、Email ベースの登録、サインイン、二要素認証 (2FA)、アカウントの復旧を含むパスワードレス認証 (Authentication) をサポートします。 Logto Email コネクターを使用すると、AWS SES を Email プロバイダーとして簡単に接続できます。数分で設定を完了できます。

Email コネクターを追加するには、次の手順に従ってください：

Console > Connector > Email and SMS connectors に移動します。
新しい Email コネクターを追加するには、「Set up」ボタンをクリックし、「AWS SES」を選択します。
選択したプロバイダーの README ドキュメントを確認します。
「パラメーター設定」セクションで設定フィールドを完了します。
JSON エディターを使用して Email テンプレートをカスタマイズします。
メールアドレスに確認コードを送信して設定をテストします。

Connector tab

注記:

インプレースコネクターガイドに従っている場合は、次のセクションをスキップできます。

AWS SES メールコネクターを設定する

AWS サービスコンソールでメールサービスを設定する

AWS アカウントを登録する

AWS にアクセスしてアカウントを登録します。

アイデンティティを作成する

Amazon Simple Email Service コンソールに移動します
アイデンティティを作成し、次のオプションのいずれかを選択します
- ドメインを作成する
- メールアドレスを作成する

コネクターの設定

Amazon コンソールの右上隅にあるユーザー名をクリックして Security Credentials に入ります。まだ持っていない場合は、AccessKey を作成し、慎重に保存してください。
Amazon Simple Email Service コネクターの設定を完了します：
- ステップ 1 で取得した AccessKey ID と AccessKey Secret を使用して、それぞれ accessKeyId と accessKeySecret を入力します。
- region: メール送信に使用するアイデンティティのリージョンを region フィールドに入力します。
- emailAddress: メール送信に使用するメールアドレスを Logto\<[email protected]> または \<[email protected]> の形式で入力します。

以下のパラメーターはオプションです。パラメーターの説明は AWS SES API ドキュメントに記載されています。

feedbackForwardingEmailAddress
feedbackForwardingEmailAddressIdentityArn
configurationSetName

Amazon SES コネクターをテストする

メールアドレスを入力し、「送信」をクリックして、設定が機能するかどうかを「保存して完了」する前に確認できます。

これで完了です。サインイン体験でコネクターを有効にするのを忘れないでください。

タイプを設定する

名前	タイプ
accessKeyId	string
accessKeySecret	string
region	string
emailAddress	string (OPTIONAL)
emailAddressIdentityArn	string (OPTIONAL)
feedbackForwardingEmailAddress	string (OPTIONAL)
feedbackForwardingEmailAddressIdentityArn	string (OPTIONAL)
configurationSetName	string (OPTIONAL)
templates	Template[]

テンプレートプロパティ	タイプ	列挙値
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' \| 'SignIn' \| 'ForgotPassword' \| 'Generic'

設定を保存する

Logto コネクター設定エリアで必要な値をすべて記入したことを確認してください。「保存して完了」または「変更を保存」をクリックすると、AWS SES コネクターが利用可能になります。

コネクターを正常に作成すると、電話番号ベースのパスワードレスログインと登録を有効にできます。

Console > サインイン体験 > サインアップとサインインに移動します。
サインアップ方法を設定します（オプション）：
1. サインアップ識別子として "メールアドレス" または "Email or phone number" を選択します。
2. "Verify at sign-up" は強制的に有効化されます。登録時に "Create a password" を有効にすることもできます。
サインイン方法を設定します：
1. サインイン識別子の一つとしてメールアドレスを選択します。複数の識別子（メール、電話番号、ユーザー名）を提供できます。
2. 認証 (Authentication) 要素として "Verification code" および / または "Password" を選択します。
"Save changes" をクリックし、"Live preview" でテストします。

サインイン体験タブ

OTP を使用した登録とログインに加えて、パスワード回復やベースのセキュリティ検証を有効にしたり、メールアドレスをプロファイルにリンクしたりすることもできます。詳細については、エンドユーザーフローを参照してください。

テストと検証

PHP アプリに戻ります。これで AWS SES を使用してサインインできるはずです。お楽しみください！

さらなる読み物

エンドユーザーフロー：Logto は、MFA やエンタープライズシングルサインオン (SSO) を含む即時使用可能な認証 (Authentication) フローを提供し、アカウント設定、セキュリティ検証、マルチテナント体験の柔軟な実装のための強力な API を備えています。

認可 (Authorization)：認可 (Authorization) は、ユーザーが認証 (Authentication) された後に行えるアクションやアクセスできるリソースを定義します。ネイティブおよびシングルページアプリケーションの API を保護し、ロールベースのアクセス制御 (RBAC) を実装する方法を探ります。

組織 (Organizations)：特にマルチテナント SaaS や B2B アプリで効果的な組織機能は、テナントの作成、メンバー管理、組織レベルの RBAC、およびジャストインタイムプロビジョニングを可能にします。

顧客 IAM シリーズ：顧客（または消費者）アイデンティティとアクセス管理に関する連続ブログ投稿で、101 から高度なトピックまでを網羅しています。

Logto にアプリケーションを作成する​

Logto SDK を統合する​

インストール​

LogtoClient の初期化​

リダイレクト URI の設定​

リダイレクトベースのサインインについて​

リダイレクト URI を設定する​

コールバックの処理​

サインインルートの実装​

サインアウトルートの実装​

認証 (Authentication) ステータスの処理​

チェックポイント: アプリケーションをテストする​

AWS SES コネクターを追加する​

AWS SES メールコネクター を設定する​

AWS サービスコンソールでメールサービスを設定する​

AWS アカウントを登録する​

アイデンティティを作成する​

コネクターの設定​

Amazon SES コネクターをテストする​

タイプを設定する​

設定を保存する​

サインイン体験で AWS SES コネクターを有効にする​

テストと検証​

さらなる読み物​