@capgo/capacitor-native-biometric

Resumen

Native Biometric es una caja de seguridad de credenciales segura para iOS y Android. Almacena credenciales en el Keychain nativo o Keystore y puede requerir autenticación biométrica antes de devolver valores sensibles. Es un reemplazo directo de las flujos de caja de seguridad de credenciales de Ionic Identity Vault; su aplicación mantiene el control de los plazos, el ciclo de vida, la pantalla de privacidad y las políticas de contraseña personalizada.

Capacidades básicas

• setCredentials y getCredentials - Almacena y recupera credenciales de manera segura para un servidor determinado.
• getSecureCredentials - Lee credenciales solo después de una verificación biométrica nativa.
• isCredentialsSaved y deleteCredentials - Crea flujos de inicio de sesión, estado bloqueado y cierre de sesión.
• isAvailable y verifyIdentity - Verifica la disponibilidad de autenticación biométrica y solicita al usuario cuando sea necesario.

Public API

Método	Descripción
isAvailable	Verifica si el hardware de autenticación biométrica está disponible.
addListener	Agrega un oyente que se llama cuando la aplicación vuelve a estar en segundo plano. Esto es útil para detectar si la disponibilidad de la biometría ha cambiado mientras la aplicación estaba en segundo plano (por ejemplo, el usuario se inscribió/desinscribió biometrías).
verifyIdentity	Indica al usuario que autenticar con biometrías.
getCredentials	Obtiene las credenciales almacenadas para un servidor dado.
setCredentials	Almacena las credenciales dadas para un servidor dado.
deleteCredentials	Borra las credenciales almacenadas para un servidor dado.
getSecureCredentials	Obtiene las credenciales almacenadas para un servidor dado, requiriendo autenticación biométrica. Las credenciales deben haberse almacenado con accessControl establecido en BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
isCredentialsSaved	Verifica si las credenciales ya están guardadas para un servidor dado.
getPluginVersion	Obtiene la versión nativa del plugin Capacitor.

Valores de Referencia

Utiliza estos valores al manejar biometricError 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	Los biometrios están inaccesibles porque el hardware está ausente o no está disponible.
USER_LOCKOUT	2	Android, iOS	El usuario está bloqueado después de demasiados intentos fallidos.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	No hay biometrías registradas en el dispositivo.
USER_TEMPORARY_LOCKOUT	4	Android	El usuario está temporalmente bloqueado, típicamente durante 30 segundos.
AUTHENTICATION_FAILED	10	Android, iOS	Falló la autenticación.
APP_CANCEL	11	iOS	La aplicación canceló el flujo de autenticación.
INVALID_CONTEXT	12	iOS	El contexto de autenticación es inválido.
NOT_INTERACTIVE	13	iOS	La autenticación no fue interactiva.
PASSCODE_NOT_SET	14	Android, iOS	El dispositivo no tiene configurado un código de acceso, PIN o credencial de respaldo.
SYSTEM_CANCEL	15	Android, iOS	El sistema canceló la autenticación, por ejemplo después de 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 está sincronizada desde src/definitions.ts en capacitor-biométrico-nativo.

Seguir adelante desde @capgo/capacitor-native-biometric

Si estás utilizando @capgo/capacitor-native-biometric para planificar flujos de autenticación y cuentas, conecta con Usando @capgo/capacitor-native-biometric para la capacidad nativa en Usando @capgo/capacitor-native-biometric, @capgo/capacitor-social-login para el detalle 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 los detalles de implementación en la autenticación de dos factores, y SSO (Empresas) para los detalles de implementación en SSO (Empresas).