# flutter_secure_storage 10.3.1 A Flutter plugin for securely storing sensitive data using encrypted storage. ## Installing ``` export PUB_HOSTED_URL=https://pub.mirror.p-hatan.com flutter pub add 'flutter_secure_storage:10.3.1' ``` Published: 2026-05-27T06:02:31.417147Z Expected archive SHA-256: 7686b1d6a29985dcbb808c59518226e603e3bfa7c0ddfd1a0d00e4cda77c868e Available in cache; verification: upstream_checksum ## Direct dependencies - flutter: map[sdk:flutter] - flutter_secure_storage_darwin: ^0.3.2 - flutter_secure_storage_linux: ^3.0.1 - flutter_secure_storage_platform_interface: ^2.0.1 - flutter_secure_storage_web: ^2.1.1 - flutter_secure_storage_windows: ^4.1.0 - meta: ^1.3.0 ## Package README (untrusted upstream documentation) # flutter_secure_storage [![Pub Version](https://img.shields.io/pub/v/flutter_secure_storage.svg)](https://pub.dev/packages/flutter_secure_storage) [![Pub Version Prerelease](https://img.shields.io/pub/v/flutter_secure_storage.svg?include_prereleases)](https://pub.dev/packages/flutter_secure_storage) [![Build Status](https://github.com/mogol/flutter_secure_storage/actions/workflows/code-quality.yml/badge.svg)](https://github.com/juliansteenbakker/flutter_secure_storage/actions/workflows/code-quality.yml) [![Code Quality: Very Good Analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis) [![Codecov](https://codecov.io/gh/juliansteenbakker/flutter_secure_storage/graph/badge.svg?token=UUVTJ6MS4A)](https://codecov.io/gh/juliansteenbakker/flutter_secure_storage) [![GitHub Sponsors](https://img.shields.io/github/sponsors/juliansteenbakker)](https://github.com/sponsors/juliansteenbakker) A Flutter plugin to securely store sensitive data in a key-value pair format using platform-specific secure storage solutions. It supports Android, iOS, macOS, Windows, and Linux. ## Features - **Secure Data Storage**: Uses Keychain for iOS/macOS, custom secure ciphers with optional biometric authentication for Android, and platform-specific secure mechanisms for Windows, Linux, and Web. - **Encryption**: Encrypts data before storing it using platform-specific encryption (RSA OAEP + AES-GCM on Android by default). - **Cross-Platform**: Works seamlessly across Android, iOS, macOS, Windows, Linux, and Web. - **Biometric Authentication**: Optional biometric authentication support on Android (API 23+) and iOS/macOS. - **Customizable Options**: Configure encryption algorithms, accessibility attributes, biometric requirements, and more. ## Important notice for Android Version 10.0.0 introduces a major security update with custom cipher implementations. The deprecated Jetpack Security library's `encryptedSharedPreferences` is no longer recommended. **Key Changes:** - New default ciphers: RSA OAEP (key cipher) + AES-GCM (storage cipher) - New `AndroidOptions()` and `AndroidOptions.biometric()` constructors - Automatic migration from old ciphers via `migrateOnAlgorithmChange` (enabled by default) - Minimum Android SDK is now 23 (Android 6.0+) - Enhanced biometric authentication with graceful degradation ## Important notice for Web flutter_secure_storage only works on HTTPS or localhost environments. [Please see this issue for more information.](https://github.com/juliansteenbakker/flutter_secure_storage/issues/320#issuecomment-976308930) ## Installation If not present already, please call WidgetsFlutterBinding.ensureInitialized() in your main before you do anything with the MethodChannel. [Please see this issue for more info.](https://github.com/juliansteenbakker/flutter_secure_storage/issues/336) Add the dependency in your `pubspec.yaml` file: ``` dependencies: flutter_secure_storage: ^ ``` Then run: `flutter pub get` ## Usage ### Import the Package `import 'package:flutter_secure_storage/flutter_secure_storage.dart';` ### Create an Instance ```dart // Default secure storage - Uses RSA OAEP + AES-GCM (recommended) final storage = FlutterSecureStorage(); // Or with explicit Android options final storage = FlutterSecureStorage( aOptions: AndroidOptions(), ); // Biometric storage with graceful degradation final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( enforceBiometrics: false, // Works without biometrics biometricPromptTitle: 'Authenticate to access data', ), ); // Strict biometric enforcement (requires device security) final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( enforceBiometrics: true, // Requires biometric/PIN/pattern biometricPromptTitle: 'Authentication Required', ), ); ``` ### Write Data `await storage.write(key: 'username', value: 'flutter_user');` ### Read Data `String? username = await storage.read(key: 'username');` ### Delete Data `await storage.delete(key: 'username');` ### Delete All Data `await storage.deleteAll();` ### Check for Key Existence `bool containsKey = await storage.containsKey(key: 'username');` ## Configuration Each platform provides its own set of configuration options to tailor secure storage behavior. For example, on iOS, the `IOSOptions` class includes an `accessibility` option that determines when the app can access secure values stored in the Keychain. The `accessibility` option allows you to specify conditions under which secure values are accessible. For instance: - `first_unlock`: Enables access to secure values after the device is unlocked for the first time after a reboot. - `first_unlock_this_device`: Allows access to secure values only after the device is unlocked for the first time since installation on this device. - `unlocked` (default): Values are accessible only when the device is unlocked. Here’s an example of configuring the accessibility option on iOS: ```dart final options = IOSOptions(accessibility: KeychainAccessibility.first_unlock); await storage.write(key: key, value: value, iOptions: options); ``` By setting `accessibility`, you can control when secure values are accessible, enhancing security and usability for your app on iOS. Similar platform-specific options are available for other platforms as well. ### Android #### Disabling Auto Backup _Note_ By default Android backups data on Google Drive. It can cause exception `java.security.InvalidKeyException: Failed to unwrap key`. You need to: - [Disable autobackup](https://developer.android.com/guide/topics/data/autobackup#EnablingAutoBackup), [details](https://github.com/juliansteenbakker/flutter_secure_storage/issues/13#issuecomment-421083742) - [Exclude sharedprefs](https://developer.android.com/guide/topics/data/autobackup#IncludingFiles) used by `FlutterSecureStorage`, [details](https://github.com/juliansteenbakker/flutter_secure_storage/issues/43#issuecomment-471642126) Add the following to your `android/app/src/main/AndroidManifest.xml`: ```xml ``` #### Encryption Options (Version 10.0.0+) Version 10 introduces new cipher options and biometric support. Choose the configuration that fits your security requirements: | Constructor | Key Cipher | Storage Cipher | Biometric Support | Description | |----------------------------------------------------------------------------------------------------------|---------------------------------------|-------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | `AndroidOptions()` | RSA/ECB/OAEPWithSHA-256AndMGF1Padding | AES/GCM/NoPadding | No | **Default.** Standard secure storage with RSA OAEP key wrapping. Strong authenticated encryption without biometrics. Recommended for most use cases. | | `AndroidOptions.biometric(enforceBiometrics: false)` | AES/GCM/NoPadding | AES/GCM/NoPadding | Optional | KeyStore-based with optional biometric authentication. Gracefully degrades if biometrics unavailable. | | `AndroidOptions.biometric(enforceBiometrics: true)` | AES/GCM/NoPadding | AES/GCM/NoPadding | Required | KeyStore-based requiring biometric/PIN authentication. Throws error if device security not available. Requires API 28+ for biometric enforcement. | | `AndroidOptions.biometric(enforceBiometrics: true, biometricType: AndroidBiometricType.strongBiometricOnly)` | AES/GCM/NoPadding | AES/GCM/NoPadding | Required (strong) | Same as above but restricts authentication to Class 3 (strong) biometrics only. Device credentials (PIN/pattern/password) are rejected. | #### Custom Cipher Combinations (Advanced) For advanced users, all combinations below are supported using the `AndroidOptions()` constructor with custom parameters: | Key Cipher Algorithm | Storage Cipher Algorithm | Implementation | Biometric Support | |-----------------------------------------|--------------------------|-----------------|------------------------------------| | `RSA_ECB_PKCS1Padding` | `AES_CBC_PKCS7Padding` | RSA-wrapped AES | No | | `RSA_ECB_PKCS1Padding` | `AES_GCM_NoPadding` | RSA-wrapped AES | No | | `RSA_ECB_OAEPwithSHA_256andMGF1Padding` | `AES_CBC_PKCS7Padding` | RSA-wrapped AES | No | | `RSA_ECB_OAEPwithSHA_256andMGF1Padding` | `AES_GCM_NoPadding` | RSA-wrapped AES | No | | `AES_GCM_NoPadding` | `AES_CBC_PKCS7Padding` | KeyStore AES | Optional (via `enforceBiometrics`) | | `AES_GCM_NoPadding` | `AES_GCM_NoPadding` | KeyStore AES | Optional (via `enforceBiometrics`) | **Notes:** - **RSA key ciphers** wrap the AES encryption key with RSA. No biometric support. - **AES key cipher** stores the key directly in Android KeyStore. Supports optional biometric authentication. - **`enforceBiometrics` parameter** (default: `false`): - `false`: Gracefully degrades if biometrics unavailable - `true`: Strictly requires device security (PIN/pattern/biometric), throws exception if unavailable #### Migration with Backup Protection When upgrading between versions that use different encryption algorithms, `flutter_secure_storage` can automatically migrate your data. To protect against data loss during migration (e.g., app crashes), enable backup protection: ```dart final storage = FlutterSecureStorage( aOptions: AndroidOptions( migrateWithBackup: true, // Enable crash-resistant migration ), ); ``` **How it works:** 1. **Before migration:** Creates backup copies of encrypted data with `_BACKUP` suffix 2. **During migration:** Tracks progress per-key using `_MIGRATED` markers 3. **After migration:** Automatically cleans up backup and progress markers 4. **On crash:** Resumes from last checkpoint without data loss **When to use:** - Recommended for production apps storing critical data (wallet seeds, credentials, etc.) - Protects against data loss if migration crashes mid-process - Enables safe recovery to pre-migration state if needed **Default behavior:** - `migrateWithBackup: false` (default for backward compatibility) - When disabled, automatic migration is turned off to prevent unsafe data loss - Enable this option if you want crash-resistant migrations **Example migration scenarios:** ```dart // Migrating from old to new algorithm with backup protection final storage = FlutterSecureStorage( aOptions: AndroidOptions( migrateWithBackup: true, keyCipherAlgorithm: KeyCipherAlgorithm.RSA_ECB_OAEPwithSHA_256andMGF1Padding, storageCipherAlgorithm: StorageCipherAlgorithm.AES_GCM_NoPadding, ), ); // Migrating to biometric storage with backup final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( migrateWithBackup: true, enforceBiometrics: false, ), ); ``` **Technical details:** - Backup data stored alongside original data in SharedPreferences - Per-key progress tracking prevents re-processing already-migrated keys - Idempotent: safe to run multiple times - Supports all migration paths (non-biometric ↔ biometric, algorithm changes) - Automatic cleanup after successful migration ### iOS #### Biometric Authentication Flutter Secure Storage supports biometric authentication (fingerprint, face recognition, etc.) on Android API 23+. ##### Required Permissions To use biometric authentication, add the following permission to your `android/app/src/main/AndroidManifest.xml`: ```xml ``` For devices running Android 9.0 (API 28) and above, `USE_BIOMETRIC` is the recommended permission. For backward compatibility with devices running Android 6.0 - 8.1 (API 23-27), you may also need: ```xml ``` ##### Using Biometric Authentication You can enable biometric authentication using the `AndroidOptions.biometric()` constructor: ```dart // Optional biometric authentication (graceful degradation) final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( enforceBiometrics: false, // Default - works without biometrics biometricPromptTitle: 'Unlock to access your data', biometricPromptSubtitle: 'Use fingerprint or face unlock', ), ); // Strict biometric enforcement (requires device security) final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( enforceBiometrics: true, // Requires biometric/PIN/pattern biometricPromptTitle: 'Biometric authentication required', ), ); // Strong biometric only — device credentials (PIN/pattern/password) rejected final storage = FlutterSecureStorage( aOptions: AndroidOptions.biometric( enforceBiometrics: true, biometricType: AndroidBiometricType.strongBiometricOnly, biometricPromptTitle: 'Fingerprint required', ), ); ``` **Note:** When `enforceBiometrics: true`, the app will throw an exception if the device has no PIN, pattern, password, or biometric enrolled. **`biometricType`** controls which authentication methods satisfy the biometric prompt (only applies when using `AES_GCM_NoPadding` key cipher): | Value | Accepted methods | |---------------------------------------------|---------------------------------------------------------| | `AndroidBiometricType.biometricOrDeviceCredential` | Class 3 biometrics **or** PIN / pattern / password (default) | | `AndroidBiometricType.strongBiometricOnly` | Class 3 (strong) biometrics only — credentials rejected | > **Note:** On Android 10 (API level 29) and lower, `setAllowedAuthenticators` is unavailable. Device credentials (PIN/pattern/password) are not accepted on these versions — only Class 3 (strong) biometrics work, regardless of the `biometricType` setting. ##### Requirements - **API Level**: Android 6.0 (API 23) minimum for basic encryption - **API Level**: Android 9.0 (API 28) minimum for enforced biometric authentication - **API Level**: Android 11.0 (API 30) minimum for `AndroidBiometricType.strongBiometricOnly` to be fully enforced - **Device Security**: Device must have a PIN, pattern, password, or biometric enrolled (when using `enforceBiometrics: true`) - **Permissions**: `USE_BIOMETRIC` permission in AndroidManifest.xml #### Migration from Version 9.x Version 10 automatically migrates data from older cipher algorithms when `migrateOnAlgorithmChange: true` (enabled by default). If you were using `encryptedSharedPreferences` in version 9, the data will be automatically migrated to the new cipher implementation. To disable automatic migration: ```dart final storage = FlutterSecureStorage( aOptions: AndroidOptions( migrateOnAlgorithmChange: false, ), ); ``` ### macOS & iOS You also need to add Keychain Sharing as capability to your macOS runner. To achieve this, please add the following in *both* your `macos/Runner/DebugProfile.entitlements` *and* `macos/Runner/Release.entitlements` for macOS or for iOS `ios/Runner/DebugProfile.entitlements` *and* `ios/Runner/Release.entitlements`. ``` keychain-access-groups ``` If you have set your application up to use App Groups then you will need to add the name of the App Group to the `keychain-access-groups` argument above. Failure to do so will result in values appearing to be written successfully but never actually being written at all. For example if your app has an App Group named "aoeu" then your value for above would instead read: ``` keychain-access-groups $(AppIdentifierPrefix)aoeu ``` If you are configuring this value through XCode then the string you set in the Keychain Sharing section would simply read "aoeu" with XCode appending the `$(AppIdentifierPrefix)` when it saves the configuration. ### Web Flutter Secure Storage uses an experimental implementation using WebCrypto. Use at your own risk at this time. Feedback welcome to improve it. The intent is that the browser is creating the private key, and as a result, the encrypted strings in local_storage are not portable to other browsers or other machines and will only work on the same domain. **It is VERY important that you have HTTP Strict Forward Secrecy enabled and the proper headers applied to your responses or you could be subject to a javascript hijack.** Please see: - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security - https://www.netsparker.com/blog/web-security/http-security-headers/ #### application-specific key option On the web, all keys are stored in LocalStorage. flutter_secure_storage has an option for the web to wrap this stored key with an application-specific key to make it more difficult to analyze. ```dart final _storage = const FlutterSecureStorage( webOptions: WebOptions( wrapKey: '${your_application_specific_key}', wrapKeyIv: '${your_application_specific_iv}', ), ); ``` ### Windows You need the C++ ATL libraries installed along with the rest of Visual Studio Build Tools. Download them from [here](https://visualstudio.microsoft.com/downloads/?q=build+tools) and make sure the C++ ATL under optional is installed as well. ### Linux You need to install [Libsecret](https://github.com/GNOME/libsecret) packages: 1. **development package**: on your machine to build the project 2. **runtime package**: to run the application (add it as a dependency after packaging your app).
Apt / Dnf / Pacman For Ubuntu / Debian-based distros (e.g., Linux Mint, PopOS): ```shell sudo apt install libsecret-1-0 libsecret-1-dev ``` For Fedora / RHEL / CentOS distros: ```shell sudo dnf install libsecret libsecret-devel ``` For Arch based distros (a single package containing both development and runtime modules): ```shell sudo pacman -S libsecret ```
Flatpak / Flathub [Libsecret supports](https://github.com/GNOME/libsecret#libsecret) both `org.freedesktop.Secret` and `org.freedesktop.portal.Secret` and is compatible with Flatpak or sandboxed apps. Freedesktop runtime version 25.08 (also GNOME runtime 49, KDE runtime 6.10 and 5.15-25.08) provides libsecret; therefore, it no longer needs to be compiled ([flathub/shared-modules/#424](https://github.com/flathub/shared-modules/issues/424)) in your app manifest: ```yaml runtime: org.freedesktop.Platform runtime-version: '25.08' # Should be at least 25.08 (or newer) ``` > However, if you are still using an older runtime, you may use [Flathub Shared Modules](https://docs.flathub.org/docs/for-app-authors/shared-modules) and add `shared-modules/libsecret/libsecret.json` (**no longer recommend** and will be removed).
Snapcraft If you using snapcraft to build the project, use the following: ```yaml parts: your-app: plugin: flutter flutter-target: lib/main.dart build-packages: - libsecret-1-dev stage-packages: - libsecret-1-0 ```
Apart from `libsecret`, you also need a keyring service. This is typically already installed by the desktop environment: - [`gnome-keyring`](https://wiki.gnome.org/Projects/GnomeKeyring) (for Gnome users) - [`kwalletmanager`](https://wiki.archlinux.org/title/KDE_Wallet) (for KDE users) - Or a light provider such as [`secret-service`](https://github.com/yousefvand/secret-service) For more details, including known issues and CI setup, see the [`flutter_secure_storage_linux` README](https://pub.dev/packages/flutter_secure_storage_linux). ## Integration Tests To run the integration tests, navigate to the `example` directory and execute the following command: `flutter drive --target=test_driver/app.dart` This will launch the integration tests specified in the `test_driver` directory. ## Contributing We welcome contributions to this project! To set up your workspace after cloning the repository, follow these steps: 1. Fetch the Flutter dependencies: `flutter pub get` 2. Activate `melos`: `dart pub global activate melos` 3. (Optional) Add pub executables to your path: `export PATH="$PATH":"$HOME/.pub-cache/bin"` 4. Bootstrap the workspace with `melos`: `melos bootstrap` This will prepare the project for development by linking and configuring all required dependencies. ## API Reference For a complete list of available methods and configuration options, refer to the [API documentation](https://pub.dev/documentation/flutter_secure_storage/latest/). ## License This project is licensed under the BSD 3 License. See the [LICENSE](LICENSE) file for details. ## Changelog ## 10.3.1 ### Android - Fixed `AEADBadTagException` when biometric authentication is cancelled on first launch: a stale IV is now cleared and the cipher re-initialised in encrypt mode so the next authentication attempt succeeds. - Fixed `NullPointerException` when retrying an operation after a cancelled biometric prompt: `preferences` is now only assigned once cipher initialisation completes successfully, allowing a clean retry. ## 10.3.0 ### Android - Added `AndroidBiometricType` enum and `biometricType` option to `AndroidOptions` to control which authentication methods are accepted during biometric prompts (requires `KeyCipherAlgorithm.AES_GCM_NoPadding`). - `AndroidBiometricType.biometricOrDeviceCredential` (default) accepts Class 3 biometrics or device credentials (PIN/pattern/password), preserving previous behaviour. - `AndroidBiometricType.strongBiometricOnly` restricts authentication to Class 3 (strong) biometrics only; device credentials are explicitly rejected. - Fully enforced on Android 11+ (API 30+) via `setAllowedAuthenticators` on `BiometricPrompt` and `setUserAuthenticationParameters` on the KeyStore key. On earlier API levels the system may still permit device credentials. - Added `biometricPromptNegativeButton` option to `AndroidOptions` to customise the dismiss button label on the biometric prompt. Required when using `strongBiometricOnly` or on Android 10 and lower. ### iOS / macOS - Fixed `secStoreAvailabilitySink` not being called when protected data availability changes. - Fixed `kSecUseDataProtectionKeychain` being added to Keychain queries unconditionally; it is now only set when `useDataProtectionKeychain` is explicitly enabled. ### Windows - Fixed `deleteAll` and `containsKey` not acquiring the mutex lock, which could cause data races under concurrent access. If you are on Dart >=3.10.0, this fix is applied automatically. Otherwise, pin `flutter_secure_storage_windows: ^4.2.2` in your `pubspec.yaml` to opt in and make sure your constraint is set for minimum of Dart >=3.10.0. ### Linux - Fixed `deleteKeyring` storing the string `"null"` instead of an empty JSON object `{}`. - Fixed non-UTF-8 error messages from libsecret causing a `FormatException` on the Dart side; messages are now sanitised before being sent through the method channel. - Fixed locked or unavailable keyring now surfacing as a catchable `PlatformException` with code `KeyringLocked`. - Fixed JSON parse errors and other C++ exceptions now surfacing as a `PlatformException` with code `StorageError` instead of sending malformed bytes through the channel. ## 10.2.0 ### Android - Deprecated `KeyCipherAlgorithm.RSA_ECB_PKCS1Padding`. Existing data is automatically migrated to the default `RSA_ECB_OAEPwithSHA_256andMGF1Padding` when `migrateOnAlgorithmChange` is true. - Deprecated `StorageCipherAlgorithm.AES_CBC_PKCS7Padding`. Existing data is automatically migrated to the default `AES_GCM_NoPadding` when `migrateOnAlgorithmChange` is true. - Fixed Gradle space-assignment warnings in `build.gradle`. ### iOS / macOS - Fixed iOS build by updating availability annotation for Secure Enclave methods from `iOS 11.3` to `iOS 13.0`. ### Windows - Fixed compatibility with `win32` 6.0.0 in `flutter_secure_storage_windows 4.2.0`. If you are on Dart >=3.10.0, this fix is applied automatically. Otherwise, pin `flutter_secure_storage_windows: ^4.2.0` in your `pubspec.yaml` to opt in and make sure your constraint is set for minimum of Dart >=3.10.0. ## 10.1.0 ### Android - Added `storageNamespace` option to `AndroidOptions` for full namespace isolation across storage instances (SharedPreferences, KeyStore aliases, config/key storage). Use this instead of `sharedPreferencesName` when running multiple `FlutterSecureStorage` instances with different cipher configurations. - Deprecated `sharedPreferencesName` in favor of `storageNamespace`, which provides complete isolation rather than data-only isolation. - Added `migrateWithBackup` option to `AndroidOptions` for crash-resistant migration. When enabled, backup copies of encrypted data are created before migration starts, allowing recovery if migration fails or the app crashes mid-migration. Works in conjunction with `migrateOnAlgorithmChange`. - Made `KeyCipherAlgorithm` and `StorageCipherAlgorithm` public enums. **Fixes:** - Fixed crash on biometric failure (not error). - Fixed null safety issue in `MethodRunner` that could cause a crash on Android. - Fixed config being overwritten on initialization. - Fixed default Android key cipher not aligning with the Flutter default. ### iOS / macOS - Added `useSecureEnclave` option to `IOSOptions` and `MacOsOptions` to store keys in the device's Secure Enclave for hardware-backed security. **Fixes:** - Fixed `kSecAttrSynchronizable` being silently dropped when no access control flags are set. - Fixed `readAll` not returning Secure Enclave items correctly. ## 10.0.0 This major release brings significant security improvements, platform updates, and modernization across all supported platforms. ### Android Due to the deprecation of Jetpack Security library, the Android implementation has been largely rewritten with custom secure ciphers, enhanced biometrics support, and migration tools. **Breaking Changes:** - `AndroidOptions().encryptedSharedPreferences` is now deprecated due to Jetpack Crypto package deprecation - Migration will automatically happen due to `migrateOnAlgorithmChange: true`, which can also be set to false if not wanted. - ResetOnError will now automatically be true, because most errors are unrecoverable due to key storage problems. It can still be disabled with `resetOnError: false` - Default key cipher changed to `RSA_ECB_OAEPwithSHA_256andMGF1Padding` - Default storage cipher changed to `AES_GCM_NoPadding` - Minimum Android SDK changed from 19 to 23 - Target SDK updated to 36 - Migrated from deprecated Jetpack Crypto library to custom cipher implementation (Tink doesn't support biometrics) - Migrated to Java Version 17 **New Features:** - New named constructors: `AndroidOptions()`, `AndroidOptions.biometric()` - `AndroidOptions().migrateOnAlgorithmChange` automatically migrates data to new ciphers when enabled - Improved biometric authentication with graceful degradation when device has no security setup - Migration tools for transitioning from deprecated encryptedSharedPreferences - Enhanced error handling with proper exception messages for biometric unavailability **Fixes:** - Fixed biometric authentication on devices without security (PIN/pattern/password) - now gracefully degrades when `enforceBiometrics=false` - Fixed storage cipher and key cipher pairing validation - Fixed migration checks for encrypted shared preferences - Fixed biometric permission handling - Fixed exception when reading data after boot **Other Changes:** - Updated Gradle, Kotlin, and Tink dependencies - Refactored custom cipher implementations for better maintainability - Added delete key functions for proper reset handling - Migrated to new analyzer and code cleanup ### iOS / macOS (darwin) - Merged iOS and macOS implementations into unified `flutter_secure_storage_darwin` package - Added support for Swift Package Manager - Remove keys regardless of synchronizable state or accessibility constraints - Change minimum iOS version from 9 to 12 - Change minimum macOS version to 10.14 - Use serial queue for execution of keychain operations - Added privacy manifest - Refactored code and added missing options to IOSOptions and MacOSOptions - Fixed warnings with Privacy Manifest - Fixed delete and deleteAll when synchronizable is set - Fixed migration when value is saved while key already exists with different accessibility option - Use accessibility option for all operations - Migrated to new analyzer and code cleanup ### Web - Web is now compatible with WASM - Updated code style and migrated to very_good_analysis - Add check for secure context (operations only allowed with secure context) - Remove dart:io to support WASM build - Migrated away from `html` to `web` package - Removed `js` in favor of using js-interop - Added `useSessionStorage` parameter to WebOptions for saving in session storage instead of local storage - Updated web dependency support to <2.0.0 - Migrated to new analyzer and code cleanup ### Windows - Upgrades deprecated member usage of win32 - Migrated to `win32` version 5.5.4 to support Dart 3.4 / Flutter 3.22.0 - Migrated to new analyzer and code cleanup - Write encrypted data to files instead of the Windows credential system ### Linux - Fixed whitespace deprecation warning - Reverted json.dump with indentations due to problems - Fixed search with schemas fails in cold keyrings - Fixed erase called on null - Fixed memory management issue - Remove and replace libjsoncpp1 dependency - Migrated to new analyzer and code cleanup ### Platform Interface - Remove dart:io to support WASM build of web - Migrated to new analyzer and code cleanup ### General Improvements - Listener functionality via `FlutterSecureStorage().registerListener()` - All platforms updated to support Dart SDK <4.0.0 - Comprehensive test coverage improvements - Documentation updates across all platforms ## 10.0.0-beta.5 Due to security issues regarding the handling of biometrics in v10.0.0-beta.4, together with the deprecation of Jetpack Security library, it took me some time to find a secure alternative. My apologies for the delay. The Android part has been largely rewritten, reintroducing the customer cipher construction from before, but with secure ciphers, biometrics support, updated default ciphers and migration tools. **Breaking Changes:** - `AndroidOptions().encryptedSharedPreferences` is now deprecated due to Jetpack Crypto package being deprecated For now you can still use deprecated encryptedSharedPreferences by setting `encryptedSharedPreferences: true` and `migrateOnAlgorithmChange: false`. If `encryptedSharedPreferences` is `true` and `migrateOnAlgorithmChange` is `true`, data will be automatically migrated to the new cipher, and encryptedSharedPreferences cannot be used anymore. - Google recommends using Tink library, but Tink does not support biometrics, so custom ciphers have been reintroduced - Default key cipher changed to `RSA_ECB_OAEPwithSHA_256andMGF1Padding` - Default storage cipher changed to `AES_GCM_NoPadding` **New Features:** - New named constructors: `AndroidOptions()`, `AndroidOptions.biometric()` - `AndroidOptions().migrateOnAlgorithmChange` automatically migrates data to new ciphers when enabled - Improved biometric authentication with graceful degradation when device has no security setup - Migration tools for transitioning from deprecated encryptedSharedPreferences - Enhanced error handling with proper exception messages for biometric unavailability **Key Fixes:** - Fixed biometric authentication on devices without security (PIN/pattern/password) - now gracefully degrades when `enforceBiometrics=false` - Fixed storage cipher and key cipher pairing validation - Fixed migration checks for encrypted shared preferences - Fixed biometric permission handling - Fixed default `resetOnError` behavior (now defaults to `true`) **Other Changes:** - Target SDK 36 - Updated Gradle, Kotlin, and Tink dependencies - Updated minimum SDK according to Flutter requirements - Refactored custom cipher implementations for better maintainability - Added delete key functions for proper reset handling ## 10.0.0-beta.4 * [Apple] Merged ios and macos implementation into a new package flutter_secure_storage_darwin * [Apple] Refactored code and added missing options * [Apple] Added support for swift package manager * [Web] Update flutter_secure_storage_platform_interface to be compatible with WASM. ## 10.0.0-beta.3 * [iOS] Fix delete and deleteAll when synchronizable is set. * [iOS] Update migration when value is saved while key already exists with different accessibility option. * [Android] Fix deprecation warning. ## 10.0.0-beta.2 * [Web] Update flutter_secure_storage_platform_interface to be compatible with WASM. ## 10.0.0-beta.1 This new major release has some big changes. This plugin requires a minimum dart sdk of 3.3.0 or higher and a minimum flutter version of 3.19.0. [Android] - By default, encryptedSharedPreferences will be enabled, and cannot be disabled. If there is still data saved by previous versions using encryptedSharedPreferences = false, it will be automatically transferred to encryptedSharedPreferences. - Migrated from deprecated Jetpack Crypto library to Google Tink Crypto library. - Migrated to Android SDK 35 - Migrated to Java Version 17 - Minimum Android SDK is changed from 19 to 23. - Migrated to new analyzer and clean-up code. - Lots of minor code improvements [iOS] - Change minimum iOS version from 9 to 12 - Use serial queue for execution of iOS keychain operations - Migrated to new analyzer and clean-up code. [Web] - Web is now migrated to be compatible with WASM. - The parameter useSessionStorage is added to WebOptions, which you can use to save in session storage instead of local storage. - Migrated to new analyzer and clean-up code. [Windows] - Migrates to `win32` version 5.5.4 to support Dart 3.4 / Flutter 3.22.0. - Migrated to new analyzer and clean-up code. [Platform Interface] - Migrated to new analyzer and clean-up code. ## 9.2.4 * [Android] Fix errors when building for release by upgrading Tink to 1.9.0. * [iOS] Fix delete and deleteAll when synchronizable is set. * [iOS] Update migration when value is saved while key already exists with different accessibility option. ## 9.2.3 * [iOS] Fix for issue #711: The specified item already exists in the keychain. * [Linux] Fix json.dump with indentations. * [Web] Update web dependency support to support <2.0.0 instead of <1.0.0. * [Web] Add wrapKey and wrapKeyIv parameters to webOptions. See readme for more information. * [macOS] Added useDataProtectionKeyChain parameter. ## 9.2.2 [iOS, macOS] Fixed an issue which caused the readAll and deleteAll to not work properly. ## 9.2.1 * Fix async race condition bug in storage operations. * [macOS] Return nil on macOS if key is not found ## 9.2.0 New Features: * [iOS, macOS] Reintroduced isProtectedDataAvailable. * Listener functionality via `FlutterSecureStorage().registerListener()` Bugs Fixed: * [iOS] Return nil on iOS read if key is not found * [macOS] Also set kSecUseDataProtectionKeychain on read for macos. ## 9.1.1 Reverts new feature because of breaking changes. * [iOS, macOS] Added isProtectedDataAvailable, A boolean value that indicates whether content protection is active. ## 9.1.0 New Features: * [iOS, macOS] Added isProtectedDataAvailable, A boolean value that indicates whether content protection is active. Improvements: * [iOS, macOS] Use accessibility option for all operations * [iOS, macOS] Added privacy manifest * [iOS] Fixes error when no item exists * [Linux] Fixed search with schemas fails in cold keyrings * [Linux] Fixed erase called on null * [Android] Fixed native Android stacktraces in PlatformExceptions * [Android] Fixed exception when reading data after boot ## 9.0.0 Breaking changes: * [Windows] Migrated to FFI with win32 package. ## 8.1.0 * [Android] Upgraded to Gradle 8. * [Android] Fixed resetOnError not working. * [Windows] Changed PathNotFoundException to FileSystemException to be backwards compatible with Flutter SDK 2.12.0. * [Windows] Applied lint suggestions. * [Linux] Remove and replace libjsoncpp1 dependency. * [Linux, macOS, Windows, Web] Update Dart SDK Constraint to support <4.0.0 instead of <3.0.0. ## 8.0.0 Breaking changes: * [macOS] The minimum macOS version supported is now 10.14. Other changes: * [Android] Fixed an issue when Encrypted Shared Preferences failed, the fallback would not handle the data correctly. * [Windows] Write encrypted data to files instead of the windows credential system. * [Linux] Fixed an issue with memory management. ## 7.0.2 [macOS] Fix issue with plugin name. ## 7.0.1 [Android] Reverted double initialization of the SharedPreferences because this will break mixed usage of secureSharedPreference on Android. ## 7.0.0 Breaking changes: * [macOS] The minimum macOS version supported is now 10.13. Other changes: * [Android] Fixed double initialization of the SharedPreferences which caused containsKey and other functions to not work properly. * [macOS] Upgraded codebase to swift which fixed containsKey always returning true. ## 6.1.0 * [iOS] (From 6.1.0-beta.1) Migrated from objective C to Swift. This also fixes issues with containsKey and possibly other issues. * [Android] Upgrade security-crypto from 1.1.0-alpha03 to 1.1.0-alpha04 * [Android] Fix deprecation warnings. * [All] Migrated from flutter_lints to lint and applied suggestions. ## 6.1.0-beta.1 * [iOS] Migrated from objective C to Swift. This also fixes issues with containsKey and possibly other issues. ## 6.0.0 * [Android] Upgrade to Android SDK 33. ## 5.1.2 This version reverts some breaking changes of update 5.1.0. These changes will become available in version 6.0.0 * [Android] Revert upgrade to Android SDK 33. ## 5.1.1 * Example app dependencies updated * Updated homepage ## 5.1.0 * [Android] You can now select your own key prefix or database name. * [Android] Upgraded to Android SDK 33. * [Android] You can now select the keyCipherAlgorithm and storageCipherAlgorithm. * [Linux] Fixed an issue where no error was being reported if there was something wrong accessing the secret service. * [macOS] Fixed an memory-leak. * [macOS] You can now select the same options as for iOS. ## 5.0.2 * [Android] Fixed bug where sharedPreference object was not yet initialized. ## 5.0.1 * [Android] Added java 8 requirement for gradle build. ## 5.0.0 First stable release of flutter_secure_storage for multi-platform! Please see all beta release notes for changes. This first release also fixes several stability issues on Android regarding encrypted shared preferences. ## [5.0.0-beta.5] * [Linux, iOS & macOS] Add containsKey function. * [Linux] Fix for use of undeclared identifier 'flutter_secure_storage_linux_plugin_register_with_registrar' ## [5.0.0-beta.4] * [Windows] Fixed application crashing when key doesn't exists. * [Web] Added prefix to local storage key when deleting, fixing items that wouldn't delete. ## [5.0.0-beta.3] * [Android] Add possibility to reset data when an error occurs. * [Windows] Add readAll, deleteAll and containsKey functions. * [All] Refactor option defaults. ## [5.0.0-beta.2] * [Android] Improved EncryptedSharedPreferences by not loading unused Cipher. * [Android] Removed deprecated classes * [Web] Improved containsKey function ## [5.0.0-beta.1] Initial BETA support for macOS, web & Windows. Development is still ongoing so expect some functions to not work correctly! Please read the readme.md for information about every platform. * Migrated to a federated project structure. [#254](https://github.com/mogol/flutter_secure_storage/pull/257). Thanks [jhancock4d](https://github.com/jhancock4d) * Added support for encrypted shared preferences on Android. [#259](https://github.com/mogol/flutter_secure_storage/pull/259) ## [4.2.1] * Added kSecAttrSynchronizable support by setting IOSOptions.synchronizable [#51](https://github.com/mogol/flutter_secure_storage/issues/51) * Changed deprecated jcenter to mavenCentral [#246](https://github.com/mogol/flutter_secure_storage/pull/246) ## [4.2.0] * Remove Strongbox for Android [225](https://github.com/mogol/flutter_secure_storage/pull/225). Thanks [JordyLangen](https://github.com/JordyLangen). ## [4.1.0] * Add support for Linux [185](https://github.com/mogol/flutter_secure_storage/pull/185). Thanks [talhabalaj](https://github.com/talhabalaj) * Improve first-time read speed on Android by not creating cipher when key is not present. Thanks [PieterAelse](https://github.com/PieterAelse) * Make it possible to customize iOS account name(kSecAttrService). Thanks [klyver](https://github.com/klyver) ## [4.0.0] * Introduce null-safety. Thanks [Steve Alexander](https://github.com/SteveAlexander) ## [3.3.5] * Fix thread safety issues in android code to close [161](https://github.com/mogol/flutter_secure_storage/issues/161). Thanks [koskimas](https://github.com/koskimas) ## [3.3.4] * Fix Android hanging UI on StorageCipher initialization [#116](https://github.com/mogol/flutter_secure_storage/issues/116) by [morrica](https://github.com/morrica) * Fix crash only observed for v2 apps [#124](https://github.com/mogol/flutter_secure_storage/pull/124) by [lidongze91](https://github.com/lidongze91) * Fix crash when generating keys in android with RTL locales [#132](https://github.com/mogol/flutter_secure_storage/pull/132) by [iassal](https://github.com/iassal) * Fix returning the error as String rather than Exception [#134](https://github.com/mogol/flutter_secure_storage/issues/134) by [wytesk133](https://github.com/wytesk133)s * Fix Android crash onDetachedFromEngine when init fails [#144](https://github.com/mogol/flutter_secure_storage/issues/144) by [iassal](https://github.com/iassal) * Handle null value at write function [#95](https://github.com/mogol/flutter_secure_storage/issues/95) by [ewertonrp](https://github.com/ewertonrp) * Add support for containsKey [#139](https://github.com/mogol/flutter_secure_storage/issues/139) by [iassal](https://github.com/iassal) ## [3.3.3] * Fix compatibility with non-AndroidX project. [AndroidX Migration](https://flutter.dev/docs/development/androidx-migration) is recommended. ## [3.3.2] * Migrate to Android v2 embedder. * Adds support for specifying [iOS Keychain Item Accessibility](https://developer.apple.com/documentation/security/keychain_services/keychain_items/restricting_keychain_item_accessibility?language=objc). ## [3.3.1+2] * Fix iOS build warning [Issue 30](https://github.com/mogol/flutter_secure_storage/issues/30) ## [3.3.1+1] * Fix Android Manifest error [Issue 77](https://github.com/mogol/flutter_secure_storage/issues/77) and [Issue 79](https://github.com/mogol/flutter_secure_storage/issues/79). Thanks [nate-eisner](https://github.com/nate-eisner). ## [3.3.1] * Fix crash without [iOSOptions](https://github.com/mogol/flutter_secure_storage/issues/73). ## [3.3.0] * Added groupId for iOS keychain sharing. Thanks [Maleandr](https://github.com/Maleandr). * Fix Gradle version in `gradle-wrapper.properties`. Thanks [blasten](https://github.com/blasten). * Added minimum sdk requirement on AndroidManifest. Thanks [lidongze91](https://github.com/lidongze91). ## [3.2.1] * Fix Android 9.0 Pie [KeyStore exception](https://github.com/mogol/flutter_secure_storage/issues/46). ## [3.2.0] * **Breaking change**. Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to [also migrate](https://developer.android.com/jetpack/androidx/migrate) if they're using the original support library. Thanks [I-am-original](https://github.com/I-am-original). * Enable StrongBox on Android devices that support it. Thanks [bbedward](https://github.com/bbedward). ## [3.1.3] * Fix Android 9.0 Pie KeyStore exception. Thanks [hacker1024](https://github.com/hacker1024) ## [3.1.2] * Added recreating secretKey if its decoding failed. Fix for [unwrap key](https://github.com/mogol/flutter_secure_storage/issues/13). Thanks [hnvn](https://github.com/hnvn). ## [3.1.1] * Suppress warning about unchecked operations when compiling for Android. ## [3.1.0] * Added `readAll` and `deleteAll`. ## [3.0.0] * **Breaking change**. Changed payloads encryption for Android from RSA to AES, AES secret key is encrypted with RSA. ## [2.0.0]```` * **Breaking change**. Changed key alias to fix Android 4.4.2 issue. The plugin isn't able to get previous stored data. ## [1.0.0] * Bump version ## [0.0.1] * Initial release