@capgo/capacitor-native-biometric

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

Aperçu

Native Biometric est un coffre-fort de credentials sécurisé pour iOS et Android. Il stocke les credentials 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 credential-vault d'Ionic Identity Vault ; votre app garde le contrôle du timeout, du cycle de vie, de la privacy-screen et des politiques de passcode personnalisé.

Fonctionnalités clés

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.

API public

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

Utilisez ces valeurs lors du traitement des biometricError résultats 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	La biométrie est indisponible car le matériel est absent ou indisponible.
`USER_LOCKOUT`	`2`	Android, iOS	L'utilisateur est bloqué après trop de tentatives infructueuses.
`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 bloqué, 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	Le code de l'appareil, le code PIN ou l'identifiant de secours n'est pas configuré.
`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é

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

Continuer avec @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).