secure_biometrics 0.1.0+1

A package for secure biometrics authentication.

Secure Biometrics

A Flutter package that implements secure biometric operations with cryptographic key pairs. This package enables biometric authentication without storing raw biometric data, instead using the device's secure hardware and cryptographic operations.

Core Features

• Biometric authentication using device hardware
• RSA key pair generation and secure storage
• Challenge-response based authentication
• Private key protection with biometric access
• Public key export in PEM format
• Failed attempts tracking and management
• Fallback mechanisms for key loss

How It Works

1. Device generates an RSA key pair during setup
2. Private key is stored securely, protected by biometric authentication
3. Public key can be shared with your server
4. Authentication uses challenge-response with cryptographic signatures
5. All biometric operations use device hardware - no biometric data is stored

Getting Started

Prerequisites

This package uses local_auth for biometric operations and pointycastle for the cryptographic operations. Follow platform-specific setup:

See local_auth documentation for detailed setup instructions.

see pointycastle documentation

Installation

dependencies:
  secure_biometrics: ^0.0.1

Usage

Initial Setup

import 'package:secure_biometrics/secure_biometrics.dart';

// Get instance
final secureBiometrics = SecureBiometrics.instance;

// Generate key pair
await secureBiometrics.generateKeyPair();

Authentication Flow

try {
  // Server sends challenge
  const challenge = "random_challenge_from_server";

  // Sign challenge (requires biometric authentication)
  final signature = await secureBiometrics.signData(challenge);

  // Send signature back to server
  // Server verifies using stored public key
} on BiometricAuthenticationException catch (e) {
  // Handle authentication failure
} on MaxAttemptsExceededException {
  // Handle too many failed attempts
}

Key Management

// Export public key for server storage
final publicKeyPEM = await secureBiometrics.exportPublicKeyPEM();

RSA Signature Scheme

This package uses RSA signatures with the following specifications:

• Key Size: 2048 bits
• Hash Algorithm: SHA-256
• Padding Scheme: PKCS#1 v1.5
• Public Exponent: 65537 (0x10001)

Error Handling

try {
  await secureBiometrics.signData(challenge);
} on BiometricAuthenticationException catch (e) {
  // Failed biometric authentication
} on MaxAttemptsExceededException {
  // Too many failed attempts
} on BiometricNotAvailableException {
  // Biometrics not available
} on KeyNotFoundException catch (e) {
  // Key not found
} on KeyOperationException catch (e) {
  // Key operation failed
}

Example

Check the example folder for a complete demonstration app.

Tests

Check the test folder for complete test including signature verification.

License

This project is licensed under the MIT License - see the LICENSE file for details.