Übersicht
Abschnitt mit dem Titel “Übersicht”Native Biometrisch ist ein sicheres Zertifikatslager für iOS und Android. Es speichert Zertifikate im native Keychain oder Keystore und kann eine biometrische Authentifizierung vor der Rückgabe sensitiver Werte erfordern. Es ist ein direkter Ersatz für die Ionic-Identitäts-Vault-Zertifikatslager-Flüsse; Ihre App behält die Kontrolle über Timeout, Lebenszyklus, Privatsphäre-Schirm und benutzerdefinierte Passwort-Politik.
Kernfunktionen
Abschnitt mit dem Titel “Kernfunktionen”setCredentialsundgetCredentials- Zertifikate sicher speichern und abrufen für einen bestimmten Server.getSecureCredentials- Zertifikate nur nach einer native biometrischen Überprüfung lesen.isCredentialsSavedunddeleteCredentials- Onboarding-, Ausgangszustand- und Abmeldevorgänge erstellen.isAvailableundverifyIdentity- Überprüft die Verfügbarkeit der Authentifizierung und fordert den Benutzer auf, wenn erforderlich.
Öffentlich API
Sektion mit dem Titel „Öffentlich API“| Methode | Beschreibung |
|---|---|
isAvailable | Überprüft, ob Biometrie-Hardware 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 zu erkennen, ob die Verfügbarkeit der Biometrie während der Abwesenheit der App (z.B. Benutzer registriert/entfernt Biometrien) geändert wurde. |
verifyIdentity | Fordert den Benutzer auf, mit Biometrien zu authentifizieren. |
getCredentials | Gets the stored credentials for a given server. |
setCredentials | Stores the given credentials for a given server. |
deleteCredentials | Löscht die gespeicherten Anmeldeinformationen für einen bestimmten Server. |
getSecureCredentials | Ermittelt die gespeicherten Anmeldeinformationen für einen bestimmten Server, die eine biometrische Authentifizierung erfordern. Die Anmeldeinformationen müssen mit Zugriffssteuerung auf BIOMETRY_CURRENT_SET oder BIOMETRY_ANY gespeichert worden sein. |
isCredentialsSaved | Überprüft, ob Anmeldeinformationen bereits für einen bestimmten Server gespeichert sind. |
getPluginVersion | Ermittelt die native Version des Capacitor-Plugins. |
Referenzwerte
Abschnitt mit dem Titel „Referenzwerte“Verwenden Sie diese Werte bei der Verarbeitung von biometricError Erfolgen aus authenticate.
Fehler bei der biometrischen Authentifizierung
Section titled “Biometric Auth Errors”| 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 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 | Der Benutzer ist vorübergehend abgeblockt, typischerweise für 30 Sekunden. |
AUTHENTICATION_FAILED | 10 | Android, iOS | Authentifizierung fehlgeschlagen. |
APP_CANCEL | 11 | iOS | Die App hat die Authentifizierungsablauf abgebrochen. |
INVALID_CONTEXT | 12 | iOS | Authentifizierungs Kontext ist ungültig. |
NOT_INTERACTIVE | 13 | iOS | Die Authentifizierung war nicht interaktiv. |
PASSCODE_NOT_SET | 14 | Android, iOS | Ein Gerätpasswort, PIN oder ein Fallbackkonto ist nicht eingerichtet. |
SYSTEM_CANCEL | 15 | Android, iOS | Das System hat die Authentifizierung abgebrochen, z.B. nach Bildschirmabschaltung. |
USER_CANCEL | 16 | Android, iOS | Benutzer hat die Authentifizierung abgebrochen. |
USER_FALLBACK | 17 | Android, iOS | Benutzer hat die Ersatzauthentifizierung gewählt. |
Quelle der Wahrheit
Abschnitt mit dem Titel „Quelle der Wahrheit“Diese Referenz wird von src/definitions.ts in capacitor-native-biometrisch.
Weitergehen von @capgo/capacitor-native-biometrisch
Abschnitt mit dem Titel „Weitergehen von @capgo/capacitor-native-biometrisch“Wenn Sie native-biometrische Funktionen verwenden @capgo/capacitor-native-biometrisch um die Authentifizierung und die Kontenflüsse zu planen, verbinden Sie es mit Mit @capgo/capacitor-native-biometric zur nativen Fähigkeit in Mit @capgo/capacitor-native-biometric, @capgo/capacitor-Social-Login zur Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-Passkey zur Implementierungsdetails in @capgo/capacitor-passkey, Zwei-Faktor-Authentifizierung zur Implementierungsdetails in Zwei-Faktor-Authentifizierung und SSO (Unternehmen) zur Implementierungsdetails in SSO (Unternehmen).