-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[APT-10658] Better EncryptedSharedPreference Resilience
The earlier failsafe does not protect against the app crashing on startup. This time, the exception is caught and the SecureStorage can handle the SharedPref being null.
- Loading branch information
Showing
6 changed files
with
130 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
Armadillo/src/main/java/com/scribd/armadillo/extensions/SharedPrefExt.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package com.scribd.armadillo.extensions | ||
|
|
||
| import android.content.Context | ||
| import android.content.SharedPreferences | ||
| import android.security.keystore.KeyGenParameterSpec | ||
| import android.security.keystore.KeyProperties.BLOCK_MODE_GCM | ||
| import android.security.keystore.KeyProperties.ENCRYPTION_PADDING_NONE | ||
| import android.security.keystore.KeyProperties.PURPOSE_DECRYPT | ||
| import android.security.keystore.KeyProperties.PURPOSE_ENCRYPT | ||
| import android.util.Log | ||
| import androidx.security.crypto.EncryptedSharedPreferences | ||
| import androidx.security.crypto.MasterKeys | ||
| import com.scribd.armadillo.Constants.DI.STANDARD_STORE_FILENAME | ||
| import com.scribd.armadillo.Constants.Keys.ANDROID_KEYSTORE_NAME | ||
| import java.io.File | ||
| import java.security.KeyStore | ||
|
|
||
| fun SharedPreferences.deleteSharedPreference(context: Context, filename: String, keystoreAlias: String) { | ||
| val tag = "DeletingSharedPrefs" | ||
| try { | ||
| val sharedPrefsFile = File( | ||
| (context.filesDir.getParent()?.plus("/shared_prefs/")) + filename + ".xml" | ||
| ) | ||
|
|
||
| edit().clear().commit() | ||
|
|
||
| if (sharedPrefsFile.exists()) { | ||
| 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}") | ||
| } | ||
|
|
||
| val keyStore = KeyStore.getInstance(ANDROID_KEYSTORE_NAME) | ||
| keyStore.load(null) | ||
| keyStore.deleteEntry(keystoreAlias) | ||
| } catch (e: Exception) { | ||
| Log.e(tag, "Error occurred while trying to reset shared prefs", e) | ||
| } | ||
| } | ||
|
|
||
| fun createEncryptedSharedPrefKeyStoreWithRetry(context: Context, fileName: String, keystoreAlias: String): SharedPreferences? { | ||
| val firstAttempt = createEncryptedSharedPrefsKeyStore(context = context, fileName = fileName, keystoreAlias = keystoreAlias) | ||
| return if(firstAttempt != null) { | ||
| firstAttempt | ||
| } else { | ||
| context.getSharedPreferences(fileName, Context.MODE_PRIVATE).deleteSharedPreference( | ||
| context = context, | ||
| filename = fileName, | ||
| keystoreAlias = keystoreAlias | ||
| ) | ||
| createEncryptedSharedPrefsKeyStore(context = context, fileName = fileName, keystoreAlias = keystoreAlias) | ||
| } | ||
| } | ||
|
|
||
| fun createEncryptedSharedPrefsKeyStore(context: Context, fileName: String, keystoreAlias: String) | ||
| : SharedPreferences? { | ||
| val keySpec = KeyGenParameterSpec.Builder(keystoreAlias, PURPOSE_ENCRYPT or PURPOSE_DECRYPT) | ||
| .setKeySize(256) | ||
| .setBlockModes(BLOCK_MODE_GCM) | ||
| .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).deleteSharedPreference( | ||
| context = context, | ||
| filename = fileName, | ||
| keystoreAlias = keystoreAlias ) | ||
| MasterKeys.getOrCreate(keySpec) | ||
| } | ||
| return try { | ||
| EncryptedSharedPreferences.create( | ||
| fileName, | ||
| keys, | ||
| context, | ||
| EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV, | ||
| EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM | ||
| ) | ||
| } catch(ex: Exception) { | ||
| null | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters