Class TOTP

constructor

• new TOTP(config?): TOTP

• Creates a TOTP object.

  Parameters

  • Optional config: {
        algorithm: undefined | string;
        digits: undefined | number;
        issuer: undefined | string;
        issuerInLabel: undefined | boolean;
        label: undefined | string;
        period: undefined | number;
        secret: undefined | string | Secret;
    } = {}

    Configuration options.

    • algorithm: undefined | string

      HMAC hashing algorithm.

    • digits: undefined | number

      Token length.

    • issuer: undefined | string

      Account provider.

    • issuerInLabel: undefined | boolean

      Include issuer prefix in label.

    • label: undefined | string

      Account label.

    • period: undefined | number

      Token time-step duration.

    • secret: undefined | string | Secret

      Secret key.

  Returns TOTP

algorithm

digits

issuer

issuerInLabel

label

period

secret

Static defaults

• 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;
  }

  • algorithm: string

  • digits: number

  • issuer: string

  • issuerInLabel: boolean

  • label: string

  • period: number

  • window: number

generate

• generate(config?): string

• Generates a TOTP token.

  Parameters

  • Optional config: {
        timestamp: undefined | number;
    } = {}

    Configuration options.

    • timestamp: undefined | number

      Timestamp value in milliseconds.

  Returns string

  Token.

toString

• toString(): string

• Returns a Google Authenticator key URI.

  Returns string

  URI.

validate

• validate(config): null | number

• Validates a TOTP token.

  Parameters

  • config: {
        timestamp: undefined | number;
        token: string;
        window: undefined | number;
    }

    Configuration options.

    • timestamp: undefined | number

      Timestamp value in milliseconds.

    • token: string

      Token value.

    • window: undefined | 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.

Static generate

• generate(config): string

• Generates a TOTP token.

  Parameters

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

    Configuration options.

    • algorithm: undefined | string

      HMAC hashing algorithm.

    • digits: undefined | number

      Token length.

    • period: undefined | number

      Token time-step duration.

    • secret: Secret

      Secret key.

    • timestamp: undefined | number

      Timestamp value in milliseconds.

  Returns string

  Token.

Static validate

• validate(config): null | number

• Validates a TOTP token.

  Parameters

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

    Configuration options.

    • algorithm: undefined | string

      HMAC hashing algorithm.

    • digits: number

      Token length.

    • period: undefined | number

      Token time-step duration.

    • secret: Secret

      Secret key.

    • timestamp: undefined | number

      Timestamp value in milliseconds.

    • token: string

      Token value.

    • window: undefined | 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.