@capgo/capacitor-biométrico nativo

Resumen

Native Biometric es una caja de seguridad de credenciales segura para iOS y Android. Almacena credenciales en la caja de llaves nativa o el almacén de claves 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; la aplicación mantiene el control de los plazos de tiempo, el ciclo de vida, la pantalla de privacidad y las políticas de contraseña personalizada.

Capacidades principales

• setCredentials y getCredentials Almacenar y recuperar credenciales de manera segura para un servidor determinado.
• getSecureCredentials Leer credenciales solo después de un control biométrico nativo.
• isCredentialsSaved y deleteCredentials Crear flujos de inicio de sesión, estado bloqueado y cierre de sesión.
• isAvailable y verifyIdentity Verifique la disponibilidad de autenticación y solicite al usuario cuando sea necesario.

Publico 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 ha inscrito/desinscrito de la biometría).
verifyIdentity	Solicita al usuario que se autentique con biometría.
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 los credenciales están guardadas para un servidor dado.
getPluginVersion	Obtén la versión del plugin nativo 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	La biometría no está disponible debido a la falta de hardware.
USER_LOCKOUT	2	Android, iOS	El usuario está bloqueado después de demasiados intentos fallidos.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	No hay biometrios registrados en el dispositivo.
USER_TEMPORARY_LOCKOUT	4	Android	El usuario está temporalmente bloqueado, típicamente durante 30 segundos.
AUTHENTICATION_FAILED	10	Android, iOS	La autenticación falló.
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	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, 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 por defecto.

Fuente de Verdad

Esta referencia está sincronizada desde src/definitions.ts en capacitor-biométrico nativo.

Sigue adelante desde @capgo/capacitor-biométrico nativo

Si está utilizando @capgo/capacitor-biométrico nativo para planificar la autenticación y los flujos de cuenta, conecte con Usando @capgo/capacitor-biométrico nativo para la capacidad nativa en Usando @capgo/capacitor-biométrico nativo, @capgo/capacitor-iniciode sesión social para el detalle de implementación en @capgo/capacitor-iniciode sesión social, @capgo/capacitor-clave de acceso para el detalle de implementación en @capgo/capacitor-clave de acceso, Autenticación en dos factores para el detalle de implementación en Autenticación en dos factores, y SSO (Empresas) para el detalle de implementación en SSO (Empresas).