https://github.com/rohit-chouhan/auth_totp
A fast and easy-to-use time-based one-time password (TOTP) authentication package for your Flutter application
https://github.com/rohit-chouhan/auth_totp
auth authentication dart flutter otp totp
Last synced: about 2 months ago
JSON representation
A fast and easy-to-use time-based one-time password (TOTP) authentication package for your Flutter application
- Host: GitHub
- URL: https://github.com/rohit-chouhan/auth_totp
- Owner: rohit-chouhan
- License: mit
- Created: 2024-06-23T11:06:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T15:49:54.000Z (almost 2 years ago)
- Last Synced: 2026-04-26T17:33:53.786Z (about 2 months ago)
- Topics: auth, authentication, dart, flutter, otp, totp
- Language: Dart
- Homepage: https://pub.dev/packages/auth_totp
- Size: 621 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A fast and easy-to-use time-based one-time password (TOTP) authentication package for your Flutter application. It is compatible with `Google Authenticator`, `1Password`, `LastPass`, `Microsoft Authenticator` and various other authenticator apps.
## Get Started
- [🔑 Create Secret Key](#create-secret-key)
- [✔️ Verify TOTP Code](#verify-totp-code)
- [🚀 Generate TOTP Code](#generate-totp-code)
- [📸 Get QR Code to Scan](#get-qr-code-to-scan)
- [🔐 Tested Authenticator Apps](#tested-authenticator-services)
- [🔐 Full Example](#full-example)
- [🐛 Report bugs or issues](#report-bugs-or-issues)
## Create Secret Key
🔑 This method generates a random secret key, which is used to create verify codes from authentication apps.
```dart
String secret = AuthTOTP.createSecret(
length: 16,
autoPadding: true,
secretKeyStyle: SecretKeyStyle.upperLowerCase
);
//output : xHu6 nh7I D8uI s9B1
```
- `length` : The length of the secret to generate. Must be between 16 and 255, Default is 32.
- `autoPadding` : If true, it will create a secret with a letter by 4 sections, Default is false.
- `secretKeyStyle` : SecretKeyStyle is used to set the case of the secret key. Default is upperCase.
- enum `SecretKeyStyle`
- `upperCase` : Secret key will be upper case
- `lowerCase` : Secret key will be lower case
- `upperLowerCase` : Secret key will be upper and lower both case
This method accepts a single parameter to specify the length of the secret key. By default, it generates a 32-character secret key. The length limit is between `16` to `255` characters.
## Verify TOTP Code
✔️ This method verifies a Time-based One-Time Password (TOTP) code using the secret key and the TOTP code generated by your `authenticator app`.
Use this method after the user has scanned a QR code or entered the secret key into the authentication app. The same secret key generated by `createSecret` and the TOTP code generated by the `authenticator app` should be passed here to verify.
```dart
bool checkOTP = AuthTOTP.verifyCode({
secretKey: "secret_key_here",
totpCode: "totp_code_here_by_user",
interval: 30
});
```
- `secretKey`: A secret key generate by createSecret method
- `totpCode`: The TOTP code entered by the user.
- `interval`: Time interval in seconds, default is 30
It will return true if code is correct, otherwise false.
## Generate TOTP Code
🚀 This method generates a TOTP code based on the secret key and the time interval. The time interval is specified in seconds.
```dart
String generatedTOTPCode = AuthTOTP.generateTOTPCode(
secretKey: 'secret_key_here',
interval: 30
);
```
- `secretKey`: A secret key generate by createSecret method
- `interval`: Time interval in seconds, ex. 30
As well as you can use this method to verify TOTP code also.
#### Example Code:-
```dart
String generatedTOTPCode = AuthTOTP.generateTOTPCode(
secretKey: 'secret_key_here',
interval: 30
);
String inputedOTP = "otp_inputed_by_user";
if(generatedTOTPCode === inputedOTP){
print("Verified")
} else {
print("Not Verified")
}
```
## Get QR Code to Scan
📸 This method returns a QR code URL to scan with your authenticator app. It can be used in `Image.Network()`
```dart
String qrCodeUrl = AuthTOTP.getQRCodeUrl({
appName: "your app name"
secretKey: "secret_key_here",
issuer:"auth_totp"
});
//Image.Network(qrCodeUrl);
```
- `appName`: App name, or any text
- `secretKey`: A secret key generate by `createSecret` method
- `issuer`: Issuer name, default is `auth_totp`
## Tested Authenticator Services
🔐
|Logo | Service Name | Status |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------ |
| 
| Google Authenticator | ✅ |
| 
| 1Password | ✅ |
| 
| LastPass | ✅ |
| 
| Microsoft Authenticator | ✅ |
Absolutely, it works with all authenticator apps. But feel free to contribute if you have tested it with any other authenticator app.
## Full Example
👉 For a complete example, refer to the [Auth TOTP package documentation](https://pub.dev/packages/auth_totp/example).
## Report bugs or issues
🐛 You are welcome to open a _[ticket](https://github.com/rohit-chouhan/auth_totp/issues)_ on github if any 🐞 problems arise. New ideas are always welcome.
> Copyright © 2024 **[Rohit Chouhan](https://rohitchouhan.com)**. Licensed under the _[MIT LICENSE](https://github.com/rohit-chouhan/auth_totp/blob/main/LICENSE)_