Encryption added

EncryptedSharedPreferences

Author: AndroidWithRossyn

.idea/gradle.xml

@@ -46,6 +46,15 @@ dependencies {
     androidTestImplementation(libs.androidx.junit)
     androidTestImplementation(libs.androidx.espresso.core)
 
+
+
+    implementation(libs.androidx.security.crypto)
+
     implementation("com.google.code.gson:gson:2.11.0")
+
     implementation("com.jakewharton.timber:timber:5.0.1")
+
+
+
+
 }

.idea/vcs.xml

@@ -3,6 +3,8 @@ package com.banrossyn.sharedprefexample
 import android.content.Context
 import android.content.SharedPreferences
 import androidx.core.content.edit
+import androidx.security.crypto.EncryptedSharedPreferences
+import androidx.security.crypto.MasterKey
 import com.google.gson.Gson
 import com.google.gson.JsonParseException
 import com.google.gson.JsonSyntaxException
@@ -17,45 +19,64 @@ import kotlin.reflect.KProperty
  */
 object SharedPref {
     private var TAG = "SharedPref"
-    private var preferences: SharedPreferences? = null
+    private var preferences : SharedPreferences? = null
     private const val SHARED_PREFERENCE_FILE_NAME = "MY-PREFERENCE"
+
     /**
      * Initializes the SharedPreferences.
      * @param context The application context
      */
-    fun init(context: Context) {
+    fun init(context : Context) {
         Timber.tag(TAG).d("init: %s", context)
-        this.preferences = context.getSharedPreferences(
-            SHARED_PREFERENCE_FILE_NAME, Context.MODE_PRIVATE
+
+
+        /*Normal way*/
+        /*  this.preferences = context.getSharedPreferences(
+              SHARED_PREFERENCE_FILE_NAME, Context.MODE_PRIVATE
+          )*/
+
+
+        val masterKeyAlias = MasterKey.Builder(context)
+            .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
+            .build()
+
+        this.preferences = EncryptedSharedPreferences.create(
+            context,
+            SHARED_PREFERENCE_FILE_NAME,
+            masterKeyAlias,
+            EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
+            EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
         )
+
     }
+
     /**
      * Checks the initialization status of SharedPreferences.
      * @return true if SharedPreferences has been initialized, false otherwise
      */
-    fun isInitialized(): Boolean {
+    fun isInitialized() : Boolean {
         return preferences != null
     }
+
     /**
      * Registers a listener to listen for changes in SharedPreferences.
      * @param listener An object implementing the OnSharedPreferenceChangeListener interface
      */
-    fun registerOnSharedPreferenceChangeListener(listener: SharedPreferences.OnSharedPreferenceChangeListener) {
+    fun registerOnSharedPreferenceChangeListener(listener : SharedPreferences.OnSharedPreferenceChangeListener) {
         preferences!!.registerOnSharedPreferenceChangeListener(listener)
     }
+
     /**
      * Unregisters a previously registered listener.
      * @param listener The OnSharedPreferenceChangeListener to be unregistered
      */
-    fun unregisterOnSharedPreferenceChangeListener(listener: SharedPreferences.OnSharedPreferenceChangeListener) {
+    fun unregisterOnSharedPreferenceChangeListener(listener : SharedPreferences.OnSharedPreferenceChangeListener) {
         preferences!!.unregisterOnSharedPreferenceChangeListener(listener)
     }
 
 
-
-
-    const val isLogged ="isLoggedIn"
-    const val age ="userAge"
+    const val isLogged = "isLoggedIn"
+    const val age = "userAge"
 
     var isLoggedIn by BooleanPreference(isLogged, false)
     var userAge by IntPreference(age, 0)
@@ -70,73 +91,74 @@ object SharedPref {
      * @property name The key for the preference
      * @property defaultValue The default value if the preference is not set
      */
-    private class BooleanPreference(private val name: String, private val defaultValue: Boolean) :
+    private class BooleanPreference(private val name : String, private val defaultValue : Boolean) :
         ReadWriteProperty<SharedPref, Boolean> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getBoolean(name, defaultValue)
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: Boolean) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : Boolean) =
             preferences!!.edit { putBoolean(name, value) }
     }
+
     /**
      * Delegate for Int preferences.
      * @property name The key for the preference
      * @property defaultValue The default value if the preference is not set
      */
-    private class IntPreference(private val name: String, private val defaultValue: Int) :
+    private class IntPreference(private val name : String, private val defaultValue : Int) :
         ReadWriteProperty<SharedPref, Int> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getInt(name, defaultValue)
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: Int) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : Int) =
             preferences!!.edit { putInt(name, value) }
     }
 
-    private class LongPreference(private val name: String, private val defaultValue: Long) :
+    private class LongPreference(private val name : String, private val defaultValue : Long) :
         ReadWriteProperty<SharedPref, Long> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getLong(name, defaultValue)
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: Long) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : Long) =
             preferences!!.edit { putLong(name, value) }
     }
 
