@capgo/capacitor-native-biometric

Sichere Zugangsdatenspeicherung und biometrisch-gesteuerter Zugriff für Android und iOS.

Übersicht

Native Biometrik ist ein sicheres Kredentialspeicher für iOS und Android. Es speichert Kredentials 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-Flüsse; Ihre App behält die Kontrolle über Timeout, Lebenszyklus, Privatsphäre-Schirm und benutzerdefinierte Passwortpolicies.

Kernfunktionen

setCredentials und getCredentials - Kredentials sicher speichern und abrufen für einen bestimmten Server.
getSecureCredentials - Kredentials nur nach einer nativen biometrischen Überprüfung lesen.
isCredentialsSaved und deleteCredentials - Die Onboarding-, gesperrte-Zustand- und Abmeldefluss erstellen.
isAvailable und verifyIdentity - Die Authentifizierungsverfügbarkeit überprüfen und den Benutzer anfordern, wenn erforderlich.

Öffentlich API

Methode	Beschreibung
`isAvailable`	Überprüft, ob Hardware für biometrische Authentifizierung verfügbar ist.
`addListener`	Hinzufügen eines Hörers, der aufgerufen wird, wenn die App aus dem Hintergrund zurückkehrt. Dies ist nützlich, um festzustellen, ob die Verfügbarkeit von Biometrien während der App im Hintergrund (z.B. Benutzer registriert/abgemeldet Biometrien) geändert wurde.
`verifyIdentity`	Den Benutzer auffordern, sich mit Biometrien zu authentifizieren.
`getCredentials`	Die gespeicherten Anmeldeinformationen für einen bestimmten Server abrufen.
`setCredentials`	Speichert die angegebenen Anmeldeinformationen für einen bestimmten Server.
`deleteCredentials`	Löscht die gespeicherten Anmeldeinformationen für einen bestimmten Server.
`getSecureCredentials`	Liefert die gespeicherten Anmeldeinformationen für einen bestimmten Server, bei denen eine biometrische Authentifizierung erforderlich ist. Anmeldeinformationen müssen mit Zugriffskontrolle auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein.
`isCredentialsSaved`	Überprüft, ob Anmeldeinformationen bereits für einen bestimmten Server gespeichert sind.
`getPluginVersion`	Liefert die native Capacitor-Pluginversion.

Referenzwerte

Verwende diese Werte bei der Verarbeitung von biometricError Erfolgsresultaten von authenticate.

Fehler bei der biometrischen Authentifizierung

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 Biometrie ist auf dem Gerät registriert.
`USER_TEMPORARY_LOCKOUT`	`4`	Android, iOS	Der Benutzer ist vorübergehend ausgeloggt, typischerweise für 30 Sekunden.
`AUTHENTICATION_FAILED`	`10`	Android, iOS	Die Authentifizierung 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	Kein Gerätpasswort, -PIN oder -Rückfallszustand ist eingerichtet.
`SYSTEM_CANCEL`	`15`	Android, iOS	System hat die Authentifizierung abgebrochen, zum Beispiel nach dem Bildschirmschutz.
`USER_CANCEL`	`16`	Android, iOS	Der Benutzer hat die Authentifizierung abgebrochen.
`USER_FALLBACK`	`17`	Android, iOS	Der Benutzer hat die Ersatzauthentifizierung gewählt.

Quelle der Wahrheit

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

Weitergehen von @capgo/capacitor-native-biometrisch

Wenn Sie @capgo/capacitor-native-biometric um die Authentifizierung und die Kontoflows zu planen, verbinden Sie es mit Mit @capgo/capacitor-native-biometric für die native Fähigkeit in Mit @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 in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) für die Implementierungsdetails in SSO (Enterprise).