@capgo/capacitor-native-biometric

Übersicht

Native Biometric ist ein sicheres Kredentialspeicher für iOS und Android. Es speichert Kredite im native Keychain oder Keystore und kann eine biometrische Authentifizierung vor der Rückgabe sensibler Werte erfordern. Es ist ein direkter Ersatz für die Ionic Identity Vault-Kredentialspeicher-Flows; Ihre App behält die Kontrolle über Timeout, Lebenszyklus, Privatsphäre-Schirm und benutzerdefinierte Passwortpolicies.

Kernfunktionen

• setCredentials und getCredentials - Sichere Speicherung und Abruf von Anmeldeinformationen für einen bestimmten Server.
• getSecureCredentials - Anmeldeinformationen nur nach einer nativen Biometrik-Überprüfung lesen.
• isCredentialsSaved und deleteCredentials - Einführung von Onboarding-, gesperrter Zustand- und Abmeldevorgängen.
• isAvailable und verifyIdentity - Überprüfung der Verfügbarkeit der Authentifizierung und Benachrichtigung des Benutzers, wenn erforderlich.

Öffentlich API

Methode	Beschreibung
isAvailable	Überprüft, ob Biometrik-Authentifizierungs-Hardware verfügbar ist.
addListener	Ein Listener wird hinzugefügt, der aufgerufen wird, wenn die App aus dem Hintergrund wieder aufgerufen wird. Dies ist nützlich, um zu erkennen, ob die Verfügbarkeit von Biometrien während der App im Hintergrund geändert wurde (z.B. Benutzer hat sich für Biometrien angemeldet/abgemeldet).
verifyIdentity	Der Benutzer wird aufgefordert, sich mit Biometrien zu authentifizieren.
getCredentials	Die gespeicherten Anmeldeinformationen für einen bestimmten Server werden abgerufen.
setCredentials	Die angegebenen Anmeldeinformationen werden für einen bestimmten Server gespeichert.
deleteCredentials	Die gespeicherten Anmeldeinformationen für einen bestimmten Server werden gelöscht.
getSecureCredentials	Die gespeicherten Anmeldeinformationen für einen bestimmten Server werden abgerufen, wobei eine biometrische Authentifizierung erforderlich ist. Die Anmeldeinformationen müssen mit Zugriffssteuerung gespeichert worden sein, die auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY festgelegt ist.
isCredentialsSaved	Überprüft, ob Anmeldeinformationen bereits für einen bestimmten Server gespeichert sind.
getPluginVersion	Die native Capacitor-Pluginversion wird abgerufen.

Werteverweise

Verwenden Sie diese Werte, wenn Sie Ergebnisse von biometricError Ergebnissen authenticate.

Authentifizierungsfehler der Biometrie

Wert	Code	Plattform	Bedeutung
UNKNOWN_ERROR	0	Android, iOS	Ein unbekannter Fehler ist aufgetreten.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	Die Biometrie ist nicht verfügbar, da die Hardware fehlt oder nicht verfügbar ist.
USER_LOCKOUT	2	Android, iOS	Der Benutzer ist nach zu vielen fehlgeschlagenen Versuchen abgeblockt.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Keine Biometriedaten sind auf dem Gerät registriert.
USER_TEMPORARY_LOCKOUT	4	Android	Der Benutzer ist vorübergehend ausgeloggt, typischerweise für 30 Sekunden.
AUTHENTICATION_FAILED	10	Android, iOS	Die Authentifizierung ist fehlgeschlagen.
APP_CANCEL	11	iOS	Die App hat den Authentifizierungsfluss abgebrochen.
INVALID_CONTEXT	12	iOS	Der Authentifizierungscontext ist ungültig.
NOT_INTERACTIVE	13	iOS	Die Authentifizierung war nicht interaktiv.
PASSCODE_NOT_SET	14	Android, iOS	Ein Geräteneingabe-Code, PIN oder ein Fallback-Zugriff ist nicht gesetzt.
SYSTEM_CANCEL	15	Android, iOS	Das System hat die Authentifizierung abgebrochen, z.B. nach einem Bildschirm-Sperrmodus.
USER_CANCEL	16	Android, iOS	Der Benutzer hat die Authentifizierung abgebrochen.
USER_FALLBACK	17	Android, iOS	Der Benutzer hat eine Fallback-Authentifizierung gewählt.

Quelle der Wahrheit

Diese Referenz wird von src/definitions.ts in capacitor-native-biometrische Funktion.

Weitergehen von @capgo/capacitor-native-biometrische Funktion

Wenn Sie die Funktion verwenden @capgo/capacitor-native-biometrische Funktion um die Authentifizierung und die Kontoflows zu planen, verbinden Sie sie mit Die Verwendung von @capgo/capacitor-native-biometrische Funktion für die native Fähigkeit in Die Verwendung von @capgo/capacitor-native-biometrische Funktion @capgo/capacitor-soziale Anmeldung für die Implementierungsdetails in @capgo/capacitor-soziale Anmeldung @capgo/capacitor-Passwort für die Implementierungsdetails in @capgo/capacitor-Passwort Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).