-    private class FloatPreference(private val name: String, private val defaultValue: Float) :
+    private class FloatPreference(private val name : String, private val defaultValue : Float) :
         ReadWriteProperty<SharedPref, Float> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getFloat(name, defaultValue)
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: Float) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : Float) =
             preferences!!.edit { putFloat(name, value) }
     }
 
-    private class StringPreference(private val name: String, private val defaultValue: String?) :
+    private class StringPreference(private val name : String, private val defaultValue : String?) :
         ReadWriteProperty<SharedPref, String?> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getString(name, defaultValue) ?: defaultValue
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: String?) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : String?) =
             preferences!!.edit { putString(name, value) }
     }
 
     private class StringSetPreference(
-        private val name: String, private val defaultValue: Set<String>
+        private val name : String, private val defaultValue : Set<String>
     ) : ReadWriteProperty<SharedPref, Set<String>> {
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>) =
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) =
             preferences!!.getStringSet(name, defaultValue) ?: defaultValue
 
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: Set<String>) =
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : Set<String>) =
             preferences!!.edit { putStringSet(name, value) }
     }
 
-   private class ObjectPreference<T : Any>(
-        private val key: String,
-        private val defaultValue: T,
-        private val typeToken: TypeToken<T>
+    private class ObjectPreference<T : Any>(
+        private val key : String,
+        private val defaultValue : T,
+        private val typeToken : TypeToken<T>
     ) : ReadWriteProperty<SharedPref, T> {
 
         @Throws(JsonParseException::class)
-        override fun getValue(thisRef: SharedPref, property: KProperty<*>): T {
+        override fun getValue(thisRef : SharedPref, property : KProperty<*>) : T {
             if (key.isEmpty()) {
                 Timber.w("> getObject, key must not be empty")
                 return defaultValue
@@ -148,15 +170,15 @@ object SharedPref {
             } else {
                 try {
                     Gson().fromJson(json, typeToken.type) as T
-                } catch (e: JsonSyntaxException) {
+                } catch (e : JsonSyntaxException) {
                     Timber.e("> getObject, Object stored with Key $key not able to instance to ${typeToken.type}")
                     throw e
                 }
             }
         }
 
         @Throws(IllegalArgumentException::class)
-        override fun setValue(thisRef: SharedPref, property: KProperty<*>, value: T) {
+        override fun setValue(thisRef : SharedPref, property : KProperty<*>, value : T) {
             require(key.isNotEmpty()) { "Key must not be empty" }
             Timber.i("> putObject, storing $value with key $key")
             preferences!!.edit().putString(key, Gson().toJson(value)).apply()

app/build.gradle.kts

@@ -9,6 +9,8 @@ appcompat = "1.7.0"
 material = "1.12.0"
 activity = "1.9.1"
 constraintlayout = "2.1.4"
+securityCrypto = "1.1.0-alpha06"
+
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -20,6 +22,9 @@ material = { group = "com.google.android.material", name = "material", version.r
 androidx-activity = { group = "androidx.activity", name = "activity", version.ref = "activity" }
 androidx-constraintlayout = { group = "androidx.constraintlayout", name = "constraintlayout", version.ref = "constraintlayout" }
 
+androidx-security-crypto = { module = "androidx.security:security-crypto", version.ref = "securityCrypto" }
+
+
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
 jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }