@capgo/capacitor-native-biometric

Vue d'ensemble

Native Biometric est un coffre-fort de données personnelles sécurisé pour iOS et Android. Il stocke les données personnelles dans le coffre-fort natif ou le coffre-fort et peut exiger une authentification biométrique avant de retourner des valeurs sensibles. Il s'agit d'une substitution directe pour les flux de coffre-fort de données personnelles Ionic Identity Vault ; votre application conserve le contrôle des politiques de temps limite, de cycle de vie, d'écran de confidentialité et de mot de passe personnalisé.

Fonctionnalités de base

• setCredentials et getCredentials - Stocker et récupérer de manière sécurisée les informations d'identification pour un serveur donné.
• getSecureCredentials - Ne lire les informations d'identification qu'après avoir effectué une vérification biométrique native.
• isCredentialsSaved et deleteCredentials - Créer des flux de connexion, de blocage et de déconnexion.
• isAvailable et verifyIdentity - Vérifier la disponibilité de l'authentification biométrique et demander à l'utilisateur de s'y connecter lorsque nécessaire.

Public API

Méthode	Description
isAvailable	Vérifie si le matériel d'authentification biométrique est disponible.
addListener	Ajoute un écouteur qui est appelé lorsque l'application reprend de l'arrière-plan. Cela est utile pour détecter si la disponibilité des biométries a changé pendant que l'application était en arrière-plan (par exemple, l'utilisateur s'est inscrit/désinscrit des biométries).
verifyIdentity	Invite l'utilisateur à s'authentifier avec des biométries.
getCredentials	Obtient les informations d'identification stockées pour un serveur donné.
setCredentials	Stocke les informations d'identification données pour un serveur donné.
deleteCredentials	Supprime les informations d'identification stockées pour un serveur donné.
getSecureCredentials	Obtient les informations d'identification stockées pour un serveur donné, en exigeant une authentification biométrique. Les informations d'identification doivent avoir été stockées avec accessControl défini sur BIOMETRY_CURRENT_SET ou BIOMETRY_ANY.
isCredentialsSaved	Vérifie si les informations d'identification sont déjà enregistrées pour un serveur donné.
getPluginVersion	Obtient la version native du plugin Capacitor.

Valeurs de référence

Utilisez ces valeurs lors de la gestion biometricError des résultats provenant de authenticate.

Erreurs d'authentification biométrique

Valeur	Code	Plateforme	Signification
UNKNOWN_ERROR	0	Android, iOS	Une erreur inconnue est survenue.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	Les biométriques sont indisponibles car le matériel est manquant ou indisponible.
USER_LOCKOUT	2	Android, iOS	L'utilisateur est bloqué après trop d'essais ratés.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Aucune donnée biométrique n'est enregistrée sur le dispositif.
USER_TEMPORARY_LOCKOUT	4	Android	L'utilisateur est temporairement bloqué, généralement pendant 30 secondes.
AUTHENTICATION_FAILED	10	Android, iOS	L'authentification a échoué.
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	Le code d'accès, le PIN ou le mot de passe de secours n'est pas configuré.
SYSTEM_CANCEL	15	Android, iOS	L'authentification a été annulée par le système, par exemple après verrouillage d'écran.
USER_CANCEL	16	Android, iOS	L'utilisateur a annulé l'authentification.
USER_FALLBACK	17	Android, iOS	L'utilisateur a choisi l'authentification de secours.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts dans capacitor-biométrique native.

Continuez à partir de @capgo/capacitor-biométrique native

Si vous utilisez @capgo/capacitor-biométrique native pour planifier l'authentification et les flux de compte, connectez-l’à En utilisant @capgo/capacitor-biométrique native pour la capacité native dans En utilisant @capgo/capacitor-biométrique native, @capgo/capacitor-connexion sociale pour le détail d'implémentation dans @capgo/capacitor-connexion sociale, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, Authentification à deux facteurs pour les détails d'implémentation dans Authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).