https://github.com/4cc3ssX/react-native-nitro-totp
A full-featured React Native TOTP (Time-based One-Time Password) and HOTP (HMAC-based One-Time Password) authentication.
https://github.com/4cc3ssX/react-native-nitro-totp
hotp nitro-modules nitrogen react-native totp
Last synced: 7 months ago
JSON representation
A full-featured React Native TOTP (Time-based One-Time Password) and HOTP (HMAC-based One-Time Password) authentication.
- Host: GitHub
- URL: https://github.com/4cc3ssX/react-native-nitro-totp
- Owner: 4cc3ssX
- License: mit
- Created: 2024-09-29T07:07:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-18T08:11:22.000Z (12 months ago)
- Last Synced: 2024-10-19T20:51:13.915Z (12 months ago)
- Topics: hotp, nitro-modules, nitrogen, react-native, totp
- Language: C++
- Homepage:
- Size: 3.14 MB
- Stars: 24
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# react-native-nitro-totp
## Installation
```
# npm
npm install react-native-nitro-totp
# yarn
yarn add react-native-nitro-totp
```
Extra installation steps for [Nitro Modules](https://mrousavy.github.io/nitro/) can be found [here](https://mrousavy.github.io/nitro/docs/for-users)
## Usage
```ts
import {
formatOTP,
formatSecretKey,
isSecretKeyValid,
NitroSecret,
NitroTotp,
parseSecretKey,
} from 'react-native-nitro-totp';
const secret = NitroSecret.generate();
// TOTP
const otp = NitroTotp.generate(secret);
const isValid = NitroTotp.validate(secret, otp);
const generatedAuthURL = NitroTotp.generateAuthURL({
secret,
issuer: 'NitroTotp',
label: 'NitroTotp',
period: defaultOptions.period,
digits: defaultOptions.digits,
issuerInLabel: false,
algorithm: SupportedAlgorithm.SHA1,
});
// HOTP
const otp = NitroHOTP.generate(secret);
const isValid = NitroHOTP.validate(secret, otp);
const generatedAuthURL = NitroHOTP.generateAuthURL({
secret,
issuer: 'NitroHotp',
label: 'NitroHotp',
counter: defaultOptions.counter,
digits: defaultOptions.digits,
issuerInLabel: false,
algorithm: SupportedAlgorithm.SHA1,
});
```
## Generation Options
```ts
export interface BaseGenerateOptions {
/**
* The number of digits in the OTP.
* @type {number}
* @default 6
*/
digits?: number
/**
* The algorithm to use for generating the OTP.
* @type {SupportedAlgorithm}
* @default 'SHA1'
*/
algorithm?: SupportedAlgorithm
}
export interface NitroTotpGenerateOptions extends BaseGenerateOptions {
/**
* The period in seconds.
* @type {number}
* @default 30
*/
period?: number
}
export interface NitroHOTPGenerateOptions extends BaseGenerateOptions {
/**
* The counter to use for generating the OTP.
* @type {number}
* @default 0
*/
counter?: number
}
```
## Validation Options
```ts
export interface BaseValidateOptions extends BaseGenerateOptions {
/**
* The window of time steps to allow for OTP validation.
* @type {number}
* @default 1
*/
window?: number
}
export interface NitroHOTPValidateOptions extends BaseValidateOptions {
/**
* The counter to use for validating the OTP.
* @type {number}
* @default 0
*/
counter?: number
}
export interface NitroTotpValidateOptions extends BaseValidateOptions {
/**
* The period in seconds.
* @type {number}
* @default 30
*/
period?: number
}
```
## OTP Auth URL Options
```ts
export interface OTPAuthURLOptions extends BaseGenerateOptions {
/**
* The issuer of the secret key.
* @type {string}
*/
issuer?: string
/**
* The label of the secret key.
* @type {string}
*/
label?: string
/**
* The secret key to use for generating the OTP.
* @type {string}
*/
secret: string
/**
* Whether to include the issuer in the label.
* @type {boolean}
* @default false
*/
issuerInLabel?: boolean
/**
* The period in seconds.
* @type {number}
* @default 30
*/
period?: number
/**
* The counter to use for generating the OTP.
* @type {number}
* @default 0
*/
counter?: number
}
```
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT
---
Made with [react-native-nitro-modules](https://github.com/callstack/react-native-builder-bob)