Namespace TOTP

Index

Functions

Functions

Const generate

generate(__namedParameters: { algorithm?: string; key: string | Buffer; time?: number }): string

- Defined in lib/totp.ts:13
TOTP = HOTP(K, T)

https://datatracker.ietf.org/doc/html/rfc6238#section-4.2

Parameters
- __namedParameters: { algorithm?: string; key: string | Buffer; time?: number }
  - Optional algorithm?: string
    
    custom algorithm for crypto.createHmac. Default: sha1
  - key: string | Buffer
    
    unique secret key for user
  - Optional time?: number
    
    time-step in seconds (default recomended). Default: 30
Returns string

6 digit code as a string

Const validate

validate(__namedParameters: { algorithm?: string; key: string | Buffer; time?: number; token: string; window?: number }): number

- Defined in lib/totp.ts:33
https://datatracker.ietf.org/doc/html/rfc6238#section-5.2

Parameters
- __namedParameters: { algorithm?: string; key: string | Buffer; time?: number; token: string; window?: number }
  - Optional algorithm?: string
    
    custom algorithm for crypto.createHmac. Default: sha1
  - key: string | Buffer
    
    unique secret key for user
  - Optional time?: number
    
    time-step in seconds (default is recomended). Default: 30
  - token: string
    
    code, provided by user
  - Optional window?: number
    
    counter values window. Default: 1
Returns number

null if nothing found or number between -window to +window if same code in steps found

Generated using TypeDoc