@gibme/mfa
    Preparing search index...

    Type Alias Config<SecretType>

    type Config<SecretType extends Secret | string> = {
        algorithm: HOTP.DigestAlgorithm;
        counter: number;
        digits: 6 | 8;
        issuer: string;
        label: string;
        secret: SecretType;
        window: number;
    }

    Type Parameters

    • SecretType extends Secret | string
    Index

    Properties

    algorithm counter digits issuer label secret window

    Properties

    algorithm: HOTP.DigestAlgorithm

    The algorithm to use for digest generation.

    Note: Most authenticator applications have limited support for anything other than SHA1

    SHA1
    counter: number

    The HOTP counter

    Note: This should be incremented upon each use to prevent replay attacks. user must also increment.

    Note: This value is overwritten when TOTP is used.

    0
    digits: 6 | 8

    The number of digits to use for the OTP

    6
    issuer: string

    Displays as the "issuer" in most Authenticator applications

    <empty>
    label: string

    Displays as the account label in most Authenticator applications

    'Change Me'
    secret: SecretType

    The Secret seed for the generation/validation of the OTP

    <random>
    window: number

    The window of permitted OTP codes when verifying. A value of 1 would allow an OTP that is valid for the current counter/period +/- 1. A value of 2 would allow +/- 2.

    1

    Settings

    Member Visibility

    On This Page

    Properties