@otplib/totp

@otplib/totp

RFC 6238 TOTP implementation for otplib.

Installation

npm install @otplib/totp
pnpm install @otplib/totp
yarn add @otplib/totp

Usage

import { generate, verify } from "@otplib/totp";
import { crypto } from "@otplib/plugin-crypto-node";
import { base32 } from "@otplib/plugin-base32-scure";

// Generate a TOTP token
const token = await generate({
  secret: "GEZDGNBVGY3TQOJQGEZDGNBVGY",
  crypto,
  base32,
});

// Verify a TOTP token
const result = await verify({
  secret: "GEZDGNBVGY3TQOJQGEZDGNBVGY",
  token: "123456",
  crypto,
  base32,
});

// result.valid: boolean
// result.delta: number | null

Functions

generate

Generate a TOTP code:

import { generate } from '@otplib/totp';
import { crypto } from '@otplib/plugin-crypto-node';
import { base32 } from '@otplib/plugin-base32-scure';

const token = await generate({
  secret: new Uint8Array([...]),  // Required: secret as bytes
  crypto,                          // Required: crypto plugin
  base32,                          // Optional: base32 plugin (for decoding)
  algorithm: 'sha1',               // Optional: 'sha1' | 'sha256' | 'sha512'
  digits: 6,                       // Optional: 6 | 7 | 8
  period: 30,                      // Optional: time step in seconds
  epoch: Math.floor(Date.now() / 1000), // Optional: current time in seconds
});

verify

Verify a TOTP code:

import { verify } from '@otplib/totp';
import { crypto } from '@otplib/plugin-crypto-node';
import { base32 } from '@otplib/plugin-base32-scure';

const result = await verify({
  secret: new Uint8Array([...]),  // Required: secret as bytes
  token: '123456',                 // Required: token to verify
  crypto,                          // Required: crypto plugin
  base32,                          // Optional: base32 plugin (for decoding)
  algorithm: 'sha1',               // Optional: hash algorithm
  digits: 6,                       // Optional: expected digits
  period: 30,                      // Optional: time step
  epoch: Math.floor(Date.now() / 1000), // Optional: current time
  epochTolerance: 30,              // Optional: time tolerance in seconds
});

// Returns: { valid: boolean, delta: number | null }

getRemainingTime

Get the remaining time before the next TOTP period:

import { getRemainingTime } from "@otplib/totp";

const seconds = getRemainingTime(
  Math.floor(Date.now() / 1000), // time
  30, // period
  0, // t0
);

// Returns: number of seconds remaining

getTimeStepUsed

Get the time step used for a specific time:

import { getTimeStepUsed } from "@otplib/totp";

const counter = getTimeStepUsed(
  Math.floor(Date.now() / 1000), // time
  30, // period
  0, // t0
);

// Returns: the counter value

Documentation

Full documentation available at otplib.yeojz.dev:

• Getting Started Guide
• API Reference

License

MIT

Similar packages

Other packages similar to @otplib/totp

speakeasy

Speakeasy is a popular package for generating and verifying one-time passwords, including both TOTP and HOTP. It offers similar functionality to @otplib/totp, with a focus on simplicity and ease of use. Speakeasy is widely used for implementing 2FA in Node.js applications.

notp

notp is another package that provides support for TOTP and HOTP. It is a lightweight library that offers basic functionality for generating and verifying OTPs. Compared to @otplib/totp, notp is more minimalistic and may lack some of the advanced configuration options available in otplib.

authenticator

Authenticator is a package designed for generating and verifying TOTP tokens. It is similar to @otplib/totp in terms of functionality but is designed to be a simple and straightforward solution for adding 2FA to applications. It may not offer as many customization options as otplib.