搜索插件、代码仓与 APP 分类

插件详情v5.0.1

biometric_storage

安全存储:加密数据存储,可选择通过生物识别锁定,支持 iOS、Android 和 MacOS。对 Linux、Windows 和 web(localStorage)提供部分支持。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
3.7万
喜欢数
288
Pub 分数
130

安装插件

flutter pub add biometric_storage

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Biometric Storage 是一个 Flutter 包,提供安全的加密数据存储,并在支持的平台上可选地使用生物识别认证(指纹或面部识别)。它利用 Android 和 iOS 上的原生安全功能,并在其他平台(包括 Web(使用 localStorage)、macOS、Windows 和 Linux)上提供回退加密。专为敏感数据(如密码或令牌)设计,即使设备被攻破也能确保数据受到保护。该包可无缝集成到需要注重隐私的本地持久化应用中。

适合场景

  • 安全密码存储
  • 身份验证令牌持久化
  • 用户偏好加密
  • 生物特征保护的数据访问
  • 离线数据保护
  • 注重隐私的应用程序开发

主要特点

  • 端到端加密存储
  • 生物识别认证支持
  • 跨平台兼容性
  • 回退到加密本地存储
  • 用于读写操作的简单 API
  • 平台特定的安全集成

适合对象

  • 处理敏感用户数据的应用程序
  • 密码管理器
  • 安全的笔记应用
  • 认证系统
  • 注重隐私的应用程序
  • 注重数据安全的开发者

使用建议

  • 非移动平台上的生物识别支持有限
  • Web 版本使用 localStorage(安全性低于原生)
  • 需要正确的权限处理
  • 无云同步功能
  • 可能需要为桌面平台进行额外设置
  • 依赖于底层操作系统安全机制

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

biometric_storage

Pub

Encrypted file store, optionally secured by biometric lock for Android, iOS, MacOS and partial support for Linux, Windows and Web.

Meant as a way to store small data in a hardware encrypted fashion. E.g. to store passwords, secret keys, etc. but not massive amounts of data.

  • Android: Uses androidx with KeyStore.
  • iOS and MacOS: LocalAuthentication with KeyChain.
  • Linux: Stores values in Keyring using libsecret. (No biometric authentication support).
  • Windows: Uses wincred.h to read/write into the credential store.
  • Web: Warning Uses unauthenticated, unencrypted storage in localStorage. If you have a better idea for secure storage on web platform, please open an Issue.

Check out AuthPass Password Manager for a app which makes heavy use of this plugin.

Getting Started

Installation
Android

Always required:

  • API Level >= 23 (android/app/build.gradle minSdkVersion 23)

Required only if you actually prompt for authentication, that is, if any storage uses the default authenticationRequired: true. Storage created with authenticationRequired: false never shows a BiometricPrompt, so neither of the following applies to it:

  • MainActivity must extend FlutterFragmentActivity. BiometricPrompt needs a FragmentActivity to host its dialog. If the plugin is attached to a plain FlutterActivity it logs an error and every authenticated read or write fails with AuthError:Failed — unauthenticated storage keeps working.

  • The activity theme must descend from Theme.AppCompat — but only for devices where androidx.biometric falls back to drawing its own fingerprint dialog, which it builds with androidx.appcompat.app.AlertDialog. That fallback is used below API 28, on API 28 devices without a fingerprint sensor, and on a short manufacturer allow-list where a crypto object forces it. From API 28 onwards the system BiometricPrompt is used and the theme does not matter.

    If you do need it:

    android/app/src/main/AndroidManifest.xml:

    <activity
        android:name=".MainActivity"
        android:launchMode="singleTop"
        android:theme="@style/LaunchTheme">
        [...]
        <meta-data
              android:name="io.flutter.embedding.android.NormalTheme"
              android:resource="@style/NormalTheme"
              />
    </activity>
    

    android/app/src/main/res/values/styles.xml:

    <resources>
      <style name="LaunchTheme" parent="Theme.AppCompat.NoActionBar">
        ...
      </style>
      <style name="NormalTheme" parent="Theme.AppCompat.NoActionBar">
        ...
      </style>
    </resources>
    
