@capgo/capacitor-native-biometric 7.1.6 → 7.1.12

package/README.md

@@ -1,15 +1,15 @@
 # Capacitor Native Biometric 
  <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
-
+ 
 <div align="center">
-  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo 🚀</a></h2>
-  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Fix your annoying bug now, Hire a Capacitor expert 💪</a></h2>
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
 </div>
 
 
 Use biometrics confirm device owner presence or authenticate users. A couple of methods are provided to handle user credentials. These are securely stored using Keychain (iOS) and Keystore (Android).
 
-## Installation (Only supports Capacitor 6)
+## Installation (Only supports Capacitor 7)
 
 - `npm i @capgo/capacitor-native-biometric`
 

package/android/src/main/java/ee/forgr/biometric/AuthActivity.java

@@ -14,6 +14,7 @@ import java.util.concurrent.Executor;
 
 public class AuthActivity extends AppCompatActivity {
 
+  private BiometricPrompt biometricPrompt;
   private int maxAttempts;
   private int counter = 0;
 
@@ -76,7 +77,7 @@ public class AuthActivity extends AppCompatActivity {
 
     BiometricPrompt.PromptInfo promptInfo = builder.build();
 
-    BiometricPrompt biometricPrompt = new BiometricPrompt(
+    biometricPrompt = new BiometricPrompt(
       this,
       executor,
       new BiometricPrompt.AuthenticationCallback() {
@@ -86,9 +87,16 @@ public class AuthActivity extends AppCompatActivity {
           @NonNull CharSequence errString
         ) {
           super.onAuthenticationError(errorCode, errString);
-          int pluginErrorCode = AuthActivity.convertToPluginErrorCode(
-            errorCode
-          );
+          // Handle lockout cases explicitly
+          if (
+            errorCode == BiometricPrompt.ERROR_LOCKOUT ||
+            errorCode == BiometricPrompt.ERROR_LOCKOUT_PERMANENT
+          ) {
+            int pluginErrorCode = convertToPluginErrorCode(errorCode);
+            finishActivity("error", pluginErrorCode, errString.toString());
+            return;
+          }
+          int pluginErrorCode = convertToPluginErrorCode(errorCode);
           finishActivity("error", pluginErrorCode, errString.toString());
         }
 
@@ -104,11 +112,11 @@ public class AuthActivity extends AppCompatActivity {
         public void onAuthenticationFailed() {
           super.onAuthenticationFailed();
           counter++;
-          if (counter == maxAttempts) finishActivity(
-            "failed",
-            10,
-            "Authentication failed."
-          );
+          if (counter >= maxAttempts) {
+            biometricPrompt.cancelAuthentication();
+            // Use error code 4 for too many attempts to match iOS behavior
+            finishActivity("error", 4, "Too many failed attempts");
+          }
         }
       }
     );
@@ -146,11 +154,11 @@ public class AuthActivity extends AppCompatActivity {
       case BiometricPrompt.ERROR_HW_NOT_PRESENT:
         return 1;
       case BiometricPrompt.ERROR_LOCKOUT_PERMANENT:
-        return 2;
+        return 2; // Permanent lockout
       case BiometricPrompt.ERROR_NO_BIOMETRICS:
         return 3;
       case BiometricPrompt.ERROR_LOCKOUT:
-        return 4;
+        return 4; // Temporary lockout (too many attempts)
       // Authentication Failure (10) Handled by `onAuthenticationFailed`.
       // App Cancel (11), Invalid Context (12), and Not Interactive (13) are not valid error codes for Android.
       case BiometricPrompt.ERROR_NO_DEVICE_CREDENTIAL:
@@ -161,6 +169,8 @@ public class AuthActivity extends AppCompatActivity {
       case BiometricPrompt.ERROR_USER_CANCELED:
       case BiometricPrompt.ERROR_NEGATIVE_BUTTON:
         return 16;
+      case BiometricPrompt.AUTHENTICATION_RESULT_TYPE_BIOMETRIC:
+        return 0; // Success case, should not be handled here
       default:
         return 0;
     }

package/android/src/main/java/ee/forgr/biometric/NativeBiometric.java

@@ -468,9 +468,18 @@ public class NativeBiometric extends Plugin {
         )
           .setDigests(KeyProperties.DIGEST_SHA256, KeyProperties.DIGEST_SHA512)
           .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_RSA_PKCS1)
+          .setUserAuthenticationRequired(true)
+          // Set authentication validity duration to 0 to require authentication for every use
+          .setUserAuthenticationParameters(
+            0,
+            KeyProperties.AUTH_BIOMETRIC_STRONG
+          )
           .build()
       );
       keyPairGenerator.generateKeyPair();
+      // Get the newly generated key entry
+      privateKeyEntry = (KeyStore.PrivateKeyEntry) getKeyStore()
+        .getEntry(KEY_ALIAS, null);
     }
 
     return privateKeyEntry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-native-biometric",
-  "version": "7.1.6",
+  "version": "7.1.12",
   "description": "This plugin gives access to the native biometric apis for android and iOS",
   "main": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",