jsotp
jsotp
is a node module to generate and verify one-time passwords that were used to implement 2FA and MFA authentication method in web applications and other login-required systems.
The module was implement based on RFC4226 (HOTP: An HMAC-Based One-Time Password Algorithm) and RFC6238 (TOTP: Time-Based One-Time Password Algorithm)
Example
Feature
- Generate random base32 encoded string
- Generate a
otpauth url
with the b32 encoded string - Create a HOTP object with verification
- Verify a HOTP token
- Create a TOTP object with verification
- Verify a TOTP token
Installation
npm install jsotp
Module
All modules support:
const jsotp = ;
Usage
Time-based OTPs
// importconst jsotp = ; // Create TOTP objectconst totp = jsotp;totp; // => 432143 // Verify for current timetotp; // => true // Verify after 30stotp; // => false
Counter-based OTPs
// importconst jsotp = ; // Create HOTP objectconst hotp = jsotp;hotp; // => 432143hotp; // => 231434hotp; // => 242432 // Verify with a counterhotp; // => truehotp; // => false
Generate random base32 encoded secret
// importconst jsotp = ; // Generateconst b32_secret = jsotpBase32;
Api
jsotp.Base32.random_gen(length)
•param: length
type: int
default: 16
return: String
desc: the length of random base32 encoded string.
jsotp.TOTP(secret)
•param: secret
type: string
return: TOTP
desc: generate TOTP instance.
jsotp.TOTP.now()
•return: String
desc: get the one-time password with current time.
jsotp.TOTP.verify(totp)
•param: totp
type: string
return: Boolean
desc: verify the totp code.
jsotp.TOTP.url_gen(issuer)
•param: issuer
type: string
return: string
desc: generate url with TOTP instance
jsotp.HOTP(secret)
•param: secret
type: string
return: HOTP
desc: generate HOTP instance.
jsotp.HOTP.at(counter)
•param: counter
type: int
return: String
desc: generate one-time password with counter.
jsotp.HOTP.verify(hotp, count)
•param: hotp
type: string
param: count
type: int
return: Boolean
desc: verify the hotp code.
jsotp.HOTP.url_gen(issuer)
•param: issuer
type: string
return: string
desc: generate url with HOTP instance
Contribute
- Clone repo and install dependencies
git clone git@github.com:LanceGin/jsotp.gitnpm install
- Contribute the code in
src/
, and run command below to build the es6 code to es2015. That will create a local directory namedlib/
.
npm run build
- Unit test
npm test