Mailgun Email パスワードレスサインインを Ruby で構築する方法

新しい友達のために:

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

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

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

前提条件

稼働中の Logto インスタンス。紹介ページをチェックして始めてください。
Ruby の基本的な知識。
使用可能な Mailgun アカウント。

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

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

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

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

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

Logto SDK を統合する

ヒント:

以下のデモンストレーションは Ruby 3.3.3 を基に構築されています。
サンプルプロジェクトは GitHub リポジトリで利用可能です。

インストール

Logto SDK をバンドラーを通じてインストールします：

bundle add logto

または、お好みの方法で gem を追加してください。

注記:

以下のデモンストレーションは Ruby on Rails 用です。ただし、他の Ruby フレームワークにも同じ手順を適用できます。

Logto クライアントを初期化する

Logto クライアントを初期化したいファイル（例：ベースコントローラーやミドルウェア）に、次のコードを追加します：

require "logto/client"

@client = LogtoClient.new(
  config: LogtoClient::Config.new(
    endpoint: "https://your-logto-endpoint.com",
    app_id: "your-logto-app-id",
    app_secret: "your-logto-app-secret"
  ),
  navigate: ->(uri) { a_redirect_method(uri) },
  storage: LogtoClient::SessionStorage.new(the_session_object)
)
end

例えば、Rails コントローラーでは、コードは次のようになります：

app/controllers/sample_controller.rb
require "logto/client"

class SampleController < ApplicationController
  before_action :initialize_logto_client

  private

  def initialize_logto_client
    @client = LogtoClient.new(
      config: LogtoClient::Config.new(
        # ...your configuration
      ),
      # クライアントが他のホスト（つまり、あなたの Logto テナント）にリダイレクトできるようにする
      navigate: ->(uri) { redirect_to(uri, allow_other_host: true) },
      # コントローラーはセッションオブジェクトにアクセスできる
      storage: LogtoClient::SessionStorage.new(session)
    )
  end
end

リダイレクト 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 セクションとして追加します。

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

コールバックを処理する

リダイレクト URI が http://localhost:3000/callback に設定されているため、アプリケーションで処理する必要があります。Rails コントローラーでは、次のコードを追加できます：

app/controllers/sample_controller.rb
class SampleController < ApplicationController
  def callback
    @client.handle_sign_in_callback(url: request.original_url)
  end
end

そして、config/routes.rb にルートを設定します：

config/routes.rb
Rails.application.routes.draw do
  get "/callback", to: "sample#callback"
end

アプリケーションでサインインとサインアウトを呼び出す方法はさまざまです。例えば、Rails アプリケーションに 2 つのルートを実装できます：

app/controllers/sample_controller.rb
class SampleController < ApplicationController
  def sign_in
    @client.sign_in(redirect_uri: request.base_url + "/callback")
  end

  def sign_out
    @client.sign_out(post_logout_redirect_uri: request.base_url)
  end

  # ...
end

config/routes.rb
Rails.application.routes.draw do
  get "/sign_in", to: "sample#sign_in"
  get "/sign_out", to: "sample#sign_out"

  # ...
end

次に、ビューにボタンやリンクを作成して、これらのアクションをトリガーできます。例えば：

app/views/sample/index.html.erb
<% if @client.is_authenticated? %>
  <a href="<%= sign_out_path %>">Sign out</a>
<% else %>
  <a href="<%= sign_in_path %>">Sign in</a>
<% end %>

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

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

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

Mailgun コネクターを追加する

Email コネクターは、認証 (Authentication) のためにワンタイムパスワード (OTP) を送信するための方法です。これは、Email ベースの登録、サインイン、二要素認証 (2FA)、アカウント回復を含むパスワードレス認証 (Authentication) をサポートするためにメールアドレスの確認を可能にします。 Logto の Email コネクターを使用すると、数分でこれを設定できます。

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

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

注記:

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

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

前提条件

