Native Biometrie Capacitor Plugin

Mit @capgo/capacitor-native-biometric

Dieses Plugin bietet Zugriff auf die nativen Biometric-APIs für Android und iOS.

Kompatibilität

Die Hauptversion des Plugins folgt Capacitor: Nutze v8 für Capacitor 8 (aktiv gepflegt) und v7 für Capacitor 7 (bei Bedarf gepflegt). Siehe die Kompatibilitätstabelle.

Installieren

# Capacitor 8
bun add @capgo/capacitor-native-biometric@8
# Capacitor 7
bun add @capgo/capacitor-native-biometric@7
bunx cap sync

bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

API auf einen Blick

Methode	Beschreibung
isAvailable	Prüft, ob Hardware für biometrische Authentifizierung verfügbar ist.
verifyIdentity	Fordert den Benutzer zur biometrischen Authentifizierung auf.
getCredentials	Ruft die gespeicherten Credentials für einen bestimmten Server ab.
setCredentials	Speichert die angegebenen Credentials für einen bestimmten Server.
deleteCredentials	Löscht die gespeicherten Credentials für einen bestimmten Server.
getSecureCredentials	Ruft die gespeicherten Credentials für einen bestimmten Server ab; dabei ist eine biometrische Authentifizierung erforderlich. Die Credentials müssen mit accessControl = BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein.
isCredentialsSaved	Prüft, ob bereits Credentials für einen bestimmten Server gespeichert sind.
setData	Speichert einen beliebigen String-Wert unter dem angegebenen Key. Werte werden im Ruhezustand mit dem Secure-Storage-Backend der Plattform verschlüsselt (Android Keystore + SharedPreferences, iOS Keychain).
getData	Ruft einen zuvor gespeicherten Wert für den angegebenen Key ab. Gibt nur Werte zurück, die ohne biometrischen Schutz gespeichert wurden. accessControl.
getSecureData	Ruft einen biometrisch geschützten Wert für den angegebenen Key ab. Der Wert muss mit accessControl BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein.
deleteData	Löscht den gespeicherten Wert für den angegebenen Key (geschützt und ungeschützt).
isDataSaved	Prüft, ob für den angegebenen Key bereits ein Wert gespeichert ist.

Beispiele

isAvailable()

Prüft, ob Hardware für biometrische Authentifizierung verfügbar ist.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.isAvailable();
console.log(result);

verifyIdentity()

Fordert den Benutzer zur biometrischen Authentifizierung auf.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.verifyIdentity();

getCredentials()

Ruft die gespeicherten Credentials für einen bestimmten Server ab.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.

setCredentials()

Speichert die angegebenen Credentials für einen bestimmten Server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.setCredentials({
  username: 'username',
  password: 'password',
  server: 'example.com',
});

deleteCredentials()

Löscht die gespeicherten Credentials für einen bestimmten Server.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.deleteCredentials({ server: 'example.com' });

getSecureCredentials()

Ruft die gespeicherten Credentials für einen bestimmten Server ab; dabei ist eine biometrische Authentifizierung erforderlich. Die Credentials müssen mit accessControl = BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.

Die obige Tabelle listet die 12 Kernmethoden auf. Listener und Versions-Helper sowie der vollständige Contract jeder Methode sind dokumentiert in der GitHub Repository.

Events abonnieren

addListener gibt ein Handle zurück. Rufe handle.remove() wenn der Screen unmountet wird.

Vollständige Referenz

• GitHub Repository
• Dokumentation
• API-Referenz

Weiter geht's mit Using @capgo/capacitor-native-biometric

Wenn du es nutzt Mit @capgo/capacitor-native-biometric Um Authentifizierungs- und Account-Flows zu planen, verbinde es mit @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric, Erste Schritte für die Implementierungsdetails in Erste Schritte, @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, und Zwei-Faktor-Authentifizierung für die Implementierungsdetails zur Zwei-Faktor-Authentifizierung.