@capgo/capacitor-biométrique

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

Vue d'ensemble

Native Biometric est une boîte de sécurité des informations d'identification pour iOS et Android. Il stocke les informations d'identification dans la clé native ou le magasin de clés et peut exiger une authentification biométrique avant de retourner des valeurs sensibles. Il s'agit d'une remplacement direct des flux de coffre-fort d'identité Ionic Identity Vault ; votre application conserve le contrôle du temps d'attente, du cycle de vie, de l'écran de confidentialité et des politiques de code de passe personnalisé.

Capacités de base

setCredentials et getCredentials - Securely store and retrieve credentials for a given server.
getSecureCredentials - Read credentials only after a native biometric check.
isCredentialsSaved et deleteCredentials - Construire des flux d'inscription, d'état verrouillé et de déconnexion.
isAvailable et verifyIdentity - Vérifiez la disponibilité de l'authentification et demandez au utilisateur quand 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 du fond. 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, utilisateur inscrit/désinscrit des biométries).
`verifyIdentity`	Demande à l'utilisateur d'authentifier avec des biométries.
`getCredentials`	Récupère les informations de connexion stockées pour un serveur donné.
`setCredentials`	Stocke les informations de connexion données pour un serveur donné.
`deleteCredentials`	Supprime les informations de connexion stockées pour un serveur donné.
`getSecureCredentials`	Récupère les informations d'identification stockées pour un serveur donné, nécessitant 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 de connexion 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 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'appareil, le PIN ou le mot de passe de secours n'est pas configuré.
`SYSTEM_CANCEL`	`15`	Android, iOS	Le système a annulé l'authentification, par exemple après 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 à 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’avec En utilisant @capgo/capacitor-native-biometrique pour la capacité native dans En utilisant @capgo/capacitor-native-biometrique, @capgo/capacitor-connexion-social pour le détail d'implémentation dans @capgo/capacitor-connexion-social, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, l'authentification à deux facteurs pour le détail d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour le détail d'implémentation dans SSO (Entreprise).