Guía
Cómo usar Native Biometric en Capacitor
Usando @capgo/capacitor-native-biometric
Este plugin da acceso a las APIs biométricas nativas de Android e iOS.
Instalar
bun add @capgo/capacitor-native-biometric
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
API de un vistazo
| Método | Descripción |
|---|---|
isAvailable |
Comprueba si el hardware de autenticación biométrica está disponible. |
verifyIdentity |
Solicita al usuario que se autentique mediante 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 de un servidor específico. |
getSecureCredentials |
Obtiene las credenciales de un servidor mediante autenticación biométrica. Deben haberse guardado con accessControl en BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
isCredentialsSaved |
Comprueba si ya existen credenciales guardadas para un servidor. |
setData |
Guarda un valor de texto bajo una clave específica. Los valores se cifran en reposo usando el almacenamiento seguro de la plataforma (Android Keystore + SharedPreferences, iOS Keychain). |
getData |
Obtiene un valor guardado previamente para una clave. Solo devuelve valores sin protección biométrica. accessControl. |
getSecureData |
Obtiene un valor protegido por biometría para una clave. El valor debe haberse guardado con accessControl el ajuste BIOMETRY_CURRENT_SET o BIOMETRY_ANY. |
deleteData |
Elimina el valor almacenado para la clave indicada (protegida o no). |
isDataSaved |
Comprueba si ya existe un valor guardado para la clave indicada. |
Ejemplos
isAvailable()
Comprueba si el hardware de autenticación biométrica está disponible.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.isAvailable();
console.log(result);
verifyIdentity()
Solicita al usuario que se autentique mediante biometría.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
Obtiene las credenciales almacenadas para un servidor específico.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
setCredentials()
Almacena las credenciales proporcionadas para un servidor específico.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
Elimina las credenciales almacenadas para un servidor específico.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
Obtiene las credenciales de un servidor mediante autenticación biométrica. Deben haberse guardado con accessControl en BIOMETRY_CURRENT_SET o BIOMETRY_ANY.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
La tabla anterior detalla los 12 métodos principales. Los helpers de Listener, versión y el contrato completo de cada método están en la repositorio de GitHub.
Escuchar eventos
addListener devuelve un handle. Llama a handle.remove() cuando la pantalla se desmonta.
Referencia completa
Continúa desde Usando @capgo/capacitor-native-biometric
Si estás usando Usando @capgo/capacitor-native-biometric para planificar flujos de autenticación y cuentas, conéctalo con @capgo/capacitor-native-biometric para los detalles de implementación en @capgo/capacitor-native-biometric, Primeros pasos para los detalles de implementación en Primeros pasos, @capgo/capacitor-social-login para el detalle de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey para los detalles de implementación en @capgo/capacitor-passkey, y Autenticación de dos factores para los detalles de implementación en la autenticación de dos factores.