https://github.com/lamnhan066/passcode_biometric_auth
A Flutter plugin is used to control passcode and biometric easily
https://github.com/lamnhan066/passcode_biometric_auth
Last synced: 5 months ago
JSON representation
A Flutter plugin is used to control passcode and biometric easily
- Host: GitHub
- URL: https://github.com/lamnhan066/passcode_biometric_auth
- Owner: lamnhan066
- License: mit
- Created: 2024-03-20T05:43:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-27T14:49:08.000Z (7 months ago)
- Last Synced: 2024-12-27T15:30:46.642Z (7 months ago)
- Language: Dart
- Size: 102 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Passcode Biometric Auth
A Flutter package that combines both passcode and biometric authentications effectively.
## Passcode Demo
[https://pub.lamnhan.dev/passcode-biometric-auth/](https://pub.lamnhan.dev/passcode-biometric-auth/)
## Usage
```dart
class App extends StatefulWidget {
const App({super.key});
@override
State createState() => _AppState();
}
class _AppState extends State {
final auth = PasscodeBiometricAuthUICached(
forceCreatePasscode: true,
title: 'Passcode',
checkConfig: const CheckConfig(
maxRetries: 5,
retryInSecond: 30,
content: 'Input Passcode',
incorrectText:
'This passcode is incorrect (max: @{counter}/@{maxRetries} times)\n'
'You have to wait for @{retryInSecond}s to try again when the max number of retries is exceeded',
forgotButtonText: 'Forgot your passcode?',
useBiometricCheckboxText: 'Use biometric authentication',
maxRetriesExceededText:
'Maximum number of retries is exceeded\nPlease try again in @{second}s',
biometricReason: 'Please authenticate to use this feature',
),
createConfig: const CreateConfig(
content: 'Create Passcode',
subcontent: 'Please remember your passcode. '
'When you forget your passcode, you can reset it but '
'all your cards will be removed from your local storage '
'and your Google account will be signed out.',
),
onForgotPasscode: (context, authUI) async {
if (await _forgotPasscode(context)) {
return true;
}
return false;
},
);
static Future _forgotPasscode(BuildContext context) async {
final result = await showDialog(
context: context,
builder: (ctx) {
return AlertDialog(
title: const Text('Forget Passcode'),
content: const Text(
'All of your local data will be removed when reset the passcode. Would you like to continue?',
textAlign: TextAlign.justify,
),
actions: [
OutlinedButton(
child: const Text('No'),
onPressed: () {
Navigator.pop(ctx, false);
},
),
ElevatedButton(
child: const Text('Yes'),
onPressed: () {
Navigator.pop(ctx, true);
},
),
],
);
});
return result == true;
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: const Text('Passcode Biometric Auth'),
),
body: Center(
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
ElevatedButton(
onPressed: () {
auth.authenticate(context);
},
child: const Text('Authenticate'),
),
const SizedBox(height: 20),
ElevatedButton(
onPressed: () {
auth.changePasscode(context);
},
child: const Text('Change Passcode'),
),
],
),
),
);
}
}
```
Basic methods:
```dart
// Basic authentication
authUI.authenticate(context);
// Change the passcode
authUI.changePasscode(context);
```
Beside that, there're classes that you can use to create your own custom UI:
```dart
/// Base biometric auth
class PasscodeBiometricAuth {
/// Check whether biometric authentication is available on the current device.
Future isBiometricAvailable();
/// `true`: authenticated
/// `false`: not authenticated or not available
Future isBiometricAuthenticated({
String biometricReason = 'Please authenticate to use this feature',
});
/// Check whether the passcode `code` is correct.
bool isPasscodeAuthenticated(String code);
/// Check if there is a passcode.
bool isAvailablePasscode();
}
```
```dart
/// Base UI
class PasscodeBiometricAuthUI {
/// This method will automatically handles both passcode and biometric authentications.
///
/// If the `forceCreatePasscode` is set to `true`, the app requests to create a passcode if it's
/// unavailable. If `false`, the app only requests to create a passcode if
/// the biometric authentication is unavailable in the device. Default is set to
/// the global config.
///
/// If the `isUseBiometric` is set to `true`, the app will try to use biometric
/// authentication if available. Default is set to the global config.
Future authenticate(
BuildContext context, {
bool? forceCreatePasscode,
bool? isUseBiometric,
});
/// Check whether biometric authentication is available on the current device.
Future isBiometricAvailable();
/// Manually authenticate via biometric authentication.
Future authenticateWithBiometric();
/// Manually authenticate via passcode authentication.
Future authenticateWithPasscode(BuildContext context);
/// Change the passcode.
Future changePasscode(BuildContext context);
/// Check whether the passcode `code` is correct.
Future isPasscodeAuthenticated(String code);
/// Set the `isUseBiometric` value.
Future useBiometric(bool isUse);
/// Remove the current passcode.
Future removePasscode();
/// Check whether the passcode is available.
FutureOr isAvailablePasscode();
}
```
And the `PasscodeBiometricAuthUICached` is just a `PasscodeBiometricAuthUI` with built-in `onRead` and `onWrite` using `SharedPreferences`. If you want to use a more secure way to cache the data then you need to use the `PasscodeBiometricAuthUI`.