TotpSecret class

Provedor para gerar um TotpMultiFactorAssertion .

Armazena a chave secreta compartilhada e outros parâmetros para gerar OTPs baseados em tempo. Implementa métodos para recuperar a chave secreta compartilhada e gerar um URL de código QR.

Assinatura:

export declare class TotpSecret 

Propriedades

Propriedade Modificadores Tipo Descrição
codeIntervalSeconds número O intervalo (em segundos) quando os códigos OTP devem mudar.
codeLength número Comprimento das senhas descartáveis ​​a serem geradas.
prazo de conclusão da inscrição corda O timestamp (string UTC) pelo qual a inscrição no TOTP deve ser concluída.
hash Algoritmo corda Algoritmo de hashing usado.
chave secreta corda Chave/semente secreta compartilhada usada para inscrição no TOTP MFA e geração de OTPs.

Métodos

Método Modificadores Descrição
gerarQrCodeUrl(accountName, emissor) Retorna um URL de código QR conforme descrito em https://github.com/google/google-authenticator/wiki/Key-Uri-Format Isso pode ser exibido para o usuário como um código QR a ser digitalizado em um aplicativo TOTP como o Google Authenticator . Se os parâmetros opcionais não forem especificados, um accountName de e emissor de são usados.

TotpSecret.codeIntervalSeconds

O intervalo (em segundos) quando os códigos OTP devem mudar.

Assinatura:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

Comprimento das senhas descartáveis ​​a serem geradas.

Assinatura:

readonly codeLength: number;

TotpSecret.enrollmentCompletionDeadline

O timestamp (string UTC) pelo qual a inscrição no TOTP deve ser concluída.

Assinatura:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

Algoritmo de hashing usado.

Assinatura:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

Chave/semente secreta compartilhada usada para inscrição no TOTP MFA e geração de OTPs.

Assinatura:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

Retorna um URL de código QR conforme descrito em https://github.com/google/google-authenticator/wiki/Key-Uri-Format Isso pode ser exibido para o usuário como um código QR a ser digitalizado em um aplicativo TOTP como o Google Authenticator . Se os parâmetros opcionais não forem especificados, um accountName de e emissor de são usados.

Assinatura:

generateQrCodeUrl(accountName?: string, issuer?: string): string;

Parâmetros

Parâmetro Tipo Descrição
nome da conta corda o nome da conta/aplicativo junto com um identificador de usuário.
emissor corda emissor do TOTP (provavelmente o nome do aplicativo).

Retorna:

corda

Uma string de URL de código QR.