Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TotpTwoFactorAuthStrategyOptions

Hierarchy

  • TotpTwoFactorAuthStrategyOptions

Properties

Properties

Readonly serviceName

serviceName: string

Service name used for QR code containing totp secret. More details can be found here.

Readonly totp

totp: object

TOTP related options.

Type declaration

  • authenticator: Readonly<Omit<RequireSome<AuthenticatorOptions<string>, "algorithm" | "digits" | "encoding" | "step" | "window">, "keyEncoder" | "keyDecoder" | "createRandomBytes" | "epoch" | "createDigest" | "createHmacKey" | "digest">>

    TOTP authenticator options.

  • encryption: false | SecretEncryptionOptions

    This option dictates how totp secret will be stored by AccountWithTotpSecret.totpSecret property (i.e. how it will be stored in data storage).
    Depending on the value, the following behaviour will be employed:

    • false - totp secret will be stored in plaintext (unsecure, but faster)
    • SecretEncryptionOptions - totp secret will be encrypted before being stored (secure, but a bit slower as crypto is implied)
  • secretLength: number

    TOTP secret length.