otpauth

OTPAuth

One Time Password (HOTP/TOTP) library for Node.js and browser.

Installation

Install the module via npm.

$ npm install otpauth

Usage

Node.js

const OTPAuth = require('otpauth');

// Generate a random secret
let randomTOTP = new OTPAuth.TOTP();

// Specify a custom secret
let customTOTP = new OTPAuth.TOTP({
	'issuer': 'ACME',
	'label': 'AzureDiamond',
	'algorithm': 'SHA512',
	'digits': 8,
	'period': 20,
	'secret': new OTPAuth.Secret({
		'buffer': OTPAuth.Utils.b32.encode('NB2W45DFOIZA')
	})
});

// Convert to Google Authenticator key URI
console.log(customTOTP.toString());

// Generate token
console.log(customTOTP.generate());

Browser

<script src="otpauth.js"></script>
<script>
	var randomTOTP = new OTPAuth.TOTP();

	// Same as above...
</script>

Supported hashing algorithms

In Node.js, the same algorithms as Crypto.createHmac function are supported, since it is used internally. In browsers, the SHA1, SHA256 and SHA512 algorithms are supported by using the Stanford Javascript Crypto Library.

Documentation

See the documentation page.

Similar packages

Other packages similar to otpauth

speakeasy

Speakeasy is a library for generating and verifying one-time passwords (OTPs) using both HOTP and TOTP algorithms. It provides similar functionality to otpauth but also includes additional features such as QR code generation for easier 2FA setup.

notp

notp is a simple library for generating and verifying one-time passwords (OTPs) using the HOTP and TOTP algorithms. It is lightweight and easy to use, making it a good alternative to otpauth for basic OTP needs.

otp-generator

otp-generator is a library focused on generating one-time passwords (OTPs) with customizable length and character sets. While it does not provide validation functionality, it is useful for generating OTPs in various formats.