Skip to content
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

Add ServerWebExchange parameter to AuthorizationRequestCustomizer #16320

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −3
Open

Add ServerWebExchange parameter to AuthorizationRequestCustomizer #16320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 22 additions & 2 deletions ...rk/security/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import java.util.Base64;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import reactor.core.publisher.Mono;
Expand Down Expand Up @@ -92,7 +93,8 @@ public class DefaultServerOAuth2AuthorizationRequestResolver implements ServerOA

private final ReactiveClientRegistrationRepository clientRegistrationRepository;

private Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer = (customizer) -> {
private BiConsumer<OAuth2AuthorizationRequest.Builder, ServerWebExchange> authorizationRequestCustomizer = (
customizer, exchange) -> {
};

/**
Expand Down Expand Up @@ -148,11 +150,29 @@ public Mono<OAuth2AuthorizationRequest> resolve(ServerWebExchange exchange, Stri
* @param authorizationRequestCustomizer the {@code Consumer} to be provided the
* {@link OAuth2AuthorizationRequest.Builder}
* @since 5.3
* @deprecated Use {@link #setAuthorizationRequestCustomizer(BiConsumer) } instead
* @see OAuth2AuthorizationRequestCustomizers
*/
@Deprecated
public final void setAuthorizationRequestCustomizer(
Consumer<OAuth2AuthorizationRequest.Builder> authorizationRequestCustomizer) {
Assert.notNull(authorizationRequestCustomizer, "authorizationRequestCustomizer cannot be null");
this.authorizationRequestCustomizer = (customizer, exchange) -> authorizationRequestCustomizer
.accept(customizer);
}

/**
* Sets the {@code BiConsumer} to be provided the
* {@link OAuth2AuthorizationRequest.Builder} and {@link ServerWebExchange} allowing
* for further customizations.
* @param authorizationRequestCustomizer the {@code BiConsumer} to be provided the
* {@link OAuth2AuthorizationRequest.Builder} and {@link ServerWebExchange}
* @since 6.5
* @see OAuth2AuthorizationRequestCustomizers
*/
public final void setAuthorizationRequestCustomizer(
BiConsumer<OAuth2AuthorizationRequest.Builder, ServerWebExchange> authorizationRequestCustomizer) {
Assert.notNull(authorizationRequestCustomizer, "authorizationRequestCustomizer cannot be null");
this.authorizationRequestCustomizer = authorizationRequestCustomizer;
}

Expand All @@ -175,7 +195,7 @@ private OAuth2AuthorizationRequest authorizationRequest(ServerWebExchange exchan
.state(DEFAULT_STATE_GENERATOR.generateKey());
// @formatter:on

this.authorizationRequestCustomizer.accept(builder);
this.authorizationRequestCustomizer.accept(builder, exchange);

return builder.build();
}
Expand Down
17 changes: 16 additions & 1 deletion ...curity/oauth2/client/web/server/DefaultServerOAuth2AuthorizationRequestResolverTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package org.springframework.security.oauth2.client.web.server;

import java.util.function.Consumer;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -68,7 +70,8 @@ public void setup() {

@Test
public void setAuthorizationRequestCustomizerWhenNullThenThrowIllegalArgumentException() {
assertThatIllegalArgumentException().isThrownBy(() -> this.resolver.setAuthorizationRequestCustomizer(null));
assertThatIllegalArgumentException().isThrownBy(() -> this.resolver
.setAuthorizationRequestCustomizer((Consumer<OAuth2AuthorizationRequest.Builder>) null));
}

@Test
Expand Down Expand Up @@ -254,6 +257,18 @@ public void resolveWhenAuthorizationRequestCustomizerOverridesParameterThenQuery
+ "nonce=([a-zA-Z0-9\\-\\.\\_\\~]){43}&" + "appid=client-id");
}

@Test
public void resolveWhenAuthorizationRequestCustomizerAdditionParameterFromRequest() {
given(this.clientRegistrationRepository.findByRegistrationId(any()))
.willReturn(Mono.just(TestClientRegistrations.clientRegistration().scope(OidcScopes.OPENID).build()));
this.resolver.setAuthorizationRequestCustomizer((builder, exchange) -> builder.parameters((params) -> {
params.put("aa", exchange.getRequest().getQueryParams().getFirst("a"));
params.put("bb", exchange.getRequest().getQueryParams().getFirst("b"));
}));
OAuth2AuthorizationRequest authorizationRequest = resolve("/oauth2/authorization/registration-id?a=A&b=B");
assertThat(authorizationRequest.getAuthorizationRequestUri()).contains("aa=A&bb=B");
}

private OAuth2AuthorizationRequest resolve(String path) {
ServerWebExchange exchange = MockServerWebExchange.from(MockServerHttpRequest.get(path));
return this.resolver.resolve(exchange).block();
Expand Down
Loading