TotpMultiFactorGenerator class

Proveedor para generar una TotpMultiFactorAssertion .

Firma:

export declare class TotpMultiFactorGenerator

Propiedades

Propiedad Modificadores Tipo Descripción
FACTOR_ID static 'totop' El identificador del segundo factor TOTP: totp .

Métodos

Método Modificadores Descripción
aserciónParaEnrolamiento(secreto, oneTimePassword) static Proporciona una TotpMultiFactorAssertion para confirmar la propiedad del segundo factor TOTP (contraseña de un solo uso basada en tiempo). Esta afirmación se utiliza para completar la inscripción en el segundo factor TOTP.
aserciónParaSignIn(identificador de inscripción, contraseña de un tiempo) static Proporciona una TotpMultiFactorAssertion para confirmar la propiedad del segundo factor TOTP. Esta afirmación se utiliza para completar el inicio de sesión con TOTP como segundo factor.
generarSecreto(sesión) static Devuelve una promesa a TotpSecret que contiene la clave secreta compartida TOTP y otros parámetros. Crea un secreto TOTP como parte del registro de un segundo factor TOTP. Se utiliza para generar una URL de código QR o ingresar en una aplicación TOTP. Este método utiliza la instancia de autenticación correspondiente al usuario en multiFactorSession.

TotpMultiFactorGenerator.FACTOR_ID

El identificador del segundo factor TOTP: totp .

Firma:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

Proporciona una TotpMultiFactorAssertion para confirmar la propiedad del segundo factor TOTP (contraseña de un solo uso basada en tiempo). Esta afirmación se utiliza para completar la inscripción en el segundo factor TOTP.

Firma:

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

Parámetros

Parámetro Tipo Descripción
secreto TotpSecret Un TotpSecret que contiene la clave secreta compartida y otros parámetros TOTP.
oneTimeContraseña cadena Contraseña de un solo uso de la aplicación TOTP.

Devoluciones:

Aserción TotpMultiFactor

Una TotpMultiFactorAssertion que se puede utilizar con MultiFactorUser.enroll() .

TotpMultiFactorGenerator.assertionForSignIn()

Proporciona una TotpMultiFactorAssertion para confirmar la propiedad del segundo factor TOTP. Esta afirmación se utiliza para completar el inicio de sesión con TOTP como segundo factor.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de inscripción cadena identifica el segundo factor TOTP registrado.
oneTimeContraseña cadena Contraseña de un solo uso de la aplicación TOTP.

Devoluciones:

Aserción TotpMultiFactor

Una TotpMultiFactorAssertion que se puede utilizar con MultiFactorResolver.resolveSignIn() .

TotpMultiFactorGenerator.generateSecret()

Devuelve una promesa a TotpSecret que contiene la clave secreta compartida TOTP y otros parámetros. Crea un secreto TOTP como parte del registro de un segundo factor TOTP. Se utiliza para generar una URL de código QR o ingresar en una aplicación TOTP. Este método utiliza la instancia de autenticación correspondiente al usuario en multiFactorSession.

Firma:

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

Parámetros

Parámetro Tipo Descripción
sesión Sesión MultiFactor La MultiFactorSession de la que forma parte el usuario.

Devoluciones:

Promesa< TotpSecret >

Una promesa a TotpSecret .