Biometric Authorization

A Flutter plugin that provides easy-to-use biometric authentication for Android, iOS, and macOS platforms. This plugin allows your app to securely authenticate users using biometric features such as fingerprint, face recognition, and other available biometric methods.

Features

Check if biometric authentication is available on the device
Verify if biometric credentials are enrolled
Get a list of available biometric types (fingerprint, face recognition)
Authenticate users with biometric verification
Support for both default system UI and custom UI for authentication
Cross-platform implementations for Android, iOS, and macOS
Native macOS Touch ID integration with SwiftUI custom UI

Screenshots

iOS Authentication

Touch ID - System UI	Touch ID - Custom UI	Face ID - Custom UI

Android Authentication

Default UI	Custom UI (Sheet)	Custom UI (Dialog)

macOS Authentication

Touch ID - System UI	Touch ID - Custom UI

Platform Support

Android	iOS	macOS
Fingerprint, Face recognition	Face ID, Touch ID	Touch ID
API 21+	iOS 11.0+	macOS 10.15+

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  biometric_authorization: ^1.1.0

Then run:

flutter pub get

Android Setup

Add the following permission to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.USE_BIOMETRIC" />

Important: You must use FlutterFragmentActivity instead of FlutterActivity in your Android project. In your MainActivity.kt file:

import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity: FlutterFragmentActivity() {
    // ...
}

iOS Setup

Add the following to your Info.plist file:

<key>NSFaceIDUsageDescription</key>
<string>Your app needs to authenticate using your biometric data for secure access</string>

macOS Setup

Minimum Version: Ensure your macOS deployment target is at least macOS 10.15 (Catalina) in your macos/Runner.xcodeproj project settings.

Entitlements: No special entitlements are required for Touch ID authentication. The LocalAuthentication framework handles permissions automatically. Your existing entitlements files should work as-is:

<!-- macos/Runner/DebugProfile.entitlements -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>com.apple.security.app-sandbox</key>
    <true/>
    <key>com.apple.security.cs.allow-jit</key>
    <true/>
    <key>com.apple.security.network.server</key>
    <true/>
</dict>
</plist>

Hardware Requirements: Touch ID functionality requires a Mac with Touch ID sensor (MacBook Pro with Touch Bar, MacBook Air 2018+, iMac Pro, Mac Studio, etc.).

Usage

Import the package:

import 'package:biometric_authorization/biometric_authorization.dart';
import 'package:biometric_authorization/biometric_type.dart';

Check Biometric Availability

final biometricAuth = BiometricAuthorization();

// Check if biometric authentication is available
bool isAvailable = await biometricAuth.isBiometricAvailable();

// Check if biometric credentials are enrolled
bool isEnrolled = await biometricAuth.isBiometricEnrolled();

// Get available biometric types
List<BiometricType> types = await biometricAuth.getAvailableBiometricTypes();

Authenticate with Biometrics

Using Default System UI

try {
  bool authenticated = await biometricAuth.authenticate(
    reason: 'Please authenticate to access your account',
    title: 'Biometric Authentication',
    confirmText: 'Verify',
  );

  if (authenticated) {
    // User authenticated successfully
    print('Authentication successful');
  } else {
    // Authentication failed or was cancelled
    print('Authentication failed');
  }
} catch (e) {
  print('Error during authentication: $e');
}

Using Custom UI

bool authenticated = await biometricAuth.authenticate(
  reason: 'Please authenticate to access your account',
  title: 'Biometric Authentication',
  confirmText: 'Verify',
  useCustomUI: true,
);

Using Dialog UI (Available on Android)

bool authenticated = await biometricAuth.authenticate(
  reason: 'Please authenticate to access your account',
  title: 'Biometric Authentication',
  confirmText: 'Verify',
  useDialog: true,
);

Platform-Specific Parameters

The authenticate method has some parameters that behave differently depending on the platform:

biometricType: This parameter is required on iOS and macOS to specify which biometric method to use (face or fingerprint). On Android, it's optional as Android will automatically use available methods.

// Example for iOS/macOS - must specify biometricType
await biometricAuth.authenticate(
  biometricType: BiometricType.fingerprint, // Use Touch ID on macOS
  reason: 'Authenticate to continue',
);

cancelText: This parameter is only effective on Android. It specifies the text for the cancel button in the authentication dialog. On iOS and macOS, this parameter is ignored.
```
// Example for Android - can specify cancelText
await biometricAuth.authenticate(
  reason: 'Authenticate to continue',
  cancelText: 'Not now',
);
```

API Reference