Merge pull request #584 from AzureAD/release/0.0.15

Merge Release/0.0.15 to master

Author: kreedula

changelog.txt

@@ -1,3 +1,7 @@
+Version 0.0.15
+-------------
+- Bug Fix : Adding null safety check to avoid crash on EmbeddedWebViewStrategy
+
 Version 0.0.14
 -------------
 - Bug fix : Read user id from the request bundle for broker silent request.

common/src/main/java/com/microsoft/identity/common/adal/internal/cache/StorageHelper.java

@@ -25,7 +25,9 @@
 import android.annotation.SuppressLint;
 import android.annotation.TargetApi;
 import android.content.Context;
+import android.content.SharedPreferences;
 import android.os.Build;
+import android.preference.PreferenceManager;
 import android.security.KeyPairGeneratorSpec;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -119,6 +121,8 @@ public class StorageHelper implements IStorageHelper {
 
     private static final String HMAC_ALGORITHM = "HmacSHA256";
 
+    private static final String CURRENT_ACTIVE_BROKER = "current_active_broker";
+
     private static final int KEY_SIZE = 256;
 
     /**
@@ -295,13 +299,10 @@ public String decrypt(final String encryptedBlob) throws GeneralSecurityExceptio
                 }
 
                 String result = decryptWithSecretKey(bytes, secretKey);
-                Logger.verbose(TAG + methodName, "Finished decryption.");
+                Logger.verbose(TAG + methodName, "Finished decryption with keyType:" + keyType.name());
                 return result;
             } catch (GeneralSecurityException | IOException e) {
-                logEvent(methodName,
-                        AuthenticationConstants.TelemetryEvents.DECRYPTION_ERROR,
-                        true,
-                        "failed to decrypt with keyType:" + keyType.name() + " exception: " + e.toString());
+                emitDecryptionFailureTelemetryIfNeeded(keyType, e);
             }
         }
 
@@ -312,6 +313,36 @@ public String decrypt(final String encryptedBlob) throws GeneralSecurityExceptio
         throw new GeneralSecurityException(ErrorStrings.DECRYPTION_FAILED);
     }
 
+    // This is to make sure that Decryption error failure is only emitted once - to avoid bombarding ARIA.
+    private void emitDecryptionFailureTelemetryIfNeeded(@NonNull final KeyType keyType,
+                                                        @NonNull final Exception exception) {
+        final String methodName = ":emitDecryptionFailureTelemetryIfNeeded";
+        final SharedPreferences sharedPreferences = PreferenceManager.
+                getDefaultSharedPreferences(mContext);
+        final String previousActiveBroker = sharedPreferences.getString(
+                CURRENT_ACTIVE_BROKER,
+                ""
+        );
+        final String activeBroker = mContext.getPackageName();
+
+        if (!previousActiveBroker.equalsIgnoreCase(activeBroker)) {
+            final String message = "Decryption failed with key: " + keyType.name()
+                    + " Active broker: " + activeBroker
+                    + " Exception: " + exception.toString();
+
+            Logger.info(TAG + methodName, message);
+
+            if (mTelemetryCallback != null) {
+                mTelemetryCallback.logEvent(mContext,
+                        AuthenticationConstants.TelemetryEvents.DECRYPTION_ERROR,
+                        true,
+                        message);
+            }
+
+            sharedPreferences.edit().putString(CURRENT_ACTIVE_BROKER, activeBroker).apply();
+        }
+    }
+
     /**
      * Determine type of encryption performed on the given data blob.
      * NOTE: If it cannot verify the keyVersion, it will assume that this data is not encrypted.
@@ -524,8 +555,6 @@ protected void setBlobVersion(@NonNull String blobVersion) {
     public SecretKey loadSecretKey(@NonNull final KeyType keyType) throws IOException, GeneralSecurityException {
         final String methodName = ":loadSecretKey";
 
-        Logger.verbose(TAG + methodName, "Loading key with Type:" + keyType.name());
-
         switch (keyType) {
             case LEGACY_AUTHENTICATOR_APP_KEY:
                 return getSecretKey(AuthenticationSettings.INSTANCE.getBrokerSecretKeys().get(AZURE_AUTHENTICATOR_APP_PACKAGE_NAME));

common/src/main/java/com/microsoft/identity/common/internal/ui/webview/EmbeddedWebViewAuthorizationStrategy.java

@@ -23,7 +23,6 @@
 package com.microsoft.identity.common.internal.ui.webview;
 
 import android.app.Activity;
-import android.app.PendingIntent;
 import android.content.Intent;
 import android.net.Uri;
 import android.support.annotation.NonNull;
@@ -88,8 +87,22 @@ public Future<AuthorizationResult> requestAuthorization(GenericAuthorizationRequ
     @Override
     public void completeAuthorization(int requestCode, int resultCode, Intent data) {
         if (requestCode == BROWSER_FLOW) {
-            final AuthorizationResult result = mOAuth2Strategy.getAuthorizationResultFactory().createAuthorizationResult(resultCode, data, mAuthorizationRequest);
-            mAuthorizationResultFuture.setResult(result);
+            if (mOAuth2Strategy != null && mAuthorizationResultFuture != null) {
+                final AuthorizationResult result = mOAuth2Strategy
+                        .getAuthorizationResultFactory()
+                        .createAuthorizationResult(
+                                resultCode,
+                                data,
+                                mAuthorizationRequest
+                        );
+                mAuthorizationResultFuture.setResult(result);
+            } else {
+                Logger.warn(TAG, "SDK Cancel triggering before request is sent out. " +
+                        "Potentially due to an stale activity state, " +
+                        "oAuth2Strategy null ? [" + (mOAuth2Strategy == null) + "]" +
+                        "mAuthorizationResultFuture ? [" + (mAuthorizationResultFuture == null) + "]"
+                );
+            }
         } else {
             Logger.warnPII(TAG, "Unknown request code " + requestCode);
         }

common/versioning/version.properties

@@ -1,3 +1,3 @@
 #Thu Aug 02 12:03:16 PDT 2018
-versionName=0.0.14
+versionName=0.0.15
 versionCode=1