WeCom サインインを Ruby で構築する方法

新しい友達のために:

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

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

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

前提条件

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

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 で最初のアプリケーションを作成しました。詳細な統合ガイドを含むお祝いページが表示されます。ガイドに従って、アプリケーションでの体験を確認してください。

Ruby 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 のサインインページにリダイレクトされます。
サインインすると、アプリケーションに戻り、サインアウトボタンが表示されます。
サインアウトボタンをクリックして、トークンストレージをクリアし、サインアウトします。

WeCom コネクターを追加する

迅速なサインインを有効にし、ユーザーコンバージョンを向上させるために、アイデンティティプロバイダー (IdP) として Ruby を接続します。Logto ソーシャルコネクターは、いくつかのパラメーター入力を許可することで、この接続を数分で確立するのに役立ちます。

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

Console > Connectors > Social Connectors に移動します。
「Add social connector」をクリックし、「WeCom」を選択します。
README ガイドに従い、必要なフィールドを完了し、設定をカスタマイズします。

注記:

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

WeCom アプリを設定する

はじめに

管理者アカウントで WeCom WebUI にサインインするか、WeCom アプリから Manage the enterprise(管理企业) をクリックします。

「アプリ管理」タブでページを下にスクロールし、「アプリを作成」をクリックします。

アプリに応じて適切な情報を入力し、作成します。

これで Agent ID（APPID ではありません）と Secret が取得できました。

ウェブサイト情報

このページで必要な項目を設定します。例：

許可ユーザー： このアプリを閲覧できるユーザー
アプリホームページ： アプリのホームページ。例： logto.io/demo-app

重要このページには「開発者 API(开发者接口)」に関する 3 つの項目があります。

ウェブ認証と JS-SDK
WeCom による認証でログイン
企業信頼 IP

WeCom のガイドに従って入力してください。

Corp ID

WeChat 開発に慣れている場合、Corp ID の使い方が APP ID と同じであることに気付くかもしれません。

「マイ企業(我的企业)」タブページの下部で Corp ID を確認できます。ww**** のような形式です。

コネクターの設定

これで Agent ID、Secret、Corp ID が揃いました。

コネクターのフォームを完成させましょう。

Scope フィールドはオプションなので空欄でも構いません。あるいは snsapi_base や snsapi_privateinfo を入力することもできます。

保存して完了

WeCom コネクターのテスト

これで完了です。WeCom コネクターが利用可能になっているはずです。サインイン体験でソーシャルコネクターを有効化するのを忘れずに。

設定を保存する

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

ソーシャルコネクターを正常に作成したら、サインイン体験で「WeCom で続行」ボタンとして有効にすることができます。

Console > サインイン体験 > サインアップとサインインに移動します。
（オプション）ソーシャルログインのみが必要な場合は、サインアップ識別子に「該当なし」を選択します。
設定済みの WeCom コネクターを「ソーシャルサインイン」セクションに追加します。

テストと検証

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

さらなる読み物

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

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

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

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

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

Ruby SDK を統合する​

インストール​

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

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

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

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

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

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

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

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

WeCom アプリ を設定する​

はじめに​

ウェブサイト情報​

Corp ID​

コネクターの設定​

WeCom コネクターのテスト​

設定を保存する​

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

テストと検証​

さらなる読み物​

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

Ruby SDK を統合する

インストール

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

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

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

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

コールバックを処理する

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

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

WeCom コネクターを追加する

WeCom アプリを設定する

はじめに

ウェブサイト情報

Corp ID

コネクターの設定

WeCom コネクターのテスト

設定を保存する

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

テストと検証

さらなる読み物