Feat/sdk 4214/Encryption v2

clevertap-core/src/main/java/com/clevertap/android/sdk/CleverTapFactory.kt

@@ -3,6 +3,7 @@ package com.clevertap.android.sdk
 import android.content.Context
 import com.clevertap.android.sdk.CTPreferenceCache.Companion.getInstance
 import com.clevertap.android.sdk.StoreProvider.Companion.getInstance
+import com.clevertap.android.sdk.cryption.CryptFactory
 import com.clevertap.android.sdk.cryption.CryptHandler
 import com.clevertap.android.sdk.cryption.CryptMigrator
 import com.clevertap.android.sdk.cryption.CryptRepository
@@ -94,11 +95,15 @@ internal object CleverTapFactory {
             context = context,
             accountId = config.accountId
         )
+        val cryptFactory = CryptFactory(
+            context = context,
+            accountId = config.accountId
+        )
         val cryptHandler = CryptHandler(
             encryptionLevel = fromInt(value = config.encryptionLevel),
             accountID = config.accountId,
-            context = context,
-            repository = repository
+            repository = repository,
+            cryptFactory = cryptFactory
         )
         val dataMigrationRepository = DataMigrationRepository(
             context = context,

clevertap-core/src/main/java/com/clevertap/android/sdk/cryption/AESCrypt.kt

@@ -14,15 +14,13 @@ import javax.crypto.spec.SecretKeySpec
 /**
  * This class implements the AES Cryption algorithm
  */
-class AESCrypt(val accountID: String) : Crypt() {
+class AESCrypt(accountID: String) : Crypt() {
     /**
      * This method returns the key-password to be used for encryption/decryption
      *
      * @return key-password
      */
-    private fun generateKeyPassword(): String {
-        return APP_ID_KEY_PREFIX + accountID + APP_ID_KEY_SUFFIX
-    }
+    private val keyPassword: String = APP_ID_KEY_PREFIX + accountID + APP_ID_KEY_SUFFIX
 
     /**
      * This method is used internally to encrypt the plain text
@@ -32,9 +30,9 @@ class AESCrypt(val accountID: String) : Crypt() {
      */
     override fun encryptInternal(plainText: String): String? {
         return performCryptOperation(
-            Cipher.ENCRYPT_MODE, generateKeyPassword(), plainText.toByteArray(
-                StandardCharsets.UTF_8
-            )
+            mode = Cipher.ENCRYPT_MODE,
+            password = keyPassword,
+            text = plainText.toByteArray(StandardCharsets.UTF_8)
         )?.let { encryptedBytes ->
             encryptedBytes.contentToString()
         }
@@ -49,7 +47,11 @@ class AESCrypt(val accountID: String) : Crypt() {
      */
     override fun decryptInternal(cipherText: String): String? {
         return parseCipherText(cipherText)?.let { bytes ->
-            performCryptOperation(Cipher.DECRYPT_MODE, generateKeyPassword(), bytes)
+            performCryptOperation(
+                mode = Cipher.DECRYPT_MODE,
+                password = keyPassword,
+                text = bytes
+            )
         }?.let { decryptedBytes ->
             String(decryptedBytes, StandardCharsets.UTF_8)
         }

clevertap-core/src/main/java/com/clevertap/android/sdk/cryption/AESGCMCrypt.kt

@@ -182,7 +182,28 @@ class AESGCMCrypt(private val context: Context) : Crypt() {
         }
     }
 
-    private data class AESGCMCryptResult(val iv: ByteArray, val encryptedBytes: ByteArray)
+    private data class AESGCMCryptResult(
+        val iv: ByteArray,
+        val encryptedBytes: ByteArray
+    ) {
+        override fun equals(other: Any?): Boolean {
+            if (this === other) return true
+            if (javaClass != other?.javaClass) return false
+
+            other as AESGCMCryptResult
+
+            if (!iv.contentEquals(other.iv)) return false
+            if (!encryptedBytes.contentEquals(other.encryptedBytes)) return false
+
+            return true
+        }
+
+        override fun hashCode(): Int {
+            var result = iv.contentHashCode()
+            result = 31 * result + encryptedBytes.contentHashCode()
+            return result
+        }
+    }
 
     // Utility extension functions for Base64 encoding/decoding
     private fun ByteArray.toBase64(): String = Base64.encodeToString(this, Base64.NO_WRAP)

clevertap-core/src/main/java/com/clevertap/android/sdk/cryption/CryptFactory.kt

@@ -1,18 +1,36 @@
 package com.clevertap.android.sdk.cryption
 
 import android.content.Context
+import com.clevertap.android.sdk.cryption.CryptHandler.EncryptionAlgorithm
 
 /**
  * This class is a factory class to generate a Crypt object based on the EncryptionAlgorithm
  */
-class CryptFactory {
+internal class CryptFactory(
+    private val context: Context,
+    private val accountId: String
+) {
+
+    // Cache to hold instances of Crypt for different encryption algorithms.
+    private val cryptInstances: MutableMap<EncryptionAlgorithm, Crypt> = mutableMapOf()
+
     companion object {
         @JvmStatic
-        fun getCrypt(type: CryptHandler.EncryptionAlgorithm, accountID: String, context: Context): Crypt {
+        fun getCrypt(type: EncryptionAlgorithm, accountID: String, context: Context): Crypt {
             return when (type) {
-                CryptHandler.EncryptionAlgorithm.AES -> AESCrypt(accountID)
-                CryptHandler.EncryptionAlgorithm.AES_GCM -> AESGCMCrypt(context)
+                EncryptionAlgorithm.AES -> AESCrypt(accountID)
+                EncryptionAlgorithm.AES_GCM -> AESGCMCrypt(context)
             }
         }
     }
+
+    /**
+     * Retrieves or creates a Crypt instance for the specified algorithm.
+     *
+     * @param algorithm - The encryption algorithm to use.
+     * @return The Crypt instance for the specified algorithm.
+     */
+    fun getCryptInstance(algorithm: EncryptionAlgorithm): Crypt {
+        return cryptInstances.getOrPut(algorithm) { getCrypt(algorithm, accountId, context) }
+    }
 }

clevertap-core/src/main/java/com/clevertap/android/sdk/cryption/CryptHandler.kt

@@ -1,6 +1,5 @@
 package com.clevertap.android.sdk.cryption
 
-import android.content.Context
 import com.clevertap.android.sdk.Constants
 import com.clevertap.android.sdk.Constants.AES_GCM_SUFFIX
 import com.clevertap.android.sdk.Constants.AES_GCM_PREFIX
@@ -13,16 +12,13 @@ import com.clevertap.android.sdk.Constants.AES_PREFIX
  * @param encryptionLevel - The encryption level to use.
  * @param accountID - The account ID for which the cryptographic operations are performed.
  */
-class CryptHandler(
+internal class CryptHandler constructor(
     private val encryptionLevel: EncryptionLevel,
     private val accountID: String,
-    private val context: Context,
-    private val repository: CryptRepository
+    private val repository: CryptRepository,
+    private val cryptFactory: CryptFactory
 ) {
 
-    // Cache to hold instances of Crypt for different encryption algorithms.
-    private val cryptInstances: MutableMap<EncryptionAlgorithm, Crypt> = mutableMapOf()
-
     /**
      * Supported encryption algorithms.
      */
@@ -45,19 +41,22 @@ class CryptHandler(
         algorithm: EncryptionAlgorithm = EncryptionAlgorithm.AES_GCM
     ): String? {
 
-        if(isTextEncrypted(plainText))
+        if (isTextEncrypted(plainText)) {
             return plainText
+        }
 
         // Use AES_GCM algorithm by default.
-        val crypt = getCryptInstance(algorithm)
+        val crypt = cryptFactory.getCryptInstance(algorithm)
         when (encryptionLevel) {
             EncryptionLevel.MEDIUM -> {
                 // Encrypt only if the key is valid
                 if (key in Constants.MEDIUM_CRYPT_KEYS) {
                     return crypt.encryptInternal(plainText)
                 }
             }
-            else -> return plainText
+            else -> {
+                return plainText
+            }
         }
         return plainText
     }
@@ -80,7 +79,7 @@ class CryptHandler(
             return cipherText
         }
 
-        val crypt = getCryptInstance(algorithm)
+        val crypt = cryptFactory.getCryptInstance(algorithm)
         when (encryptionLevel) {
             EncryptionLevel.MEDIUM -> {
                 // Decrypt only if the key is valid.
@@ -101,8 +100,11 @@ class CryptHandler(
      * @param plainText - The text to encrypt.
      * @return The encrypted text, or null if encryption fails.
      */
-    fun encrypt(plainText: String, algorithm: EncryptionAlgorithm = EncryptionAlgorithm.AES_GCM): String? {
-        val crypt = getCryptInstance(algorithm)
+    fun encrypt(
+        plainText: String,
+        algorithm: EncryptionAlgorithm = EncryptionAlgorithm.AES_GCM
+    ): String? {
+        val crypt = cryptFactory.getCryptInstance(algorithm)
         return crypt.encryptInternal(plainText)
     }
 
@@ -113,21 +115,14 @@ class CryptHandler(
      * @return The decrypted text, or null if decryption fails.
      */
     @JvmOverloads
-    fun decrypt(cipherText: String, algorithm: EncryptionAlgorithm = EncryptionAlgorithm.AES_GCM): String? {
-        val crypt = getCryptInstance(algorithm)
+    fun decrypt(
+        cipherText: String,
+        algorithm: EncryptionAlgorithm = EncryptionAlgorithm.AES_GCM
+    ): String? {
+        val crypt = cryptFactory.getCryptInstance(algorithm)
         return crypt.decryptInternal(cipherText)
     }
 
-    /**
-     * Retrieves or creates a Crypt instance for the specified algorithm.
-     *
-     * @param algorithm - The encryption algorithm to use.
-     * @return The Crypt instance for the specified algorithm.
-     */
-    private fun getCryptInstance(algorithm: EncryptionAlgorithm): Crypt {
-        return cryptInstances.getOrPut(algorithm) { CryptFactory.getCrypt(algorithm, accountID, context) }
-    }
-
     /**
      * Updates the encryption state in case of failure while processing new data.
      *