TotpMultiFactorGenerator class

Provedor para gerar uma TotpMultiFactorAssertion.

Assinatura:

export declare class TotpMultiFactorGenerator 

Propriedades

Propriedade Modificadores Tipo Descrição
FACTOR_ID (link em inglês) static "totp" O identificador do segundo fator de TOTP: totp.

Métodos

Método Modificadores Descrição
assertionForRegistration(secret, oneTimePassword) static Oferece uma TotpMultiFactorAssertion para confirmar a propriedade do segundo fator de senha única baseada em tempo (TOTP). Esta declaração é usada para concluir a inscrição no segundo fator do TOTP.
assertionForSignIn(enrollmentId, oneTimePassword) static Fornece uma TotpMultiFactorAssertion para confirmar a propriedade do segundo fator de TOTP. Essa declaração é usada para concluir o login com o TOTP como o segundo fator.
generateSecret(session) (em inglês) static Retorna uma promessa para TotpSecret que contém a chave do secret compartilhado do TOTP e outros parâmetros. Cria um secret TOTP como parte da inscrição de um segundo fator de TOTP. Usado para gerar um URL de QR code ou inseri-lo em um app TOTP. Esse método usa a instância de autenticação correspondente ao usuário na multiFactorSession.

TotpMultiFactorGenerator.FACTOR_ID

O identificador do segundo fator de TOTP: totp.

Assinatura:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

Oferece uma TotpMultiFactorAssertion para confirmar a propriedade do segundo fator de senha única baseada em tempo (TOTP). Esta declaração é usada para concluir a inscrição no segundo fator do TOTP.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
secret TotpSecret (em inglês) Um TotpSecret contendo a chave do secret compartilhado e outros parâmetros de TOTP.
Senha oneTime string Senha única do app TOTP.

Retorna:

TotpMultiFactorAssertion (link em inglês)

Uma TotpMultiFactorAssertion que pode ser usada com MultiFactorUser.enroll().

TotpMultiFactorGenerator.assertionForSignIn()

Fornece uma TotpMultiFactorAssertion para confirmar a propriedade do segundo fator de TOTP. Essa declaração é usada para concluir o login com o TOTP como o segundo fator.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ID da inscrição string identifica o segundo fator do TOTP registrado.
Senha oneTime string Senha única do app TOTP.

Retorna:

TotpMultiFactorAssertion (link em inglês)

Uma TotpMultiFactorAssertion que pode ser usada com MultiFactorResolver.resolveSignIn().

TotpMultiFactorGenerator.generateSecret()

Retorna uma promessa para TotpSecret que contém a chave do secret compartilhado do TOTP e outros parâmetros. Cria um secret TOTP como parte da inscrição de um segundo fator de TOTP. Usado para gerar um URL de QR code ou inseri-lo em um app TOTP. Esse método usa a instância de autenticação correspondente ao usuário na multiFactorSession.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
sessão MultiFactorSession (em inglês) A MultiFactorSession de que o usuário faz parte.

Retorna:

Promessa<TotpSecret>

Uma promessa para TotpSecret.