hotp.js

HOTP manager

Usage

General

import { createOTP } from 'hotp.js';

const otp = createOTP('otpauth://totp/ACME%20Co:[e-mail]?secret=HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ&issuer=ACME%20Co&algorithm=SHA1&digits=6&period=30');

otp.get();
// {
//   "code": "123456",
//   "type": "totp",
//   "timeout": 12,
//   "issuer": "ACME Co",
//   "acount": "[e-mail]"
// }

otp.getCode();
// 123456

otp.isValid('123456')
// true

// Lax mode. Also validates neighbours (±1) counter or timer of OTP factor
otp.isValid('654321', true)
// true

otp.toString();
// otpauth://totp/ACME%20Co:[e-mail]?secret=HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ&issuer=ACME%20Co&algorithm=SHA1&digits=6&period=30

Classess

import { HOTP, TOTP } from 'hotp.js';

const hotp = new HOTP({
  secret: Buffer, // <Buffer >
  counter: 1,
  // not required
  algorithm: 'sha1', // sha1, sha256, sha512, default sha1
  digits: 6, // 6, 8, default 6
  issuer: 'Some issuer',
  account: 'Some username'
});

hotp.evalCounter(); // increment counter, returns result
hotp.counter; // current counter


const totp = new TOTP({
  secret: Buffer, // <Buffer >
  // not required
  period: 30, // period in seconds, default 30
  algorithm: 'sha1', // sha1, sha256, sha512, default sha1
  digits: 6, // 6, 8, default 6
  issuer: 'Some issuer',
  account: 'Some username'
});

totp.getTimeout(); // time in seconds before code updates

Utils

import { formatURI, parseURI, importSecret, exportSecret } from 'hotp.js';

formatURI({
  type: 'totp',
  secret: Buffer,
  algorithm: 'sha1',
  digits: 6,
  period: 30,
  counter: 0,
  issuer: 'Some issuer',
  account: 'Sume username'
});
/// otpauth://totp/...

parseURI('otpauth://totp...');
// {
//   "type: "totp",
//   ...
// }

importSecret(Base32String);
// <Buffer ...>

exportSecret(Buffer);
// Base32 string

CommonJS

const { createOTP, ... } = require('hotp.js');