@capgo/capacitor-native-biometric 7.1.13 → 7.1.15

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoCapacitorNativeBiometric",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapgoCapacitorNativeBiometric",
+            targets: ["CapgoNativeBiometricPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "CapgoNativeBiometricPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/CapgoNativeBiometricPlugin"),
+        .testTarget(
+            name: "CapgoNativeBiometricPluginTests",
+            dependencies: ["CapgoNativeBiometricPlugin"],
+            path: "ios/Tests/CapgoNativeBiometricPluginTests")
+    ]
+)

package/README.md

@@ -9,6 +9,10 @@
 
 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).
 
+## Documentation
+
+The most complete doc is available here: https://capgo.app/docs/plugins/native-biometric/
+
 ## Installation (Only supports Capacitor 7)
 
 - `npm i @capgo/capacitor-native-biometric`

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

@@ -14,185 +14,160 @@ import java.util.concurrent.Executor;
 
 public class AuthActivity extends AppCompatActivity {
 
-  private BiometricPrompt biometricPrompt;
-  private int maxAttempts;
-  private int counter = 0;
-
-  @Override
-  protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    setContentView(R.layout.activity_auth_acitivy);
-
-    maxAttempts = getIntent().getIntExtra("maxAttempts", 1);
-
-    Executor executor;
-    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
-      executor = this.getMainExecutor();
-    } else {
-      executor = new Executor() {
-        @Override
-        public void execute(Runnable command) {
-          new Handler().post(command);
+    private BiometricPrompt biometricPrompt;
+    private int maxAttempts;
+    private int counter = 0;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_auth_acitivy);
+
+        maxAttempts = getIntent().getIntExtra("maxAttempts", 1);
+
+        Executor executor;
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+            executor = this.getMainExecutor();
+        } else {
+            executor = new Executor() {
+                @Override
+                public void execute(Runnable command) {
+                    new Handler().post(command);
+                }
+            };
         }
-      };
-    }
-
-    BiometricPrompt.PromptInfo.Builder builder =
-      new BiometricPrompt.PromptInfo.Builder()
-        .setTitle(
-          getIntent().hasExtra("title")
-            ? Objects.requireNonNull(getIntent().getStringExtra("title"))
-            : "Authenticate"
-        )
-        .setSubtitle(
-          getIntent().hasExtra("subtitle")
-            ? getIntent().getStringExtra("subtitle")
-            : null
-        )
-        .setDescription(
-          getIntent().hasExtra("description")
-            ? getIntent().getStringExtra("description")
-            : null
-        );
 
-    boolean useFallback = getIntent().getBooleanExtra("useFallback", false);
-    int[] allowedTypes = getIntent().getIntArrayExtra("allowedBiometryTypes");
+        BiometricPrompt.PromptInfo.Builder builder = new BiometricPrompt.PromptInfo.Builder()
+            .setTitle(getIntent().hasExtra("title") ? Objects.requireNonNull(getIntent().getStringExtra("title")) : "Authenticate")
+            .setSubtitle(getIntent().hasExtra("subtitle") ? getIntent().getStringExtra("subtitle") : null)
+            .setDescription(getIntent().hasExtra("description") ? getIntent().getStringExtra("description") : null);
 
-    int authenticators = BiometricManager.Authenticators.BIOMETRIC_STRONG;
-    if (useFallback) {
-      authenticators |= BiometricManager.Authenticators.DEVICE_CREDENTIAL;
-    }
-    if (allowedTypes != null) {
-      // Filter authenticators based on allowed types
-      authenticators = getAllowedAuthenticators(allowedTypes);
-    }
-    builder.setAllowedAuthenticators(authenticators);
+        boolean useFallback = getIntent().getBooleanExtra("useFallback", false);
+        int[] allowedTypes = getIntent().getIntArrayExtra("allowedBiometryTypes");
 
-    if (!useFallback) {
-      String negativeText = getIntent().getStringExtra("negativeButtonText");
-      builder.setNegativeButtonText(
-        negativeText != null ? negativeText : "Cancel"
-      );
-    }
-
-    BiometricPrompt.PromptInfo promptInfo = builder.build();
-
-    biometricPrompt = new BiometricPrompt(
-      this,
-      executor,
-      new BiometricPrompt.AuthenticationCallback() {
-        @Override
-        public void onAuthenticationError(
-          int errorCode,
-          @NonNull CharSequence errString
-        ) {
-          super.onAuthenticationError(errorCode, errString);
-          // 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());
+        int authenticators = BiometricManager.Authenticators.BIOMETRIC_STRONG;
+        if (useFallback) {
+            authenticators |= BiometricManager.Authenticators.DEVICE_CREDENTIAL;
         }
-
-        @Override
-        public void onAuthenticationSucceeded(
-          @NonNull BiometricPrompt.AuthenticationResult result
-        ) {
-          super.onAuthenticationSucceeded(result);
-          finishActivity();
+        if (allowedTypes != null) {
+            // Filter authenticators based on allowed types
+            authenticators = getAllowedAuthenticators(allowedTypes);
         }
+        builder.setAllowedAuthenticators(authenticators);
 
-        @Override
-        public void onAuthenticationFailed() {
-          super.onAuthenticationFailed();
-          counter++;
-          if (counter >= maxAttempts) {
-            biometricPrompt.cancelAuthentication();
-            // Use error code 4 for too many attempts to match iOS behavior
-            finishActivity("error", 4, "Too many failed attempts");
-          }
+        if (!useFallback) {
+            String negativeText = getIntent().getStringExtra("negativeButtonText");
+            builder.setNegativeButtonText(negativeText != null ? negativeText : "Cancel");
         }
-      }
-    );
 
-    biometricPrompt.authenticate(promptInfo);
-  }
+        BiometricPrompt.PromptInfo promptInfo = builder.build();
+
+        biometricPrompt = new BiometricPrompt(
+            this,
+            executor,
+            new BiometricPrompt.AuthenticationCallback() {
+                @Override
+                public void onAuthenticationError(int errorCode, @NonNull CharSequence errString) {
+                    super.onAuthenticationError(errorCode, errString);
+                    // 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());
+                }
+
+                @Override
+                public void onAuthenticationSucceeded(@NonNull BiometricPrompt.AuthenticationResult result) {
+                    super.onAuthenticationSucceeded(result);
+                    finishActivity();
+                }
+
+                @Override
+                public void onAuthenticationFailed() {
+                    super.onAuthenticationFailed();
+                    counter++;
+                    if (counter >= maxAttempts) {
+                        biometricPrompt.cancelAuthentication();
+                        // Use error code 4 for too many attempts to match iOS behavior
+                        finishActivity("error", 4, "Too many failed attempts");
+                    }
+                }
+            }
+        );
 
-  void finishActivity() {
-    finishActivity("success", null, null);
-  }
+        biometricPrompt.authenticate(promptInfo);
+    }
 
-  void finishActivity(String result, Integer errorCode, String errorDetails) {
-    Intent intent = new Intent();
-    intent.putExtra("result", result);
-    if (errorCode != null) {
-      intent.putExtra("errorCode", String.valueOf(errorCode));
+    void finishActivity() {
+        finishActivity("success", null, null);
     }
-    if (errorDetails != null) {
-      intent.putExtra("errorDetails", errorDetails);
+
+    void finishActivity(String result, Integer errorCode, String errorDetails) {
+        Intent intent = new Intent();
+        intent.putExtra("result", result);
+        if (errorCode != null) {
+            intent.putExtra("errorCode", String.valueOf(errorCode));
+        }
+        if (errorDetails != null) {
+            intent.putExtra("errorDetails", errorDetails);
+        }
+        setResult(RESULT_OK, intent);
+        finish();
     }
-    setResult(RESULT_OK, intent);
-    finish();
-  }
-
-  /**
-   * Convert Auth Error Codes to plugin expected Biometric Auth Errors (in README.md)
-   * This way both iOS and Android return the same error codes for the same authentication failure reasons.
-   * !!IMPORTANT!!: Whenever this is modified, check if similar function in iOS Plugin.swift needs to be modified as well
-   * @see <a href="https://developer.android.com/reference/androidx/biometric/BiometricPrompt#constants">...</a>
-   * @return BiometricAuthError
-   */
-  public static int convertToPluginErrorCode(int errorCode) {
-    switch (errorCode) {
-      case BiometricPrompt.ERROR_HW_UNAVAILABLE:
-      case BiometricPrompt.ERROR_HW_NOT_PRESENT:
-        return 1;
-      case BiometricPrompt.ERROR_LOCKOUT_PERMANENT:
-        return 2; // Permanent lockout
-      case BiometricPrompt.ERROR_NO_BIOMETRICS:
-        return 3;
-      case BiometricPrompt.ERROR_LOCKOUT:
-        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:
-        return 14;
-      case BiometricPrompt.ERROR_TIMEOUT:
-      case BiometricPrompt.ERROR_CANCELED:
-        return 15;
-      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;
+
+    /**
+     * Convert Auth Error Codes to plugin expected Biometric Auth Errors (in README.md)
+     * This way both iOS and Android return the same error codes for the same authentication failure reasons.
+     * !!IMPORTANT!!: Whenever this is modified, check if similar function in iOS Plugin.swift needs to be modified as well
+     * @see <a href="https://developer.android.com/reference/androidx/biometric/BiometricPrompt#constants">...</a>
+     * @return BiometricAuthError
+     */
+    public static int convertToPluginErrorCode(int errorCode) {
+        switch (errorCode) {
+            case BiometricPrompt.ERROR_HW_UNAVAILABLE:
+            case BiometricPrompt.ERROR_HW_NOT_PRESENT:
+                return 1;
+            case BiometricPrompt.ERROR_LOCKOUT_PERMANENT:
+                return 2; // Permanent lockout
+            case BiometricPrompt.ERROR_NO_BIOMETRICS:
+                return 3;
+            case BiometricPrompt.ERROR_LOCKOUT:
+                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:
+                return 14;
+            case BiometricPrompt.ERROR_TIMEOUT:
+            case BiometricPrompt.ERROR_CANCELED:
+                return 15;
+            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;
+        }
     }
-  }
-
-  private int getAllowedAuthenticators(int[] allowedTypes) {
-    int authenticators = 0;
-    for (int type : allowedTypes) {
-      switch (type) {
-        case 3: // FINGERPRINT
-          authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
-          break;
-        case 4: // FACE_AUTHENTICATION
-          authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
-          break;
-        case 5: // IRIS_AUTHENTICATION
-          authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
-          break;
-      }
+
+    private int getAllowedAuthenticators(int[] allowedTypes) {
+        int authenticators = 0;
+        for (int type : allowedTypes) {
+            switch (type) {
+                case 3: // FINGERPRINT
+                    authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
+                    break;
+                case 4: // FACE_AUTHENTICATION
+                    authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
+                    break;
+                case 5: // IRIS_AUTHENTICATION
+                    authenticators |= BiometricManager.Authenticators.BIOMETRIC_STRONG;
+                    break;
+            }
+        }
+        return authenticators > 0 ? authenticators : BiometricManager.Authenticators.BIOMETRIC_STRONG;
     }
-    return authenticators > 0
-      ? authenticators
-      : BiometricManager.Authenticators.BIOMETRIC_STRONG;
-  }
 }