Interface TotpApi

base32

helpers

validate

generateToken

• generateToken(
      secret: Buffer,
      counter: number,
      digits: TotpDigits,
      algorithm: TotpAlgorithm,
  ): string

  Generates a token for a specific counter value.

  Parameters

  • secret: Buffer

    Decoded secret bytes.

  • counter: number

    Time-step counter.

  • digits: TotpDigits

    Number of digits to return.

  • algorithm: TotpAlgorithm

    HMAC algorithm.

  Returns string

  A zero-padded TOTP token.

generateURI

• generateURI(options: GenerateUriOptions): GenerateUriResult

  Generates an otpauth URI and associated secret.

  Parameters

  • options: GenerateUriOptions

    TOTP configuration values.

  Returns GenerateUriResult

  The generated otpauth URI and secret.

verifyToken

• verifyToken(
      token: string,
      secret: string,
      options?: Partial<VerifyTokenOptions>,
  ): boolean

  Checks a token against a shared secret without replay protection.

  Parameters

  • token: string

    User-provided token.

  • secret: string

    Canonical unpadded Base32 secret.

  • Optionaloptions: Partial<VerifyTokenOptions>

    Verification overrides.

  Returns boolean

  true when the token is valid for the given window.

verifyTokenOnce

• verifyTokenOnce(
      token: string,
      secret: string,
      claimCounter: ClaimTotpCounter,
      options?: Partial<VerifyTokenOptions>,
  ): Promise<boolean>

  Verifies a token and atomically claims its matched counter. The claim callback must persist the greatest accepted counter per account and return true only when it advances that counter.

  Parameters

  • token: string
  • secret: string
  • claimCounter: ClaimTotpCounter
  • Optionaloptions: Partial<VerifyTokenOptions>

  Returns Promise<boolean>