Allez directement au contenu principal
@capgo/capacitor-biométrie-native Auth & Sécurité Open source

Biométrie native plugin Capacitor

Authentification sécurisée à l'aide des API de Face ID, Touch ID et Android

Installer

bun add @capgo/capacitor-native-biometric bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-native-biometric
  • pnpm add @capgo/capacitor-native-biometric
  • yarn add @capgo/capacitor-native-biometric

Guide

Comment utiliser les biométriques natives dans Capacitor

Tester sur appareil

Téléchargez l'application Capgo, puis scannez le QR code.

Prévisualisation du plugin de biométrie native QR code

En utilisant @capgo/capacitor-native-biometric

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

Installer

bun add @capgo/capacitor-native-biometric
bunx cap sync

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

Importer

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

API en un coup d'œil

Méthode Description
isAvailable Vérifie si un matériel d'authentification biométrique est disponible.
verifyIdentity Authentifie l'utilisateur à l'aide de ses données biométriques.
getCredentials Récupère les informations de connexion stockées pour un serveur donné.
setCredentials Stocke les informations de connexion données pour un serveur donné.
deleteCredentials Supprime les informations de connexion stockées pour un serveur donné.
getSecureCredentials Récupère les informations de connexion stockées pour un serveur donné, en exigeant une authentification biométrique. Les informations de connexion doivent avoir été stockées avec accessControl défini sur BIOMETRY_CURRENT_SET ou BIOMETRY_ANY.
isCredentialsSaved Vérifie si des informations de connexion sont déjà enregistrées pour un serveur donné.
setData Enregistre une valeur de chaîne arbitraire sous la clé donnée. Les valeurs sont chiffrées en stockage à l'aide du backend de stockage sécurisé de la plateforme (Android Keystore + SharedPreferences, Keychain iOS).
getData Récupère une valeur stockée précédemment pour la clé donnée. Ne retourne que les valeurs stockées sans biométrique. 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 à BIOMETRIE_CURRENT_SET ou BIOMETRIE_ANY.
deleteData Supprime la valeur stockée pour la clé spécifiée (protégée et non protégée).
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()

Authentifie l'utilisateur à l'aide de ses données biométriques.

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

await NativeBiometric.verifyIdentity();

getCredentials()

Gets the stored credentials for a given server.

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

Stores the given credentials for a given server.

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

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

deleteCredentials()

Supprime les informations de connexion stockées pour un serveur spécifique.

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

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

getSecureCredentials()

Obtient les informations d'identification stockées pour un serveur donné, nécessitant une authentification biométrique. Les informations d'identification doivent avoir été stockées 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.

La table ci-dessus liste les 12 méthodes de base. Les écouteurs et les assistants de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le GitHub dépôt.

Écoutez les événements

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

Référence complète

Continuez à partir de l'utilisation de @capgo/capacitor-native-biometric

Si vous utilisez Utilisez @capgo/capacitor-native-biometric pour planifier l'authentification et les flux de compte, connectez-l’avec @capgo/capacitor-biométrique native pour les détails d'implémentation dans @capgo/capacitor-native-biometric, Prise en main pour les détails d'implémentation dans Prise en main, @capgo/capacitor-connexion-social 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 dans Authentification à deux facteurs.

FAQ

FAQ du plugin de biometrique native

How install the Native Biometric plugin in a Capacitor app?

Exécutez "bun add @capgo/capacitor-native-biometric" (ou "npm install @capgo/capacitor-native-biometric"), puis exécutez "bunx cap sync" afin que les projets iOS et Android prennent en compte le code natif. Importez-l’à partir de "@capgo/capacitor-native-biometric" dans votre application code.

Le plugin @capgo/capacitor-native-biometric fonctionne-t-il avec React, Vue et Angular ?

Oui. Le package Native Biometric est un Capacitor, il fonctionne donc avec tout framework web qui s'exécute à l'intérieur d'un Capacitor, y compris Ionic, React, Vue, Angular, Svelte et JavaScript pur.

Quelle version de Capacitor est prise en charge par @capgo/capacitor-native-biometric ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple, plugin v8 avec Capacitor 8). La table de compatibilité dans le fichier README du GitHub liste les versions maintenues.

Le plugin @capgo/capacitor-native-biometric est-il gratuit et open source ?

Oui. Le code source code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-native-biometric/ et le package est gratuit pour l'installer à partir de npm. Les rapports de bogues et les demandes de modification sont les bienvenus.

Puis-je mettre à jour code qui utilise Native Biometric sans passer par une revue de l'App Store ?

L'installation ou la mise à niveau du plugin change le code natif, il faut donc une nouvelle mise à jour de l'application. Après cela, les modifications JavaScript, HTML et CSS qui appellent le plugin peuvent être déployées instantanément avec les mises à jour Capgo.

Envoyez les modifications Native Biométrique sans attendre l'examen de l'application

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Commencez avec Capgo