@capgo/capacitor-native-biometric

Sichere Zugriffskonten und biometrisch geschützte Zugriffe für Android und iOS.

Übersicht

Native Biometrisch ist ein sicheres Kreditkartenkästchen für iOS und Android. Es speichert Kreditkarten in dem 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-Identitäts-Vault-Kreditkartenkästchen-Flows; Ihre App behält die Kontrolle über die Zeitüberschreitung, das Lebenszyklus, die Privatsphäre-Schirm und die benutzerdefinierte Passwort-Politik.

Kernfunktionen

setCredentials und getCredentials - Sichere Speicherung und Abruf von Anmeldeinformationen für einen bestimmten Server.
getSecureCredentials - Anmeldeinformationen lesen, nur nach einer nativen Biometrie-Überprüfung.
isCredentialsSaved - Und deleteCredentials - Einstieg in die Onboarding-, gesperrten-Zustand- und Abmeldevorgänge.
isAvailable - Und verifyIdentity - Überprüfen Sie die Verfügbarkeit der Authentifizierung und fordern Sie den Benutzer an, wenn erforderlich.

- Öffentlich API

- Methode	- Beschreibung
`isAvailable`	- Überprüft, ob Biometrie-Authentifizierungs-Hardware 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 festzustellen, ob die Biometrie-Verfügbarkeit während der App im Hintergrund (z.B. Benutzer hat sich für Biometrie angemeldet/abgemeldet) geändert hat.
`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. 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`	Ermittelt die native Capacitor-Pluginversion.

Referenzwerte

Verwenden Sie diese Werte, wenn Sie Ergebnisse von biometricError Fehlern bei der Biometrischen Authentifizierung authenticate.

handle

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 abgeblockt, 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	Geräte-Passwort, PIN oder alternatives Anmeldeinformationen sind nicht gesetzt.
`SYSTEM_CANCEL`	`15`	Android, iOS	Das System hat die Authentifizierung abgebrochen, z.B. nach dem Bildschirmschutz.
`USER_CANCEL`	`16`	Android, iOS	Der Benutzer hat die Authentifizierung abgebrochen.
`USER_FALLBACK`	`17`	Android, iOS	Der Benutzer hat die alternative Authentifizierung gewählt.

Quelle der Wahrheit

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

Weitermachen von @capgo/capacitor-native-biometric

Wenn Sie “@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometric” verwenden @capgo/capacitor-native-biometric um die Authentifizierung und die Kontenflüsse zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-native-biometric für die native Fähigkeit in Verwenden Sie @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 (Unternehmen).