Prevent double-escaping of authorize URL parameters #7881
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the authorization URL in the OAuth2 provider configuration contained query parameters with escaped characters, these characters were escaped a second time. This commit fixes it. It is relevant to support the OIDC claims parameter (see https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter). Fixes gh-7871
spring-projects-issues
added
the
status: waiting-for-triage
jgrandja
added
in: oauth2
jgrandja
requested changes
Feb 5, 2020
.../main/java/org/springframework/security/oauth2/core/endpoint/OAuth2AuthorizationRequest.java
Outdated
Show resolved
Hide resolved
.../java/org/springframework/security/oauth2/core/endpoint/OAuth2AuthorizationRequestTests.java
Show resolved
Hide resolved
If the authorization URL in the OAuth2 provider configuration contained query parameters with escaped characters, these characters were escaped a second time. This commit fixes it. It is relevant to support the OIDC claims parameter (see https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter). Fixes gh-7871
|
Thanks again for providing this fix @manuelbl ! This is now in master and backported to 5.2.x. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If the authorization URL in the OAuth2 provider configuration contained query parameters with percent escaped characters, these characters were escaped a second time – damaging the URL. This commit fixes it.
It is relevant to support the OIDC claims parameter (see https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter).
Fixes gh-7871
Implementation notes
As
UriComponentsBuildercannot fully decode query parameters (no implementation for undoing the percent escaping), the approach is to assemble already escaped components. Before adding query parameters to the authorization URL, they must therefore be properly escaped.The method for percent escaping uses separate
UriComponentsBuilderinstances. That's not straight-forward but the only way to access the methodHierarchicalUriComponents.encodeUriComponent. It ensures that the minimal necessary escaping according to RFC 3986 is applied.An alternative would be to use
java.net.URLEncoder.encode. Contrary to its name, this method applies HTML form encoding, which is similar but far more aggressive, i.e. it escapes additional characters such as/,:etc.