-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Allow opt-in to omitting default parameters
Closes gh-11298
- Loading branch information
Showing
2 changed files
with
133 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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
98 changes: 98 additions & 0 deletions
98
...amework/security/oauth2/client/endpoint/DefaultOAuth2TokenRequestParametersConverter.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /* | ||
| * Copyright 2002-2024 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.springframework.security.oauth2.client.endpoint; | ||
|
|
||
| import org.springframework.core.convert.converter.Converter; | ||
| import org.springframework.security.oauth2.client.registration.ClientRegistration; | ||
| import org.springframework.security.oauth2.core.ClientAuthenticationMethod; | ||
| import org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.LinkedMultiValueMap; | ||
| import org.springframework.util.MultiValueMap; | ||
|
|
||
| /** | ||
| * Default {@link Converter} used to convert an | ||
| * {@link AbstractOAuth2AuthorizationGrantRequest} to the default {@link MultiValueMap | ||
| * parameters} of an OAuth 2.0 Access Token Request. | ||
| * <p> | ||
| * This implementation does not provide grant-type specific parameters. The following | ||
| * parameters are provided: | ||
| * | ||
| * <ul> | ||
| * <li>{@code grant_type} - always provided</li> | ||
| * <li>{@code client_id} - provided unless the {@code clientAuthenticationMethod} is | ||
| * {@code client_secret_basic}</li> | ||
| * <li>{@code client_secret} - provided when the {@code clientAuthenticationMethod} is | ||
| * {@code client_secret_post}</li> | ||
| * </ul> | ||
| * | ||
| * @param <T> type of grant request | ||
| * @author Steve Riesenberg | ||
| * @since 6.4 | ||
| * @see AbstractWebClientReactiveOAuth2AccessTokenResponseClient | ||
| * @see AbstractRestClientOAuth2AccessTokenResponseClient | ||
| */ | ||
| public final class DefaultOAuth2TokenRequestParametersConverter<T extends AbstractOAuth2AuthorizationGrantRequest> | ||
| implements Converter<T, MultiValueMap<String, String>> { | ||
|
|
||
| private final Converter<T, MultiValueMap<String, String>> defaultParametersConverter; | ||
|
|
||
| public DefaultOAuth2TokenRequestParametersConverter() { | ||
| this(DefaultOAuth2TokenRequestParametersConverter::defaultParameters); | ||
| } | ||
|
|
||
| private DefaultOAuth2TokenRequestParametersConverter( | ||
| Converter<T, MultiValueMap<String, String>> defaultParametersConverter) { | ||
| Assert.notNull(defaultParametersConverter, "defaultParametersConverter cannot be null"); | ||
| this.defaultParametersConverter = defaultParametersConverter; | ||
| } | ||
|
|
||
| @Override | ||
| public MultiValueMap<String, String> convert(T grantRequest) { | ||
| return this.defaultParametersConverter.convert(grantRequest); | ||
| } | ||
|
|
||
| private static <T extends AbstractOAuth2AuthorizationGrantRequest> MultiValueMap<String, String> defaultParameters( | ||
| T grantRequest) { | ||
| ClientRegistration clientRegistration = grantRequest.getClientRegistration(); | ||
| MultiValueMap<String, String> parameters = new LinkedMultiValueMap<>(); | ||
| parameters.set(OAuth2ParameterNames.GRANT_TYPE, grantRequest.getGrantType().getValue()); | ||
| if (!ClientAuthenticationMethod.CLIENT_SECRET_BASIC | ||
| .equals(clientRegistration.getClientAuthenticationMethod())) { | ||
| parameters.set(OAuth2ParameterNames.CLIENT_ID, clientRegistration.getClientId()); | ||
| } | ||
| if (ClientAuthenticationMethod.CLIENT_SECRET_POST.equals(clientRegistration.getClientAuthenticationMethod())) { | ||
| parameters.set(OAuth2ParameterNames.CLIENT_SECRET, clientRegistration.getClientSecret()); | ||
| } | ||
| return parameters; | ||
| } | ||
|
|
||
| /** | ||
| * Wrap a custom {@link Converter} in order to override or omit default parameters | ||
| * with | ||
| * {@link AbstractWebClientReactiveOAuth2AccessTokenResponseClient#setParametersConverter(Converter)}. | ||
| * @param defaultParametersConverter the {@link Converter} used for converting the | ||
| * @param <T> type of grant request {@link AbstractOAuth2AuthorizationGrantRequest} to | ||
| * {@link MultiValueMap parameters} | ||
| * @return the wrapped {@link Converter} | ||
| */ | ||
| public static <T extends AbstractOAuth2AuthorizationGrantRequest> Converter<T, MultiValueMap<String, String>> of( | ||
| Converter<T, MultiValueMap<String, String>> defaultParametersConverter) { | ||
| return new DefaultOAuth2TokenRequestParametersConverter<>(defaultParametersConverter); | ||
| } | ||
|
|
||
| } |