# react-native-biometric-id > React Native authentication with the native Touch ID popup. Latest version **1.0.6** (published 2021-08-24) · MIT license · 0 weekly downloads ## Install ```sh npm install react-native-biometric-id pnpm add react-native-biometric-id yarn add react-native-biometric-id bun add react-native-biometric-id ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.6 | | Published | 2021-08-24 | | First published | 2021-08-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 582.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Shehan Guruge | | Maintainers | shehang | | Keywords | react-native, react, native, touch-id, react-component, react-native-component, authentication, auth, authenticate, mobile | ## Links - npm: https://www.npmjs.com/package/react-native-biometric-id - Repository: https://github.com/shehanGuruge/react-native-biometric-id - Issues: https://github.com/shehanGuruge/react-native-biometric-id/issues - npm.io page: https://npm.io/package/react-native-biometric-id ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads - [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads ## Recent versions - 1.0.6 (latest) — 2021-08-24 - 1.0.5 — 2021-08-19 - 1.0.4 — 2021-08-16 - 1.0.3 — 2021-08-16 - 1.0.2 — 2021-08-16 - 1.0.1 — 2021-08-16 ## README # React Native Biometric ID (react-native-biometric-id) [![react-native version](https://img.shields.io/badge/react--native-0.57-green.svg?style=flat-square)](https://github.com/facebook/react-native/releases) [![npm version](https://img.shields.io/npm/v/react-native-touch-id.svg?style=flat-square)](https://www.npmjs.com/package/react-native-touch-id) [![npm downloads](https://img.shields.io/npm/dm/react-native-touch-id.svg?style=flat-square)](https://www.npmjs.com/package/react-native-touch-id) [![Code Climate](https://img.shields.io/codeclimate/github/naoufal/react-native-touch-id.svg?style=flat-square)](https://codeclimate.com/github/naoufal/react-native-touch-id) React Native Biometric ID is a [React Native](http://facebook.github.io/react-native/) library for authenticating users with biometric authentication methods like Face ID and Touch ID on both iOS and Android (experimental). Note: the awesome folks over at [Expo](https://expo.io) have begun open-sourcing some of their modules for compatability with React Native projects not built with Expo. As such you can attempt to use their equivalent library called [LocalAuthentication](https://docs.expo.io/versions/v30.0.0/sdk/local-authentication) at [expo-local-authentication](https://www.npmjs.com/package/expo-local-authentication) if you run into any issues here! ## Documentation - [Install](https://github.com/shehanGuruge/react-native-biometric-id#install) - [Usage](https://github.com/shehanGuruge/react-native-biometric-id#usage) - [Example](https://github.com/shehanGuruge/react-native-biometric-id#example) - [Fallback](https://github.com/shehanGuruge/react-native-biometric-id#fallback) - [Methods](https://github.com/shehanGuruge/react-native-biometric-id#methods) - [Errors](https://github.com/shehanGuruge/react-native-biometric-id#errors) ## Install ```shell npm i --save react-native-biometric-id ``` or ```shell yarn add react-native-biometric-id ``` ## Support Due to the rapid changes being made in the React Native ecosystem, we are not officially going to support this module on anything but the latest version of React Native. The current supported version is indicated on the React Native badge at the top of this README. If it's out of date, we encourage you to submit a pull request! ## Usage ### Linking the Library In order to use Biometric Authentication, you must first link the library to your project. #### Using react-native link Use the built-in command: ```shell react-native link react-native-biometric-id ``` #### Using Cocoapods (iOS only) On iOS you can also link package by updating your podfile ```ruby pod 'TouchID', :path => "#{node_modules_path}/react-native-biometric-id" ``` and then run ```shell pod install ``` #### Using native linking There's excellent documentation on how to do this in the [React Native Docs](http://facebook.github.io/react-native/docs/linking-libraries-ios.html#content). ### Platform Differences iOS and Android differ slightly in their TouchID authentication. On Android you can customize the title and color of the pop-up by passing in the **optional config object** with a color and title key to the `authenticate` method. Further, you can disable the alert in android and implement your own UI in react-native. (Please note: For in display fingerprint embedded devices the native fingerprint sensor will popup on top of your customized UI).Even if you pass in the config object, iOS **does not** allow you change the color nor the title of the pop-up. iOS does support `passcodeFallback` as an option, which when set to `true` will allow users to use their device pin - useful for people with Face / Touch ID disabled. Passcode fallback only happens if the device does not have touch id or face id enabled. Error handling is also different between the platforms, with iOS currently providing much more descriptive error codes. ### App Permissions Add the following permissions to their respective files: In your `AndroidManifest.xml`: ```xml ``` In your `Info.plist`: ```xml NSFaceIDUsageDescription Enabling Face ID allows you quick and secure access to your account. ``` ### Requesting Face ID/Touch ID Authentication Once you've linked the library, you'll want to make it available to your app by requiring it: ```js var BiometricAuthenticator = require('react-native-biometric-id'); ``` or ```js import BiometricAuthenticator from 'react-native-biometric-id'; ``` Requesting Face ID/Touch ID Authentication is as simple as calling: ```js BiometricAuthenticator.authenticate('to demo this react-native component', optionalConfigObject) .then(success => { // Success code }) .catch(error => { // Failure code }); ``` ## Example Using Face ID/Touch ID in your app will usually look like this: ```js import React from "react" var BiometricAuthenticator = require('react-native-biometric-id'); //or import BiometricAuthenticator from 'react-native-biometric-id' class YourComponent extends React.Component { _pressHandler() { BiometricAuthenticator.authenticate('to demo this react-native component', optionalConfigObject) .then(success => { AlertIOS.alert('Authenticated Successfully'); }) .catch(error => { AlertIOS.alert('Authentication Failed'); }); }, render() { return ( ... Authenticate with Touch ID ); } }; ``` ## Methods ### authenticate(reason, config) Attempts to authenticate with Face ID/Touch ID. Returns a `Promise` object. **Arguments** - `reason` - **optional** - `String` that provides a clear reason for requesting authentication. - `config` - **optional** - configuration object for more detailed dialog setup: - `title` - **Android** - title of confirmation dialog - `imageColor` - **Android** - color of fingerprint image - `imageErrorColor` - **Android** - color of fingerprint image after failed attempt - `sensorDescription` - **Android** - text shown next to the fingerprint image - `sensorErrorDescription` - **Android** - text shown next to the fingerprint image after failed attempt - `cancelText` - **Android** - cancel button text - `fallbackLabel` - **iOS** - by default specified 'Show Password' label. If set to empty string label is invisible. - `unifiedErrors` - return unified error messages (see below) (default = false) - `showAlert` - **Android** - hide the native alert - `passcodeFallback` - **iOS** - by default set to false. If set to true, will allow use of keypad passcode. **Examples** ```js const optionalConfigObject = { title: 'Authentication Required', // Android imageColor: '#e00606', // Android imageErrorColor: '#ff0000', // Android sensorDescription: 'Touch sensor', // Android sensorErrorDescription: 'Failed', // Android cancelText: 'Cancel', // Android fallbackLabel: 'Show Passcode', // iOS (if empty, then label is hidden) unifiedErrors: false, // use unified error messages (default false), showAlert: false, // Android - default set to true passcodeFallback: false, // iOS - allows the device to fall back to using the passcode, if faceid/touch is not available. this does not mean that if touchid/faceid fails the first few times it will revert to passcode, rather that if the former are not enrolled, then it will use the passcode. }; BiometricAuthenticator.authenticate('to demo this react-native component', optionalConfigObject) .then(success => { AlertIOS.alert('Authenticated Successfully'); }) .catch(error => { AlertIOS.alert('Authentication Failed'); }); ``` ### isSupported() Returns a `Promise` that rejects if TouchID is not supported. On iOS resolves with a `biometryType` `String` of `FaceID` or `TouchID`. **Examples** ```js const optionalConfigObject = { unifiedErrors: false // use unified error messages (default false) passcodeFallback: false // if true is passed, itwill allow isSupported to return an error if the device is not enrolled in touch id/face id etc. Otherwise, it will just tell you what method is supported, even if the user is not enrolled. (default false) } BiometricAuthenticator.isSupported(optionalConfigObject) .then(biometryType => { // Success code if (biometryType === 'FaceID') { console.log('FaceID is supported.'); } else { console.log('TouchID is supported.'); } }) .catch(error => { // Failure code console.log(error); }); ``` ### cancelAuthentication() This method supports for both **Android** and **IOS** and you do not need to perform a platform check prior calling this method. This method will cancel the authentication if the authentication is in progress such that you can execute your RN tasks. (This method is now available on IOS. Please ensure you are using the latest version of this package) **Examples** ```js handleOnCancelPressed = () => { BiometricAuthenticator.cancelAuthentication(); } ``` ## Errors There are various reasons why biomentric authentication may not be available or fail. `TouchID.isSupported` and `TouchID.authenticate` will return an error representing the reason. #### iOS Errors Format: ``` { name: "TheErrorCode", message: "the error message", details: { name: "TheErrorCode", message: "the error message" } } ``` | name | message | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `LAErrorAuthenticationFailed` | Authentication was not successful because the user failed to provide valid credentials. | | `LAErrorUserCancel` | Authentication was canceled by the user—for example, the user tapped Cancel in the dialog. | | `LAErrorUserFallback` | Authentication was canceled because the user tapped the fallback button (Enter Password). | | `LAErrorSystemCancel` | Authentication was canceled by system—for example, if another application came to foreground while the authentication dialog was up. | | `LAErrorPasscodeNotSet` | Authentication could not start because the passcode is not set on the device. | | `LAErrorTouchIDNotAvailable` | Authentication could not start because Touch ID is not available on the device | | `LAErrorTouchIDNotEnrolled` | Authentication could not start because Touch ID has no enrolled fingers. | | `RCTTouchIDUnknownError` | Could not authenticate for an unknown reason. | | `RCTTouchIDNotSupported` | Device does not support Touch ID. | _More information on errors can be found in [Apple's Documentation](https://developer.apple.com/library/prerelease/ios/documentation/LocalAuthentication/Reference/LAContext_Class/index.html#//apple_ref/c/tdef/LAError)._ #### Android errors Format: ``` { name: "Touch ID Error", message: "Touch ID Error", details: "the error message", code: "THE_ERROR_CODE" } ``` isSupported: | name | message | details | code | | ---------------- | ---------------- | -------------- | --------------- | | `Touch ID Error` | `Touch ID Error` | Not supported. | `NOT_SUPPORTED` | | `Touch ID Error` | `Touch ID Error` | Not supported. | `NOT_AVAILABLE` | | `Touch ID Error` | `Touch ID Error` | Not supported. | `NOT_PRESENT` | | `Touch ID Error` | `Touch ID Error` | Not supported. | `NOT_ENROLLED` | authenticate: | name | message | details | code | | ---------------- | ---------------- | ----------------------------------------------- | -------------------------------------- | | `Touch ID Error` | `Touch ID Error` | Not supported | `NOT_SUPPORTED` | | `Touch ID Error` | `Touch ID Error` | Not supported | `NOT_AVAILABLE` | | `Touch ID Error` | `Touch ID Error` | Not supported | `NOT_PRESENT` | | `Touch ID Error` | `Touch ID Error` | Not supported | `NOT_ENROLLED` | | `Touch ID Error` | `Touch ID Error` | failed | `AUTHENTICATION_FAILED` | | `Touch ID Error` | `Touch ID Error` | cancelled | `AUTHENTICATION_CANCELED` | | `Touch ID Error` | `Touch ID Error` | Too many attempts. Try again Later. | `FINGERPRINT_ERROR_LOCKOUT` | | `Touch ID Error` | `Touch ID Error` | Too many attempts. Fingerprint sensor disabled. | `FINGERPRINT_ERROR_LOCKOUT_PERMANENT` | | `Touch ID Error` | `Touch ID Error` | ? | `FINGERPRINT_ERROR_UNABLE_TO_PROCESS`, | | `Touch ID Error` | `Touch ID Error` | ? | `FINGERPRINT_ERROR_TIMEOUT`, | | `Touch ID Error` | `Touch ID Error` | ? | `FINGERPRINT_ERROR_CANCELED`, | | `Touch ID Error` | `Touch ID Error` | ? | `FINGERPRINT_ERROR_VENDOR`, | #### Unified errors Format: ``` { name: "TouchIDError", message: "the error message", code: "THE_ERROR_CODE" } ``` | name | message | code | | -------------- | ----------------------------------- | ----------------------- | | `TouchIDError` | Authentication failed | `AUTHENTICATION_FAILED` | | `TouchIDError` | User canceled authentication | `USER_CANCELED` | | `TouchIDError` | System canceled authentication | `SYSTEM_CANCELED` | | `TouchIDError` | Biometry hardware not present | `NOT_PRESENT` | | `TouchIDError` | Biometry is not supported | `NOT_SUPPORTED` | | `TouchIDError` | Biometry is not currently available | `NOT_AVAILABLE` | | `TouchIDError` | Biometry is not enrolled | `NOT_ENROLLED` | | `TouchIDError` | Biometry timeout | `TIMEOUT` | | `TouchIDError` | Biometry lockout | `LOCKOUT` | | `TouchIDError` | Biometry permanent lockout | `LOCKOUT_PERMANENT` | | `TouchIDError` | Biometry processing error | `PROCESSING_ERROR` | | `TouchIDError` | User selected fallback | `USER_FALLBACK` | | `TouchIDError` | User selected fallback not enrolled | `FALLBACK_NOT_ENROLLED` | | `TouchIDError` | Unknown error | `UNKNOWN_ERROR` | Copyright (c) 2021, [Shehan Guruge] --- _Source: https://npm.io/package/react-native-biometric-id · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._