expo-local-authentication 13.3.0 → 13.4.1

package/CHANGELOG.md

@@ -10,7 +10,18 @@
 
 ### 💡 Others
 
-## 13.3.0 — 2023-04-10
+## 13.4.1 — 2023-06-13
+
+### 🐛 Bug fixes
+
+- [Android] Fixed device credentials fallback when biometric sensors are unavailable ([#22388](https://github.com/expo/expo/pull/22388) by [@hubastard](https://github.com/hubastard))
+- Fixed Android build warnings for Gradle version 8. ([#22537](https://github.com/expo/expo/pull/22537), [#22609](https://github.com/expo/expo/pull/22609) by [@kudo](https://github.com/kudo))
+
+## 13.4.0 — 2023-05-08
+
+_This version does not introduce any user-facing changes._
+
+## 13.3.0 - 2023-04-10
 
 ### 🐛 Bug fixes
 

package/README.md

@@ -16,7 +16,7 @@ Provides an API for FaceID and TouchID (iOS) or the Fingerprint API (Android) to
 
 # Installation in managed Expo projects
 
-For [managed](https://docs.expo.dev/versions/latest/introduction/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/local-authentication/).
+For [managed](https://docs.expo.dev/archive/managed-vs-bare/) Expo projects, please follow the installation instructions in the [API documentation for the latest stable release](https://docs.expo.dev/versions/latest/sdk/local-authentication/).
 
 # Installation in bare React Native projects
 
@@ -25,7 +25,7 @@ For bare React Native projects, you must ensure that you have [installed and con
 ### Add the package to your npm dependencies
 
 ```
-expo install expo-local-authentication
+npx expo install expo-local-authentication
 ```
 
 ### Configure for iOS

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '13.3.0'
+version = '13.4.1'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -35,19 +35,11 @@ buildscript {
   }
 }
 
-// Creating sources with comments
-task androidSourcesJar(type: Jar) {
-  classifier = 'sources'
-  from android.sourceSets.main.java.srcDirs
-}
-
 afterEvaluate {
   publishing {
     publications {
       release(MavenPublication) {
         from components.release
-        // Add additional sourcesJar to artifacts
-        artifact(androidSourcesJar)
       }
     }
     repositories {
@@ -70,15 +62,21 @@ android {
     jvmTarget = JavaVersion.VERSION_11.majorVersion
   }
 
+  namespace "expo.modules.localauthentication"
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 30
-    versionName "13.3.0"
+    versionName "13.4.1"
   }
   lintOptions {
     abortOnError false
   }
+  publishing {
+    singleVariant("release") {
+      withSourcesJar()
+    }
+  }
 }
 
 dependencies {

package/android/src/main/AndroidManifest.xml

@@ -1,4 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="expo.modules.localauthentication">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
     <uses-permission android:name="android.permission.USE_FINGERPRINT" />
     <uses-permission android:name="android.permission.USE_BIOMETRIC" />
 </manifest>

package/android/src/main/java/expo/modules/localauthentication/LocalAuthenticationModule.kt

@@ -30,10 +30,13 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
   private val SECURITY_LEVEL_NONE = 0
   private val SECURITY_LEVEL_SECRET = 1
   private val SECURITY_LEVEL_BIOMETRIC = 2
+  private val DEVICE_CREDENTIAL_FALLBACK_CODE = 6
   private val biometricManager = BiometricManager.from(context)
   private val packageManager = context.packageManager
   private var biometricPrompt: BiometricPrompt? = null
   private var promise: Promise? = null
+  private var authOptions: Map<String?, Any?>? = null
+  private var isRetryingWithDeviceCredentials = false
   private var isAuthenticating = false
   private val moduleRegistryDelegate: ModuleRegistryDelegate = ModuleRegistryDelegate()
   private val uIManager: UIManager by moduleRegistry()
@@ -52,9 +55,21 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
     }
   }
 
+  private fun isBiometricUnavailable(code: Int): Boolean {
+    return when (code) {
+      BiometricPrompt.ERROR_HW_NOT_PRESENT,
+      BiometricPrompt.ERROR_HW_UNAVAILABLE,
+      BiometricPrompt.ERROR_NO_BIOMETRICS,
+      BiometricPrompt.ERROR_UNABLE_TO_PROCESS,
+      BiometricPrompt.ERROR_NO_SPACE -> true
+      else -> false
+    }
+  }
+
   private val authenticationCallback: BiometricPrompt.AuthenticationCallback = object : BiometricPrompt.AuthenticationCallback() {
     override fun onAuthenticationSucceeded(result: BiometricPrompt.AuthenticationResult) {
       isAuthenticating = false
+      isRetryingWithDeviceCredentials = false
       biometricPrompt = null
       promise?.resolve(
         Bundle().apply {
@@ -62,10 +77,30 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
         }
       )
       promise = null
+      authOptions = null
     }
 
     override fun onAuthenticationError(errMsgId: Int, errString: CharSequence) {
+      // Make sure to fallback to the Device Credentials if the Biometrics hardware is unavailable.
+      if (isBiometricUnavailable(errMsgId) && isDeviceSecure && !isRetryingWithDeviceCredentials) {
+        val options = authOptions
+
+        if (options != null) {
+          val disableDeviceFallback = options["disableDeviceFallback"] as Boolean?
+
+          // Don't run the device credentials fallback if it's disabled.
+          if (disableDeviceFallback != true) {
+            promise?.let {
+              isRetryingWithDeviceCredentials = true
+              promptDeviceCredentialsFallback(options, it)
+              return
+            }
+          }
+        }
+      }
+
       isAuthenticating = false
+      isRetryingWithDeviceCredentials = false
       biometricPrompt = null
       promise?.resolve(
         Bundle().apply {
@@ -75,6 +110,7 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
         }
       )
       promise = null
+      authOptions = null
     }
   }
 
@@ -177,6 +213,8 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
       return
     }
 
+    this.authOptions = options
+
     // BiometricPrompt callbacks are invoked on the main thread so also run this there to avoid
     // having to do locking.
     uIManager.runOnUiQueueThread(
@@ -245,11 +283,85 @@ class LocalAuthenticationModule(context: Context) : ExportedModule(context), Act
     }
   }
 
+  fun promptDeviceCredentialsFallback(options: Map<String?, Any?>, promise: Promise) {
+    val fragmentActivity = currentActivity as FragmentActivity?
+    if (fragmentActivity == null) {
+      promise.resolve(
+        Bundle().apply {
+          putBoolean("success", false)
+          putString("error", "not_available")
+          putString("warning", "getCurrentActivity() returned null")
+        }
+      )
+      return
+    }
+
+    val promptMessage = options["promptMessage"] as? String ?: ""
+    val requireConfirmation = options["requireConfirmation"] as? Boolean ?: true
+
+    // BiometricPrompt callbacks are invoked on the main thread so also run this there to avoid
+    // having to do locking.
+    uIManager.runOnUiQueueThread(
+      Runnable {
+        // On Android devices older than 11, we need to use Keyguard to unlock by Device Credentials.
+        if (Build.VERSION.SDK_INT < 30) {
+          val credentialConfirmationIntent = keyguardManager.createConfirmDeviceCredentialIntent(promptMessage, "")
+          fragmentActivity.startActivityForResult(credentialConfirmationIntent, DEVICE_CREDENTIAL_FALLBACK_CODE)
+          return@Runnable
+        }
+
+        val executor: Executor = Executors.newSingleThreadExecutor()
+        val localBiometricPrompt = BiometricPrompt(fragmentActivity, executor, authenticationCallback)
+        if (localBiometricPrompt == null) {
+          promise.reject("E_INTERNAL_ERRROR", "Canceled authentication due to an internal error")
+          return@Runnable
+        }
+        biometricPrompt = localBiometricPrompt
+
+        val promptInfoBuilder = PromptInfo.Builder()
+        promptMessage?.let {
+          promptInfoBuilder.setTitle(it)
+        }
+        promptInfoBuilder.setAllowedAuthenticators(BiometricManager.Authenticators.DEVICE_CREDENTIAL)
+        promptInfoBuilder.setConfirmationRequired(requireConfirmation)
+        val promptInfo = promptInfoBuilder.build()
+        try {
+          localBiometricPrompt.authenticate(promptInfo)
+        } catch (ex: NullPointerException) {
+          promise.reject("E_INTERNAL_ERRROR", "Canceled authentication due to an internal error")
+        }
+      }
+    )
+  }
+
   override fun onActivityResult(activity: Activity, requestCode: Int, resultCode: Int, data: Intent?) {
-    // If the user uses PIN as an authentication method, the result will be passed to the `onActivityResult`.
-    // Unfortunately, react-native doesn't pass this value to the underlying fragment - we won't resolve the promise.
-    // So we need to do it manually.
-    if (activity is FragmentActivity) {
+    // When Biometric is unavailable and using Keyguard fallback, the result will be handled here.
+    if (requestCode == DEVICE_CREDENTIAL_FALLBACK_CODE) {
+      if (resultCode == Activity.RESULT_OK) {
+        promise?.resolve(
+          Bundle().apply {
+            putBoolean("success", true)
+          }
+        )
+      } else {
+        promise?.resolve(
+          Bundle().apply {
+            putBoolean("success", false)
+            putString("error", "user_cancel")
+            putString("warning", "Device Credentials canceled")
+          }
+        )
+      }
+
+      isAuthenticating = false
+      isRetryingWithDeviceCredentials = false
+      biometricPrompt = null
+      promise = null
+      authOptions = null
+    } else if (activity is FragmentActivity) {
+      // If the user uses PIN as an authentication method, the result will be passed to the `onActivityResult`.
+      // Unfortunately, react-native doesn't pass this value to the underlying fragment - we won't resolve the promise.
+      // So we need to do it manually.
       val fragment = activity.supportFragmentManager.findFragmentByTag("androidx.biometric.BiometricFragment")
       fragment?.onActivityResult(requestCode and 0xffff, resultCode, data)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-local-authentication",
-  "version": "13.3.0",
+  "version": "13.4.1",
   "description": "Provides an API for FaceID and TouchID (iOS) or the Fingerprint API (Android) to authenticate the user with a face or fingerprint scan.",
   "main": "build/LocalAuthentication.js",
   "types": "build/LocalAuthentication.d.ts",
@@ -46,5 +46,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "5613f862a64dfa5e046b9c4a336280e3ac6dd9df"
+  "gitHead": "3ccd2edee9cbfed217557675cb50f0ba5e55a9e4"
 }