TotpMultiFactorGenerator class

Provedor para gerar um TotpMultiFactorAssertion .

Assinatura:

export declare class TotpMultiFactorGenerator 

Propriedades

Propriedade Modificadores Tipo Descrição
FACTOR_ID static 'totp' O identificador do segundo fator TOTP: totp .

Métodos

Método Modificadores Descrição
assertionForEnrollment(secret, oneTimePassword) static Fornece um TotpMultiFactorAssertion para confirmar a propriedade do segundo fator TOTP (senha única baseada em tempo). Esta afirmação é usada para concluir a inscrição no segundo fator do TOTP.
assertionForSignIn(enrollmentId, oneTimePassword) static Fornece um TotpMultiFactorAssertion para confirmar a propriedade do segundo fator TOTP. Essa asserção é usada para concluir o signIn com TOTP como o segundo fator.
gerarSegredo(sessão) static Retorna uma promessa para TotpSecret que contém a chave secreta compartilhada TOTP e outros parâmetros. Cria um segredo TOTP como parte do registro de um segundo fator TOTP. Usado para gerar um URL de código QR ou inserir em um aplicativo TOTP. Este método usa a instância de autenticação correspondente ao usuário na multiFactorSession.

TotpMultiFactorGenerator.FACTOR_ID

O identificador do segundo fator TOTP: totp .

Assinatura:

static FACTOR_ID: 'totp';

TotpMultiFactorGenerator.assertionForEnrollment()

Fornece um TotpMultiFactorAssertion para confirmar a propriedade do segundo fator TOTP (senha única baseada em tempo). Esta afirmaçã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
segredo TopSecret Um TotpSecret contendo a chave secreta compartilhada e outros parâmetros TOTP.
oneTimePassword corda Senha de uso único do TOTP App.

Retorna:

TotpMultiFactorAssertion

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

TotpMultiFactorGenerator.assertionForSignIn()

Fornece um TotpMultiFactorAssertion para confirmar a propriedade do segundo fator TOTP. Essa asserção é usada para concluir o signIn com TOTP como o segundo fator.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ID da inscrição corda identifica o segundo fator TOTP registrado.
oneTimePassword corda Senha de uso único do TOTP App.

Retorna:

TotpMultiFactorAssertion

Um TotpMultiFactorAssertion que pode ser usado com MultiFactorResolver.resolveSignIn() .

TotpMultiFactorGenerator.generateSecret()

Retorna uma promessa para TotpSecret que contém a chave secreta compartilhada TOTP e outros parâmetros. Cria um segredo TOTP como parte do registro de um segundo fator TOTP. Usado para gerar um URL de código QR ou inserir em um aplicativo TOTP. Este 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 A MultiFactorSession da qual o usuário faz parte.

Retorna:

Promessa< TotpSecret >

Uma promessa à TotpSecret .