Skip to content

Fix SAML RelayState allowlist validation #4014

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
duanemay merged 3 commits into from
Aug 14, 2026
Merged

Fix SAML RelayState allowlist validation #4014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c103821
Implement SAML RelayState allowlist validation ai-assisted=yes
joemahady-comm Jul 29, 2026
e136256
Fix SAML RelayState allowlist validation
joemahady-comm Aug 7, 2026
0afc783
Fix SAML RelayState allowlist validation - Review Comments
joemahady-comm Aug 12, 2026
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
13 changes: 11 additions & 2 deletions ...a/org/cloudfoundry/identity/uaa/web/UaaSavedRequestAwareAuthenticationSuccessHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.savedrequest.HttpSessionRequestCache;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.cloudfoundry.identity.uaa.zone.IdentityZoneHolder;

import java.io.IOException;
import java.util.Collections;
import java.util.List;
import java.util.Optional;

@Slf4j
public class UaaSavedRequestAwareAuthenticationSuccessHandler extends SavedRequestAwareAuthenticationSuccessHandler {
Expand All @@ -46,8 +50,13 @@ public void onAuthenticationSuccess(HttpServletRequest request, HttpServletRespo
if (savedRequest == null) {
String relayState = UaaStringUtils.getCleanedUserControlString(request.getParameter(Saml2ParameterNames.RELAY_STATE), UaaStringUtils.EMPTY_STRING);
if (UaaStringUtils.hasText(relayState) && UaaUrlUtils.isUrl(relayState)) {
log.debug("Redirecting to relayState URI: {}", relayState);
this.getRedirectStrategy().sendRedirect(request, response, relayState);
List<String> samlRelayStateWhitelist = Optional.ofNullable(
IdentityZoneHolder.get().getConfig().getLinks().getLogout().getWhitelist()
).orElse(Collections.emptyList());
String fallbackUrl = this.getDefaultTargetUrl();
String redirectUri = UaaUrlUtils.findMatchingRedirectUri(samlRelayStateWhitelist, relayState, fallbackUrl);
log.debug("Redirecting after SAML login. requestedRelayState='{}' redirectUri='{}'", relayState, redirectUri);
this.getRedirectStrategy().sendRedirect(request, response, redirectUri);
} else {
super.onAuthenticationSuccess(request, response, authentication);
}
Expand Down
30 changes: 28 additions & 2 deletions .../cloudfoundry/identity/uaa/web/UaaSavedRequestAwareAuthenticationSuccessHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@
import org.springframework.security.core.Authentication;
import org.springframework.security.saml2.core.Saml2ParameterNames;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.cloudfoundry.identity.uaa.zone.IdentityZone;
import org.cloudfoundry.identity.uaa.zone.IdentityZoneHolder;

import jakarta.servlet.http.HttpSession;

import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.cloudfoundry.identity.uaa.web.UaaSavedRequestAwareAuthenticationSuccessHandler.FORM_REDIRECT_PARAMETER;
import static org.cloudfoundry.identity.uaa.web.UaaSavedRequestAwareAuthenticationSuccessHandler.URI_OVERRIDE_ATTRIBUTE;
Expand Down Expand Up @@ -76,15 +80,37 @@ void invalidFormRedirectIsNotReturned() {
}

@Test
void onAuthenticationSuccess_noSavedRequest_hasRelayStateUrl() throws Exception {
void onAuthenticationSuccess_noSavedRequest_hasRelayStateUrl_notWhitelisted() throws Exception {
String redirectUri = "https://test.com/test2";
request.setParameter(Saml2ParameterNames.RELAY_STATE, redirectUri);

var response = new MockHttpServletResponse();
var authentication = mock(Authentication.class);
handler.onAuthenticationSuccess(request, response, authentication);

assertThat(response.getRedirectedUrl()).isEqualTo(redirectUri);
assertThat(response.getRedirectedUrl()).isEqualTo("/");
}

@Test
void onAuthenticationSuccess_noSavedRequest_hasRelayStateUrl_whitelisted() throws Exception {
String redirectUri = "https://test.com/test2";
request.setParameter(Saml2ParameterNames.RELAY_STATE, redirectUri);

IdentityZone zone = IdentityZoneHolder.get();
List<String> originalWhitelist = zone.getConfig().getLinks().getLogout().getWhitelist();
zone.getConfig().getLinks().getLogout().setWhitelist(List.of(redirectUri));
IdentityZoneHolder.set(zone);

try {
var response = new MockHttpServletResponse();
var authentication = mock(Authentication.class);
handler.onAuthenticationSuccess(request, response, authentication);

assertThat(response.getRedirectedUrl()).isEqualTo(redirectUri);
} finally {
zone.getConfig().getLinks().getLogout().setWhitelist(originalWhitelist);
IdentityZoneHolder.set(zone);
}
}

@Test
Expand Down
49 changes: 47 additions & 2 deletions ...undry/identity/uaa/web/UaaSavedRequestAwareAuthenticationSuccessHandlerZonePathTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.saml2.core.Saml2ParameterNames;
import org.springframework.security.web.savedrequest.SavedRequest;
import org.cloudfoundry.identity.uaa.extensions.EnabledIfZonePathsEnabled;
import org.cloudfoundry.identity.uaa.zone.IdentityZone;

import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
Expand Down Expand Up @@ -113,8 +118,7 @@ void onAuthenticationSuccess_withSavedRequest_redirects_to_saved_url(ZoneRequest
String savedRedirectUrl = mode.redirectPrefix().isEmpty()
? "http://localhost/oauth/authorize?client_id=admin"
: "http://localhost" + mode.redirectPrefix() + "/oauth/authorize?client_id=admin";
org.springframework.security.web.savedrequest.SavedRequest savedRequest =
mock(org.springframework.security.web.savedrequest.SavedRequest.class);
SavedRequest savedRequest = mock(SavedRequest.class);
when(savedRequest.getRedirectUrl()).thenReturn(savedRedirectUrl);
request.getSession(true).setAttribute(SPRING_SECURITY_SAVED_REQUEST, savedRequest);

Expand All @@ -125,4 +129,45 @@ void onAuthenticationSuccess_withSavedRequest_redirects_to_saved_url(ZoneRequest

assertThat(response.getRedirectedUrl()).isEqualTo(savedRedirectUrl);
}

@ParameterizedTest
@EnumSource(ZoneRequestPathMode.class)
void onAuthenticationSuccess_noSavedRequest_hasRelayStateUrl_notWhitelisted(ZoneRequestPathMode mode) throws Exception {
mode.setZone();
mode.applyRequestPath(request, "/login.do");
String redirectUri = "https://test.com/test2";
request.setParameter(Saml2ParameterNames.RELAY_STATE, redirectUri);

MockHttpServletResponse response = new MockHttpServletResponse();
Authentication authentication = mock(Authentication.class);

handler.onAuthenticationSuccess(request, response, authentication);

String expected = mode.redirectPrefix().isEmpty() ? "/" : mode.redirectPrefix() + "/";
assertThat(response.getRedirectedUrl()).isEqualTo(expected);
}

@ParameterizedTest
@EnumSource(ZoneRequestPathMode.class)
void onAuthenticationSuccess_noSavedRequest_hasRelayStateUrl_whitelisted(ZoneRequestPathMode mode) throws Exception {
mode.setZone();
mode.applyRequestPath(request, "/login.do");
String redirectUri = "https://test.com/test2";
request.setParameter(Saml2ParameterNames.RELAY_STATE, redirectUri);

IdentityZone zone = IdentityZoneHolder.get();
List<String> originalWhitelist = zone.getConfig().getLinks().getLogout().getWhitelist();
zone.getConfig().getLinks().getLogout().setWhitelist(List.of(redirectUri));

try {
MockHttpServletResponse response = new MockHttpServletResponse();
Authentication authentication = mock(Authentication.class);

handler.onAuthenticationSuccess(request, response, authentication);

assertThat(response.getRedirectedUrl()).isEqualTo(redirectUri);
} finally {
zone.getConfig().getLinks().getLogout().setWhitelist(originalWhitelist);
}
}
}
4 changes: 2 additions & 2 deletions uaa/src/test/java/org/cloudfoundry/identity/uaa/integration/feature/SamlLoginIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ void relayStateRedirectFromIdpInitiatedLogin() {
webDriver.findElement(By.xpath(samlServerConfig.getLoginPromptXpathExpr()));
sendCredentials(testAccounts.getUserName(), testAccounts.getPassword());
Page.assertThatUrlEventuallySatisfies(webDriver,
assertUrl -> assertUrl.startsWith("https://www.google.com"));
assertUrl -> assertUrl.startsWith(baseUrl));

webDriver.get("%s/logout.do".formatted(baseUrl));
}
Expand Down Expand Up @@ -1228,7 +1228,7 @@ void backportFrom77RelayTest() {
sendCredentials(testAccounts.getUserName(), "koala");

Page.assertThatUrlEventuallySatisfies(webDriver,
assertUrl -> assertUrl.startsWith("https://www.google.com"));
assertUrl -> assertUrl.startsWith(zoneUrl));
webDriver.get(baseUrl + "/logout.do");
webDriver.get(zoneUrl + "/logout.do");
}
Expand Down
Loading