@capgo/capacitor-native-biometric

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

Übersicht

Native Biometrisch ist ein sicheres Kredentialspeicher für iOS und Android. Es speichert Kredite im nativen 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 - Sichere Speicherung und Abruf von Anmeldeinformationen für einen bestimmten Server.
getSecureCredentials - Lesen Sie Anmeldeinformationen nur nach einer nativen biometrischen Überprüfung.
isCredentialsSaved und deleteCredentials - Erstellen Sie Onboarding-, gesperrter Zustand- und Abmeldevorgänge.
isAvailable und verifyIdentity - Überprüfen Sie die Verfügbarkeit der Authentifizierung und fordern Sie den Benutzer auf, wenn erforderlich.

Öffentlich API

Methode	Beschreibung
`isAvailable`	Überprüft, ob biometrische AuthentifizierungsHardware verfügbar ist.
`addListener`	Fügt einen Listener hinzu, der aufgerufen wird, wenn die App aus dem Hintergrund wieder aufgerufen wird. Dies ist nützlich, um zu erkennen, ob die Verfügbarkeit von Biometrik während der App im Hintergrund (z.B. Benutzer registriert/entfernt Biometrik) geändert wurde.
`verifyIdentity`	Befragt den Benutzer zur Authentifizierung mit Biometrik.
`getCredentials`	Holt die gespeicherten Anmeldeinformationen für einen bestimmten Server.
`setCredentials`	Speichert die angegebenen Anmeldeinformationen für einen bestimmten Server.
`deleteCredentials`	Löscht die gespeicherten Anmeldeinformationen für einen bestimmten Server.
`getSecureCredentials`	Holt die gespeicherten Anmeldeinformationen für einen bestimmten Server, wobei eine biometrische Authentifizierung erforderlich ist. 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`	Ermittelt die native Pluginversion von Capacitor.

Referenzwerte

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

Biometrische Auth-Fehler

Wert	Code	Plattform	Bedeutung
`UNKNOWN_ERROR`	`0`	Android, iOS	Etwas ist schiefgelaufen.
`BIOMETRICS_UNAVAILABLE`	`1`	Android, iOS	Biometrische Funktionen sind nicht verfügbar, weil 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ätepasswort, PIN oder ein Fallbackkonto ist nicht eingerichtet.
`SYSTEM_CANCEL`	`15`	Android, iOS	Die Systemauthentifizierung wurde abgebrochen, z.B. nachdem das Bildschirm-Schutzprogramm aktiviert wurde.
`USER_CANCEL`	`16`	Android, iOS	Der Benutzer hat die Authentifizierung abgebrochen.
`USER_FALLBACK`	`17`	Android, iOS	Der Benutzer hat die Fallback-Authentifizierung gewählt.

Quelle der Wahrheit

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

Fortsetzen Sie von @capgo/capacitor-native-biometrische

Wenn Sie native-biometrische @capgo/capacitor-native-biometrische zum Planen von Authentifizierungs- und Konto-Flüssen verwenden, verbinden Sie es mit Mit @capgo/capacitor-native-biometrische die native Fähigkeit in Mit @capgo/capacitor-native-biometrische, @capgo/capacitor-social-login die Implementierungsdetail in @capgo/capacitor-social-login, @capgo/capacitor-passkey die Implementierungsdetail in @capgo/capacitor-passkey, Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).