- EasyPrefs Added AES Encryption for secure storage

kishandonga · kishandonga · commit 35fa90f40f83 · 2020-08-08T17:38:33.000+05:30
- Read and Write Access still pending
diff --git a/library/src/main/java/io/easyprefs/Prefs.kt b/library/src/main/java/io/easyprefs/Prefs.kt
@@ -2,22 +2,37 @@ package io.easyprefs
 
 import android.content.Context
 import io.easyprefs.contract.Edit
-import io.easyprefs.contract.PrefProvider
 import io.easyprefs.contract.Read
+import io.easyprefs.contract.Secure
 import io.easyprefs.contract.Write
+import io.easyprefs.contract.provider.PrefProvider
 import io.easyprefs.error.PrefsEditContextException
 import io.easyprefs.error.PrefsReadContextException
 import io.easyprefs.error.PrefsWriteContextException
+import io.easyprefs.ext.Pass
 import io.easyprefs.impl.EasyPrefImpl
+import io.easyprefs.impl.SecureImpl
+import io.easyprefs.typedef.Encryption
 
 object Prefs : PrefProvider {
 
     private lateinit var context: Context
 
-    fun initializeApp(context: Context) {
+    override fun initializeApp(context: Context) {
         this.context = context.applicationContext
     }
 
+    override fun securely(): Secure {
+        return securely(Pass.empty)
+    }
+
+    override fun securely(aesKey: String): Secure {
+        val secure = SecureImpl
+        secure.context = context
+        secure.aesKey = aesKey
+        return secure
+    }
+
     override fun write(): Write {
         if (this::context.isInitialized) {
             return write(context)
@@ -40,15 +55,15 @@ object Prefs : PrefProvider {
     }
 
     override fun write(context: Context): Write {
-        return EasyPrefImpl.write(context)
+        return EasyPrefImpl.write(context, Encryption.NONE, Pass.empty)
     }
 
     override fun write(context: Context, fileName: String): Write {
-        return EasyPrefImpl.writeOn(context, fileName)
+        return EasyPrefImpl.writeOn(context, fileName, Encryption.NONE, Pass.empty)
     }
 
     override fun write(context: Context, fileName: String, mode: Int): Write {
-        return EasyPrefImpl.writeOn(context, fileName, mode)
+        return EasyPrefImpl.writeOn(context, fileName, mode, Encryption.NONE, Pass.empty)
     }
 
     override fun read(): Read {
@@ -73,15 +88,15 @@ object Prefs : PrefProvider {
     }
 
     override fun read(context: Context): Read {
-        return EasyPrefImpl.read(context)
+        return EasyPrefImpl.read(context, Encryption.NONE, Pass.empty)
     }
 
     override fun read(context: Context, fileName: String): Read {
-        return EasyPrefImpl.readOn(context, fileName)
+        return EasyPrefImpl.readOn(context, fileName, Encryption.NONE, Pass.empty)
     }
 
     override fun read(context: Context, fileName: String, mode: Int): Read {
-        return EasyPrefImpl.readOn(context, fileName, mode)
+        return EasyPrefImpl.readOn(context, fileName, mode, Encryption.NONE, Pass.empty)
     }
 
     override fun edit(): Edit {
@@ -106,14 +121,14 @@ object Prefs : PrefProvider {
     }
 
     override fun edit(context: Context): Edit {
-        return EasyPrefImpl.edit(context)
+        return EasyPrefImpl.edit(context, Encryption.NONE, Pass.empty)
     }
 
     override fun edit(context: Context, fileName: String): Edit {
-        return EasyPrefImpl.editOn(context, fileName)
+        return EasyPrefImpl.editOn(context, fileName, Encryption.NONE, Pass.empty)
     }
 
     override fun edit(context: Context, fileName: String, mode: Int): Edit {
-        return EasyPrefImpl.editOn(context, fileName, mode)
+        return EasyPrefImpl.editOn(context, fileName, mode, Encryption.NONE, Pass.empty)
     }
 }
diff --git a/library/src/main/java/io/easyprefs/contract/EasyPref.kt b/library/src/main/java/io/easyprefs/contract/EasyPref.kt
@@ -1,29 +1,30 @@
 package io.easyprefs.contract
 
 import android.content.Context
+import io.easyprefs.typedef.Encryption
 
 interface EasyPref {
-    fun write(context: Context): Write
-    fun writeOn(context: Context, fileName: String): Write
+    fun write(context: Context, encType: Encryption, aesKey: String): Write
+    fun writeOn(context: Context, fileName: String, encType: Encryption, aesKey: String): Write
     fun writeOn(
         context: Context,
         fileName: String,
-        mode: Int
+        mode: Int, encType: Encryption, aesKey: String
     ): Write
 
-    fun read(context: Context): Read
-    fun readOn(context: Context, fileName: String): Read
+    fun read(context: Context, encType: Encryption, aesKey: String): Read
+    fun readOn(context: Context, fileName: String, encType: Encryption, aesKey: String): Read
     fun readOn(
         context: Context,
         fileName: String,
-        mode: Int
+        mode: Int, encType: Encryption, aesKey: String
     ): Read
 
-    fun edit(context: Context): Edit
-    fun editOn(context: Context, fileName: String): Edit
+    fun edit(context: Context, encType: Encryption, aesKey: String): Edit
+    fun editOn(context: Context, fileName: String, encType: Encryption, aesKey: String): Edit
     fun editOn(
         context: Context,
         fileName: String,
-        mode: Int
+        mode: Int, encType: Encryption, aesKey: String
     ): Edit
 }
diff --git a/library/src/main/java/io/easyprefs/contract/PrefProvider.kt b/library/src/main/java/io/easyprefs/contract/PrefProvider.kt
diff --git a/library/src/main/java/io/easyprefs/contract/Secure.kt b/library/src/main/java/io/easyprefs/contract/Secure.kt
@@ -0,0 +1,6 @@
+package io.easyprefs.contract
+
+import io.easyprefs.contract.provider.ReadPrefProvider
+import io.easyprefs.contract.provider.WritePrefProvider
+
+interface Secure : WritePrefProvider, ReadPrefProvider
diff --git a/library/src/main/java/io/easyprefs/contract/provider/EditPrefProvider.kt b/library/src/main/java/io/easyprefs/contract/provider/EditPrefProvider.kt
@@ -0,0 +1,14 @@
+package io.easyprefs.contract.provider
+
+import android.content.Context
+import io.easyprefs.contract.Edit
+
+interface EditPrefProvider {
+    fun edit(): Edit
+    fun edit(fileName: String): Edit
+    fun edit(fileName: String, mode: Int): Edit
+
+    fun edit(context: Context): Edit
+    fun edit(context: Context, fileName: String): Edit
+    fun edit(context: Context, fileName: String, mode: Int): Edit
+}
diff --git a/library/src/main/java/io/easyprefs/contract/provider/PrefProvider.kt b/library/src/main/java/io/easyprefs/contract/provider/PrefProvider.kt
@@ -0,0 +1,10 @@
+package io.easyprefs.contract.provider
+
+import android.content.Context
+
+interface PrefProvider : SecurePrefProvider,
+    WritePrefProvider,
+    ReadPrefProvider,
+    EditPrefProvider {
+    fun initializeApp(context: Context)
+}
diff --git a/library/src/main/java/io/easyprefs/contract/provider/ReadPrefProvider.kt b/library/src/main/java/io/easyprefs/contract/provider/ReadPrefProvider.kt
@@ -0,0 +1,14 @@
+package io.easyprefs.contract.provider
+
+import android.content.Context
+import io.easyprefs.contract.Read
+
+interface ReadPrefProvider {
+    fun read(): Read
+    fun read(fileName: String): Read
+    fun read(fileName: String, mode: Int): Read
+
+    fun read(context: Context): Read
+    fun read(context: Context, fileName: String): Read
+    fun read(context: Context, fileName: String, mode: Int): Read
+}
diff --git a/library/src/main/java/io/easyprefs/contract/provider/SecurePrefProvider.kt b/library/src/main/java/io/easyprefs/contract/provider/SecurePrefProvider.kt
@@ -0,0 +1,8 @@
+package io.easyprefs.contract.provider
+
+import io.easyprefs.contract.Secure
+
+interface SecurePrefProvider {
+    fun securely(): Secure
+    fun securely(aesKey: String): Secure
+}
diff --git a/library/src/main/java/io/easyprefs/contract/provider/WritePrefProvider.kt b/library/src/main/java/io/easyprefs/contract/provider/WritePrefProvider.kt
@@ -0,0 +1,14 @@
+package io.easyprefs.contract.provider
+
+import android.content.Context
+import io.easyprefs.contract.Write
+
+interface WritePrefProvider {
+    fun write(): Write
+    fun write(fileName: String): Write
+    fun write(fileName: String, mode: Int): Write
+
+    fun write(context: Context): Write
+    fun write(context: Context, fileName: String): Write
+    fun write(context: Context, fileName: String, mode: Int): Write
+}
diff --git a/library/src/main/java/io/easyprefs/ext/Extensions.kt b/library/src/main/java/io/easyprefs/ext/Extensions.kt
@@ -0,0 +1,7 @@
+package io.easyprefs.ext
+
+class Pass {
+    companion object {
+        const val empty = ""
+    }
+}
diff --git a/library/src/main/java/io/easyprefs/impl/EasyPrefImpl.kt b/library/src/main/java/io/easyprefs/impl/EasyPrefImpl.kt
@@ -5,37 +5,50 @@ import io.easyprefs.contract.EasyPref
 import io.easyprefs.contract.Edit
 import io.easyprefs.contract.Read
 import io.easyprefs.contract.Write
+import io.easyprefs.typedef.Encryption
 
 object EasyPrefImpl : EasyPref {
 
-    override fun write(context: Context): Write {
+    override fun write(context: Context, encType: Encryption, aesKey: String): Write {
         return WriteImpl(
             context.getSharedPreferences(
                 getFileName(context),
                 Context.MODE_PRIVATE
-            ).edit()
+            ).edit(),
+            encType, aesKey
         )
     }
 
-    override fun writeOn(context: Context, fileName: String): Write {
+    override fun writeOn(
+        context: Context,
+        fileName: String,
+        encType: Encryption,
+        aesKey: String
+    ): Write {
         return WriteImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
                 Context.MODE_PRIVATE
-            ).edit()
+            ).edit(), encType, aesKey
         )
     }
 
-    override fun writeOn(context: Context, fileName: String, mode: Int): Write {
+    override fun writeOn(
+        context: Context,
+        fileName: String,
+        mode: Int,
+        encType: Encryption,
+        aesKey: String
+    ): Write {
         return WriteImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
                 mode
-            ).edit()
+            ).edit(), encType, aesKey
         )
     }
 
-    override fun read(context: Context): Read {
+    override fun read(context: Context, encType: Encryption, aesKey: String): Read {
         return ReadImpl(
             context.getSharedPreferences(
                 getFileName(context),
@@ -44,7 +57,12 @@ object EasyPrefImpl : EasyPref {
         )
     }
 
-    override fun readOn(context: Context, fileName: String): Read {
+    override fun readOn(
+        context: Context,
+        fileName: String,
+        encType: Encryption,
+        aesKey: String
+    ): Read {
         return ReadImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
@@ -53,7 +71,13 @@ object EasyPrefImpl : EasyPref {
         )
     }
 
-    override fun readOn(context: Context, fileName: String, mode: Int): Read {
+    override fun readOn(
+        context: Context,
+        fileName: String,
+        mode: Int,
+        encType: Encryption,
+        aesKey: String
+    ): Read {
         return ReadImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
@@ -62,7 +86,7 @@ object EasyPrefImpl : EasyPref {
         )
     }
 
-    override fun edit(context: Context): Edit {
+    override fun edit(context: Context, encType: Encryption, aesKey: String): Edit {
         return EditImpl(
             context.getSharedPreferences(
                 getFileName(context),
@@ -71,7 +95,12 @@ object EasyPrefImpl : EasyPref {
         )
     }
 
-    override fun editOn(context: Context, fileName: String): Edit {
+    override fun editOn(
+        context: Context,
+        fileName: String,
+        encType: Encryption,
+        aesKey: String
+    ): Edit {
         return EditImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
@@ -80,7 +109,13 @@ object EasyPrefImpl : EasyPref {
         )
     }
 
-    override fun editOn(context: Context, fileName: String, mode: Int): Edit {
+    override fun editOn(
+        context: Context,
+        fileName: String,
+        mode: Int,
+        encType: Encryption,
+        aesKey: String
+    ): Edit {
         return EditImpl(
             context.getSharedPreferences(
                 getFileNameOn(fileName),
diff --git a/library/src/main/java/io/easyprefs/impl/SecureImpl.kt b/library/src/main/java/io/easyprefs/impl/SecureImpl.kt
diff --git a/library/src/main/java/io/easyprefs/impl/WriteImpl.kt b/library/src/main/java/io/easyprefs/impl/WriteImpl.kt
diff --git a/library/src/main/java/io/easyprefs/secure/AESCrypt.kt b/library/src/main/java/io/easyprefs/secure/AESCrypt.kt
diff --git a/library/src/main/java/io/easyprefs/typedef/Annotations.kt b/library/src/main/java/io/easyprefs/typedef/Annotations.kt
