Aller au contenu

@capgo/capacitor-native-biometric

Stockage sécurisé des identifiants et accès protégé par biométrie pour Android et iOS.

Native Biometric est un coffre-fort d’identifiants sécurisé pour iOS et Android. Il stocke les identifiants dans le Keychain ou le Keystore natif et peut exiger une authentification biométrique avant de renvoyer des valeurs sensibles. Il remplace directement les flux de coffre d’identifiants d’Ionic Identity Vault ; votre app garde la main sur les politiques de timeout, de cycle de vie, de Privacy Screen et de code d’accès personnalisé.

La version majeure du plugin suit Capacitor : v8 pour Capacitor 8 (activement maintenu), v7 pour Capacitor 7 (maintenu sur demande).

  • setCredentials et getCredentials - Stockez et récupérez en toute sécurité les identifiants d'un serveur donné.
  • getSecureCredentials - Ne lisez les identifiants qu'après une vérification biométrique native.
  • isCredentialsSaved et deleteCredentials - Créez des parcours d'onboarding, d'état verrouillé et de déconnexion.
  • isAvailable et verifyIdentity - Vérifiez la disponibilité de l'authentification et affichez un prompt si nécessaire.
MéthodeDescription
isAvailableVérifie si le matériel d'authentification biométrique est disponible.
addListenerAjoute un listener appelé lorsque l'application revient au premier plan. C'est utile pour détecter si la disponibilité de la biométrie a changé pendant que l'application était en arrière-plan (par exemple, si l'utilisateur a ajouté ou supprimé des données biométriques).
verifyIdentityDemande à l'utilisateur de s'authentifier par biométrie.
getCredentialsRécupère les identifiants stockés pour un serveur donné.
setCredentialsEnregistre les identifiants fournis pour un serveur donné.
deleteCredentialsSupprime les identifiants stockés pour un serveur donné.
getSecureCredentialsRé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.
isCredentialsSavedVérifie si des identifiants sont déjà enregistrés pour un serveur donné.
getPluginVersionRécupère la version du plugin natif Capacitor.

Utilisez ces valeurs lors du traitement des biometricError résultats de authenticate.

Erreurs d'authentification biométrique

Section titled “Biometric Auth Errors”
ValeurCodePlateformeSignification
UNKNOWN_ERROR0Android, iOSUne erreur inconnue est survenue.
BIOMETRICS_UNAVAILABLE1Android, iOSLa biométrie est indisponible car le matériel est absent ou indisponible.
USER_LOCKOUT2Android, iOSL'utilisateur est verrouillé après trop de tentatives échouées.
BIOMETRICS_NOT_ENROLLED3Android, iOSAucune donnée biométrique n’est enregistrée sur l’appareil.
USER_TEMPORARY_LOCKOUT4AndroidL'utilisateur est temporairement verrouillé, généralement pendant 30 secondes.
AUTHENTICATION_FAILED10Android, iOSÉchec de l’authentification.
APP_CANCEL11iOSL’application a annulé le flux d’authentification.
INVALID_CONTEXT12iOSLe contexte d’authentification est invalide.
NOT_INTERACTIVE13iOSL’authentification n’était pas interactive.
PASSCODE_NOT_SET14Android, iOSDevice passcode, PIN, or fallback credential is not set.
SYSTEM_CANCEL15Android, iOSLe système a annulé l’authentification, par exemple après le verrouillage de l’écran.
USER_CANCEL16Android, iOSL'utilisateur a annulé l'authentification.
USER_FALLBACK17Android, iOSUser chose fallback authentication.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-native-biometric.

Continuer depuis @capgo/capacitor-native-biometric

Section intitulée « Continuer depuis @capgo/capacitor-native-biometric »

Si vous utilisez @capgo/capacitor-native-biometric pour planifier les flux d'authentification et de compte, le connecter à Utiliser @capgo/capacitor-native-biometric pour la fonctionnalité native dans l'utilisation de @capgo/capacitor-native-biometric, @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 Authentification à deux facteurs pour les détails d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans le SSO (Enterprise).