biometric_authorization 1.1.0

A Flutter plugin for biometric authentication on Android, iOS, and macOS. Supports fingerprint, Face ID, Touch ID with both system and custom UI options.

example/lib/main.dart

import 'dart:io';

import 'package:flutter/material.dart';
import 'dart:async';

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

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  bool _isBiometricAvailable = false;
  bool _isBiometricEnrolled = false;
  List<BiometricType> _availableBiometricTypes = [];
  bool _isAuthenticated = false;
  bool _isDarkMode = false;
  final _biometricAuthorizationPlugin = BiometricAuthorization();

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  void _toggleTheme() {
    setState(() {
      _isDarkMode = !_isDarkMode;
    });
  }

  Future<void> initPlatformState() async {
    String platformVersion;
    bool isBiometricAvailable;
    bool isBiometricEnrolled;
    List<BiometricType> availableBiometricTypes;

    try {
      platformVersion =
          await _biometricAuthorizationPlugin.getPlatformVersion() ??
          'Unknown platform version';
      isBiometricAvailable =
          await _biometricAuthorizationPlugin.isBiometricAvailable();
      isBiometricEnrolled =
          await _biometricAuthorizationPlugin.isBiometricEnrolled();
      availableBiometricTypes =
          await _biometricAuthorizationPlugin.getAvailableBiometricTypes();
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
      isBiometricAvailable = false;
      isBiometricEnrolled = false;
      availableBiometricTypes = [];
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
      _isBiometricAvailable = isBiometricAvailable;
      _isBiometricEnrolled = isBiometricEnrolled;
      _availableBiometricTypes = availableBiometricTypes;
    });
  }

  Future<void> _authenticate({
    required bool useCustomUI,
    bool useDialog = false,
  }) async {
    if (_availableBiometricTypes.isEmpty ||
        _availableBiometricTypes.first == BiometricType.none) {
      ScaffoldMessenger.of(context).showSnackBar(
        const SnackBar(content: Text('No biometric authentication available')),
      );
      return;
    }

    try {
      final bool result = await _biometricAuthorizationPlugin.authenticate(
        biometricType: _availableBiometricTypes.first,
        reason: 'Please authenticate to continue',
        title: 'Biometric Authentication',
        confirmText: 'Authenticate',
        useDialogUI: useDialog,
        useCustomUI: useCustomUI,
        cancelText: Platform.isAndroid ? 'Cancel' : null,
      );

      setState(() {
        _isAuthenticated = result;
      });
    } on PlatformException catch (e) {
      debugPrint("Error: ${e.message}");
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        primarySwatch: Colors.blue,
        useMaterial3: true,
        brightness: Brightness.light,
      ),
      darkTheme: ThemeData(
        primarySwatch: Colors.blue,
        useMaterial3: true,
        brightness: Brightness.dark,
      ),
      themeMode: _isDarkMode ? ThemeMode.dark : ThemeMode.light,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Biometric Authorization Example'),
          elevation: 2,
        ),
        body: SingleChildScrollView(
          padding: const EdgeInsets.all(16),
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.start,
            children: [
              Card(
                margin: const EdgeInsets.only(bottom: 16),
                child: Padding(
                  padding: const EdgeInsets.all(16),
                  child: Column(
                    crossAxisAlignment: CrossAxisAlignment.start,
                    children: [
                      const Text(
                        'Device Information',
                        style: TextStyle(
                          fontSize: 18,
                          fontWeight: FontWeight.bold,
                        ),
                      ),
                      const SizedBox(height: 12),
                      InfoRow(label: 'Platform', value: _platformVersion),
                      InfoRow(
                        label: 'Biometric Available',
                        value: _isBiometricAvailable ? 'Yes' : 'No',
                      ),
                      InfoRow(
                        label: 'Biometric Enrolled',
                        value: _isBiometricEnrolled ? 'Yes' : 'No',
                      ),
                      InfoRow(
                        label: 'Available Biometrics',
                        value:
                            _availableBiometricTypes.isEmpty
                                ? 'None'
                                : _availableBiometricTypes
                                    .map((type) => type.name)
                                    .join(', '),
                      ),
                    ],
                  ),
                ),
              ),
              Row(
                children: [
                  Expanded(
                    child: Card(
                      margin: const EdgeInsets.only(bottom: 16),
                      child: Padding(
                        padding: const EdgeInsets.all(16),
                        child: Column(
                          crossAxisAlignment: CrossAxisAlignment.start,
                          children: [
                            const Text(
                              'Authentication Status',
                              style: TextStyle(
                                fontSize: 18,
                                fontWeight: FontWeight.bold,
                              ),
                            ),
                            const SizedBox(height: 12),
                            Container(
                              padding: const EdgeInsets.symmetric(
                                vertical: 8,
                                horizontal: 12,
                              ),
                              decoration: BoxDecoration(
                                color:
                                    _isAuthenticated
                                        ? Colors.green.shade100
                                        : Colors.red.shade100,
                                borderRadius: BorderRadius.circular(4),
                              ),
                              child: Row(
                                mainAxisSize: MainAxisSize.min,
                                children: [
                                  Icon(
                                    _isAuthenticated
                                        ? Icons.check_circle
                                        : Icons.cancel,
                                    color:
                                        _isAuthenticated
                                            ? Colors.green
                                            : Colors.red,
                                  ),
                                  const SizedBox(width: 8),
                                  Text(
                                    _isAuthenticated
                                        ? 'Authenticated'
                                        : 'Not Authenticated',
                                    style: TextStyle(
                                      color:
                                          _isAuthenticated
                                              ? Colors.green.shade900
                                              : Colors.red.shade900,
                                      fontWeight: FontWeight.bold,
                                    ),
                                  ),
                                ],
                              ),
                            ),
                          ],
                        ),
                      ),
                    ),
                  ),
                ],
              ),
              const SizedBox(height: 16),
              const Text(
                'Test Authentication',
                style: TextStyle(fontSize: 18, fontWeight: FontWeight.bold),
              ),
              const SizedBox(height: 16),
              Row(
                children: [
                  Expanded(
                    child: ElevatedButton.icon(
                      onPressed:
                          _isBiometricAvailable && _isBiometricEnrolled
                              ? () => _authenticate(useCustomUI: false)
                              : null,
                      icon: const Icon(Icons.fingerprint),
                      label: const Text('Standard UI'),
                      style: ElevatedButton.styleFrom(
                        padding: const EdgeInsets.symmetric(vertical: 12),
                      ),
                    ),
                  ),
                  const SizedBox(width: 16),
                  Expanded(
                    child: ElevatedButton.icon(
                      onPressed:
                          _isBiometricAvailable && _isBiometricEnrolled
                              ? () => _authenticate(useCustomUI: true)
                              : null,
                      icon: const Icon(Icons.face),
                      label: const Text('Custom UI'),
                      style: ElevatedButton.styleFrom(
                        padding: const EdgeInsets.symmetric(vertical: 12),
                        backgroundColor: Colors.indigo,
                        foregroundColor: Colors.white,
                      ),
                    ),
                  ),
                ],
              ),
              const SizedBox(height: 16),
              if (Platform.isAndroid)
                Row(
                  children: [
                    Expanded(
                      child: ElevatedButton.icon(
                        onPressed:
                            _isBiometricAvailable && _isBiometricEnrolled
                                ? () => _authenticate(
                                  useCustomUI: false,
                                  useDialog: true,
                                )
                                : null,
                        icon: const Icon(Icons.fingerprint),
                        label: const Text('Dialog UI'),
                        style: ElevatedButton.styleFrom(
                          padding: const EdgeInsets.symmetric(vertical: 12),
                        ),
                      ),
                    ),
                    const SizedBox(width: 16),
                    Expanded(
                      child: ElevatedButton.icon(
                        onPressed:
                            _isBiometricAvailable && _isBiometricEnrolled
                                ? () => _authenticate(
                                  useCustomUI: true,
                                  useDialog: true,
                                )
                                : null,
                        icon: const Icon(Icons.face),
                        label: const Text('Dialog UI'),
                        style: ElevatedButton.styleFrom(
                          padding: const EdgeInsets.symmetric(vertical: 12),
                          backgroundColor: Colors.indigo,
                          foregroundColor: Colors.white,
                        ),
                      ),
                    ),
                  ],
                ),
              const SizedBox(height: 16),
              Row(
                children: [
                  Expanded(
                    child: OutlinedButton.icon(
                      onPressed: initPlatformState,
                      icon: const Icon(Icons.refresh),
                      label: const Text('Refresh Status'),
                      style: OutlinedButton.styleFrom(
                        padding: const EdgeInsets.symmetric(
                          vertical: 12,
                          horizontal: 8,
                        ),
                      ),
                    ),
                  ),
                ],
              ),
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _toggleTheme,
          tooltip: '切换主题',
          child: Icon(_isDarkMode ? Icons.light_mode : Icons.dark_mode),
        ),
      ),
    );
  }
}

class InfoRow extends StatelessWidget {
  final String label;
  final String value;

  const InfoRow({super.key, required this.label, required this.value});

  @override
  Widget build(BuildContext context) {
    return Padding(
      padding: const EdgeInsets.only(bottom: 8.0),
      child: Row(
        children: [
          Text('$label: ', style: const TextStyle(fontWeight: FontWeight.bold)),
          Expanded(
            child: Text(
              value,
              style: TextStyle(
                color: Theme.of(context).textTheme.bodyLarge?.color,
              ),
            ),
          ),
        ],
      ),
    );
  }
}