Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skyost/simplesecurestorage
A simple and secure storage system for Flutter.
https://github.com/skyost/simplesecurestorage
flutter secure simple storage
Last synced: about 1 month ago
JSON representation
A simple and secure storage system for Flutter.
- Host: GitHub
- URL: https://github.com/skyost/simplesecurestorage
- Owner: Skyost
- License: other
- Created: 2024-02-25T17:18:05.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-12T12:50:20.000Z (8 months ago)
- Last Synced: 2024-10-07T16:47:38.926Z (about 1 month ago)
- Topics: flutter, secure, simple, storage
- Language: C++
- Homepage: https://pub.dev/packages/simple_secure_storage
- Size: 442 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Simple Secure Storage
A simple and secure storage system for Flutter. Supports Android, iOS, macOS, Windows and web !
[](https://pub.dev/packages/simple_secure_storage/score)
[](https://pub.dev/packages/simple_secure_storage/score)
[](https://pub.dev/packages/simple_secure_storage/score)
[](https://github.com/invertase/melos)
## Motivations
I'm currently creating a TOTP app where secrets are encrypted using a master password and I need
a secure place to store the encryption / decryption key.
I knew that Flutter already had a such package called `flutter_secure_storage`. The only problem
is that it have 100+ open issues on Github, and that the author is currently inactive on
Github.
That's why I've decided to create my own solution : **Simple Secure Storage** (_SSS_).
## Features
* Very _very_ simple and straightforward.
* Supports Android, iOS, macOS, Windows, Linux and web.
* Allows data to be cached (so that you can access it as fast as possible).
* Secure.
* Again, very simple.
## Getting started
### Minimum requirements
Simple Secure Storage uses :
* [Keychain](https://developer.apple.com/documentation/security/keychain_services) on Apple devices,
which is supported since _iOS 2.0_ and _macOS 10.6_.
* [`EncryptedSharedPreferences`](https://developer.android.com/reference/androidx/security/crypto/EncryptedSharedPreferences)
on Android, which supports a minimum SDK version of, at least, _21_.
* [`wincred.h`](https://learn.microsoft.com/en-us/windows/win32/api/wincred/) on Windows, which seems to
be available since _Windows XP_.
* [`libsecret`](https://wiki.gnome.org/Projects/Libsecret) on Linux. Therefore, you need a _secret service_ (`gnome_keyring`
is commonly installed).
* [`sembast_web`](https://pub.dev/packages/sembast_web) and [`webcrypto`](https://pub.dev/packages/webcrypto)
on web.
### Installation
Run the following command to add Simple Secure Storage to your Flutter project :
```shell
flutter pub add simple_secure_storage
```
Then, please make sure you follow the specific instructions for each platform you're targeting.
#### Android
Update the minimum SDK version in your `android/app/build.gradle` :
```xml
android {
defaultConfig {
minSdkVersion 18
}
}
```
Also, as stated on [Android Developers](https://developer.android.com/reference/androidx/security/crypto/EncryptedSharedPreferences),
> **WARNING:** The preference file should not be backed up with Auto Backup.
> When restoring the file it is likely the key used to encrypt it will no longer be present.
> You should exclude all `EncryptedSharedPreferences` from backup using [backup rules](https://developer.android.com/guide/topics/data/autobackup#IncludingFiles).
so either you completely disable auto backup, in your `AndroidManifest.xml` :
```xml
android:allowBackup="false"
android:fullBackupContent="false">
```
or you only disable the backup of the encrypted shared preferences, which can be done
using [backup rules](https://developer.android.com/guide/topics/data/autobackup#IncludingFiles).
Note that the `sharedpref` path is the `namespace` key you're passing to the `initialize` method
of the plugin.
#### macOS
In Xcode, go to _Project settings_ > _Capabilities_ and enable _Keychain Sharing_
(see [this](https://stackoverflow.com/questions/65131018/how-can-i-enable-the-keychain-sharing-capability-in-xcode)).
#### Linux
Run the following command to install `libsecret-1-dev` :
```shell
sudo apt install -y libsecret-1-dev
```
### Code snippet
Here's a simple example to get started.
```dart
// Initialize the plugin before using. Typically done in your `main()` method.
// Please don't forget to provide your namespace and your app name.
if (kIsWeb) {
// To secure your data on Flutter web, we have to encrypt it using a password and a salt.
await SimpleSecureStorage.initialize(WebInitializationOptions(keyPassword: 'password', encryptionSalt: 'salt'));
} else {
await SimpleSecureStorage.initialize(); // Feel free to use `InitializationOptions` if you want here too.
}
// Write a value.
await SimpleSecureStorage.write('key', 'value');
// Check if a value exists.
print(await SimpleSecureStorage.has('key')); // Will print "true".
// Read a value.
print(await SimpleSecureStorage.read('key')); // Will print "value".
// Remove a value.
await SimpleSecureStorage.delete('key');
// Clear everything.
await SimpleSecureStorage.clear();
```
In the previous snippet, everything is being read "on demand". You may want to access your data
without always having to write `await`. To do so, use the class `CachedSimpleSecureStorage`.
It behaves exactly like the snippet above, except that you don't have to call `await SimpleSecureStorage.initialize()`,
but `await CachedSimpleSecureStorage.getInstance()`.
If you want a more complete example, feel free to check and run
[this one](https://github.com/Skyost/SimpleSecureStorage/tree/master/packages/simple_secure_storage/example),
which available on Github. Note that, to run the example app on Darwin platforms (iOS & macOS),
you need to configure the development team in the project settings.
## Contributions
You have a lot of options to contribute to this project ! You can :
* [Fork it](https://github.com/Skyost/SimpleSecureStorage/fork) on Github.
* [Submit](https://github.com/Skyost/SimpleSecureStorage/issues/new/choose) a feature request or a bug report.
* [Donate](https://paypal.me/Skyost) to the developer.