Mailgun アカウント
Mailgun アカウントから取得した API キー（メッセージ（メール）送信の権限が必要です）。詳細は Where Can I Find My API Key and SMTP Credentials? を参照してください。

基本設定

異なる Mailgun API エンドポイントを使用する場合は、endpoint フィールドに入力してください。たとえば、EU リージョンの場合は https://api.eu.mailgun.net となります。デフォルト値は https://api.mailgun.net です。
domain フィールドには、Mailgun アカウントで登録したドメインを入力してください。この値は Mailgun ダッシュボードの Domains セクションで確認できます。ドメインは example.com の形式で、https:// や http:// のプレフィックスは不要です。
apiKey フィールドには、Mailgun アカウントで生成した API キーを入力してください。
from フィールドには、メール送信元として使用するメールアドレスを入力してください。このメールアドレスは Mailgun アカウントに登録されている必要があります。メールアドレスは Sender Name <[email protected]> の形式で入力してください。

Deliveries

Config オブジェクト

「Deliveries」セクションでは、さまざまなシナリオで送信されるメールの内容を設定できます。これは JSON のキーと値のマップであり、キーは使用タイプ、値は送信するメールの内容設定を含むオブジェクトです。

{
  "<usage-type>": {
    // ...
  }
}

使用タイプ

サポートされている使用タイプは次のとおりです：

Register: ユーザーが登録する際に送信されるメール。
SignIn: ユーザーがサインインする際に送信されるメール。
ForgotPassword: ユーザーがパスワードをリセットする際に送信されるメール。
Generic: ユーザーが汎用的なアクション（例：メールコネクターのテスト）を行う際に送信されるメール。

注記:

deliveries 設定で使用タイプが指定されていない場合、汎用メールが送信されます。汎用メールも指定されていない場合、コネクターはエラーを返します。

内容設定

コネクターは、直接 HTML コンテンツまたは Mailgun テンプレートの両方をサポートしています。各使用タイプごとにいずれかを利用できます。

件名や内容には {{code}} プレースホルダーを使用して認証コードを挿入できます。

直接 HTML コンテンツを使用する場合は、次のフィールドを入力してください：

subject: 送信するメールの件名。
replyTo: 返信先として使用するメールアドレス。
html: （必須）送信するメールの HTML コンテンツ。
text: 送信するメールのプレーンテキスト版。

Mailgun テンプレートを使用する場合は、次のフィールドを入力してください：

subject: 送信するメールの件名。
replyTo: 返信先として使用するメールアドレス。
template: （必須）使用する Mailgun テンプレート名。
variables: Mailgun テンプレートに渡す変数。Mailgun へ送信する前に文字列化されるため、JSON のキーと値のマップで指定してください。code 変数はコネクターによって自動的に追加されるため、含める必要はありません。

例

以下は deliveries 設定の例です：

{
  "Register": {
    "subject": "{{code}} is your verification code",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>Welcome to Logto</h1><p>Your verification code is {{code}}.</p>",
    "text": "Welcome to Logto. Your verification code is {{code}}."
  },
  "SignIn": {
    "subject": "Welcome back to Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

設定を保存する

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

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

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

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

テストと検証

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

さらなる読み物

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

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

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

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

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

Logto SDK を統合する​

インストール​

Logto クライアントを初期化する​

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

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

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

コールバックを処理する​

サインインとサインアウトを呼び出す​

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

Mailgun コネクターを追加する​

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

前提条件​

基本設定​

Deliveries​

Config オブジェクト​

使用タイプ​

内容設定​

例​

設定を保存する​

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

テストと検証​

さらなる読み物​

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

Logto SDK を統合する

インストール

Logto クライアントを初期化する

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

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

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

コールバックを処理する

サインインとサインアウトを呼び出す

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

Mailgun コネクターを追加する

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

前提条件

基本設定

Deliveries

Config オブジェクト

使用タイプ

内容設定

例

設定を保存する

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

テストと検証

さらなる読み物