TotpSecret class

Provider for generating a TotpMultiFactorAssertion.

Stores the shared secret key and other parameters to generate time-based OTPs. Implements methods to retrieve the shared secret key and generate a QR code URL.

Signature:

export declare class TotpSecret 

Properties

Methods

TotpSecret.codeIntervalSeconds

The interval (in seconds) when the OTP codes should change.

Signature:

readonly codeIntervalSeconds: number;

TotpSecret.codeLength

Length of the one-time passwords to be generated.

Signature:

readonly codeLength: number;

TotpSecret.enrollmentCompletionDeadline

The timestamp (UTC string) by which TOTP enrollment should be completed.

Signature:

readonly enrollmentCompletionDeadline: string;

TotpSecret.hashingAlgorithm

Hashing algorithm used.

Signature:

readonly hashingAlgorithm: string;

TotpSecret.secretKey

Shared secret key/seed used for enrolling in TOTP MFA and generating OTPs.

Signature:

readonly secretKey: string;

TotpSecret.generateQrCodeUrl()

Returns a QR code URL as described in https://github.com/google/google-authenticator/wiki/Key-Uri-Format This can be displayed to the user as a QR code to be scanned into a TOTP app like Google Authenticator. If the optional parameters are unspecified, an accountName of and issuer of are used.

Signature:

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

Parameters

Returns:

string

A QR code URL string.