Biométrie native Plugin Capacitor

Utiliser @capgo/capacitor-native-biometric

Ce plugin donne accès aux API biométriques natives pour Android et iOS.

Compatibilité

La version majeure du plugin suit Capacitor : utilisez v8 pour Capacitor 8 (activement maintenu) et v7 pour Capacitor 7 (maintenu sur demande). Voir le tableau de compatibilité.

Installer

# Capacitor 8
bun add @capgo/capacitor-native-biometric@8
# Capacitor 7
bun add @capgo/capacitor-native-biometric@7
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

Aperçu de API

Méthode	Description
isAvailable	Vérifie si le matériel d'authentification biométrique est disponible.
verifyIdentity	Demande à l'utilisateur de s'authentifier par biométrie.
getCredentials	Récupère les identifiants stockés pour un serveur donné.
setCredentials	Enregistre les identifiants fournis pour un serveur donné.
deleteCredentials	Supprime les identifiants stockés pour un serveur donné.
getSecureCredentials	Récupère les identifiants stockés pour un serveur donné, avec authentification biométrique requise. Les identifiants doivent avoir été stockés avec accessControl défini sur BIOMETRY_CURRENT_SET ou BIOMETRY_ANY.
isCredentialsSaved	Vérifie si des identifiants sont déjà enregistrés pour un serveur donné.
setData	Stocke une valeur de chaîne arbitraire sous la clé donnée. Les valeurs sont chiffrées au repos via le backend de stockage sécurisé de la plateforme (Android Keystore + SharedPreferences, iOS Keychain).
getData	Récupère une valeur précédemment stockée pour la clé donnée. Ne renvoie que les valeurs stockées sans biométrie accessControl.
getSecureData	Récupère une valeur protégée par biométrie pour la clé donnée. La valeur doit avoir été stockée avec accessControl défini sur BIOMETRY_CURRENT_SET ou BIOMETRY_ANY.
deleteData	Supprime la valeur stockée pour la clé donnée (protégée ou non).
isDataSaved	Vérifie si une valeur est déjà enregistrée pour la clé donnée.

Exemples

isAvailable()

Vérifie si le matériel d'authentification biométrique est disponible.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

const result = await NativeBiometric.isAvailable();
console.log(result);

verifyIdentity()

Demande à l'utilisateur de s'authentifier par biométrie.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.verifyIdentity();

getCredentials()

Récupère les identifiants stockés pour un serveur donné.

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

Enregistre les identifiants fournis pour un serveur donné.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.setCredentials({
  username: 'username',
  password: 'password',
  server: 'example.com',
});

deleteCredentials()

Supprime les identifiants stockés pour un serveur donné.

import { NativeBiometric } from '@capgo/capacitor-native-biometric';

await NativeBiometric.deleteCredentials({ server: 'example.com' });

getSecureCredentials()

Récupère les identifiants stockés pour un serveur donné, avec authentification biométrique requise. Les identifiants doivent avoir été stockés avec accessControl défini sur BIOMETRY_CURRENT_SET ou 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.

Le tableau ci-dessus liste les 12 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lorsque l'écran est démonté.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer à partir de « Utiliser @capgo/capacitor-native-biometric »

Si vous utilisez Utiliser @capgo/capacitor-native-biometric pour planifier les flux d'authentification et de compte, le connecter à @capgo/capacitor-native-biometric pour les détails d'implémentation dans @capgo/capacitor-native-biometric, Prise en main pour les détails d'implémentation dans Getting Started @capgo/capacitor-social-login pour les détails d'implémentation dans @capgo/capacitor-social-login @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey, et Authentification à deux facteurs pour les détails d'implémentation de l'authentification à deux facteurs.