Shared preferences are a simple key-value storage mechanism that can be used to store small amounts
of data. However, since shared preferences are stored in plain text, it is not suitable for storing
sensitive information. To address this issue, you can use AES encryption to encrypt the data before
saving it to shared preferences.
To use shared preferences with AES encryption support, you can add this package to your project as
dependency.
Open pub.dev
Legacy EncryptedSharedPreferences
void main () async {
final key = "" ;
await EncryptedSharedPreferences .initialize (key: key);
var sharedPref = EncryptedSharedPreferences .getInstance ();
await sharedPref.setString (
'user_token' , 'xxxxxxxxxxxx' , notify: true );
sharedPref.getString ('user_token' );
await sharedPref.setInt ('age' , 99 , notify: true );
sharedPref.getInt ('age' , defaultValue: 1001 );
await sharedPref.setDouble ('pi' , 3.14 , notify: true );
sharedPref.getDouble ('pi' );
await sharedPref.setBool ('isPremium' , true , notify: true );
sharedPref.getBool ('isPremium' );
await sharedPref.setStringList ("stringList" , ["apple" , "orange" , "boom" ]);
sharedPref.getStringList ("stringList" );
await sharedPref.remove ('user_token' , notify: true );
await sharedPref.clear (notify: true );
await sharedPref.reload ();
final badKeys = {
"key1"
"key2"
};
await sharedPref.removeWhere ((key, value) => badKeys.contains (key));
sharedPref.observe (key: 'token' ).listen ((event) {
print (event);
});
sharedPref.observeSet (keys: {'key1' , 'key2' , 'keyN' }).listen ((event) {
print (event);
});
}
EncryptedSharedPreferencesAsync
void main () async {
final key = "" ;
await EncryptedSharedPreferencesAsync .initialize (key: key);
var sharedPref = EncryptedSharedPreferencesAsync .getInstance ();
await sharedPref.setString (
'user_token' , 'xxxxxxxxxxxx' , notify: true );
await sharedPref.getString ('user_token' );
await sharedPref.setInt ('age' , 99 , notify: true );
await sharedPref.getInt ('age' , defaultValue: 1001 );
await sharedPref.setDouble ('pi' , 3.14 , notify: true );
await sharedPref.getDouble ('pi' );
await sharedPref.setBool ('isPremium' , true , notify: true );
await sharedPref.getBool ('isPremium' );
await sharedPref.setStringList ("stringList" , ["apple" , "orange" , "boom" ]);
await sharedPref.getStringList ("stringList" );
await sharedPref.remove ('user_token' , notify: true );
await sharedPref.clear (notify: true );
await sharedPref.reload ();
final badKeys = {
"key1"
"key2"
};
await sharedPref.removeWhere ((key, value) =>
badKeys.contains (key));
sharedPref.observe (key: 'token' ).listen ((event) {
print (event);
});
sharedPref.observeSet (keys: {'key1' , 'key2' , 'keyN' }).listen ((event) {
print (event);
});
}
[Shared builder] Here is example of how to use SharedBuilder widget
class _MyAppState extends State <MyApp > {
@override
Widget build (BuildContext context) {
return MaterialApp (
home: Scaffold (
body: SharedBuilder (
listenKeys: const {"key1" , "key2" },
builder: (EncryptedSharedPreferences encryptedSharedPreferences, String ? updatedKey) {
return Text ("value : ${encryptedSharedPreferences.getString("key1" )} " );
},
),
floatingActionButton: FloatingActionButton (
onPressed: () async {
EncryptedSharedPreferences .getInstance ()
.setString ('key1' , 'dataValue' );
Future .delayed (const Duration (seconds: 3 ), () {
EncryptedSharedPreferences .getInstance ()
.setString ('key2' , 'dataValue' );
});
},
),
),
);
}
}
[Shared builder async] Here is example of how to use SharedBuilder widget
class _MyAppState extends State <MyApp > {
@override
Widget build (BuildContext context) {
return MaterialApp (
home: Scaffold (
body: SharedBuilderAsync (
listenKeys: const {"key1" , "key2" },
builder: (EncryptedSharedPreferencesAsync encryptedSharedPreferences,
String ? updatedKey) {
return Text ("value : $updatedKey " );
},
),
floatingActionButton: FloatingActionButton (
onPressed: () async {
EncryptedSharedPreferencesAsync .getInstance ()
.setString ('key1' , 'dataValue' );
Future .delayed (const Duration (seconds: 3 ), () {
EncryptedSharedPreferencesAsync .getInstance ()
.setString ('key2' , 'dataValue' );
});
},
),
),
);
}
}
Also you can add custom external encryptor
class CustomEncryptor extends IEncryptor {
@override
String decrypt (String key, String encryptedData) {
}
@override
String encrypt (String key, String plainText) {
}
}
void main () {
final key = "" ;
await EncryptedSharedPreferences .initialize (key: key, encryptor: CustomEncryptor ());
var sharedPref = EncryptedSharedPreferences .getInstance ();
}
DevTools extension for inspecting values