TotpMultiFactorGenerator class

用於產生TotpMultiFactorAssertion 的提供程序

簽名:

export declare class TotpMultiFactorGenerator 

特性

財產修飾符類型描述
因子ID static '托普' TOTP 第二個因素的識別碼: totp

方法

方法修飾符描述
斷言ForEnrollment(秘密,oneTimePassword) static提供TotpMultiFactorAssertion以確認 TOTP(基於時間的一次性密碼)第二因素的所有權。該斷言用於完成 TOTP 第二因素的註冊。
assertionForSignIn(enrollmentId, oneTimePassword) static提供TotpMultiFactorAssertion來確認 TOTP 第二個因素的所有權。該斷言用於以 TOTP 作為第二個因素完成登入。
生成秘密(會話) static傳回TotpSecret的承諾,其中包含 TOTP 共享金鑰和其他參數。建立 TOTP 機密作為註冊 TOTP 第二因素的一部分。用於產生二維碼 URL 或輸入 TOTP 應用程式。此方法使用 multiFactorSession 中與使用者對應的 auth 實例。

TotpMultiFactorGenerator.FACTOR_ID

TOTP第二因素的識別碼: totp

簽名:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

提供TotpMultiFactorAssertion以確認 TOTP(基於時間的一次性密碼)第二因素的所有權。該斷言用於完成 TOTP 第二因素的註冊。

簽名:

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

參數

範圍類型描述
秘密頂級秘密包含共用金鑰和其他 TOTP 參數的TotpSecret
免洗密碼細繩TOTP 應用程式的一次性密碼。

返回:

頂部多因素斷言

可以與MultiFactorUser.enroll()一起使用的TotpMultiFactorAssertion

TotpMultiFactorGenerator.assertionForSignIn()

提供TotpMultiFactorAssertion來確認 TOTP 第二個因素的所有權。該斷言用於以 TOTP 作為第二個因素完成登入。

簽名:

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

參數

範圍類型描述
註冊ID細繩確定已登記的 TOTP 第二因素。
免洗密碼細繩TOTP 應用程式的一次性密碼。

返回:

頂部多因素斷言

可以與MultiFactorResolver.resolveSignIn()一起使用的TotpMultiFactorAssertion

TotpMultiFactorGenerator.generateSecret()

傳回TotpSecret的承諾,其中包含 TOTP 共享金鑰和其他參數。建立 TOTP 機密作為註冊 TOTP 第二因素的一部分。用於產生二維碼 URL 或輸入 TOTP 應用程式。此方法使用 multiFactorSession 中與使用者對應的 auth 實例。

簽名:

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

參數

範圍類型描述
會議多因素會話用戶所屬的MultiFactorSession

返回:

承諾 < ToppSecret >

TotpSecret的承諾