Skip to content

Allow specifying a ServerAuthenticationConverter for x509() #17382

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow specifying a ServerAuthenticationConverter for x509() #17382

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
17 changes: 16 additions & 1 deletion config/src/main/java/org/springframework/security/config/web/server/ServerHttpSecurity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3214,6 +3214,8 @@ public final class X509Spec {

private ReactiveAuthenticationManager authenticationManager;

private ServerAuthenticationConverter serverAuthenticationConverter;

private X509Spec() {
}

Expand All @@ -3227,11 +3229,17 @@ public X509Spec authenticationManager(ReactiveAuthenticationManager authenticati
return this;
}

public X509Spec serverAuthenticationConverter(ServerAuthenticationConverter serverAuthenticationConverter) {
this.serverAuthenticationConverter = serverAuthenticationConverter;
return this;
}

protected void configure(ServerHttpSecurity http) {
ReactiveAuthenticationManager authenticationManager = getAuthenticationManager();
X509PrincipalExtractor principalExtractor = getPrincipalExtractor();
ServerAuthenticationConverter converter = getServerAuthenticationConverter(principalExtractor);
AuthenticationWebFilter filter = new AuthenticationWebFilter(authenticationManager);
filter.setServerAuthenticationConverter(new ServerX509AuthenticationConverter(principalExtractor));
filter.setServerAuthenticationConverter(serverAuthenticationConverter);
http.addFilterAt(filter, SecurityWebFiltersOrder.AUTHENTICATION);
}

Expand All @@ -3250,6 +3258,13 @@ private ReactiveAuthenticationManager getAuthenticationManager() {
return new ReactivePreAuthenticatedAuthenticationManager(userDetailsService);
}

private ServerAuthenticationConverter getServerAuthenticationConverter(X509PrincipalExtractor extractor) {
if (this.serverAuthenticationConverter != null) {
return this.serverAuthenticationConverter;
}
return new ServerX509AuthenticationConverter(extractor);
}

}

public final class OAuth2LoginSpec {
Expand Down
23 changes: 23 additions & 0 deletions ...src/test/java/org/springframework/security/config/web/server/ServerHttpSecurityTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
import org.springframework.security.web.server.authentication.DelegatingServerAuthenticationSuccessHandler;
import org.springframework.security.web.server.authentication.HttpBasicServerAuthenticationEntryPoint;
import org.springframework.security.web.server.authentication.HttpStatusServerEntryPoint;
import org.springframework.security.web.server.authentication.ServerAuthenticationConverter;
import org.springframework.security.web.server.authentication.ServerAuthenticationFailureHandler;
import org.springframework.security.web.server.authentication.ServerAuthenticationSuccessHandler;
import org.springframework.security.web.server.authentication.ServerX509AuthenticationConverter;
Expand Down Expand Up @@ -497,6 +498,17 @@ public void x509WhenCustomizedThenAddsX509Filter() {
assertThat(x509WebFilter).isNotNull();
}

@Test
public void x509WithConverterAndNoExtractorThenAddsX509Filter() {
ServerAuthenticationConverter mockConverter = mock(ServerAuthenticationConverter.class);
this.http.x509((x509) -> x509.serverAuthenticationConverter(mockConverter));
SecurityWebFilterChain securityWebFilterChain = this.http.build();
WebFilter x509WebFilter = securityWebFilterChain.getWebFilters()
.filter(filter -> matchesX509Converter(filter, mockConverter))
.blockFirst();
assertThat(x509WebFilter).isNotNull();
}

@Test
public void addsX509FilterWhenX509AuthenticationIsConfiguredWithDefaults() {
this.http.x509(withDefaults());
Expand Down Expand Up @@ -769,6 +781,17 @@ private boolean isX509Filter(WebFilter filter) {
}
}

private boolean matchesX509Converter(WebFilter filter, ServerAuthenticationConverter expectedConverter) {
try {
Object converter = ReflectionTestUtils.getField(filter, "authenticationConverter");
return converter.equals(expectedConverter);
}
catch (IllegalArgumentException ex) {
// field doesn't exist
return false;
}
}

private <T extends WebFilter> Optional<T> getWebFilter(SecurityWebFilterChain filterChain, Class<T> filterClass) {
return (Optional<T>) filterChain.getWebFilters()
.filter(Objects::nonNull)
Expand Down