@capgo/capacitor-native-biometrique

Stockage sécurisé des informations d'identification et accès contrôlé par biométrie pour Android et iOS.

Vue d'ensemble

Native Biometric est une boîte de sécurité de jetons d'accès pour iOS et Android. Il stocke les informations d'identification dans le cléchain ou le clésafe natif et peut exiger une authentification biométrique avant de retourner des valeurs sensibles. Il s'agit d'une remplacement direct de la fonctionnalité de coffre-fort d'identité 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é.

Capacités de base

setCredentials et getCredentials - Stockez et récupérez de manière sécurisée des informations d'identification pour un serveur donné.
getSecureCredentials - Lisez les informations d'identification uniquement après une vérification biométrique native.
isCredentialsSaved et deleteCredentials - Créez des flux de mise en route, d'état verrouillé et de déconnexion.
isAvailable et verifyIdentity - Vérifiez la disponibilité de l'authentification biométrique et incitez l'utilisateur lorsque cela est nécessaire.

Public API

Méthode	Description
`isAvailable`	Vérifie si le matériel d'authentification biométrique est disponible.
`addListener`	Ajoutez un écouteur qui est appelé lorsque l'application reprend du background. Cela 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, l'utilisateur s'est inscrit/désinscrit des biométries).
`verifyIdentity`	Demande à l'utilisateur de s'authentifier avec des biométriques.
`getCredentials`	Récupère 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`	Récupère 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`	Obtenez 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 s'est produite.
`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-native-biometric.

Continuez de là à @capgo/capacitor-native-biometric

Si vous utilisez @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-biometric @capgo/capacitor-native-biometric Pour planifier l'authentification et les flux de compte, connectez-le à En utilisant @capgo/capacitor-native-biometric pour la capacité native dans En utilisant @capgo/capacitor-native-biometric, @capgo/capacitor-social-login pour le détail d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, La deuxième facteur d'authentification pour les détails d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).