@exodus/react-native-biometrics 0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Exodus Movement, Inc
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# @exodus/react-native-biometrics
+
+A biometric authentication library for Android platform using the BiometricPrompt API.
+
+## Installation
+
+```sh
+npm install @exodus/react-native-biometrics
+```
+
+## Usage
+
+
+```js
+import Biometrics from '@exodus/react-native-biometrics';
+
+// ...
+
+const valid = await Biometrics.authenticate(
+  'Authenticate to continue',
+  'Use your fingerprint to authenticate',
+  'Cancel',
+);
+```
+
+## Props
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| title | string | The title of the biometric prompt |
+| subtitle | string | The subtitle of the biometric prompt |
+| cancelButtonText | string | The text of the cancel button |
+
+
+## License
+
+MIT
+
+---
+
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/android/build.gradle

@@ -0,0 +1,34 @@
+buildscript {
+    ext.safeExtGet = {prop, fallback ->
+        rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+    }
+}
+
+apply plugin: 'com.android.library'
+
+// Matches values in recent template from React Native (0.59)
+// https://github.com/facebook/react-native/blob/0.59-stable/template/android/build.gradle#L5-L9
+def DEFAULT_COMPILE_SDK_VERSION = 28
+def DEFAULT_BUILD_TOOLS_VERSION = "28.0.3"
+def DEFAULT_MIN_SDK_VERSION = 16
+def DEFAULT_TARGET_SDK_VERSION = 28
+
+android {
+  compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+  buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
+
+  defaultConfig {
+    minSdkVersion safeExtGet('minSdkVersion', DEFAULT_MIN_SDK_VERSION)
+    targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
+    versionCode 1
+    versionName "1.0"
+  }
+  lintOptions {
+    abortOnError false
+  }
+}
+
+dependencies {
+    implementation "com.facebook.react:react-native:${safeExtGet('reactnativeVersion', '+')}"
+    implementation "androidx.biometric:biometric:1.1.0"
+}

package/android/gradle.properties

@@ -0,0 +1,4 @@
+ReactNativeBiometrics_minSdkVersion=21
+ReactNativeBiometrics_targetSdkVersion=31
+ReactNativeBiometrics_compileSdkVersion=31
+ReactNativeBiometrics_ndkversion=21.4.7075529

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="org.exodusmovement.rn.biometrics">
+</manifest>

package/android/src/main/AndroidManifestNew.xml

@@ -0,0 +1,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/org/exodusmovement/rn/biometrics/RNBiometricsModule.java

@@ -0,0 +1,68 @@
+package org.exodusmovement.rn.biometrics;
+
+import java.util.concurrent.Executor;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.module.annotations.ReactModule;
+
+import androidx.biometric.BiometricPrompt;
+import androidx.biometric.BiometricManager;
+import androidx.core.content.ContextCompat;
+import androidx.fragment.app.FragmentActivity;
+
+@ReactModule(name = RNBiometricsModule.NAME)
+public final class RNBiometricsModule extends ReactContextBaseJavaModule {
+    public static final String NAME = "Biometrics";
+
+    private final ReactApplicationContext context;
+
+    public RNBiometricsModule(ReactApplicationContext context) {
+        super(context);
+        this.context = context;
+    }
+
+    @Override
+    public String getName() {
+        return NAME;
+    }
+
+    @ReactMethod
+    public void authenticate(String title, String subtitle, String cancelButtonText, Promise promise) {
+        context.getCurrentActivity().runOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    new BiometricPrompt(
+                        (FragmentActivity) context.getCurrentActivity(),
+                        ContextCompat.getMainExecutor(context),
+                        new BiometricPrompt.AuthenticationCallback() {
+                            @Override
+                            public void onAuthenticationError(int errorCode, CharSequence errString) {
+                                super.onAuthenticationError(errorCode, errString);
+                                promise.resolve(false);
+                            }
+
+                            @Override
+                            public void onAuthenticationSucceeded(BiometricPrompt.AuthenticationResult result) {
+                                super.onAuthenticationSucceeded(result);
+                                promise.resolve(true);
+                            }
+                        }
+                    ).authenticate(
+                        new BiometricPrompt.PromptInfo.Builder()
+                        .setAllowedAuthenticators(BiometricManager.Authenticators.BIOMETRIC_STRONG)
+                        .setTitle(title)
+                        .setSubtitle(subtitle)
+                        .setNegativeButtonText(cancelButtonText)
+                        .build()
+                    );
+
+                } catch (Exception e) {
+                    promise.reject(e);
+                }
+            }
+        });
+    }
+}

package/android/src/main/java/org/exodusmovement/rn/biometrics/RNBiometricsPackage.java

@@ -0,0 +1,23 @@
+package org.exodusmovement.rn.biometrics;
+
+import com.facebook.react.ReactPackage;
+import com.facebook.react.bridge.NativeModule;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.uimanager.ViewManager;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+public class RNBiometricsPackage implements ReactPackage {
+    @Override
+    public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
+        return Arrays.<NativeModule>asList(new RNBiometricsModule(reactContext));
+    }
+
+    @Override
+    @SuppressWarnings("rawtypes")
+    public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
+        return Collections.emptyList();
+    }
+}

package/index.js

@@ -0,0 +1,3 @@
+import Biometrics from './src/Biometrics';
+
+export default Biometrics;

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@exodus/react-native-biometrics",
+  "version": "0.1.0",
+  "description": "React Native Biometrics",
+  "main": "index.js",
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "index.js",
+    "*.podspec",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/.gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint ./"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/react-native-biometrics.git"
+  },
+  "author": "Exodus Movement, Inc (https://github.com/ExodusMovement)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/react-native-biometrics/issues"
+  },
+  "homepage": "https://github.com/ExodusMovement/react-native-biometrics#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-native": ">=0.57.0"
+  },
+  "react-native": {
+    "_stream_transform": "readable-stream/transform",
+    "_stream_readable": "readable-stream/readable",
+    "_stream_writable": "readable-stream/writable",
+    "_stream_duplex": "readable-stream/duplex",
+    "_stream_passthrough": "readable-stream/passthrough",
+    "stream": "stream-browserify"
+  },
+  "browser": {
+    "_stream_duplex": "readable-stream/duplex",
+    "_stream_passthrough": "readable-stream/passthrough",
+    "_stream_readable": "readable-stream/readable",
+    "_stream_transform": "readable-stream/transform",
+    "_stream_writable": "readable-stream/writable",
+    "stream": "stream-browserify"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.13.0",
+    "eslint": "^9.13.0",
+    "eslint-plugin-react": "^7.37.2",
+    "globals": "^15.11.0"
+  }
+}

package/src/Biometrics.android.js

@@ -0,0 +1,9 @@
+import { NativeModules } from 'react-native';
+
+const AndroidBiometrics = NativeModules.Biometrics;
+
+export default {
+  authenticate: async (title, subtitle, description) => {
+    return AndroidBiometrics.authenticate(title, subtitle, description);
+  }
+}

package/src/Biometrics.ios.js

@@ -0,0 +1,5 @@
+export default {
+  authenticate: async () => {
+    return Promise.reject('Biometrics is not supported on this platform');
+  }
+}