🛡️ Simple Local Auth #

A lightweight and developer-friendly Flutter plugin to authenticate users using local biometric methods such as Fingerprint, Face ID, and other platform-specific mechanisms.

✨ Features #

• Check biometric hardware availability
• Detect enrolled biometrics
• Support for Fingerprint and Face ID
• Simple API to trigger biometric authentication
• Smooth integration for Android and iOS

📦 Installation #

Add the package to your pubspec.yaml:

dependencies:
  simple_local_auth: ^1.0.0

Then run:

flutter pub get

⚙️ Platform Setup #

Android #

1. Update your android/app/build.gradle:

minSdkVersion 23

2. Add permissions to AndroidManifest.xml (usually not required, but ensure biometric support is enabled):

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

iOS #

1. Add the following to your Info.plist:

<key>NSFaceIDUsageDescription</key>
<string>This app uses Face ID to authenticate the user</string>

2. Ensure your app has a Deployment Target of iOS 11.0+ in ios/Podfile.

🚀 Getting Started #

Import the package #

import 'package:simple_local_auth/simple_local_auth.dart';
import 'package:simple_local_auth/models/auth_results.dart';

Check Biometric Availability #

final availability = await SimpleLocalAuth.getAvailabilityDetails();
if (availability.hasHardware && availability.hasEnrolledBiometrics) {
  // Safe to prompt for authentication
}

Authenticate User #

final result = await SimpleLocalAuth.authenticate(
  reason: 'Please authenticate to proceed',
  cancelButton: 'Cancel',
);

if (result.success) {
  // Authentication successful
} else {
  // Handle failure
}

🧪 Example App #

A full-featured example is included in the example/ directory.

Run it:

cd example
flutter run

The app shows:

• Biometric availability
• Authentication status
• Feedback on success/failure

📷 UI Preview #

✅ Capabilities Checked #

• Hardware Availability ✅
• Biometrics Enrolled ✅
• Fingerprint Support ✅
• Face ID Support ✅

📌 Notes #

• On some Android devices, users must manually enroll biometrics.
• On iOS, make sure Face ID/Touch ID is configured in device settings.

🤝 Contributing #

Contributions are welcome! To contribute:

1. Fork the repository
2. Create a new branch
3. Submit a pull request with a clear description

📄 License #

MIT License

Built with ❤️ by [Tamremariam Belete].

simple_local_auth/ ├── lib/ │ ├── simple_local_auth.dart # Main export file │ ├── models/ │ │ ├── auth_results.dart │ │ ├── biometric_availability.dart │ ├── exceptions/ │ │ ├── auth_exceptions.dart │ ├── src/ │ │ ├── simple_local_auth_impl.dart # Implementation │ │ ├── types.dart # Enums and types