Поставщик для создания TotpMultiFactorAssertion .
Подпись:
export declare class TotpMultiFactorGenerator
Характеристики
| Свойство | Модификаторы | Тип | Описание |
|---|---|---|---|
| FACTOR_ID | static | 'тотп' | Идентификатор второго фактора TOTP: totp . |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| AssertionForEnrollment (секрет, oneTimePassword) | static | Предоставляет TotpMultiFactorAssertion для подтверждения владения вторым фактором TOTP (одноразовый пароль на основе времени). Это утверждение используется для завершения регистрации во втором факторе TOTP. |
| AssertionForSignIn (enrollmentId, oneTimePassword) | static | Предоставляет TotpMultiFactorAssertion для подтверждения владения вторым фактором TOTP. Это утверждение используется для завершения входа в систему с TOTP в качестве второго фактора. |
| генерироватьсекрет (сеанс) | static | Возвращает обещание TotpSecret , которое содержит общий секретный ключ TOTP и другие параметры. Создает секрет TOTP как часть регистрации второго фактора TOTP. Используется для создания URL-адреса QR-кода или ввода в приложение TOTP. Этот метод использует экземпляр аутентификации, соответствующий пользователю в multiFactorSession. |
TotpMultiFactorGenerator.FACTOR_ID
Идентификатор второго фактора TOTP: totp .
Подпись:
static FACTOR_ID: 'totp';
TotpMultiFactorGenerator.assertionForEnrollment()
Предоставляет TotpMultiFactorAssertion для подтверждения владения вторым фактором TOTP (одноразовый пароль на основе времени). Это утверждение используется для завершения регистрации во втором факторе TOTP.
Подпись:
static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| секрет | ТотпСекрет | TotpSecret , содержащий общий секретный ключ и другие параметры TOTP. |
| одноразовый пароль | нить | Одноразовый пароль от приложения TOTP. |
Возврат:
TotpMultiFactorAssertion , который можно использовать с MultiFactorUser.enroll(). .
TotpMultiFactorGenerator.assertionForSignIn()
Предоставляет TotpMultiFactorAssertion для подтверждения владения вторым фактором TOTP. Это утверждение используется для завершения входа в систему с TOTP в качестве второго фактора.
Подпись:
static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| идентификатор регистрации | нить | идентифицирует зарегистрированный второй фактор TOTP. |
| одноразовый пароль | нить | Одноразовый пароль от приложения TOTP. |
Возврат:
TotpMultiFactorAssertion , который можно использовать с MultiFactorResolver.resolveSignIn(). .
TotpMultiFactorGenerator.generateSecret()
Возвращает обещание TotpSecret , которое содержит общий секретный ключ TOTP и другие параметры. Создает секрет TOTP как часть регистрации второго фактора TOTP. Используется для создания URL-адреса QR-кода или ввода в приложение TOTP. Этот метод использует экземпляр аутентификации, соответствующий пользователю в multiFactorSession.
Подпись:
static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| сессия | Многофакторная сессия | MultiFactorSession , частью которого является пользователь. |
Возврат:
Обещание < TotpSecret >
Обещание TotpSecret .