https://github.com/beliven-it/fastify-totp
A plugin to handle TOTP (e.g. for 2FA)
https://github.com/beliven-it/fastify-totp
2fa auth fastify js nodejs speakeasy totp
Last synced: 25 days ago
JSON representation
A plugin to handle TOTP (e.g. for 2FA)
- Host: GitHub
- URL: https://github.com/beliven-it/fastify-totp
- Owner: beliven-it
- License: mit
- Created: 2020-06-11T14:57:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T14:45:44.000Z (4 months ago)
- Last Synced: 2025-04-12T05:37:19.343Z (about 1 month ago)
- Topics: 2fa, auth, fastify, js, nodejs, speakeasy, totp
- Language: JavaScript
- Size: 759 KB
- Stars: 22
- Watchers: 4
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# fastify-totp
A plugin to handle TOTP (e.g. for 2FA)
## Install
```bash
npm i --save fastify-totp
```
## Usage
```js
fastify.register(require('fastify-totp'))
// ...
secret = fastify.totp.generateSecret()
// You should now store secret.ascii in order to verify the TOTP.
const token = req.body.token
isVerified = fastify.totp.verify({ secret: secret.ascii, token })
```
The plugin includes also a facility to generate a **QRCode** that can be used
to quickly configure third-party authenticators (*e.g. Google Authenticator*)
```js
const qrcode = await fastify.totp.generateQRCode({ secret: secret.ascii })
```
## Methods
| Name | Description |
|-------------------------------------|------------------------------------------------------------------------------------|
| `generateSecret (length)` | Generate a new secret with the provided `length` (or use default one otherwise) |
| `generateToken (options)` | Generate a TOTP token based on given `options`. |
| `generateAuthURL (options)` | Generate an *auth URL** that can be used to configure a third-party authenticator. |
| `generateQRCode (options) [async]` | Genereate a data-URI of a *QRCode* to share the *auth URL*. |
| `verify (options)` | Verify a TOTP token with the original secret. |
## Request
| Name | Description |
|---------------------------------|---------------------------------------------------------------|
| `request.totpVerify (options)` | See `verify`. |
## Options
| Name | Description |
|--------------------|----------------------------------------------------------------------------------------------|
| `secretLength` | The length of the generated secret. *Default: 20* |
| `totpLabel` | The label to show in third-party authenticators. Usually the app name. *Default: "Fastify"* |
| `totpWindow` | The allowable previous or future "time-windows" to check against of. *Default: 1* |
| `totpAlg` | The algorithm to use for hash generation. *Default: "sha512"* |
| `totpStep` | Time step in seconds. *Default: 30* |
**NOTE:** for more details, please take a look at [Speakeasy docs](https://www.npmjs.com/package/speakeasy#documentation).
## Test
```bash
npm test
```
## Acknowledgements
This project is kindly sponsored by:
[](https://www.beliven.com)
## License
Licensed under [MIT](./LICENSE)