flutter_biopass 0.1.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 71

flutter_biopass #

Store a password behind biometric authentication.

This is a microlibrary for storing a password in the keychain, instructing the keychain to only give it back if the user first authenticates with TouchID or FaceID.

note: Android is currently unsupported, I hope to implement this soon.

note: On iOS, in order for your user not to receive a prompt that your app does not yet support Face ID, you must set a value for the Privacy - Face ID Usage Description (NSFaceIDUsageDescription) key in your app’s Info.plist.

Usage #

import 'package:flutter_biopass/flutter_biopass.dart' show BioPass;

final bioPass = BioPass();

// When the user signs up or logs in for the first time, store the password in the keychain:
await bioPass.store('P@ssw0rd');

// When asking the user to log in, first try retreiving the saved password which will, if a password is stored, trigger a biometric authentication prompt:
// If `result` is `null`, then either the user cancelled the authenticaiton, or there was no password saved.
final result = await bioPass.retreive(withPrompt: 'Example prompt text...');

// When the user manually logs out, delete the stored password from the keychain:
await bioPass.delete();

0.1.0 #

  • 🎉 Add initial implementation


import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter_biopass/flutter_biopass.dart' show BioPass;

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  _MyAppState createState() => _MyAppState();

class _MyAppState extends State<MyApp> {
  final navigatorKey = GlobalKey<NavigatorState>();

  BioPass biopass;

  void initState() {
    biopass = BioPass();

  Future<void> store(BuildContext context) async {
    await biopass.store('foobar');

      context: navigatorKey.currentState.overlay.context,
      builder: (_) => AlertDialog(
            title: Text('Store'),
            content: Text('Password stored successfully!'),
            actions: <Widget>[FlatButton(child: Text('close'), onPressed: () => navigatorKey.currentState.pop())],

  Future<void> retreive(BuildContext context) async {
    final result = await biopass.retreive(withPrompt: 'Example prompt text...');

      context: navigatorKey.currentState.overlay.context,
      builder: (_) => AlertDialog(
            title: Text('Retreive'),
            content: Text('Result: $result'),
            actions: <Widget>[FlatButton(child: Text('close'), onPressed: () => navigatorKey.currentState.pop())],

  Future<void> delete(BuildContext context) async {
    await biopass.delete();

      context: navigatorKey.currentState.overlay.context,
      builder: (_) => AlertDialog(
            title: Text('Delete'),
            content: Text('Password deleted successfully!'),
            actions: <Widget>[FlatButton(child: Text('close'), onPressed: () => navigatorKey.currentState.pop())],

  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: navigatorKey,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
                child: Text('Store'),
                onPressed: () => this.store(context),
                child: Text('Retreive'),
                onPressed: () => this.retreive(context),
                child: Text('Delete'),
                onPressed: () => this.delete(context),

Use this package as a library

1. Depend on it

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

  flutter_biopass: ^0.1.0

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:flutter_biopass/flutter_biopass.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Apr 1, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health issues and suggestions

Document public APIs. (-1 points)

8 out of 8 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/flutter_biopass.dart.

Run flutter format to format lib/flutter_biopass.dart.

Maintenance suggestions

The package description is too short. (-11 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies