https://github.com/stevent-team/totp
Lightweight RFC-compliant TOTP authentication library based on crypto
https://github.com/stevent-team/totp
2fa authentication nodejs totp typescript
Last synced: 10 months ago
JSON representation
Lightweight RFC-compliant TOTP authentication library based on crypto
- Host: GitHub
- URL: https://github.com/stevent-team/totp
- Owner: stevent-team
- License: mit
- Created: 2023-01-23T06:07:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T08:14:56.000Z (over 3 years ago)
- Last Synced: 2024-12-23T06:41:48.429Z (over 1 year ago)
- Topics: 2fa, authentication, nodejs, totp, typescript
- Language: TypeScript
- Homepage:
- Size: 97.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔑 totp
Lightweight rfc-compliant TOTP authentication library for nodejs based on `crypto`
[](https://www.npmjs.com/package/@stevent-team/totp)
[](https://bundlephobia.com/package/@stevent-team/totp)
> **Warning**
> This package is unstable and still in active development. You are more than welcome to contribute and make use of it but please note that there may be breaking changes
Conforms to the [IETF RFC 6238 specification](https://www.rfc-editor.org/rfc/rfc6238) including all interoperability test vectors.
## Installation
```bash
yarn add @stevent-team/totp
```
## Examples
```ts
import { generateTotp, validateTotp, type TotpOptions } from '@stevent-team/totp'
// Configure
const config: TotpOptions = {
secret: process.env['MY_SECRET_KEY'], // REQUIRED
timestamp: Date.now(),
period: 30, // seconds
periodOffset: 0,
algorithm: 'sha512',
outputDigits: 6,
}
// Generate a one time password (on a client)
const pass = generateTotp(config)
console.log(pass) // 568231
// Validate the one time password (on a server)
const isValid = validateTotp(pass, config)
console.log(isValid) // true
```
## Contributing
Issue and PR contributions are greatly welcomed and appreciated!
## License
`totp` is licensed under MIT
*Created with love by the [Stevent Team](https://stevent.club)* 💙