@sergiomorenoalbert/fastify-totp

A plugin to handle TOTP (e.g. for 2FA), forked to handle typings and updated dependencies

Install

npm i --save @sergiomorenoalbert/fastify-totp
yarn add @sergiomorenoalbert/fastify-totp
pnpm i --save @sergiomorenoalbert/fastify-totp

Usage

fastify.register(require('@sergiomorenoalbert/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)

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.

Test

pnpm install
pnpm test

Acknowledgements

This project is kindly forked by:

License

Licensed under MIT