Release MSAL 1.6.0 (#1108)

* Add UI Tests in MSAL (#1047)

* Initial commit for msal automation app

* Updates to msal automation app

* Initial commit for ui autmation tests

* Updates to ui automation

* Add more ui automator tests

* Fix bugs in ui tests

* Add msal automated test, remove unused files

* Automate msal us gov sov cloud test plan

* Move ui test utilities to its own module

* Add ui automator versions to versions.gradle

* Add ui automation utilities to msal project

* Remove stale test code

* Remove stale code from setup

* Update submodule

* Rename packages

* Remove ignored tests

* Remove test application id; fix comment

* Refactor test setup logic

* Add mising license

* Remove acquire token btn from automation app

* Remove redundant username variable

* Disable test toast temporarily

* Update submodule

* Address comments

* Add comments with test descriptions

* Update submodule

* Remove mockito from automation test app deps

* Update submodule

* Update submodule

* Add correlation id to Authentication Result

* Update submodule

* Add new line at end of IAuthenticationResult.java

* Address comments

* Add unit tests for command parameters and correlation id

* Add unit tests for Authentication Result and correlation id

* Update submodule

* Address comments

* Update submodule

* changes

* Add single account overload tests (#1070)

* Add single account pca overload network tests

* Add mocked tests for single account overloads

* Remove unused code

* Update submodule

* Add back private

* Update submodule

* Update submodule to latest (#1073)

* Add basic b2c ui tests

* Add b2c tests for idlab siso policy

* Update submodule

* Update snapshot

* removed extra line

* Clean up b2c test code

* Update submodule

* Update submodule

* Update submodule to latest (#1082)

* Closes #1084 - Load properties via withInputStream syntax to auto-close (#1085)

* Closes #1084

* Goovier syntax

* Hotfix Release 1.5.4 - Merge to Master (#1083) (#1087)

* Hotfix Release 1.5.4 - Merge to Master (#1083)

* Update submodule to [email protected]

* Update version to 1.5.4

* Update gradle deps to 2.0.12

* Update changelog

* Fix merge issue

* Update common sumbodule.

 * Document the process.

* Update the documentation for comments.

* Add enums for cloud instance and audience

* Add authority overloads to Token Parameters

* Add tests for token parameters authority

* Add javadoc to enum constants

* Throw error if tenant specified but audience not My Org

* Remove unused method

* Fix #1092

* Fix #1096

* Update submodule

* Add Locale.ROOT to toLowerCase calls

* Post 1.5.5 Deployment Merge to Dev (#1106)

* Hotfix Release 1.5.4 - Merge to Master (#1083)

* Update submodule to [email protected]

* Update version to 1.5.4

* Update gradle deps to 2.0.12

* Update changelog

* MSAL Release 1.5.5 (#1104)

* Update submodule pointer to [email protected]

* Update version.properties

* Update changelog

* Update dependencies

* Update common submodule pointer to [email protected]

* Update changelog for hf versioning

* Update dependency for [email protected]

* Update snapshot, dist to 2.0.14 versions

* Update submodule pointer to [email protected]

* Update changelog for 1.6.0

* Update version.properties for 1.6.0-RC1

* Update build.gradle deps for 2.0.15-RC1

* Set submodule pointer to common@master (2.0.15)

* Set version.properties to 1.6.0

* Update build.gradle for [email protected]

* Update changelog for 1.6.0

Co-authored-by: Shahzaib <[email protected]>
Co-authored-by: shahzaibj <[email protected]>
Co-authored-by: Tanmay Manolkar <[email protected]>
Co-authored-by: tanmaymanolkar1 <[email protected]>
Co-authored-by: kreedula <[email protected]>
Co-authored-by: Krishna Eedula <[email protected]>
Co-authored-by: Adam Johnson <[email protected]>
Co-authored-by: AdamBJohnsonx <[email protected]>
Co-authored-by: Shane Oatman <[email protected]>

Author: 7 people

changelog

@@ -1,5 +1,14 @@
 MSAL Wiki : https://github.com/AzureAD/microsoft-authentication-library-for-android/wiki
 
+Version 1.6.0
+-----------
+- Introduces new AadAuthorityAudience enum to support new syntax for specifying cloud + audience
+- Adds new property to IAuthenticationResult: correlation_id
+- Fix for String encoding issue affecting devices with Turkish locale
+- Fix for #1092: (Single Account Mode) getCurrentAccount() does not return MSA accounts if broker is installed
+- Fix for #1096: (Single Account Mode) signOut() doesn't remove MSA accounts if broker is installed
+- Picks up [email protected]
+
 Version 1.5.5
 -----------
 - Picks up fixes in [email protected]

common

@@ -0,0 +1,15 @@
+
+In order to update the common submodule, we need to pull the latest version.
+
+In this flow, you may want to use a branch that isn't dev, since we may
+be using code that is experimental, or represents a fix or a patch.  In
+that event, you should checkout whatever branch is appropriate.
+
+```
+ cd common
+ git checkout dev
+ git pull
+ cd ..
+ git add common
+ git commit
+```

docs/submodule-update.md

@@ -12,6 +12,9 @@ ext {
     androidMavenGradlePluginVersion = "1.4.1"
 
     // Libraries
+    androidxTestRunnerVersion = "1.2.0"
+    androidxTestOrchestratorVersion = "1.2.0"
+    androidxTestMonitorVersion = "1.2.0"
     androidxTestCoreVersion = "1.2.0"
     androidxJunitVersion = "1.1.1"
     annotationVersion = "1.0.0"
@@ -33,6 +36,7 @@ ext {
     runnerVersion = "1.2.0"
     rulesVersion = "1.2.0"
     robolectricVersion = "4.3.1"
+    uiAutomatorVersion = "2.2.0"
 
     // TODO: adal automation test app.
     supportLibraryVersion = "27.1.+"

gradle/versions.gradle

@@ -148,9 +148,9 @@ dependencies {
         transitive = false
     }
 
-    snapshotApi(group: 'com.microsoft.identity', name: 'common', version: '2.0.12-hf1', changing: true)
+    snapshotApi(group: 'com.microsoft.identity', name: 'common', version: '2.0.15-SNAPSHOT', changing: true)
 
-    distApi("com.microsoft.identity:common:2.0.12-hf1") {
+    distApi("com.microsoft.identity:common:2.0.15") {
         transitive = false
     }
 }
@@ -208,8 +208,8 @@ publishing {
 
                 // Description
                 asNode().appendNode(
-                        'description',
-                        'Microsoft Identity library for Android gives you the ability to add authentication to your application with just a few lines of additional code. Using our MSAL SDKs you can quickly and easily extend your existing application to all the employees that use MSA, B2C, Azure AD and Active Directory on-premises using Active Directory Federation Services, including Office365 customers.'
+                    'description',
+                    'Microsoft Identity library for Android gives you the ability to add authentication to your application with just a few lines of additional code. Using our MSAL SDKs you can quickly and easily extend your existing application to all the employees that use MSA, B2C, Azure AD and Active Directory on-premises using Active Directory Federation Services, including Office365 customers.'
                 )
 
                 // URL

msal/build.gradle

@@ -0,0 +1,67 @@
+//  Copyright (c) Microsoft Corporation.
+//  All rights reserved.
+//
+//  This code is licensed under the MIT License.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files(the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions :
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+package com.microsoft.identity.client;
+
+import androidx.annotation.Nullable;
+
+/**
+ * The audiences that can be used for Authority when making token requests in MSAL
+ */
+public enum AadAuthorityAudience {
+
+    /**
+     * Users with a personal Microsoft account, or a work or school account in any organization’s
+     * Azure AD tenant. Maps to https://[instance]/common/
+     */
+    AzureAdAndPersonalMicrosoftAccount("common"),
+
+    /**
+     * Users with a Microsoft work or school account in any organization’s Azure AD tenant
+     * (i.e. multi-tenant). Maps to https://[instance]/organizations/
+     */
+    AzureAdMultipleOrgs("organizations"),
+
+    /**
+     * Users with a personal Microsoft account. Maps to https://[instance]/consumers/
+     */
+    PersonalMicrosoftAccount("consumers"),
+
+    /**
+     * Users with a Microsoft work or school account in my organization’s Azure AD tenant
+     * (i.e. single tenant). Maps to https://[instance]/[tenantId]
+     */
+    AzureAdMyOrg(null);
+
+    @Nullable
+    private String audienceValue;
+
+    AadAuthorityAudience(@Nullable String audienceValue) {
+        this.audienceValue = audienceValue;
+    }
+
+    @Nullable
+    public String getAudienceValue() {
+        return audienceValue;
+    }
+
+}

msal/src/main/java/com/microsoft/identity/client/AadAuthorityAudience.java

@@ -22,15 +22,19 @@
 //  THE SOFTWARE.
 package com.microsoft.identity.client;
 
+import android.text.TextUtils;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
 import com.microsoft.identity.common.internal.authscheme.TokenAuthenticationScheme;
 import com.microsoft.identity.common.internal.cache.ICacheRecord;
 import com.microsoft.identity.common.internal.dto.AccessTokenRecord;
+import com.microsoft.identity.common.internal.logging.Logger;
 
 import java.util.Date;
 import java.util.List;
+import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
 /**
@@ -39,15 +43,20 @@
  */
 public final class AuthenticationResult implements IAuthenticationResult {
 
+    private static final String TAG = AuthenticationResult.class.getSimpleName();
+
     private final String mTenantId;
     private final AccessTokenRecord mAccessToken;
     private final IAccount mAccount;
+    private final UUID mCorrelationId;
 
-    AuthenticationResult(@NonNull final List<ICacheRecord> cacheRecords) {
+    AuthenticationResult(@NonNull final List<ICacheRecord> cacheRecords,
+                         @Nullable final String correlationId) {
         final ICacheRecord mostRecentlyAuthorized = cacheRecords.get(0);
         mAccessToken = mostRecentlyAuthorized.getAccessToken();
         mTenantId = mostRecentlyAuthorized.getAccount().getRealm();
         mAccount = AccountAdapter.adapt(cacheRecords).get(0);
+        mCorrelationId = sanitizeCorrelationId(correlationId);
     }
 
     @Override
@@ -108,4 +117,27 @@ public IAccount getAccount() {
     public String[] getScope() {
         return mAccessToken.getTarget().split("\\s");
     }
+
+    @Nullable
+    @Override
+    public UUID getCorrelationId() {
+        return mCorrelationId;
+    }
+
+    @Nullable
+    private UUID sanitizeCorrelationId(@Nullable final String correlationId) {
+        final String methodName = "sanitizeCorrelationId";
+
+        if (TextUtils.isEmpty(correlationId)) {
+            Logger.warn(TAG + methodName, "Correlation id was empty, returning null.");
+            return null;
+        }
+
+        try {
+            return UUID.fromString(correlationId);
+        } catch (IllegalArgumentException e) {
+            Logger.error(TAG + methodName, "Correlation id is not a valid UUID.", e);
+            return null;
+        }
+    }
 }

msal/src/main/java/com/microsoft/identity/client/AuthenticationResult.java

@@ -32,6 +32,7 @@
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Set;
 
 class AuthenticationResultAdapter {
@@ -40,7 +41,8 @@ class AuthenticationResultAdapter {
 
     static IAuthenticationResult adapt(@NonNull final ILocalAuthenticationResult localAuthenticationResult) {
         final IAuthenticationResult authenticationResult = new AuthenticationResult(
-                localAuthenticationResult.getCacheRecordWithTenantProfileData()
+                localAuthenticationResult.getCacheRecordWithTenantProfileData(),
+                localAuthenticationResult.getCorrelationId()
         );
         return authenticationResult;
     }
@@ -86,14 +88,14 @@ static List<String> getDeclinedScopes(@NonNull final List<String> grantedScopes,
 
         // Add each granted scope to the Set
         for (final String grantedScope : grantedScopes) {
-            grantedScopesSet.add(grantedScope.toLowerCase());
+            grantedScopesSet.add(grantedScope.toLowerCase(Locale.ROOT));
         }
 
         final Set<String> requestedScopesSet = new HashSet<>();
 
         // Add each requested scope to the Set
         for (final String requestedScope : requestedScopes) {
-            requestedScopesSet.add(requestedScope.toLowerCase());
+            requestedScopesSet.add(requestedScope.toLowerCase(Locale.ROOT));
         }
 
         final List<String> declinedScopes = new ArrayList<>();

msal/src/main/java/com/microsoft/identity/client/AuthenticationResultAdapter.java

@@ -0,0 +1,59 @@
+//  Copyright (c) Microsoft Corporation.
+//  All rights reserved.
+//
+//  This code is licensed under the MIT License.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files(the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions :
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+package com.microsoft.identity.client;
+
+/**
+ * The clouds that can be used for Authority when making token requests in MSAL
+ */
+public enum AzureCloudInstance {
+
+    /**
+     * Microsoft Azure public cloud. Maps to https://login.microsoftonline.com
+     */
+    AzurePublic("https://login.microsoftonline.com"),
+
+    /**
+     * Microsoft Chinese national cloud. Maps to https://login.partner.microsoftonline.cn
+     */
+    AzureChina("https://login.partner.microsoftonline.cn"),
+
+    /**
+     * Microsoft German national cloud (“Black Forest”). Maps to https://login.microsoftonline.de
+     */
+    AzureGermany("https://login.microsoftonline.de"),
+
+    /**
+     * US Government cloud. Maps to https://login.microsoftonline.us
+     */
+    AzureUsGov("https://login.microsoftonline.us");
+
+    private String cloudInstanceUri;
+
+    AzureCloudInstance(String cloudInstanceUri) {
+        this.cloudInstanceUri = cloudInstanceUri;
+    }
+
+    public String getCloudInstanceUri() {
+        return cloudInstanceUri;
+    }
+}

msal/src/main/java/com/microsoft/identity/client/AzureCloudInstance.java

@@ -26,6 +26,7 @@
 import androidx.annotation.Nullable;
 
 import java.util.Date;
+import java.util.UUID;
 
 public interface IAuthenticationResult {
 
@@ -81,4 +82,13 @@ public interface IAuthenticationResult {
      */
     @NonNull
     String[] getScope();
-}
+
+    /**
+     * Gets the correlation id used during the acquire token request. Could be null if an error
+     * occurs when parsing from String or if not set.
+     *
+     * @return a UUID representing a correlation id
+     */
+    @Nullable
+    UUID getCorrelationId(); // this should never actually be null for MSAL
+}