Native Biometric es un vault de credenciales seguro para iOS y Android. Almacena las credenciales en el Keychain o Keystore nativo y puede requerir autenticación biométrica antes de devolver valores sensibles. Es un reemplazo directo para los flujos de credential-vault de Ionic Identity Vault; tu app mantiene el control de las políticas de timeout, lifecycle, privacy-screen y passcode personalizado.
Compatibilidad
Sección titulada “Compatibilidad”La versión mayor del plugin sigue a Capacitor: v8 para Capacitor 8 (mantenimiento activo), v7 para Capacitor 7 (mantenimiento bajo demanda).
Funcionalidades principales
Sección titulada “Funcionalidades principales”setCredentialsygetCredentials- Almacena y recupera credenciales de forma segura para un servidor dado.getSecureCredentials- Lee credenciales solo después de una verificación biométrica nativa.isCredentialsSavedydeleteCredentials- Crea flujos de onboarding, estado bloqueado y logout.isAvailableyverifyIdentity- Verifica la disponibilidad de autenticación y muestra un prompt al usuario cuando sea necesario.
Público API
Sección titulada “Público API”| Método | Descripción |
|---|---|
isAvailable | Comprueba si el hardware de autenticación biométrica está disponible. |
addListener | Añade un listener que se llama cuando la app vuelve del background. Esto es útil para detectar si la disponibilidad de biometría ha cambiado mientras la app estaba en background (p. ej., el usuario registró/desregistró biometría). |
verifyIdentity | Solicita al usuario que se autentique con biometría. |
getCredentials | Obtiene las credenciales almacenadas para un servidor específico. |
setCredentials | Almacena las credenciales proporcionadas para un servidor específico. |
deleteCredentials | Elimina las credenciales almacenadas para un servidor específico. |
getSecureCredentials | Obtiene las credenciales almacenadas para un servidor específico, requiriendo autenticación biométrica. Las credenciales deben haberse guardado con accessControl establecido en BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
isCredentialsSaved | Comprueba si ya existen credenciales guardadas para un servidor específico. |
getPluginVersion | Obtén la versión del plugin nativo Capacitor. |
Valores de referencia
Sección titulada “Valores de referencia”Usa estos valores al procesar biometricError los resultados de authenticate.
Errores de autenticación biométrica
Sección titulada “Errores de autenticación biométrica”| Valor | Code | Plataforma | Significado |
|---|---|---|---|
UNKNOWN_ERROR | 0 | Android, iOS | Ocurrió un error desconocido. |
BIOMETRICS_UNAVAILABLE | 1 | Android, iOS | La biometría no está disponible porque el hardware falta o no está disponible. |
USER_LOCKOUT | 2 | Android, iOS | El usuario ha sido bloqueado tras demasiados intentos fallidos. |
BIOMETRICS_NOT_ENROLLED | 3 | Android, iOS | No hay datos biométricos registrados en el dispositivo. |
USER_TEMPORARY_LOCKOUT | 4 | Android | El usuario está bloqueado temporalmente, normalmente por 30 segundos. |
AUTHENTICATION_FAILED | 10 | Android, iOS | Error de autenticación. |
APP_CANCEL | 11 | iOS | La app canceló el flujo de autenticación. |
INVALID_CONTEXT | 12 | iOS | El contexto de autenticación no es válido. |
NOT_INTERACTIVE | 13 | iOS | La autenticación no fue interactiva. |
PASSCODE_NOT_SET | 14 | Android, iOS | No se ha configurado un código de dispositivo, PIN o credencial de respaldo. |
SYSTEM_CANCEL | 15 | Android, iOS | El sistema canceló la autenticación (por ejemplo, tras bloquear la pantalla). |
USER_CANCEL | 16 | Android, iOS | El usuario canceló la autenticación. |
USER_FALLBACK | 17 | Android, iOS | El usuario eligió la autenticación de respaldo. |
Fuente de verdad
Sección titulada “Fuente de verdad”Esta referencia se sincroniza desde src/definitions.ts en capacitor-native-biometric.
Continúa desde @capgo/capacitor-native-biometric
Sección titulada “Continúa desde @capgo/capacitor-native-biometric”Si estás usando @capgo/capacitor-native-biometric para planificar los flujos de autenticación y de cuenta, conéctalo con Uso de @capgo/capacitor-native-biometric para la capacidad nativa en Uso de @capgo/capacitor-native-biometric, @capgo/capacitor-social-login para los detalles de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey, Autenticación de dos factores para el detalle de implementación en la autenticación de dos factores, y SSO (Empresa) para el detalle de implementación en SSO (Enterprise).