@capgo/capacitor-native-biometric

Stoccaggio di credenziali sicuro e accesso biometrico per Android e iOS.

Panoramica

Native Biometric è un deposito sicuro di credenziali per iOS e Android. Memorizza le credenziali nel Keychain o Keystore nativi 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'applica mantenendo il controllo dei tempi di scadenza, ciclo di vita, schermo di privacy e politiche di codice personalizzato.

Capacità di base

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 Esegui - Costruisci flussi di onboarding, stato bloccato e logout. deleteCredentials Esegui - Controlla la disponibilità dell'autenticazione e sollecita l'utente quando necessario.
isAvailable Pubblico __CAPGO_KEEP_0__ verifyIdentity Sottosezione intitolata “Pubblico __CAPGO_KEEP_0__”

Public API

Verifica se sono disponibili dispositivi di autenticazione biometrica.	Aggiunge un ascoltatore che viene chiamato quando l'applicazione riprende l'esecuzione 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).
`isAvailable`	Sollecita l'utente ad autenticarsi con le biometrie.
`addListener`	Recupera le credenziali memorizzate per un server specifico.
`verifyIdentity`	Esegui - Costruisci flussi di onboarding, stato bloccato e logout.
`getCredentials`	Esegui - Controlla la disponibilità dell'autenticazione e sollecita l'utente quando necessario.
`setCredentials`	Memorizza le credenziali fornite per un server specifico.
`deleteCredentials`	Elimina le credenziali memorizzate per un server specifico.
`getSecureCredentials`	Recupera le credenziali memorizzate per un server specifico, richiedendo l'autenticazione biometrica. 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`	Recupera la versione nativa del plugin Capacitor.

Valori di Riferimento

Utilizza questi valori quando gestisci biometricError risultati da authenticate.

Errori 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 di hardware mancante o non disponibile.
`USER_LOCKOUT`	`2`	Android, iOS	L'utente è bloccato dopo troppi tentativi falliti.
`BIOMETRICS_NOT_ENROLLED`	`3`	Android, iOS	Non sono registrate biometrie sul dispositivo.
`USER_TEMPORARY_LOCKOUT`	`4`	Android, iOS	L'utente è temporaneamente bloccato, tipicamente per 30 secondi.
`AUTHENTICATION_FAILED`	`10`	Android, iOS	La verifica delle credenziali è 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 del dispositivo, la PIN o il credenziale di fallback non sono 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à

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

Continua da @capgo/capacitor-native-biometric

If you are using @capgo/capacitor-native-biometric per pianificare l'autenticazione e le flussi di account, connettilo con Utilizzando @capgo/capacitor-native-biometric per la capacità nativa in Utilizzando @capgo/capacitor-native-biometric, @capgo/capacitor-social-login per il dettaglio di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per il dettaglio di implementazione in @capgo/capacitor-passkey, Autenticazione a due fattori per il dettaglio di implementazione in Autenticazione a due fattori, e SSO (Enterprise) per i dettagli di implementazione in SSO (Enterprise).