React Native Simple Biometrics
A simple and straight forward API to ask a user to authenticate with on device biometrics. This can be used to quickly verify if the app is being used by the owner of the phone (or a trustee) before showing some sensitive info.
Getting started
$ yarn add react-native-simple-biometrics
minimum versions
- iOS target:
8.0 - Android minSdkVersion:
21
iOS permission
It is required to add an entry in your ios app's info.plist giving a valid reason to use the phones face ID system.
<key>NSFaceIDUsageDescription</key>
<string>a valid reason to use biometrics</string>
Calling the authenticate function will automatically ask iOS users for the permission. For more control over when to ask permissions, use react-native-permissions
Usage
Only 2 methods are exposed
canAuthenticate()requestBioAuth(promptTitle: string, promptMessage: string)
import RNBiometrics from "react-native-simple-biometrics";
// this will be false if
// - no biometrics hardware
// - permission was denied for face ID (iOS only)
const can = await RNBiometrics.canAuthenticate();
if (can) {
try {
await RNBiometrics.requestBioAuth("prompt-title", "prompt-message");
// stuff to do when authenticated
// ...
} catch (error) {
// stuff to do when auth failed
// ...
}
}
credits
react-native-biometrics is a super-set of this library. For more features like keys generation, signatures, etc use react-native-biometrics.
4 Dec 6, 2022
246 Jan 5, 2023
3 Mar 9, 2022
43 Dec 10, 2022
2 Feb 4, 2022
2 May 11, 2022
1 Jan 25, 2022
2.8k Jan 3, 2023
54 Dec 24, 2022
2 Apr 30, 2022
6 Nov 21, 2022
1k Jan 5, 2023
2.5k Dec 30, 2022
307 Dec 26, 2022
2 Jan 2, 2022
15 Jan 19, 2022
1 Jan 17, 2022