biometric_vault library
Encrypted storage with optional biometric protection.
Start with BiometricVault.canAuthenticate to check device support, then open a store with BiometricVault.getStorage and use BiometricVaultFile.read, BiometricVaultFile.write, and BiometricVaultFile.delete. Every failure surfaces as a subtype of the sealed BiometricVaultException.
Classes
- AndroidPromptInfo
- Texts and behavior of the Android system authentication prompt.
- BiometricVault
- The entry point for biometric/secure storage.
- BiometricVaultFile
- One named, isolated secure store obtained from BiometricVault.getStorage.
- DarwinPromptInfo
- Prompt messages shown by iOS and macOS when the keychain asks the user to authenticate.
- MethodChannelBiometricVault
- The method-channel implementation of BiometricVault, used on Android, iOS, macOS, and Linux.
- PromptInfo
- The per-platform prompt configurations for one storage operation.
- StorageFileInitOptions
- Configuration for a storage file, applied once when the storage is created by BiometricVault.getStorage.
- Win32BiometricVaultPlugin
-
Non-
dart:iostand-in for the Windows implementation.
Enums
- AuthExceptionCode
- The reason an authentication-gated operation failed, carried by AuthException.code.
- CanAuthenticateResponse
- The device's ability to authenticate the user, as reported by BiometricVault.canAuthenticate.
- StorageInvalidatedReason
- Why stored data became unusable, carried by StorageInvalidatedException.reason.
Exceptions / Errors
- AuthException
- The user could not be authenticated for a storage operation.
- BiometricVaultException
- The common base type for every failure this plugin reports.
- BiometricVaultPluginException
- An unexpected platform-side failure that is neither an authentication outcome nor data invalidation.
- StorageInvalidatedException
- The stored value exists but is permanently unusable.