@capgo/capacitor-native-biometric

Panoramica

Native Biometric è un vault sicuro per le credenziali su iOS e Android. Memorizza le credenziali nel Keychain o Keystore nativo e può richiedere l'autenticazione biometrica prima di restituire valori sensibili. È il sostituto diretto dei flussi credential-vault di Ionic Identity Vault; la tua app mantiene il controllo su timeout, lifecycle, privacy-screen e policy del codice di accesso personalizzato.

Funzionalità principali

• setCredentials 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 deleteCredentials - Crea flussi di onboarding, stati di lock e logout.
• isAvailable e verifyIdentity - Verifica la disponibilità dell'autenticazione e mostra un prompt all'utente quando necessario.

Pubblico API

Metodo	Descrizione
isAvailable	Verifica se l'hardware per l'autenticazione biometrica è disponibile.
addListener	Aggiunge un listener che viene chiamato quando l'app riprende dal background. Utile per rilevare se la disponibilità della biometria è cambiata mentre l'app era in background (es. l'utente ha aggiunto o rimosso dati biometrici).
verifyIdentity	Richiede all'utente l'autenticazione tramite biometria.
getCredentials	Recupera le credenziali salvate per un determinato server.
setCredentials	Salva le credenziali fornite per un determinato server.
deleteCredentials	Elimina le credenziali salvate per un determinato server.
getSecureCredentials	Recupera le credenziali salvate per un determinato server, richiedendo l'autenticazione biometrica. Le credenziali devono essere state salvate con accessControl impostato su BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
isCredentialsSaved	Verifica se le credenziali sono già salvate per un determinato server.
getPluginVersion	Ottieni la versione nativa del plugin Capacitor.

Valori di riferimento

Usa questi valori quando gestisci biometricError i risultati di authenticate.

Errori di Biometric Auth

Valore	Code	Piattaforma	Significato
UNKNOWN_ERROR	0	Android, iOS	Si è verificato un errore sconosciuto.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	La biometria non è disponibile perché l'hardware è assente o non disponibile.
USER_LOCKOUT	2	Android, iOS	L'utente è bloccato dopo troppi tentativi falliti.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Nessun dato biometrico registrato sul dispositivo.
USER_TEMPORARY_LOCKOUT	4	Android	L'utente è temporaneamente bloccato, solitamente per 30 secondi.
AUTHENTICATION_FAILED	10	Android, iOS	Autenticazione fallita.
APP_CANCEL	11	iOS	L'app ha annullato il flusso di autenticazione.
INVALID_CONTEXT	12	iOS	Il contesto di autenticazione non è valido.
NOT_INTERACTIVE	13	iOS	L'autenticazione non è stata interattiva.
PASSCODE_NOT_SET	14	Android, iOS	Codice di sblocco, PIN o credenziali di fallback non impostati.
SYSTEM_CANCEL	15	Android, iOS	Il sistema ha annullato l'autenticazione, 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à

Questo riferimento è sincronizzato da src/definitions.ts nella capacitor-native-biometric.

Continua da @capgo/capacitor-native-biometric

Se stai usando @capgo/capacitor-native-biometric per pianificare i flussi di autenticazione e account, collegandolo a Utilizzo di @capgo/capacitor-native-biometric per la funzionalità nativa in Utilizzo di @capgo/capacitor-native-biometric, @capgo/capacitor-social-login per i dettagli di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per i dettagli di implementazione in @capgo/capacitor-passkey, Autenticazione a due fattori per i dettagli di implementazione in Two-factor authentication, e SSO (Enterprise) per i dettagli di implementazione in SSO (Enterprise).