@capgo/capacitor-native-biometric

Übersicht

Native Biometric ist ein sicherer Credential Vault für iOS und Android. Er speichert Credentials im nativen Keychain oder Keystore und kann eine biometrische Authentifizierung verlangen, bevor sensible Werte zurückgegeben werden. Er ist ein direkter Ersatz für die Credential-Vault-Flows von Ionic Identity Vault; deine App behält die Kontrolle über Timeout, Lifecycle, Privacy-Screen und benutzerdefinierte Passcode-Policies.

Kernfunktionen

• setCredentials und getCredentials - Sicherer Speicher und Abruf von Credentials für einen bestimmten Server.
• getSecureCredentials - Credentials werden erst nach einem nativen Biometric-Check gelesen.
• isCredentialsSaved und deleteCredentials - Erstellung von Onboarding-, Locked-State- und Logout-Flows.
• isAvailable und verifyIdentity - Verfügbarkeit der Authentifizierung prüfen und User bei Bedarf prompten.

Öffentliches API

Methode	Beschreibung
isAvailable	Prüft, ob Hardware für biometrische Authentifizierung verfügbar ist.
addListener	Fügt einen Listener hinzu, der aufgerufen wird, wenn die App aus dem Hintergrund zurückkehrt. Dies ist nützlich, um zu erkennen, ob sich die Verfügbarkeit der Biometrie geändert hat, während die App im Hintergrund war (z. B. wenn der Nutzer Biometrie registriert oder entfernt hat).
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.
getPluginVersion	Die native Capacitor Plugin-Version abrufen.

Referenzwerte

Verwende diese Werte beim Umgang mit biometricError Ergebnissen von authenticate.

Biometric Auth-Fehler

Wert	Code	Plattform	Bedeutung
UNKNOWN_ERROR	0	Android, iOS	Ein unbekannter Fehler ist aufgetreten.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	Biometrie ist nicht verfügbar, da die Hardware fehlt oder nicht verfügbar ist.
USER_LOCKOUT	2	Android, iOS	Der Nutzer wurde nach zu vielen Fehlversuchen gesperrt.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Auf dem Gerät sind keine Biometrie-Daten registriert.
USER_TEMPORARY_LOCKOUT	4	Android	Der Nutzer ist vorübergehend gesperrt, meist für 30 Sekunden.
AUTHENTICATION_FAILED	10	Android, iOS	Authentifizierung fehlgeschlagen.
APP_CANCEL	11	iOS	Die App hat den Authentifizierungsprozess abgebrochen.
INVALID_CONTEXT	12	iOS	Der Authentifizierungskontext ist ungültig.
NOT_INTERACTIVE	13	iOS	Die Authentifizierung war nicht interaktiv.
PASSCODE_NOT_SET	14	Android, iOS	Geräte-Passcode, PIN oder Fallback-Anmeldedaten sind nicht gesetzt.
SYSTEM_CANCEL	15	Android, iOS	Authentifizierung durch das System abgebrochen, z. B. nach der Bildschirmsperre.
USER_CANCEL	16	Android, iOS	Der Benutzer hat die Authentifizierung abgebrochen.
USER_FALLBACK	17	Android, iOS	Benutzer hat Fallback-Authentifizierung gewählt.

Source of Truth

Diese Referenz wird synchronisiert von src/definitions.ts in capacitor-native-biometric.

Weiter mit @capgo/capacitor-native-biometric

Wenn du es nutzt @capgo/capacitor-native-biometric Um Authentifizierungs- und Account-Flows zu planen, verbinde es mit Verwendung von @capgo/capacitor-native-biometric für die native Funktion in Verwendung von @capgo/capacitor-native-biometric, @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, Zwei-Faktor-Authentifizierung für die Implementierungsdetails zur Zwei-Faktor-Authentifizierung, und SSO (Enterprise) für die Implementierungsdetails zu SSO (Enterprise).