travel-union / flutter_biometrics Goto Github PK

View Code? Open in Web Editor NEW

6.0 3.0 9.0 161 KB

Key pair generation and cryptographic signing using biometrics

License: MIT License

Java 40.70% Objective-C 1.62% Dart 25.16% Ruby 1.88% Shell 1.15% Swift 29.49%

flutter_biometrics's Introduction

flutter_biometrics

Documentation is under contruction.

Flutter plugin which lets you to generate key pair and do cryptographic signing using biometric authentication.

Heavily influenced by local_auth

Usage in Dart

Import the relevant file:

import 'package:flutter_biometrics/flutter_biometrics.dart';

Available methods:

bool authAvailable =
    await FlutterBiometrics().authAvailable();

List<BiometricType> getAvailableBiometricTypes =
    await FlutterBiometrics().getAvailableBiometricTypes();

String publicKeyAsBase64 =
    await FlutterBiometrics().createKeys(reason: 'Please authenticate to generate keys');

bool signedPayloadAsBase64 =
    await FlutterBiometrics().sign(payload: 'base64string', reason: 'Please authenticate to sign payload');

Android Integration (taken from local_auth)

Note that local_auth plugin requires the use of a FragmentActivity as opposed to Activity. This can be easily done by switching to use FlutterFragmentActivity as opposed to FlutterActivity in your manifest (or your own Activity class if you are extending the base class).

Update your project's AndroidManifest.xml file to include the USE_FINGERPRINT permissions:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="com.example.app">
  <uses-permission android:name="android.permission.USE_FINGERPRINT"/>
<manifest>

Getting Started

For help getting started with Flutter, view Flutter online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

flutter_biometrics's People

Contributors

Stargazers

Watchers

Forkers

netgfx scorchy38 victor-daniel-m hubdestro danielzq abdulrzk44 pavanpucha vudieulinh96 adrianodidio

flutter_biometrics's Issues

sign_error_key

When call
String signature = await FlutterBiometrics().sign(
payload: 'test',
reason: 'Please');

Is broken and print

[ERROR:flutter/lib/ui/ui_dart_state.cc(213)] Unhandled Exception: PlatformException(sign_error_key, Error retrieving keys: Supplied key (null) is not a RSAPrivateKey instance, null, null)

E/flutter (32570): #0 StandardMethodCodec.decodeEnvelope (package:flutter/src/services/message_codecs.dart:597:7)
E/flutter (32570): #1 MethodChannel._invokeMethod (package:flutter/src/services/platform_channel.dart:156:18)
E/flutter (32570):
E/flutter (32570): #2 FlutterBiometrics.sign (package:flutter_biometrics/flutter_biometrics.dart:75:12)
E/flutter (32570):

Possible fallback to App-password if biometrics not set

Hello, is it possible to fallback to app password or passcode if biometrics are not available or user canceled?

There is an implementation using App-password here: https://github.com/algrid/keychain-sample/blob/master/keychain-sample/PwSamplesViewController.swift

Error with local_auth

Error: 'BiometricType' is imported from both 'package:local_auth/local_auth.dart' and 'package:flutter_biometrics/flutter_biometrics.dart'.
import 'package:flutter_biometrics/flutter_biometrics.dart';

Flutter 2.8 Depreciated Version

The plugin flutter_biometrics uses a deprecated version of the Android embedding.
To avoid unexpected runtime failures, or future build failures, try to see if this plugin supports the Android V2 embedding. Otherwise, consider removing it since a future release of Flutter will remove these deprecated APIs.

add support notify the exception when a new finger is enrolled

thanks for your create this plugin

if you have time please add support notify the exception when a new finger is enrolled when calling the sign method
by pass optional named parameter to enable/disable this feature in dart code.

in native android code set setInvalidatedByBiometricEnrollment(true) Minimum API version is 24 but in ios swift code I don't have the experience to develop native ios app

thanks for your advance

touchIdAny is deprecated

Apple suggests using biometryAny instead
https://developer.apple.com/documentation/security/secaccesscontrolcreateflags/1617988-touchidany

or better yet https://developer.apple.com/documentation/security/secaccesscontrolcreateflags/1392879-userpresence to offer more functionality with passcode fallback.

I could create a PR if that is desirable. But not sure how to tackle the Android part to also accept passcode as a fallback.

createKeys method in this library just returns Public Key, need details to get the Private Key.

When Biometric Authentication is successfully completed the createKeys method in this library returns just Public Key, how to get the Private Key and Public key both ? Other wise is there any method to create a Symmetric Key. Please provide these details.