Merge pull request #54 from scribd/kabliz/APT-10955-crash

[APT-10955] SharedPref Crash Fix

Author: kabliz

Armadillo/src/main/java/com/scribd/armadillo/extensions/SharedPrefExt.kt

@@ -28,7 +28,7 @@ fun SharedPreferences.deleteEncryptedSharedPreference(context: Context, filename
             val deleted = sharedPrefsFile.delete()
             Log.d(tag, "resetStorage() Shared prefs file deleted: $deleted; path: ${sharedPrefsFile.absolutePath}")
         } else {
-            Log.d(tag,"resetStorage() Shared prefs file non-existent; path: ${sharedPrefsFile.absolutePath}")
+            Log.d(tag, "resetStorage() Shared prefs file non-existent; path: ${sharedPrefsFile.absolutePath}")
         }
 
         val keyStore = KeyStore.getInstance(ANDROID_KEYSTORE_NAME)
@@ -41,7 +41,7 @@ fun SharedPreferences.deleteEncryptedSharedPreference(context: Context, filename
 
 fun createEncryptedSharedPrefKeyStoreWithRetry(context: Context, fileName: String, keystoreAlias: String): SharedPreferences? {
     val firstAttempt = createEncryptedSharedPrefsKeyStore(context = context, fileName = fileName, keystoreAlias = keystoreAlias)
-    return if(firstAttempt != null) {
+    return if (firstAttempt != null) {
         firstAttempt
     } else {
         context.getSharedPreferences(fileName, Context.MODE_PRIVATE).deleteEncryptedSharedPreference(
@@ -61,25 +61,26 @@ fun createEncryptedSharedPrefsKeyStore(context: Context, fileName: String, keyst
         .setEncryptionPaddings(ENCRYPTION_PADDING_NONE)
         .build()
 
-    val keys = try {
-        MasterKeys.getOrCreate(keySpec)
-    } catch (ex: Exception) {
-        //clear corrupted store, contents will be lost
-        context.getSharedPreferences(fileName, Context.MODE_PRIVATE).deleteEncryptedSharedPreference(
-            context = context,
-            filename = fileName,
-            keystoreAlias = keystoreAlias )
-        MasterKeys.getOrCreate(keySpec)
-    }
     return try {
+        val keys = try {
+            MasterKeys.getOrCreate(keySpec)
+        } catch (ex: Exception) {
+            //clear corrupted store, contents will be lost
+            context.getSharedPreferences(fileName, Context.MODE_PRIVATE).deleteEncryptedSharedPreference(
+                context = context,
+                filename = fileName,
+                keystoreAlias = keystoreAlias)
+            MasterKeys.getOrCreate(keySpec)
+        }
+
         EncryptedSharedPreferences.create(
             fileName,
             keys,
             context,
             EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
             EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
         )
-    } catch(ex: Exception) {
+    } catch (ex: Exception) {
         null
     }
 }

RELEASE.md

@@ -1,5 +1,8 @@
 # Project Armadillo Release Notes
 
+## 1.6.9
+- Improves the crash fix from 1.6.8, so that even retries on EncryptedSharedPreferences does not crash.
+
 ## 1.6.8
 - Fixes an app startup crash to EncryptedSharedPreference faults. 
 - Adds resilience to playing unencrypted content if it is optionally drm enabled.

gradle.properties

@@ -13,7 +13,7 @@ org.gradle.jvmargs=-Xmx1536m
 # org.gradle.parallel=true
 PACKAGE_NAME=com.scribd.armadillo
 GRADLE_PLUGIN_VERSION=7.2.0
-LIBRARY_VERSION=1.6.8
+LIBRARY_VERSION=1.6.9
 EXOPLAYER_VERSION=2.19.1
 RXJAVA_VERSION=2.2.4
 RXANDROID_VERSION=2.0.1