Skip to content

Latest commit

 

History

History
97 lines (72 loc) · 5.41 KB

TOTP.md

File metadata and controls

97 lines (72 loc) · 5.41 KB
Raw

TOTP

After imported TOTP in your file, you can access to all its methods.

import { TOTP } from '@akanass/rx-otp';

Table of contents

API in Detail

.generate(key[, options])

Generates TOTP token for given key.

Parameters:

  • {string} key (required): Key for the one time password. This should be unique and secret for every user as this is the seed that is used to calculate the HMAC. Format can be ASCII or HEX.
  • {TOTPGenerateOptions} options (optional): object contains key_format, time, timestamp, code_digits, add_checksum, truncation_offset and algorithm. (default: empty object).

Response: {Observable} - A numeric string in base 10 includes code_digits plus the optional checksum digit if requested.

Example:

TOTP.generate('12345678901234567890', { timestamp: 59000, code_digits: 8, algorithm: 'SHA1' }).subscribe({
    next: token => console.log(token), // display 94287082 in the console
    error: err => console.error(err) // show error in console
});

Back to top

.verify(token, key[, options])

Verifies TOTP token with given key.

Parameters:

  • {string} token (required): Passcode to validate.
  • {string} key (required): Key for the one time password. This should be unique and secret for every user as this is the seed that is used to calculate the HMAC. Format can be ASCII or HEX.
  • {TOTPVerifyOptions} options (optional): object contains key_format, window, time, timestamp, add_checksum, truncation_offset and algorithm. (default: empty object).

Response: {Observable} - OTPVerifyResult with delta and delta_format: 'int' if the token is valid else throw an exception

Example:

TOTP.verify('94287082', '3132333435363738393031323334353637383930', { key_format: 'hex', timestamp: 59000, algorithm: 'SHA1' }).subscribe({
    next: data => console.log(data), // display {delta: 0, delta_format: 'int'} in the console
    error: err => console.error(err) // show error in console
});

Back to top

Parameters types in detail

TOTPGenerateOptions

  • {enum} key_format (optional): The format of the key which can be 'str' for an ASCII string or 'hex' for a hexadecimal string. (default 'str')
  • {number} time (optional): The time step of the counter. This must be the same for every request and is used to calculate C. (default 30)
  • {number} timestamp (optional): OTP validity timestamp. (default current datetime)
  • {number} code_digits (optional): The number of digits in the OTP, not including the checksum, if any. (default 6)
  • {boolean} add_checksum (optional): A flag indicates if a checksum digit should be appended to the OTP. (default false)
  • {number} truncation_offset (optional): The offset into the MAC result to begin truncation. Between 0 and 15. (default -1 to delete it)
  • {enum} algorithm (optional): The algorithm to create HMAC: 'SHA1' | 'SHA256' | 'SHA512'. (default 'SHA512')

TOTPVerifyOptions

  • {enum} key_format (optional): The format of the key which can be 'str' for an ASCII string or 'hex' for a hexadecimal string. (default 'str')
  • {number} window (optional): The allowable margin, time steps in seconds since T0, for the counter. The function will check 'W' codes in the future against the provided passcode. If W = 1, and T = 30, this function will check the passcode against all One Time Passcodes between -30s and +30s. (default 1)
  • {number} time (optional): The time step of the counter. This must be the same for every request and is used to calculate C. (default 30)
  • {number} timestamp (optional): OTP validity timestamp. (default current datetime)
  • {boolean} add_checksum (optional): A flag indicates if a checksum digit should be appended to the OTP. (default false)
  • {number} truncation_offset (optional): The offset into the MAC result to begin truncation. Between 0 and 15. (default -1 to delete it)
  • {enum} algorithm (optional): The algorithm to create HMAC: 'SHA1' | 'SHA256' | 'SHA512'. (default 'SHA512')

OTPVerifyResult

  • {number | string} delta (required): The delta with the counter during the validation.
  • {enum} delta_format (required): The delta format which can be 'int' for a number or 'hex' for a hexadecimal string. This value is the same than counter_format in TOTPVerifyOptions.

Back to top

Change History

Back to top