BiometricX
The easy way to use biometric authentication in your Flutter app.
Supports Fingerprint, FaceID and Iris.
Starting
$ flutter pub add biometricx
Configuration
Change your android MainActivity to extends FlutterFragmentActivity.
import io.flutter.embedding.android.FlutterFragmentActivity
// kotlin
class MainActivity: FlutterFragmentActivity() {
...
}
import io.flutter.embedding.android.FlutterFragmentActivity;
// java
class MainActivity extends FlutterFragmentActivity {
...
}
Usage
To check biometric type of your device.
BiometricType type = await BiometricX.type;
Here is the list of biometric types.
BiometricType.FACE
BiometricType.FINGERPRINT
BiometricType.IRIS
BiometricType.MULTIPLE
BiometricType.NONE
BiometricType.NO_HARDWARE
BiometricType.UNAVAILABLE
BiometricType.UNSUPPORTED
To check if your device can use biometric authentication.
bool isBiometricEnabled = await BiometricX.isEnabled;
To encrypt data using biometric authentication.
BiometricResult result = await BiometricX.encrypt({
biometricKey: 'salkuadrat',
message: 'This is a very secret message',
});
if (result.isSuccess && result.hasData) {
// Keep this messageKey to decrypt your message.
// This messageKey will be randomly generated by BiometricX plugin.
String messageKey = result.data!;
} else {
showToast(result.errorMsg, context: context);
}
If you need a persistent messageKey, you can supply it as parameter to encrypt.
BiometricResult result = await BiometricX.encrypt({
biometricKey: 'salkuadrat',
messageKey: 'secret_message', // use persistent messageKey
message: 'This is a very secret message',
});
if (result.isSuccess && result.hasData) {
// Keep this messageKey to decrypt your message.
// This will be the same value as messageKey above ('secret_message')
String messageKey = result.data!;
} else {
showToast(result.errorMsg, context: context);
}
To decrypt data using biometric authentication.
// Use the same biometricKey that is used to encrypt your message.
// Use messageKey that you get from [BiometricX.encrypt].
BiometricResult result = await BiometricX.decrypt({
biometricKey: 'salkuadrat',
messageKey: messageKey,
});
if (result.isSuccess && result.hasData) {
// This will contains your original message.
String message = result.data!;
} else {
showToast(result.errorMsg, context: context);
}
To show custom message in your biometric prompt, method encrypt and decrypt have parameters you can use to change the biometric prompt dialog.
BiometricResult result = await BiometricX.encrypt({
biometricKey: 'salkuadrat',
message: 'This is a very secret message',
title: 'Biometric Encryption',
subtitle: 'Enter biometric credentials to encrypt your message',
description: 'Scan fingerprint or face.',
negativeButtonText: 'USE PASSWORD',
confirmationRequired: true,
});
BiometricResult message = await BiometricX.decrypt({
biometricKey: 'salkuadrat',
messageKey: messageKey,
title: 'Biometric Decryption',
subtitle: 'Enter biometric credentials to decrypt your message',
description: 'Scan fingerprint or face.',
negativeButtonText: 'USE PASSWORD',
confirmationRequired: true,
});
4 Oct 4, 2022
9 Nov 6, 2022
1 Mar 21, 2022
11 Nov 18, 2022
1 Oct 4, 2022
19 Feb 16, 2022
0 Nov 28, 2021
3 Jan 10, 2022
6 Nov 27, 2022
82 Dec 30, 2022
1 May 23, 2022
22 Jan 3, 2023
3 Jul 11, 2022
1k Dec 30, 2022
58 Dec 23, 2022
1.3k Jan 8, 2023
1 Dec 4, 2021
1k Jan 4, 2023
126 Jan 9, 2023