Tencent SMS パスワードレスサインインを Python で構築する方法

新しい友達のために:

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

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

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

前提条件

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

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" セクションをクリックします。"Flask" フレームワークカードをクリックして、アプリケーションの作成を開始します。
アプリケーション名を入力します。例：「Bookstore」と入力し、「Create application」をクリックします。

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

Logto SDK を統合する

ヒント:

この例では Flask を使用していますが、概念は他のフレームワークでも同じです。
Python のサンプルプロジェクトは、私たちの Python SDK リポジトリで利用可能です。
Logto SDK はコルーチンを活用しているため、非同期関数を呼び出す際には await を使用することを忘れないでください。

インストール

プロジェクトのルートディレクトリで実行します：

pip install logto # または `poetry add logto` などを使用

LogtoClient の初期化

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

client.py
from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # あなたの Logto エンドポイントに置き換えてください
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

ヒント:

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

また、デフォルトのメモリストレージを永続的なストレージに置き換えます。例えば：

client.py
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

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

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

flask.py
@app.route("/sign-in")
async def sign_in():
  # サインイン URL を取得し、ユーザーをその URL にリダイレクトします
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

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

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

flask.py
@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # 最初の画面にサインアップページを表示
  ))

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

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

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

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

flask.py
@app.route("/sign-out")
async def sign_out():
  return redirect(
      # サインアウトが成功した後、ユーザーをホームページにリダイレクト
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

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

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

ここでは、デモ用にシンプルなホームページを実装します：

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

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "認証されていません <a href='/sign-in'>サインイン</a>"
    return "認証されています <a href='/sign-out'>サインアウト</a>"

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

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

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

Tencent コネクターを追加する

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

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

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

注記:

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

Tencent SMS コネクターを設定する

Tencent Cloud アカウントの作成

Tencent Cloud のウェブサイトにアクセスし、アカウントをお持ちでない場合は登録してください。

Tencent Cloud SMS の有効化と設定

Tencent Cloud のウェブサイトでアカウントにサインインし、SMS サービスコンソールページに移動します。
SMS サービスページで「無料試用」(免费试用) ボタンをクリックし、セットアップ手順に従います。
「SMS サービス開通規約」(短信开通服务条款) に同意し、「サービスを有効化」(开通服务) をクリックして進めます。
「SMS コンソール概要」(短信服务控制台概览) で、サイドバーからニーズに応じて「国内メッセージ」(国内消息) または「国際/香港・マカオ・台湾メッセージ」(国际/港澳台消息) を選択します。
SMS メッセージ用のシグネチャとテンプレートを追加します。注意点：
- 「シグネチャ」(签名) を追加する際は、「適用シナリオ」(模版类型) フィールドで「認証コード」(验证码) を選択してください。
- テンプレートを追加する際は、テンプレートタイプとして「認証コード」を選択してください。
- テンプレート内容にはプレースホルダー {1} を含めてください。これはランダムに生成されたコードに置き換えられます。
- 複数のプレースホルダーを含むテンプレートはサポートされていません。単一プレースホルダーのテンプレートを使用または作成してください。
シグネチャとテンプレートを審査に提出します。提出後：
- 有効になるまでお待ちください。
- 「SMS コンソール概要」(短信服务控制台概览) からテスト SMS を送信できます。承認済みのシグネチャとテンプレートはテストに直接使用できます。審査中の場合は提供されているテスト用テンプレートを使用してください。
- テスト用にアカウント残高が十分であること、およびテスト用電話番号を事前登録して SMS を正常に受信できるようにしてください。

詳細なガイダンスは、SMS コンソール概要の「新手配置指引」(Getting Started Guide) タブをクリックしてください。

コネクター JSON の作成

「SMS コンソール概要」にアクセスし、右上のアバターにカーソルを合わせます。「アクセス管理 > アクセスキー > API キー」へ進み、セキュリティ認証を完了後に AccessKey ID と AccessKey Secret を生成します。大切に保管してください。
「国内メッセージ」(国内消息) または「国際/香港・マカオ・台湾メッセージ」(国际/港澳台消息) タブから「シグネチャ名」(签名名称) と「テンプレートコード」(模版 CODCE) を取得します。
- テスト用テンプレートの場合は、「テスト専用テンプレート」(测试专用签名模版) の下の「快速开始」(Getting Started) タブを確認してください。

Tencent Cloud SMS コネクターを次のフィールドで設定します：
- accessKeyId および accessKeySecret：ステップ 1 で取得した認証情報を使用します。
- signName：ステップ 2 で取得したシグネチャ名。すべてのテンプレートに適用されます。
- 必要に応じて、異なるシナリオ用に複数のテンプレートを追加できます。単一テンプレートの例：
  - templateCode：ステップ 2 で取得したテンプレートコード。
  - usageType：シナリオに応じて Register、SignIn、ForgotPassword、Generic のいずれかを指定します（Logto 固有のプロパティ）。
  - すべてのシナリオ（4 種類）に対してテンプレートが設定されていることを確認してください。
- sdkAppId：「アプリケーション管理」(应用管理) で確認できます。
- region：「送信ドキュメント」(发送文档) からサポートされているリージョンを指定してください。

Tencent Cloud SMS コネクターのテスト

電話番号を入力し、「送信」をクリックすることで、「保存して完了」前に設定が機能するかどうかを確認できます。

以上です。サインイン体験でコネクターを有効化するのをお忘れなく。

設定タイプ

名前	型
accessKeyId	string
accessKeySecret	string
signName	string
region	string
sdkAppId	string
templates	Template[]

テンプレートプロパティ	型	列挙値
templateCode	string	N/A
usageType	enum string	'Register' / 'SignIn' / 'ForgotPassword' / 'Generic'

設定を保存する

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

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

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

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

テストと検証

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

さらなる読み物

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

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

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

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

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

Logto SDK を統合する​

インストール​

LogtoClient の初期化​

サインインとサインアウトの実装​

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

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

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

Tencent SMS コネクター を設定する​

Tencent Cloud アカウントの作成​

Tencent Cloud SMS の有効化と設定​

コネクター JSON の作成​

Tencent Cloud SMS コネクターのテスト​

設定タイプ​

設定を保存する​

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

テストと検証​

さらなる読み物​