Biometric
A Capacitor plugin for biometric authentication and secure credential storage on iOS and Android.
What is Biometric?
Capacitor Native Biometric is a plugin for Capacitor-based mobile applications that adds biometric authentication capabilities. It allows developers to verify user identity using device biometrics (like Face ID or fingerprint) and securely store user credentials. The plugin provides a unified JavaScript API that works across both iOS and Android, handling platform-specific implementations internally.
Mobile developers building cross-platform apps with Capacitor who need to integrate biometric login or secure credential storage. It's particularly useful for apps requiring enhanced security and user convenience.
Developers choose this plugin because it offers a straightforward, cross-platform API for biometric features without needing to write native code for each platform. It securely leverages iOS Keychain and Android Keystore, provides detailed biometry detection, and includes comprehensive error handling.
Overview
Capacitor Native Biometric is a plugin that enables biometric authentication (Face ID, Touch ID, fingerprint) in Capacitor mobile apps. It provides a unified API to verify user identity and securely store credentials using platform-native secure storage (Keychain on iOS, Keystore on Android).
Key Features
- Biometric Verification — Presents a native biometric prompt to confirm device owner presence or authenticate users.
- Secure Credential Storage — Stores usernames and passwords securely using platform-specific secure storage systems.
- Credential Management — Provides methods to set, retrieve, and delete credentials associated with a server identifier.
- Biometry Type Detection — Detects available biometric hardware (Face ID, Touch ID, fingerprint, etc.) on the device.
- Cross-Platform Error Handling — Consolidates Android and iOS biometric authentication errors into a unified error code list.
- Customizable Prompts — Allows customization of the biometric prompt's title, subtitle, reason, and button text.
Philosophy
The plugin aims to provide a simple, consistent API for biometric authentication across iOS and Android, leveraging each platform's native security features without abstracting away their capabilities.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
