Saltar al contenido

@capgo/capacitor-native-biometric

Almacenamiento seguro de credenciales y acceso con biometría para Android e iOS.

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.

La versión mayor del plugin sigue a Capacitor: v8 para Capacitor 8 (mantenimiento activo), v7 para Capacitor 7 (mantenimiento bajo demanda).

  • setCredentials y getCredentials - Almacena y recupera credenciales de forma segura para un servidor dado.
  • getSecureCredentials - Lee credenciales solo después de una verificación biométrica nativa.
  • isCredentialsSaved y deleteCredentials - Crea flujos de onboarding, estado bloqueado y logout.
  • isAvailable y verifyIdentity - Verifica la disponibilidad de autenticación y muestra un prompt al usuario cuando sea necesario.
MétodoDescripción
isAvailableComprueba si el hardware de autenticación biométrica está disponible.
addListenerAñ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).
verifyIdentitySolicita al usuario que se autentique con biometría.
getCredentialsObtiene las credenciales almacenadas para un servidor específico.
setCredentialsAlmacena las credenciales proporcionadas para un servidor específico.
deleteCredentialsElimina las credenciales almacenadas para un servidor específico.
getSecureCredentialsObtiene 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.
isCredentialsSavedComprueba si ya existen credenciales guardadas para un servidor específico.
getPluginVersionObtén la versión del plugin nativo Capacitor.

Usa estos valores al procesar biometricError los resultados de authenticate.

ValorCodePlataformaSignificado
UNKNOWN_ERROR0Android, iOSOcurrió un error desconocido.
BIOMETRICS_UNAVAILABLE1Android, iOSLa biometría no está disponible porque el hardware falta o no está disponible.
USER_LOCKOUT2Android, iOSEl usuario ha sido bloqueado tras demasiados intentos fallidos.
BIOMETRICS_NOT_ENROLLED3Android, iOSNo hay datos biométricos registrados en el dispositivo.
USER_TEMPORARY_LOCKOUT4AndroidEl usuario está bloqueado temporalmente, normalmente por 30 segundos.
AUTHENTICATION_FAILED10Android, iOSError de autenticación.
APP_CANCEL11iOSLa app canceló el flujo de autenticación.
INVALID_CONTEXT12iOSEl contexto de autenticación no es válido.
NOT_INTERACTIVE13iOSLa autenticación no fue interactiva.
PASSCODE_NOT_SET14Android, iOSNo se ha configurado un código de dispositivo, PIN o credencial de respaldo.
SYSTEM_CANCEL15Android, iOSEl sistema canceló la autenticación (por ejemplo, tras bloquear la pantalla).
USER_CANCEL16Android, iOSEl usuario canceló la autenticación.
USER_FALLBACK17Android, iOSEl usuario eligió la autenticación de respaldo.

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).