@capgo/capacitor-native-biometric

Resumen

Native Biometric es un almacén de credenciales seguro para iOS y Android. Guarda 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 Ionic Identity Vault; tu app mantiene el control de los tiempos de espera, el ciclo de vida, la privacidad de pantalla y las políticas de código de acceso personalizado.

Funcionalidades principales

• setCredentials y getCredentials - Almacena y recupera credenciales de forma segura para un servidor específico.
• getSecureCredentials - Lee las credenciales solo tras una validación biométrica nativa.
• isCredentialsSaved y deleteCredentials - Crea flujos de onboarding, estados bloqueados y logout.
• isAvailable y verifyIdentity - Verifica la disponibilidad de autenticación y muestra un prompt al usuario cuando sea necesario.

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 ejecuta cuando la app vuelve del background. Es útil para detectar si la disponibilidad de biometría ha cambiado mientras la app estaba en segundo plano (por ejemplo, si el usuario registró o eliminó 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

Usa estos valores al manejar biometricError los resultados de authenticate.

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 falta el hardware 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

Esta referencia se sincroniza desde src/definitions.ts en capacitor-native-biometric.

Continuar 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 Usando @capgo/capacitor-native-biometric para la funcionalidad nativa en Usando @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 (Enterprise) para el detalle de implementación en SSO (Enterprise).