Resumen
Sección titulada “Resumen”Native Biometric es una caja de seguridad de credenciales segura para iOS y Android. Almacena credenciales en la caja de claves nativa o el almacén de claves y puede requerir una 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 principales
Sección titulada “Capacidades principales”setCredentialsygetCredentials- Almacena y recupera credenciales de manera segura para un servidor determinado.getSecureCredentials- Lee credenciales solo después de una verificación biométrica nativa.isCredentialsSavedydeleteCredentials- Construye flujos de inicio de sesión, estado bloqueado y cierre de sesión.isAvailableyverifyIdentity- Verifica la disponibilidad de autenticación y solicita al usuario cuando sea necesario.
API Público
Título de la sección “API Público”| 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 funcionar desde el fondo. Esto es útil para detectar si la disponibilidad de biometría ha cambiado mientras la aplicación estaba en segundo plano (por ejemplo, el usuario se inscribió/desinscribió biometrías). |
verifyIdentity | Solicita al usuario que se autentique con biometrías. |
getCredentials | Obtiene las credenciales almacenadas para un servidor dado. |
setCredentials | Almacena las credenciales proporcionadas para un servidor determinado. |
deleteCredentials | Elimina las credenciales almacenadas para un servidor determinado. |
getSecureCredentials | Obtiene las credenciales almacenadas para un servidor determinado, requiriendo autenticación biométrica. Las credenciales deben haberse almacenado con accessControl configurado en BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
isCredentialsSaved | Comprueba si las credenciales ya están guardadas para un servidor determinado. |
getPluginVersion | Obtiene la versión nativa del plugin Capacitor. |
Valores de referencia
Sección titulada “Valores de referencia”Utiliza estos valores al manejar biometricError 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 | Las biometrías no están disponibles 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 se han registrado biometrías en el dispositivo. |
USER_TEMPORARY_LOCKOUT | 4 | Android, iOS | 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 | No se ha configurado el código de acceso de la dispositivo, la PIN o la 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 fallback. |
Fuente de Verdad
Sección titulada “Fuente de Verdad”Esta referencia se sincroniza desde src/definitions.ts en capacitor-nativo-biometric.
Sigue adelante desde @capgo/capacitor-nativo-biometric
Sección titulada “Sigue adelante desde @capgo/capacitor-nativo-biometric”Si estás utilizando @capgo/capacitor-biométrica-nativa para planificar la autenticación y los flujos de cuenta, conecta con Usando @capgo/capacitor-biométrica-nativa para la capacidad nativa en Usando @capgo/capacitor-biométrica-nativa, @capgo/capacitor-iniciode-sesión-social para el detalle de implementación en @capgo/capacitor-iniciode-sesión-social, @capgo/capacitor-llave-de-pasaje para el detalle de implementación en @capgo/capacitor-llave-de-pasaje, Autenticación en dos factores para el detalle de implementación en Autenticación en dos factores, y SSO (Empresas) para los detalles de implementación en SSO (Enterprise).