TotpMultiFactorGenerator class

產生 TotpMultiFactorAssertion 的提供者。

簽名:

export declare class TotpMultiFactorGenerator 

屬性

屬性 修飾符 類型 說明
FACTOR_ID static 「totp」 TOTP 雙重驗證的 ID:totp

方法

方法 修飾符 說明
assertionForEnrollment(secret, oneTimePassword) static 提供 TotpMultiFactorAssertion,確認 TOTP (時間型動態密碼) 的第二驗證擁有權。此斷言用於完成 TOTP 雙重驗證註冊。
assertionForSignIn(enrollmentId, oneTimePassword) static 提供 TotpMultiFactorAssertion,確認 TOTP 雙重驗證的擁有權。這項斷言用於完成以 TOTP 做為第二重驗證方式的登入程序。
generateSecret(session) static 傳回 TotpSecret 的承諾,其中包含 TOTP 共用密鑰和其他參數。在註冊 TOTP 雙重驗證的過程中建立 TOTP 密鑰。用於產生 QR code 網址,或輸入 TOTP 應用程式。這個方法會使用與 multiFactorSession 使用者對應的驗證執行個體。

TotpMultiFactorGenerator.FACTOR_ID

TOTP 雙重驗證的 ID:totp

簽名:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

提供 TotpMultiFactorAssertion,確認 TOTP (時間型動態密碼) 的第二驗證擁有權。此斷言用於完成 TOTP 雙重驗證註冊。

簽名:

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

參數

參數 類型 說明
密鑰 TotpSecret 包含共用密鑰和其他 TOTP 參數的 TotpSecret
一次性密碼 字串 TOTP 應用程式的動態密碼。

傳回:

TotpMultiFactorAssertion

TotpMultiFactorAssertion 可與 MultiFactorUser.enroll() 搭配使用。

TotpMultiFactorGenerator.assertionForSignIn()

提供 TotpMultiFactorAssertion,確認 TOTP 雙重驗證的擁有權。這項斷言用於完成以 TOTP 做為第二重驗證方式的登入程序。

簽名:

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

參數

參數 類型 說明
註冊 ID 字串 用於識別註冊的 TOTP 第二重驗證方式
一次性密碼 字串 TOTP 應用程式的動態密碼。

傳回:

TotpMultiFactorAssertion

TotpMultiFactorAssertion 可與 MultiFactorResolver.resolveSignIn() 搭配使用。

TotpMultiFactorGenerator.generateSecret()

傳回 TotpSecret 的承諾,其中包含 TOTP 共用密鑰和其他參數。在註冊 TOTP 雙重驗證的過程中建立 TOTP 密鑰。用於產生 QR code 網址,或輸入 TOTP 應用程式。這個方法會使用與 multiFactorSession 使用者對應的驗證執行個體。

簽名:

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

參數

參數 類型 說明
工作階段 多因素工作階段 使用者所屬的 MultiFactorSession

傳回:

承諾<TotpSecret>

TotpSecret 的承諾。