Class TOTP

constructor

• new TOTP(
      config?: {
          algorithm?: string;
          digits?: number;
          issuer?: string;
          issuerInLabel?: boolean;
          label?: string;
          period?: number;
          secret?: string | Secret;
      },
  ): TOTP

  Creates a TOTP object.

  Parameters

  • Optionalconfig: {
        algorithm?: string;
        digits?: number;
        issuer?: string;
        issuerInLabel?: boolean;
        label?: string;
        period?: number;
        secret?: string | Secret;
    } = {}

    Configuration options.

    • Optionalalgorithm?: string

      HMAC hashing algorithm.

    • Optionaldigits?: number

      Token length.

    • Optionalissuer?: string

      Account provider.

    • OptionalissuerInLabel?: boolean

      Include issuer prefix in label.

    • Optionallabel?: string

      Account label.

    • Optionalperiod?: number

      Token time-step duration.

    • Optionalsecret?: string | Secret

      Secret key.

  Returns TOTP

algorithm

digits

issuer

issuerInLabel

label

period

secret

Staticdefaults

• get defaults(): {
      algorithm: string;
      digits: number;
      issuer: string;
      issuerInLabel: boolean;
      label: string;
      period: number;
      window: number;
  }

  Default configuration.

  Returns {
      algorithm: string;
      digits: number;
      issuer: string;
      issuerInLabel: boolean;
      label: string;
      period: number;
      window: number;
  }

counter

• counter(config?: { timestamp?: number }): number

  Calculates the counter. i.e. the number of periods since timestamp 0.

  Parameters

  • Optionalconfig: { timestamp?: number } = {}

    Configuration options.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns number

  Counter.

generate

• generate(config?: { timestamp?: number }): string

  Generates a TOTP token.

  Parameters

  • Optionalconfig: { timestamp?: number } = {}

    Configuration options.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns string

  Token.

remaining

• remaining(config?: { timestamp?: number }): number

  Calculates the remaining time in milliseconds until the next token is generated.

  Parameters

  • Optionalconfig: { timestamp?: number } = {}

    Configuration options.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns number

  counter.

toString

• toString(): string

  Returns a Google Authenticator key URI.

  Returns string

  URI.

validate

• validate(
      config: { timestamp?: number; token: string; window?: number },
  ): null | number

  Validates a TOTP token.

  Parameters

  • config: { timestamp?: number; token: string; window?: number }

    Configuration options.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

    • token: string

      Token value.

    • Optionalwindow?: number

      Window of counter values to test.

  Returns null | number

  Token delta or null if it is not found in the search window, in which case it should be considered invalid.

Staticcounter

• counter(config?: { period?: number; timestamp?: number }): number

  Calculates the counter. i.e. the number of periods since timestamp 0.

  Parameters

  • Optionalconfig: { period?: number; timestamp?: number } = {}

    Configuration options.

    • Optionalperiod?: number

      Token time-step duration.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns number

  Counter.

Staticgenerate

• generate(
      config: {
          algorithm?: string;
          digits?: number;
          period?: number;
          secret: Secret;
          timestamp?: number;
      },
  ): string

  Generates a TOTP token.

  Parameters

  • config: {
        algorithm?: string;
        digits?: number;
        period?: number;
        secret: Secret;
        timestamp?: number;
    }

    Configuration options.

    • Optionalalgorithm?: string

      HMAC hashing algorithm.

    • Optionaldigits?: number

      Token length.

    • Optionalperiod?: number

      Token time-step duration.

    • secret: Secret

      Secret key.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns string

  Token.

Staticremaining

• remaining(config?: { period?: number; timestamp?: number }): number

  Calculates the remaining time in milliseconds until the next token is generated.

  Parameters

  • Optionalconfig: { period?: number; timestamp?: number } = {}

    Configuration options.

    • Optionalperiod?: number

      Token time-step duration.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

  Returns number

  counter.

Staticvalidate

• validate(
      config: {
          algorithm?: string;
          digits?: number;
          period?: number;
          secret: Secret;
          timestamp?: number;
          token: string;
          window?: number;
      },
  ): null
  | number

  Validates a TOTP token.

  Parameters

  • config: {
        algorithm?: string;
        digits?: number;
        period?: number;
        secret: Secret;
        timestamp?: number;
        token: string;
        window?: number;
    }

    Configuration options.

    • Optionalalgorithm?: string

      HMAC hashing algorithm.

    • Optionaldigits?: number

      Token length.

    • Optionalperiod?: number

      Token time-step duration.

    • secret: Secret

      Secret key.

    • Optionaltimestamp?: number

      Timestamp value in milliseconds.

    • token: string

      Token value.

    • Optionalwindow?: number

      Window of counter values to test.

  Returns null | number

  Token delta or null if it is not found in the search window, in which case it should be considered invalid.