Logging

The plugin writes to android.util.Log under the tag BiometricStorage. A debug build logs everything; a release build logs nothing below INFO until you ask for it:

adb shell setprop log.tag.BiometricStorage VERBOSE

That suits reading logs off a device. If your app collects its own — a file appender, a crash reporter, slf4j, Timber — install a sink instead, from Application.onCreate or your FlutterActivity, before the first call into the plugin:

import android.util.Log
import design.codeux.biometric_storage.BiometricStorageLogging
import org.slf4j.LoggerFactory

BiometricStorageLogging.sink =
    BiometricStorageLogging.Sink { priority, tag, message, throwable ->
        val log = LoggerFactory.getLogger(tag)
        when (priority) {
            Log.VERBOSE -> log.trace(message, throwable)
            Log.DEBUG -> log.debug(message, throwable)
            Log.INFO -> log.info(message, throwable)
            Log.WARN -> log.warn(message, throwable)
            else -> log.error(message, throwable)
        }
    }

Installing a sink turns every level on, since it says something wants the records. To decide the level yourself — including keeping verbose logging in a release build without touching a device property — set it explicitly:

BiometricStorageLogging.level = Log.VERBOSE

throwable is passed separately rather than flattened into message, so you can hand the real exception to whatever you report to. The sink is called on whichever thread produced the record, so it must be safe to call from the main thread and from a background executor.

Resources
  • https://developer.android.com/topic/security/data
  • https://developer.android.com/topic/security/best-practices
iOS

https://developer.apple.com/documentation/localauthentication/logging_a_user_into_your_app_with_face_id_or_touch_id

  • include the NSFaceIDUsageDescription key in your app’s Info.plist file
  • Deployment target >= iOS 13 (below whatever Flutter itself requires, so in practice this never binds).

Known Issue: since iOS 15 the simulator seem to no longer support local authentication: https://developer.apple.com/forums/thread/685773

IosPromptInfo.saveTitle / accessTitle are invisible on Face ID devices. Face ID authenticates against a HUD that shows its glyph and the words "Face ID" and nothing else, and the "not recognized" alert after a failure offers only retry and cancel. The strings do reach the system — they are set as LAContext.localizedReason — but iOS does not draw them. Touch ID devices and macOS do show them, so they are still worth setting.

Mac OS
  • include the NSFaceIDUsageDescription key in your app’s Info.plist file
  • enable keychain sharing and signing. (not sure why this is required. but without it You will probably see an error like:

    SecurityError, Error while writing data: -34018: A required entitlement isn't present.

  • Deployment target >= macOS 10.15.
Swift Package Manager (iOS and Mac OS)

The iOS and macOS implementations ship both a Package.swift and a podspec, so they work with either dependency manager. Adding this plugin to an app that has migrated to Swift Package Manager does not bring CocoaPods back — no Podfile is generated.

Usage

You basically only need 4 methods.

  1. Check whether biometric authentication is supported by the device
  final response = await BiometricStorage().canAuthenticate()
  if (response != CanAuthenticateResponse.success) {
    // panic..
  }
  1. Create the access object
  final storageFile = await BiometricStorage().getStorage('mystorage');
  1. Read data
  final data = await storageFile.read();
  1. Write data
  final myNewData = 'Hello World';
  await storageFile.write(myNewData);

Storing without a biometric prompt — for a value a background task has to be able to refresh, for example — is authenticationRequired: false. The value is still encrypted at rest; it is simply not gated behind an authentication.

  final storageFile = await BiometricStorage().getStorage(
    'mystorage',
    options: StorageFileInitOptions(authenticationRequired: false),
  );

See also the API documentation: https://pub.dev/documentation/biometric_storage/latest/biometric_storage/BiometricStorageFile-class.html#instance-methods

所属分类

依赖

依赖清单 4 项

  • ffi>=1.0.0 <3.0.0
  • logging>=1.0.0 <2.0.0
  • plugin_platform_interface^2.0.0
  • win32>=2.0.0 <6.0.0

源码仓库

使用此插件的项目