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的承诺