Skip to content

Fix AccessTokenUtil does not url encode its parameters #40697

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rujche merged 4 commits into from
Jun 20, 2024
Merged

Fix AccessTokenUtil does not url encode its parameters #40697

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5610bb
Fix bug: clientSecret not url encoded.
rujche Jun 19, 2024
f1013fd
Url encode all parameters.
rujche Jun 19, 2024
92802ca
Fix pipeline failure by changing StandardCharsets.UTF_8 to "UTF-8".
rujche Jun 20, 2024
20a7945
Delete url encode of client-id and resource.
rujche Jun 20, 2024
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
9 changes: 6 additions & 3 deletions ...a/src/main/java/com/azure/security/keyvault/jca/implementation/utils/AccessTokenUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
import static java.util.logging.Level.INFO;

import com.azure.security.keyvault.jca.implementation.model.AccessToken;

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.logging.Logger;

Expand Down Expand Up @@ -99,9 +102,9 @@ public static AccessToken getAccessToken(String resource, String aadAuthenticati

StringBuilder requestBody = new StringBuilder();
requestBody.append(GRANT_TYPE_FRAGMENT)
.append(CLIENT_ID_FRAGMENT).append(clientId)
.append(CLIENT_SECRET_FRAGMENT).append(clientSecret)
.append(RESOURCE_FRAGMENT).append(resource);
.append(CLIENT_ID_FRAGMENT).append(URLEncoder.encode(clientId, StandardCharsets.UTF_8))
.append(CLIENT_SECRET_FRAGMENT).append(URLEncoder.encode(clientSecret, StandardCharsets.UTF_8))
.append(RESOURCE_FRAGMENT).append(URLEncoder.encode(resource, StandardCharsets.UTF_8));
Copy link
Member Author

@rujche rujche Jun 19, 2024

Choose a reason for hiding this comment

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

FYI:

  1. According to the ms doc, every parameters should url encoded, not encode one specific parameter nor the whole requestBody.
  2. According to the ms doc, the parameter should be scope, not resource. I don't know why it use resource here. Anyway, I just keep the original behavior.

Refs: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#first-case-access-token-request-with-a-shared-secret


String body = HttpUtil
.post(oauth2Url.toString(), requestBody.toString(), "application/x-www-form-urlencoded");
Expand Down
8 changes: 2 additions & 6 deletions ...urity-keyvault-jca/src/test/java/com/azure/security/keyvault/jca/AccessTokenUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfEnvironmentVariable;

import java.net.URLEncoder;

import static org.junit.jupiter.api.Assertions.assertNotNull;

/**
Expand All @@ -20,11 +18,9 @@ public class AccessTokenUtilTest {

/**
* Test getAuthorizationToken method.
*
* @throws Exception when a serious error occurs.
*/
@Test
public void testGetAuthorizationToken() throws Exception {
public void testGetAuthorizationToken() {
String tenantId = PropertyConvertorUtils.getPropertyValue("AZURE_KEYVAULT_TENANT_ID");
String clientId = PropertyConvertorUtils.getPropertyValue("AZURE_KEYVAULT_CLIENT_ID");
String clientSecret = PropertyConvertorUtils.getPropertyValue("AZURE_KEYVAULT_CLIENT_SECRET");
Expand All @@ -37,7 +33,7 @@ public void testGetAuthorizationToken() throws Exception {
aadAuthenticationUrl,
tenantId,
clientId,
URLEncoder.encode(clientSecret, "UTF-8")
clientSecret
);
assertNotNull(result);
}
Expand Down