Guide
Wie man Native Biometrie in Capacitor verwendet
Verwenden Sie @capgo/capacitor-native-biometric
Dieser Plugin bietet Zugriff auf die native Biometrie-APIS für Android und iOS.
Installieren
bun add @capgo/capacitor-native-biometric
bunx cap sync
bunx cap sync kopiert die native code des Plugins in Ihre native Projekte. Führen Sie es erneut durch, nachdem jede Plugin-Upgrade durchgeführt wurde.
Importieren
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
API im Überblick
| Methode | Beschreibung |
|---|---|
isAvailable |
Überprüft, ob Hardware für biometrische Authentifizierung verfügbar ist. |
verifyIdentity |
Befragt den Benutzer zur Authentifizierung mit Biometrik. |
getCredentials |
Gets the stored credentials for a given server. |
setCredentials |
Stores the given credentials for a given server. |
deleteCredentials |
Löscht die gespeicherten Anmeldeinformationen für einen bestimmten Server. |
getSecureCredentials |
Liefert die gespeicherten Anmeldeinformationen für einen bestimmten Server, wobei eine biometrische Authentifizierung erforderlich ist. Die Anmeldeinformationen müssen mit Zugriffssteuerung auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein. |
isCredentialsSaved |
Überprüft, ob Anmeldeinformationen bereits für einen bestimmten Server gespeichert sind. |
setData |
Speichert einen beliebigen Zeichenfolgenwert unter der angegebenen Schlüssel. Werte werden bei Ruhestand verschlüsselt, indem der Plattform-Secure-Storage-Backend (Android Keystore + SharedPreferences, iOS Keychain) verwendet wird. |
getData |
Wert für die angegebene Schlüssel abrufen. Nur Werte zurückgeben, die ohne biometrische Authentifizierung gespeichert wurden. accessControl. |
getSecureData |
Ermittelt einen für den angegebenen Schlüssel geschützten Wert. Der Wert muss mit accessControl Soll auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gesetzt werden. |
deleteData |
Löscht den gespeicherten Wert für die angegebene Schlüssel (geschützt und ungeschützt). |
isDataSaved |
Überprüft, ob bereits ein Wert für die angegebene Schlüssel gespeichert ist. |
Beispiele
isAvailable()
Überprü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()
Authentifiziert den Benutzer mit Hilfe von Biometriedaten.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
Überprüft, ob Biometrie-Hardware verfügbar ist.
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()
Fordert den Benutzer zur Authentifizierung mit Biometrien auf.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
Holt die gespeicherten Anmelddaten für einen bestimmten Server ab.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
Gets the stored credentials for a given server, requiring biometric authentication. Credentials must have been stored with accessControl set to BIOMETRY_CURRENT_SET or BIOMETRY_ANY.
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 Tabelle oben listet die 12 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind in der GitHub repository.
Hören Sie auf Ereignisse
addListener eine Verbindung zurückgibt. Aufrufen handle.remove() bei dem die Bildschirmabmeldung erfolgt.
Vollständige Referenz
Weitermachen von @capgo/capacitor-native-biometrisch
Fortsetzen von Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometric Mit @capgo/capacitor-native-biometrisch um Authentifizierung und Kontoflows zu planen, verbinden Sie es mit @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometrisch Anfängsphase zur detaillierten Implementierung in Anfängsphase, @capgo/capacitor-Social-Login zur detaillierten Implementierung in @capgo/capacitor-social-login, @capgo/capacitor-Passkey zur detaillierten Implementierung in @capgo/capacitor-passkey und Zwei-Faktor-Authentifizierung zur detaillierten Implementierung in Zwei-Faktor-Authentifizierung.