TotpSecret class

Fournisseur pour générer une TotpMultiFactorAssertion .

Stocke la clé secrète partagée et d'autres paramètres pour générer des OTP basés sur le temps. Implémente des méthodes pour récupérer la clé secrète partagée et générer une URL de code QR.

Signature:

export declare class TotpSecret 

Propriétés

Propriété Modificateurs Taper Description
codeIntervalSeconds nombre L'intervalle (en secondes) pendant lequel les codes OTP doivent changer.
codeLongueur nombre Longueur des mots de passe à usage unique à générer.
inscriptionachèvementdate limite chaîne L'horodatage (chaîne UTC) par lequel l'inscription TOTP doit être effectuée.
hachageAlgorithme chaîne Algorithme de hachage utilisé.
clef secrète chaîne Clé/graine secrète partagée utilisée pour l'inscription à TOTP MFA et la génération d'OTP.

Méthodes

Méthode Modificateurs Description
generateQrCodeUrl (nom du compte, émetteur) Renvoie une URL de code QR comme décrit dans https://github.com/google/google-authenticator/wiki/Key-Uri-Format. Elle peut être affichée à l'utilisateur sous forme de code QR à scanner dans une application TOTP comme Google Authenticator. . Si les paramètres facultatifs ne sont pas spécifiés, un accountName de et émetteur de sont utilisés.

TotpSecret.codeIntervalSeconds

L'intervalle (en secondes) pendant lequel les codes OTP doivent changer.

Signature:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

Longueur des mots de passe à usage unique à générer.

Signature:

readonly codeLength: number;

TotpSecret.enrollmentCompletionDeadline

L'horodatage (chaîne UTC) par lequel l'inscription TOTP doit être effectuée.

Signature:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithme

Algorithme de hachage utilisé.

Signature:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

Clé/graine secrète partagée utilisée pour l'inscription à TOTP MFA et la génération d'OTP.

Signature:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

Renvoie une URL de code QR comme décrit dans https://github.com/google/google-authenticator/wiki/Key-Uri-Format. Elle peut être affichée à l'utilisateur sous forme de code QR à scanner dans une application TOTP comme Google Authenticator. . Si les paramètres facultatifs ne sont pas spécifiés, un accountName de et émetteur de sont utilisés.

Signature:

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

Paramètres

Paramètre Taper Description
nom du compte chaîne le nom du compte/de l'application ainsi qu'un identifiant d'utilisateur.
émetteur chaîne émetteur du TOTP (probablement le nom de l'application).

Retour:

chaîne

Une chaîne d'URL de code QR.