Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MOB - 6865] - Keychain null crash fix #635

Merged
merged 3 commits into from
Oct 3, 2023
Merged

[MOB - 6865] - Keychain null crash fix #635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61943df
[MOB - 6865] - Keychain null crash fix
Sep 21, 2023
f8a8fa9
Catching Error along with Exception
Sep 27, 2023
8d5b427
Merge pull request #637 from Iterable/MOB-6865-add-on-changes
Ayyanchira Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion iterableapi/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ dependencies {
api 'androidx.appcompat:appcompat:1.0.0'
api 'androidx.annotation:annotation:1.0.0'
api 'com.google.firebase:firebase-messaging:20.3.0'
implementation "androidx.security:security-crypto:1.1.0-alpha04"
implementation "androidx.security:security-crypto:1.1.0-alpha06"

testImplementation 'junit:junit:4.12'
testImplementation 'androidx.test:runner:1.3.0'
Expand Down
30 changes: 17 additions & 13 deletions iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ IterableAuthManager getAuthManager() {
return authManager;
}

@NonNull
@Nullable
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
IterableKeychain getKeychain() {
if (keychain == null) {
try {
Expand Down Expand Up @@ -350,15 +350,25 @@ private String getDeviceId() {
}

private void storeAuthData() {
getKeychain().saveEmail(_email);
getKeychain().saveUserId(_userId);
getKeychain().saveAuthToken(_authToken);
IterableKeychain iterableKeychain = getKeychain();
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
if (iterableKeychain != null) {
iterableKeychain.saveEmail(_email);
iterableKeychain.saveUserId(_userId);
iterableKeychain.saveAuthToken(_authToken);
} else {
IterableLogger.e(TAG, "Shared preference creation failed. ");
}
}

private void retrieveEmailAndUserId() {
_email = getKeychain().getEmail();
_userId = getKeychain().getUserId();
_authToken = getKeychain().getAuthToken();
IterableKeychain iterableKeychain = getKeychain();
if (iterableKeychain != null) {
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
_email = iterableKeychain.getEmail();
_userId = iterableKeychain.getUserId();
_authToken = iterableKeychain.getAuthToken();
} else {
IterableLogger.e(TAG, "retrieveEmailAndUserId: Shared preference creation failed. Could not retrieve email/userId");
}

if (config.authHandler != null) {
if (_authToken != null) {
Expand All @@ -370,10 +380,6 @@ private void retrieveEmailAndUserId() {
}
}

private void updateSDKVersion() {

}

Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
private class IterableApiAuthProvider implements IterableApiClient.AuthProvider {
@Nullable
@Override
Expand Down Expand Up @@ -507,8 +513,6 @@ public static void initialize(@NonNull Context context, @NonNull String apiKey,
sharedInstance.config = new IterableConfig.Builder().build();
}

sharedInstance.updateSDKVersion();
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved

sharedInstance.retrieveEmailAndUserId();

IterableActivityMonitor.getInstance().registerLifecycleCallbacks(context);
Expand Down
6 changes: 6 additions & 0 deletions iterableapi/src/main/java/com/iterable/iterableapi/IterableConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,12 @@ public Builder setAllowedProtocols(@NonNull String[] allowedProtocols) {
return this;
}

/**
* Set whether the SDK should enforce encryption. If set to `true`, the SDK will not use fallback mechanism
* of storing data in un-encrypted shared preferences if encrypted database is not available. Set this to `true`
* if PII confidentiality is a concern for your app.
* @param encryptionEnforced `true` will have the SDK enforce encryption.
*/
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
public Builder setEncryptionEnforced(boolean encryptionEnforced) {
this.encryptionEnforced = encryptionEnforced;
return this;
Expand Down
69 changes: 36 additions & 33 deletions iterableapi/src/main/java/com/iterable/iterableapi/IterableKeychain.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ class IterableKeychain {
encryptionEnabled = false
sharedPrefs = context.getSharedPreferences(
IterableConstants.SHARED_PREFS_FILE,
Context.MODE_PRIVATE)
Context.MODE_PRIVATE
)
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
IterableLogger.v(TAG, "SharedPreferences being used")
} else {
// See if EncryptedSharedPreferences can be created successfully
Expand All @@ -39,45 +40,42 @@ class IterableKeychain {
encryptedSharedPrefsFileName,
masterKeyAlias,
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM)
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
)
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
encryptionEnabled = true
} catch (e: Exception) {
} catch (e: Throwable) {
if (e is Error) {
IterableLogger.e(
TAG,
"EncryptionSharedPreference creation failed with Error. Attempting to continue"
)
}

if (encryptionEnforced) {
//TODO: In memory Or similar solution needs to be implemented in future.
IterableLogger.e(TAG, "Error creating EncryptedSharedPreferences", e)
//TODO: In-memory or similar solution needs to be implemented in the future.
IterableLogger.w(
TAG,
"Encryption is enforced. PII will not be persisted due to EncryptionSharedPreference failure. Email/UserId and Auth token will have to be passed for every app session.",
e
)
throw e.fillInStackTrace()
} else {
sharedPrefs = context.getSharedPreferences(
IterableConstants.SHARED_PREFS_FILE,
Context.MODE_PRIVATE)
Context.MODE_PRIVATE
)
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
IterableLogger.w(
TAG,
"Using SharedPreference as EncryptionSharedPreference creation failed."
)
encryptionEnabled = false
}
}

//Try to migrate data from SharedPreferences to EncryptedSharedPreferences
if(encryptionEnabled) {
if (encryptionEnabled) {
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
migrateAuthDataFromSharedPrefsToKeychain(context)
}

}
val masterKeyAlias = MasterKey.Builder(context)
.setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
.build()
sharedPrefs = try {
EncryptedSharedPreferences.create(
context,
encryptedSharedPrefsFileName,
masterKeyAlias,
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
)
} catch (e: Exception) {
if (encryptionEnforced) {
IterableLogger.e(TAG, "Error creating EncryptedSharedPreferences", e)
throw e.fillInStackTrace()
} else {
context.getSharedPreferences(encryptedSharedPrefsFileName, Context.MODE_PRIVATE)
}
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
}
}

Expand Down Expand Up @@ -113,17 +111,20 @@ class IterableKeychain {

@RequiresApi(api = Build.VERSION_CODES.M)
private fun migrateAuthDataFromSharedPrefsToKeychain(context: Context) {
val oldPrefs: SharedPreferences = context.getSharedPreferences(
val oldPrefs: SharedPreferences = context.getSharedPreferences(
IterableConstants.SHARED_PREFS_FILE,
Context.MODE_PRIVATE)
Context.MODE_PRIVATE
)
val sharedPrefsEmail = oldPrefs.getString(IterableConstants.SHARED_PREFS_EMAIL_KEY, null)
val sharedPrefsUserId = oldPrefs.getString(IterableConstants.SHARED_PREFS_USERID_KEY, null)
val sharedPrefsAuthToken = oldPrefs.getString(IterableConstants.SHARED_PREFS_AUTH_TOKEN_KEY, null)
val sharedPrefsAuthToken =
oldPrefs.getString(IterableConstants.SHARED_PREFS_AUTH_TOKEN_KEY, null)
val editor: SharedPreferences.Editor = oldPrefs.edit()
if (getEmail() == null && sharedPrefsEmail != null) {
saveEmail(sharedPrefsEmail)
editor.remove(IterableConstants.SHARED_PREFS_EMAIL_KEY)
IterableLogger.v(TAG,
IterableLogger.v(
TAG,
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
"UPDATED: migrated email from SharedPreferences to IterableKeychain"
)
} else if (sharedPrefsEmail != null) {
Expand All @@ -132,7 +133,8 @@ class IterableKeychain {
if (getUserId() == null && sharedPrefsUserId != null) {
saveUserId(sharedPrefsUserId)
editor.remove(IterableConstants.SHARED_PREFS_USERID_KEY)
IterableLogger.v(TAG,
IterableLogger.v(
TAG,
"UPDATED: migrated userId from SharedPreferences to IterableKeychain"
)
} else if (sharedPrefsUserId != null) {
Comment on lines 135 to 140
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cosmetic changes

Expand All @@ -141,7 +143,8 @@ class IterableKeychain {
if (getAuthToken() == null && sharedPrefsAuthToken != null) {
saveAuthToken(sharedPrefsAuthToken)
editor.remove(IterableConstants.SHARED_PREFS_AUTH_TOKEN_KEY)
IterableLogger.v(TAG,
IterableLogger.v(
TAG,
Ayyanchira marked this conversation as resolved.
Show resolved Hide resolved
"UPDATED: migrated authToken from SharedPreferences to IterableKeychain"
)
} else if (sharedPrefsAuthToken != null) {
Expand Down
Loading