@rolster/capacitor-native-biometric v5.0.4

Rolster Capacitor Native Biometric

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

Package only supports Capacitor 5

npm i @rolster/capacitor-native-biometric

Usage

import { NativeBiometric } from "@rolster/capacitor-native-biometric";

async performBiometricVerificatin() {
  const result = await NativeBiometric.isAvailable();

  if (result.isAvailable) {
    const isFaceID = result.biometryType == BiometryType.FACE_ID;

    const verified = await NativeBiometric.verifyIdentity({
      reason: "For easy log in",
      title: "Log in",
      subtitle: "Maybe add subtitle here?",
      description: "Maybe a description too?",
    })
    .then(() => true)
    .catch(() => false);

    if (verified) {
      const credentials = await NativeBiometric.getCredentials({
        server: "www.example.com",
      });
    }
  }
}

// Save user's credentials
NativeBiometric.setCredentials({
  username: "username",
  password: "password",
  server: "www.example.com",
});

// Delete user's credentials
NativeBiometric.deleteCredentials({
  server: "www.example.com",
});

Methods

Interfaces

IsAvailableOptions

AvailableResult

BiometryType - enum

BiometricOptions

Biometric Auth Errors

This is a plugin specific list of error codes that can be thrown on verifyIdentity failure, or set as a part of isAvailable. It consolidates Android and iOS specific Authentication Error codes into one combined error list.

SetCredentialOptions

GetCredentialOptions

DeleteCredentialOptions

Credentials

Face ID (iOS)

To use FaceID Make sure to provide a value for NSFaceIDUsageDescription, otherwise your app may crash on iOS devices with FaceID. This value is just the reason for using FaceID. You can add something like the following example to App/info.plist:

<key>NSFaceIDUsageDescription</key>
<string>For an easier and faster log in.</string>

Biometric (Android)

To use android's BiometricPrompt api you must add the following permission to your AndroidManifest.xml:

<uses-permission android:name="android.permission.USE_BIOMETRIC">

And register the plugin by adding it to you MainActivity's onCreate:

import com.rolster.capacitor.biometric.NativeBiometric;

public class MainActivity extends BridgeActivity {
  @Override
  public void onCreate(Bundle savedInstanceState) {
    registerPlugin(NativeBiometric.class);
    // Others register plugins

    super.onCreate(savedInstanceState);
  }
}