TotpMultiFactorGenerator class

TotpMultiFactorAssertion を生成するためのプロバイダ。

署名:

export declare class TotpMultiFactorGenerator 

プロパティ

プロパティ 修飾キー タイプ 説明
FACTOR_ID static 「totp」 TOTP の第 2 要素(totp)の識別子。

メソッド

メソッド 修飾キー 説明
assertionForEnrollment(secret, oneTimePassword) static TOTP(時間ベースのワンタイム パスワード)の第 2 要素の所有権を確認するための TotpMultiFactorAssertion を提供します。このアサーションは、TOTP の第 2 要素の登録を完了するために使用されます。
assertionForSignIn(enrollmentId, oneTimePassword) static TOTP の第 2 要素の所有権を確認するための TotpMultiFactorAssertion を提供します。このアサーションは、第 2 要素として TOTP を使用してログインを完了するために使用されます。
generateSecret(session) static TOTP 共有秘密鍵とその他のパラメータを含む Promise を TotpSecret に返します。TOTP 第 2 要素の登録の一環として TOTP シークレットを作成します。QR コードの URL の生成や、TOTP アプリへの入力に使用されます。このメソッドは、multiFactorSession 内のユーザーに対応する認証インスタンスを使用します。

TotpMultiFactorGenerator.FACTOR_ID

TOTP の第 2 要素の識別子: totp

署名:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

TOTP(時間ベースのワンタイム パスワード)の第 2 要素の所有権を確認するための TotpMultiFactorAssertion を提供します。このアサーションは、TOTP の第 2 要素の登録を完了するために使用されます。

署名:

static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;

パラメータ

パラメータ 説明
Secret TotpSecret 共有秘密鍵とその他の TOTP パラメータを含む TotpSecret
ワンタイム パスワード 文字列 TOTP アプリのワンタイム パスワード。

戻り値:

TotpMultiFactorAssertion

MultiFactorUser.enroll() で使用できる TotpMultiFactorAssertion

TotpMultiFactorGenerator.assertionForSignIn()

TOTP の第 2 要素の所有権を確認するための TotpMultiFactorAssertion を提供します。このアサーションは、第 2 要素として TOTP を使用してログインを完了するために使用されます。

署名:

static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;

パラメータ

パラメータ 説明
登録 ID 文字列 登録済みの TOTP の第 2 要素を識別します。
ワンタイム パスワード 文字列 TOTP アプリのワンタイム パスワード。

戻り値:

TotpMultiFactorAssertion

MultiFactorResolver.resolveSignIn() で使用できる TotpMultiFactorAssertion

TotpMultiFactorGenerator.generateSecret()

TOTP 共有秘密鍵とその他のパラメータを含む Promise を TotpSecret に返します。TOTP 第 2 要素の登録の一環として TOTP シークレットを作成します。QR コードの URL の生成や、TOTP アプリへの入力に使用されます。このメソッドは、multiFactorSession 内のユーザーに対応する認証インスタンスを使用します。

署名:

static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;

パラメータ

パラメータ 説明
セッション MultiFactorSession ユーザーが属している MultiFactorSession

戻り値:

Promise <TotpSecret>

TotpSecret への Promise。