Sichere Speicherung: Verschlüsselter Datenspeicher, optional durch biometrische Sperre gesichert, mit Unterstützung für iOS, Android und MacOS. Teilweise Unterstützung für Linux, Windows und Web (localStorage).
Aus öffentlichen Paketdaten erstellte Orientierung.
Biometric Storage ist ein Flutter-Paket, das sichere, verschlüsselte Datenspeicherung mit optionaler biometrischer Authentifizierung (Fingerabdruck oder Gesichtserkennung) auf unterstützten Plattformen bietet. Es nutzt native Sicherheitsfunktionen unter Android und iOS und bietet Fallback-Verschlüsselung auf anderen Plattformen wie Web (mit localStorage), macOS, Windows und Linux. Für sensible Daten wie Passwörter oder Tokens konzipiert, stellt es sicher, dass die Daten auch bei einem kompromittierten Gerät geschützt bleiben. Das Paket lässt sich nahtlos in Apps integrieren, die eine datenschutzorientierte lokale Persistenz erfordern.
Anwendungsfälle
Sichere Passwortspeicherung
Authentifizierungstoken-Persistenz
Benutzereinstellungverschlüsselung
Biometrisch geschützter Datenzugriff
Offline-Datenschutz
Privatsphäre-orientierte App-Entwicklung
Hauptmerkmale
Ende-zu-Ende-verschlüsselte Speicherung
Unterstützung der biometrischen Authentifizierung
Plattformübergreifende Kompatibilität
Auf verschlüsselten lokalen Speicher zurückgreifen
Einfache API für Lese-/Schreibvorgänge
plattformspezifische Sicherheitsintegration
Geeignet für
Apps, die sensible Nutzerdaten verarbeiten
Passwort-Manager
Sichere Notiz-Apps
Authentifizierungssysteme
Datenschutzorientierte Anwendungen
Entwickler, die Daten-Sicherheit priorisieren
Hinweise
Eingeschränkter biometrischer Support auf nicht-mobilen Plattformen
Die Webversion verwendet localStorage (weniger sicher als native)
Erforderliche Berechtigungsverwaltung
Keine Cloud-Synchronisierungsfunktion
Kann zusätzliche Einrichtung für Desktop-Plattformen erfordern
Abhängig von den zugrundeliegenden Sicherheitsmechanismen des Betriebssystems
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
biometric_storage
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).
Web: Warning Uses unauthenticated, unencrypted storage in localStorage.
If you have a better idea for secure storage on web platform, please open an Issue.
API Level >= 23 (android/app/build.gradleminSdkVersion 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.
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:
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:
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.
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.
Check whether biometric authentication is supported by the device
final response = awaitBiometricStorage().canAuthenticate()
if (response != CanAuthenticateResponse.success) {
// panic..
}
Create the access object
final storageFile = awaitBiometricStorage().getStorage('mystorage');
Read data
final data = await storageFile.read();
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 = awaitBiometricStorage().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