TotpMultiFactorGenerator class

用于生成 TotpMultiFactorAssertion 的提供程序。

签名

export declare class TotpMultiFactorGenerator 

属性

属性 修饰符 类型 说明
FACTOR_ID static “totp” TOTP 第二重身份验证的标识符:totp

方法

方法 修饰符 说明
assertionForEnrollment(secret, oneTimePassword) static 提供 TotpMultiFactorAssertion 以确认对 TOTP(基于时间的一次性密码)第二重身份验证的所有权。此断言用于完成 TOTP 第二重身份验证的注册。
assertionForSignIn(enrollmentId, oneTimePassword) static 提供 TotpMultiFactorAssertion 以确认对 TOTP 第二重身份验证的所有权。此断言用于以 TOTP 作为第二因素来完成登录。
generateSecret(session) static TotpSecret 返回一个 promise,其中包含 TOTP 共享密钥和其他参数。在注册 TOTP 第二重身份验证的过程中创建 TOTP 密钥。用于生成二维码网址或输入到 TOTP 应用中。此方法使用与 multiFactorSession 中的用户对应的身份验证实例。

TotpMultiFactorGenerator.FACTOR_ID

TOTP 第二重身份验证的标识符:totp

签名

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

提供 TotpMultiFactorAssertion 以确认对 TOTP(基于时间的一次性密码)第二重身份验证的所有权。此断言用于完成 TOTP 第二重身份验证的注册。

签名

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

参数

参数 类型 说明
Secret TotpSecret 包含共享密钥和其他 TOTP 参数的 TotpSecret
一次性密码 字符串 TOTP 应用提供的动态密码。

返回

TotpMultiFactorAssertion

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

TotpMultiFactorGenerator.assertionForSignIn()

提供 TotpMultiFactorAssertion 以确认对 TOTP 第二重身份验证的所有权。此断言用于以 TOTP 作为第二因素来完成登录。

签名

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

参数

参数 类型 说明
enrollmentId 字符串 用于标识已注册的 TOTP 第二重身份验证。
一次性密码 字符串 TOTP 应用提供的动态密码。

返回

TotpMultiFactorAssertion

一个 TotpMultiFactorAssertion,可与 MultiFactorResolver.resolveSignIn() 搭配使用。

TotpMultiFactorGenerator.generateSecret()

TotpSecret 返回一个 promise,其中包含 TOTP 共享密钥和其他参数。在注册 TOTP 第二重身份验证的过程中创建 TOTP 密钥。用于生成二维码网址或输入到 TOTP 应用中。此方法使用与 multiFactorSession 中的用户对应的身份验证实例。

签名

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

参数

参数 类型 说明
会话 MultiFactorSession 用户所属的 MultiFactorSession

返回

Promise <TotpSecret>

TotpSecret 的承诺。