Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hectorm/otpauth
One Time Password (HOTP/TOTP) library for Node.js, Deno, Bun and browsers.
https://github.com/hectorm/otpauth
auth authenticator browser bun deno google-authenticator hotp javascript node node-js nodejs otp otpauth security totp two-factor two-factor-authentication two-step two-step-authentication
Last synced: about 2 months ago
JSON representation
One Time Password (HOTP/TOTP) library for Node.js, Deno, Bun and browsers.
- Host: GitHub
- URL: https://github.com/hectorm/otpauth
- Owner: hectorm
- License: mit
- Created: 2017-01-03T15:24:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T12:25:11.000Z (5 months ago)
- Last Synced: 2024-05-02T05:16:37.006Z (5 months ago)
- Topics: auth, authenticator, browser, bun, deno, google-authenticator, hotp, javascript, node, node-js, nodejs, otp, otpauth, security, totp, two-factor, two-factor-authentication, two-step, two-step-authentication
- Language: JavaScript
- Homepage: https://hectorm.github.io/otpauth/
- Size: 7.57 MB
- Stars: 834
- Watchers: 10
- Forks: 52
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/hectorm/otpauth/tags)
[](https://www.npmjs.com/package/otpauth)
# OTPAuth
One Time Password (HOTP/TOTP) library for Node.js, Deno, Bun and browsers.
## Usage
### Node.js
```javascript
import * as OTPAuth from "otpauth";
// Create a new TOTP object.
let totp = new OTPAuth.TOTP({
// Provider or service the account is associated with.
issuer: "ACME",
// Account identifier.
label: "AzureDiamond",
// Algorithm used for the HMAC function.
algorithm: "SHA1",
// Length of the generated tokens.
digits: 6,
// Interval of time for which a token is valid, in seconds.
period: 30,
// Arbitrary key encoded in Base32 or OTPAuth.Secret instance.
secret: "NB2W45DFOIZA", // or 'OTPAuth.Secret.fromBase32("NB2W45DFOIZA")'
});
// A cryptographically secure random secret can also be generated with:
let secret = new OTPAuth.Secret({ size: 20 });
// Generate a token (returns the current token as a string).
let token = totp.generate();
// Validate a token (returns the token delta or null if it is not found in the
// search window, in which case it should be considered invalid).
let delta = totp.validate({ token, window: 1 });
// Get the remaining seconds until the current token changes.
let seconds = totp.period - (Math.floor(Date.now() / 1000) % totp.period);
// Convert to Google Authenticator key URI format (usually the URI is encoded
// in a QR code that can be scanned by the user. This functionality is outside
// the scope of the project, but there are many libraries that can be used for
// this purpose).
//
// otpauth://totp/ACME:AzureDiamond?issuer=ACME&secret=NB2W45DFOIZA&algorithm=SHA1&digits=6&period=30
let uri = totp.toString(); // or 'OTPAuth.URI.stringify(totp)'
// Convert from Google Authenticator key URI format.
totp = OTPAuth.URI.parse(uri);
```
### Deno
```javascript
import * as OTPAuth from "https://deno.land/x/otpauth@VERSION/dist/otpauth.esm.js";
// Same as above.
```
### Bun
```javascript
import * as OTPAuth from "otpauth";
// Same as above.
```
### Browsers
```html
// Same as above.
```
## Documentation
See the documentation page.
> [https://hectorm.github.io/otpauth/](https://hectorm.github.io/otpauth/)
## Supported hashing algorithms
In Node.js, the same algorithms as
[`Crypto.createHmac`](https://nodejs.org/api/crypto.html#crypto_crypto_createhmac_algorithm_key_options)
function are supported, since it is used internally. In Deno, Bun and browsers, the `SHA1`, `SHA224`, `SHA256`, `SHA384`,
`SHA512`, `SHA3-224`, `SHA3-256`, `SHA3-384` and `SHA3-512` algorithms are supported by using the
[@noble/hashes](https://github.com/paulmillr/noble-hashes) library.
## License
[MIT License](https://github.com/hectorm/otpauth/blob/master/LICENSE.md)
© [Héctor Molinero Fernández](https://hector.molinero.dev/).