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é.
Compatibilité
Section intitulée « Compatibilité »La version majeure du plugin suit Capacitor : v8 pour Capacitor 8 (activement maintenu), v7 pour Capacitor 7 (maintenu sur demande).
Fonctionnalités clés
Section intitulée « Fonctionnalités clés »setCredentialsetgetCredentials- 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.isCredentialsSavedetdeleteCredentials- Créez des parcours d'onboarding, d'état verrouillé et de déconnexion.isAvailableetverifyIdentity- Vérifiez la disponibilité de l'authentification et affichez un prompt si nécessaire.
API public
Section intitulée « Public API »| Méthode | Description |
|---|---|
isAvailable | Vérifie si le matériel d'authentification biométrique est disponible. |
addListener | Ajoute 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). |
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é. |
getPluginVersion | Récupère la version du plugin natif Capacitor. |
Valeurs de référence
Section intitulée « Valeurs de référence »Utilisez ces valeurs lors du traitement des biometricError résultats de authenticate.
Erreurs d'authentification biométrique
Section titled “Biometric Auth Errors”| Valeur | Code | Plateforme | Signification |
|---|---|---|---|
UNKNOWN_ERROR | 0 | Android, iOS | Une erreur inconnue est survenue. |
BIOMETRICS_UNAVAILABLE | 1 | Android, iOS | La biométrie est indisponible car le matériel est absent ou indisponible. |
USER_LOCKOUT | 2 | Android, iOS | L'utilisateur est verrouillé après trop de tentatives échouées. |
BIOMETRICS_NOT_ENROLLED | 3 | Android, iOS | Aucune donnée biométrique n’est enregistrée sur l’appareil. |
USER_TEMPORARY_LOCKOUT | 4 | Android | L'utilisateur est temporairement verrouillé, généralement pendant 30 secondes. |
AUTHENTICATION_FAILED | 10 | Android, iOS | Échec de l’authentification. |
APP_CANCEL | 11 | iOS | L’application a annulé le flux d’authentification. |
INVALID_CONTEXT | 12 | iOS | Le contexte d’authentification est invalide. |
NOT_INTERACTIVE | 13 | iOS | L’authentification n’était pas interactive. |
PASSCODE_NOT_SET | 14 | Android, iOS | Device passcode, PIN, or fallback credential is not set. |
SYSTEM_CANCEL | 15 | Android, iOS | Le système a annulé l’authentification, par exemple après le verrouillage de l’écran. |
USER_CANCEL | 16 | Android, iOS | L'utilisateur a annulé l'authentification. |
USER_FALLBACK | 17 | Android, iOS | User chose fallback authentication. |
Source de vérité
Section intitulée « Source de vérité »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).