@capgo/capacitor-native-biometric

Panoramica

La biometria nativa è un deposito sicuro di credenziali per iOS e Android. Memorizza le credenziali nel Keychain o Keystore nativo e richiedi l'autenticazione biometrica prima di restituire valori sensibili. È una sostituzione diretta per le flussi di deposito di credenziali di Ionic Identity Vault; l'applicazione mantiene il controllo dei timeout, della vita ciclo, dello schermo di privacy e delle politiche di codice personalizzato.

Capacità di base

• setCredentials E e getCredentials - Memorizza e recupera in modo sicuro le credenziali per un server specifico.
• getSecureCredentials - Leggi le credenziali solo dopo un controllo biometrico nativo.
• isCredentialsSaved E e deleteCredentials - Costruisci flussi di onboarding, stato bloccato e logout.
• isAvailable E e verifyIdentity - Verifica la disponibilità dell'autenticazione biometrica e sollecita l'utente quando necessario.

Pubblico API

Metodo	Descrizione
isAvailable	Verifica se sono disponibili dispositivi di autenticazione biometrica.
addListener	Aggiunge un ascoltatore che viene chiamato quando l'applicazione riprende dallo sfondo. Questo è utile per rilevare se la disponibilità delle biometrie è cambiata mentre l'applicazione era in background (ad esempio, l'utente si è iscritto/desiscritto alle biometrie).
verifyIdentity	Sollecita l'utente a autenticarsi con le biometrie.
getCredentials	Ottiene le credenziali memorizzate per un server specifico.
setCredentials	Memorizza le credenziali specifiche per un server specifico.
deleteCredentials	Cancella le credenziali memorizzate per un server specifico.
getSecureCredentials	Ottiene le credenziali memorizzate per un server specifico, richiedendo l'autenticazione con le biometrie. Le credenziali devono essere state memorizzate con accessControl impostato su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
isCredentialsSaved	Controlla se le credenziali sono già salvate per un server specifico.
getPluginVersion	Ottieni la versione del plugin nativo Capacitor.

Valori di Riferimento

Usa questi valori quando gestisci biometricError risultati da authenticate.

Error di autenticazione biometrica

Valore	Code	Piattaforma	Significato
UNKNOWN_ERROR	0	Android, iOS	Si è verificato un errore sconosciuto.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	Le biometrie non sono disponibili a causa della mancanza o indisponibilità di hardware.
USER_LOCKOUT	2	Android, iOS	L'utente è bloccato dopo troppi tentativi falliti.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Non sono registrati nessun biometria sul dispositivo.
USER_TEMPORARY_LOCKOUT	4	Android	L'utente è temporaneamente bloccato, tipicamente per 30 secondi.
AUTHENTICATION_FAILED	10	Android, iOS	La autenticazione è fallita.
APP_CANCEL	11	iOS	L'app ha annullato il flusso di autenticazione.
INVALID_CONTEXT	12	iOS	Il contesto di autenticazione è invalido.
NOT_INTERACTIVE	13	iOS	L'autenticazione non è stata interattiva.
PASSCODE_NOT_SET	14	Android, iOS	Il codice di accesso, la PIN o il credenziale di fallback non sono stati impostati.
SYSTEM_CANCEL	15	Android, iOS	L'autenticazione è stata annullata dal sistema, ad esempio dopo il blocco dello schermo.
USER_CANCEL	16	Android, iOS	L'utente ha annullato l'autenticazione.
USER_FALLBACK	17	Android, iOS	L'utente ha scelto l'autenticazione di fallback.

Fonte Di Verità

Questa documentazione è sincronizzata da src/definitions.ts in capacitor-native-biometric.

Keep going from @capgo/capacitor-native-biometric

Se stai utilizzando @capgo/capacitor-native-biometric per pianificare l'autenticazione e le flussi di account, connettilo con Using @capgo/capacitor-native-biometric for the native capability in Using @capgo/capacitor-native-biometric, @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login, @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, Autenticazione a due fattori per la dettagliata implementazione in Autenticazione a due fattori, e SSO (Enterprise) per la dettagliata implementazione in SSO (Enterprise).