Merge pull request #926 from AzureAD/avdunn/nimbus-grants

Remove usage of com.nimbusds.oauth2 from grant-related classes

Author: Avery-Dunn

README.md

@@ -16,7 +16,7 @@ Quick links:
 The library supports the following Java environments:
 - Java 8 (or higher)
 
-Current version - 1.20.0
+Current version - 1.20.1
 
 You can find the changes for each version in the [change log](https://github.com/AzureAD/microsoft-authentication-library-for-java/blob/main/msal4j-sdk/changelog.txt).
 
@@ -28,13 +28,13 @@ Find [the latest package in the Maven repository](https://mvnrepository.com/arti
 <dependency>
     <groupId>com.microsoft.azure</groupId>
     <artifactId>msal4j</artifactId>
-    <version>1.20.0</version>
+    <version>1.20.1</version>
 </dependency>
 ```
 ### Gradle
 
 ```gradle
-implementation group: 'com.microsoft.azure', name: 'com.microsoft.aad.msal4j', version: '1.20.0'
+implementation group: 'com.microsoft.azure', name: 'com.microsoft.aad.msal4j', version: '1.20.1'
 ```
 
 ## Usage

changelog.txt

@@ -1,3 +1,7 @@
+Version 1.20.1
+=============
+- Fix Base64URL decoding bug (#938)
+
 Version 1.20.0
 =============
 - Replace some usage of jackson-databind with azure-json (#918)

msal4j-sdk/README.md

@@ -16,7 +16,7 @@ Quick links:
 The library supports the following Java environments:
 - Java 8 (or higher)
 
-Current version - 1.20.0
+Current version - 1.20.1
 
 You can find the changes for each version in the [change log](https://github.com/AzureAD/microsoft-authentication-library-for-java/blob/master/changelog.txt).
 
@@ -28,13 +28,13 @@ Find [the latest package in the Maven repository](https://mvnrepository.com/arti
 <dependency>
     <groupId>com.microsoft.azure</groupId>
     <artifactId>msal4j</artifactId>
-    <version>1.20.0</version>
+    <version>1.20.1</version>
 </dependency>
 ```
 ### Gradle
 
 ```gradle
-compile group: 'com.microsoft.azure', name: 'msal4j', version: '1.20.0'
+compile group: 'com.microsoft.azure', name: 'msal4j', version: '1.20.1'
 ```
 
 ## Usage

msal4j-sdk/bnd.bnd

@@ -1,2 +1,2 @@
-Export-Package: com.microsoft.aad.msal4j;version="1.20.0"
+Export-Package: com.microsoft.aad.msal4j;version="1.20.1"
 Automatic-Module-Name: com.microsoft.aad.msal4j

msal4j-sdk/pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.microsoft.azure</groupId>
 	<artifactId>msal4j</artifactId>
-	<version>1.20.0</version>
+	<version>1.20.1</version>
 	<packaging>jar</packaging>
 	<name>msal4j</name>
 	<description>

msal4j-sdk/src/integrationtest/java/infrastructure/SeleniumExtensions.java

@@ -40,7 +40,7 @@ public static WebDriver createDefaultWebDriver() {
         //No visual rendering, remove to see browser window when debugging
         options.addArguments("--headless");
         //Add to avoid issues if your real browser's history/cookies are affecting tests, should not be needed in ADO pipelines
-        //options.addArguments("--incognito");
+        options.addArguments("--incognito");
 
         System.setProperty("webdriver.chrome.driver", "C:/Windows/chromedriver.exe");
         ChromeDriver driver = new ChromeDriver(options);

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AbstractMsalAuthorizationGrant.java

@@ -3,8 +3,12 @@
 
 package com.microsoft.aad.msal4j;
 
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /**
  * Abstract class for an MSAL grant.
@@ -25,13 +29,12 @@ abstract class AbstractMsalAuthorizationGrant {
     static final String SCOPE_PROFILE = "profile";
     static final String SCOPE_OFFLINE_ACCESS = "offline_access";
 
-    static final String COMMON_SCOPES_PARAM = SCOPE_OPEN_ID + SCOPES_DELIMITER +
-            SCOPE_PROFILE + SCOPES_DELIMITER +
-            SCOPE_OFFLINE_ACCESS;
+    static final Set<String> COMMON_SCOPES = Stream.of(SCOPE_OPEN_ID, SCOPE_PROFILE, SCOPE_OFFLINE_ACCESS)
+            .collect(Collectors.toCollection(HashSet::new));
 
-    String scopes;
+    Set<String> scopes;
 
-    String getScopes() {
+    Set<String> getScopes() {
         return scopes;
     }
 

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AcquireTokenByAuthorizationGrantSupplier.java

@@ -4,14 +4,14 @@
 package com.microsoft.aad.msal4j;
 
 import com.nimbusds.jose.util.Base64URL;
-import com.nimbusds.oauth2.sdk.AuthorizationGrant;
-import com.nimbusds.oauth2.sdk.ResourceOwnerPasswordCredentialsGrant;
-import com.nimbusds.oauth2.sdk.SAML2BearerGrant;
 
-import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
 
 class AcquireTokenByAuthorizationGrantSupplier extends AuthenticationResultSupplier {
 
@@ -39,8 +39,7 @@ AuthenticationResult execute() throws Exception {
         }
 
         if (authGrant instanceof OAuthAuthorizationGrant) {
-            msalRequest.msalAuthorizationGrant =
-                    processPasswordGrant((OAuthAuthorizationGrant) authGrant);
+            processPasswordGrant((OAuthAuthorizationGrant) authGrant);
         }
 
         if (authGrant instanceof IntegratedWindowsAuthorizationGrant) {
@@ -74,58 +73,52 @@ private boolean IsUiRequiredCacheSupported() {
                 clientApplication instanceof PublicClientApplication;
     }
 
-    private OAuthAuthorizationGrant processPasswordGrant(
-            OAuthAuthorizationGrant authGrant) throws Exception {
-
-        if (!(authGrant.getAuthorizationGrant() instanceof ResourceOwnerPasswordCredentialsGrant)) {
-            return authGrant;
-        }
+    private void processPasswordGrant(OAuthAuthorizationGrant authGrant) throws Exception {
 
-        if (msalRequest.application().authenticationAuthority.authorityType != AuthorityType.AAD) {
-            return authGrant;
+        //Additional processing is only needed if it's a password grant with an AAD authority
+        if (!(authGrant.getParamValue(GrantConstants.GRANT_TYPE_PARAMETER).equals(GrantConstants.PASSWORD))
+                || msalRequest.application().authenticationAuthority.authorityType != AuthorityType.AAD) {
+            return;
         }
 
-        ResourceOwnerPasswordCredentialsGrant grant =
-                (ResourceOwnerPasswordCredentialsGrant) authGrant.getAuthorizationGrant();
-
         UserDiscoveryResponse userDiscoveryResponse = UserDiscoveryRequest.execute(
-                this.clientApplication.authenticationAuthority.getUserRealmEndpoint(grant.getUsername()),
+                this.clientApplication.authenticationAuthority.getUserRealmEndpoint(authGrant.getParamValue(GrantConstants.USERNAME_PARAMETER)),
                 msalRequest.headers().getReadonlyHeaderMap(),
                 msalRequest.requestContext(),
                 this.clientApplication.serviceBundle());
 
         if (userDiscoveryResponse.isAccountFederated()) {
             WSTrustResponse response = WSTrustRequest.execute(
                     userDiscoveryResponse.federationMetadataUrl(),
-                    grant.getUsername(),
-                    grant.getPassword().getValue(),
+                    authGrant.getParamValue(GrantConstants.USERNAME_PARAMETER),
+                    authGrant.getParamValue(GrantConstants.PASSWORD_PARAMETER),
                     userDiscoveryResponse.cloudAudienceUrn(),
                     msalRequest.requestContext(),
                     this.clientApplication.serviceBundle(),
                     this.clientApplication.logPii());
 
-            AuthorizationGrant updatedGrant = getSAMLAuthorizationGrant(response);
-
-            authGrant = new OAuthAuthorizationGrant(updatedGrant, authGrant.getParameters());
+            authGrant.addAndReplaceParams(getSAMLAuthGrantParameters(response));
         }
-        return authGrant;
     }
 
-    private AuthorizationGrant getSAMLAuthorizationGrant(WSTrustResponse response) throws UnsupportedEncodingException {
-        AuthorizationGrant updatedGrant;
+    private Map<String, List<String>> getSAMLAuthGrantParameters(WSTrustResponse response) {
+        Map<String, List<String>> params = new LinkedHashMap<>();
+
         if (response.isTokenSaml2()) {
-            updatedGrant = new SAML2BearerGrant(new Base64URL(
-                    Base64.getEncoder().encodeToString(response.getToken().getBytes(StandardCharsets.UTF_8))));
+            params.put(GrantConstants.GRANT_TYPE_PARAMETER, Collections.singletonList(GrantConstants.SAML_2_BEARER));
         } else {
-            updatedGrant = new SAML11BearerGrant(new Base64URL(
-                    Base64.getEncoder().encodeToString(response.getToken()
-                            .getBytes(StandardCharsets.UTF_8))));
+            params.put(GrantConstants.GRANT_TYPE_PARAMETER, Collections.singletonList(GrantConstants.SAML_1_1_BEARER));
         }
-        return updatedGrant;
+
+        params.put(GrantConstants.ASSERTION_PARAMETER, Collections.singletonList(new Base64URL(
+                Base64.getEncoder().encodeToString(response.getToken()
+                        .getBytes(StandardCharsets.UTF_8))).toString()));
+
+        return params;
     }
 
-    private AuthorizationGrant getAuthorizationGrantIntegrated(String userName) throws Exception {
-        AuthorizationGrant updatedGrant;
+    private Map<String, List<String>> getAuthorizationGrantIntegrated(String userName) throws Exception {
+        Map<String, List<String>> params;
 
         String userRealmEndpoint = this.clientApplication.authenticationAuthority.
                 getUserRealmEndpoint(URLEncoder.encode(userName, StandardCharsets.UTF_8.name()));
@@ -152,7 +145,7 @@ private AuthorizationGrant getAuthorizationGrantIntegrated(String userName) thro
                     this.clientApplication.serviceBundle(),
                     this.clientApplication.logPii());
 
-            updatedGrant = getSAMLAuthorizationGrant(wsTrustResponse);
+            params = getSAMLAuthGrantParameters(wsTrustResponse);
         } else if (userRealmResponse.isAccountManaged()) {
             throw new MsalClientException(
                     "Password is required for managed user",
@@ -163,6 +156,6 @@ private AuthorizationGrant getAuthorizationGrantIntegrated(String userName) thro
                     AuthenticationErrorCode.USER_REALM_DISCOVERY_FAILED);
         }
 
-        return updatedGrant;
+        return params;
     }
 }

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationCodeRequest.java

@@ -3,10 +3,10 @@
 
 package com.microsoft.aad.msal4j;
 
-import com.nimbusds.oauth2.sdk.AuthorizationCode;
-import com.nimbusds.oauth2.sdk.AuthorizationCodeGrant;
-import com.nimbusds.oauth2.sdk.AuthorizationGrant;
-import com.nimbusds.oauth2.sdk.pkce.CodeVerifier;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
 
 class AuthorizationCodeRequest extends MsalRequest {
 
@@ -17,19 +17,19 @@ class AuthorizationCodeRequest extends MsalRequest {
     }
 
     private static AbstractMsalAuthorizationGrant createMsalGrant(AuthorizationCodeParameters parameters) {
+        Map<String, List<String>> params = new LinkedHashMap<>();
+
+        params.put(GrantConstants.GRANT_TYPE_PARAMETER, Collections.singletonList(GrantConstants.AUTHORIZATION_CODE));
+        params.put("code", Collections.singletonList(parameters.authorizationCode()));
+
+        if (parameters.redirectUri() != null) {
+            params.put("redirect_uri", Collections.singletonList(parameters.redirectUri().toString()));
+        }
 
-        AuthorizationGrant authorizationGrant;
         if (parameters.codeVerifier() != null) {
-            authorizationGrant = new AuthorizationCodeGrant(
-                    new AuthorizationCode(parameters.authorizationCode()),
-                    parameters.redirectUri(),
-                    new CodeVerifier(parameters.codeVerifier()));
-
-        } else {
-            authorizationGrant = new AuthorizationCodeGrant(
-                    new AuthorizationCode(parameters.authorizationCode()), parameters.redirectUri());
+            params.put("code_verifier", Collections.singletonList(parameters.codeVerifier()));
         }
 
-        return new OAuthAuthorizationGrant(authorizationGrant, parameters.scopes(), parameters.claims());
+        return new OAuthAuthorizationGrant(params, parameters.scopes(), parameters.claims());
     }
 }

msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationRequestUrlParameters.java

@@ -61,9 +61,7 @@ private AuthorizationRequestUrlParameters(Builder builder) {
         requestParameters.put("redirect_uri", Collections.singletonList(this.redirectUri));
         this.scopes = builder.scopes;
 
-        String[] commonScopes = AbstractMsalAuthorizationGrant.COMMON_SCOPES_PARAM.split(" ");
-
-        Set<String> scopesParam = new LinkedHashSet<>(Arrays.asList(commonScopes));
+        Set<String> scopesParam = new LinkedHashSet<>(AbstractMsalAuthorizationGrant.COMMON_SCOPES);
 
         scopesParam.addAll(builder.scopes);