A Capacitor plugin for biometric authentication and secure credential storage on iOS and Android.
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.
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).
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.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Provides a consistent JavaScript interface for biometric authentication on both iOS and Android, abstracting platform-specific details like Keychain and Keystore, as shown in the usage examples.
Leverages iOS Keychain and Android Keystore to securely store user credentials, ensuring high security standards without custom implementation, as detailed in the setCredentials method.
Detects and reports specific biometric hardware types (e.g., Face ID, Touch ID) through the isAvailable method, allowing for customized user experiences based on device capabilities.
Consolidates Android and iOS biometric errors into a unified error code list, simplifying error management across platforms, as documented in the Biometric Auth Errors table.
Only supports Capacitor 3 and 4, as stated in the installation section, which excludes newer versions like Capacitor 5 and could hinder adoption in evolving projects.
Requires manual setup such as adding NSFaceIDUsageDescription in iOS plist and permissions in AndroidManifest, adding complexity compared to more plug-and-play solutions.
The README explicitly notes it hasn't been tested on Android API level 22 or lower, posing a risk for apps that need to support older devices.
While it includes a useFallback option, the plugin focuses primarily on biometrics and doesn't provide out-of-the-box alternatives like password-based authentication flows.