Skip to content

Fixes overlapping X-Forwarded-Prefix for chained path filters [server mvc] #4238

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
garvit-joshi wants to merge 1 commit into
base: main
Choose a base branch
from
+55 −10
Open

Fixes overlapping X-Forwarded-Prefix for chained path filters [server mvc] #4238

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
22 changes: 12 additions & 10 deletions ...a/org/springframework/cloud/gateway/server/mvc/filter/XForwardedRequestHeadersFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,20 +138,22 @@ public HttpHeaders apply(HttpHeaders input, ServerRequest request) {
MvcUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR);
URI requestUri = request.uri();

if (originalUris != null && requestUri != null) {
if (originalUris != null && !originalUris.isEmpty() && requestUri != null) {

originalUris.forEach(originalUri -> {
// only the first uri counts: it is the url as received from the client.
// later entries are intermediate snapshots added by each path-mutating
// filter and would produce overlapping prefixes (gh-4237)
URI originalUri = originalUris.iterator().next();

if (originalUri != null && originalUri.getPath() != null) {
// strip trailing slashes before checking if request path is end
// of original path
String originalUriPath = stripTrailingSlash(originalUri);
String requestUriPath = stripTrailingSlash(requestUri);
if (originalUri != null && originalUri.getPath() != null) {
// strip trailing slashes before checking if request path is end
// of original path
String originalUriPath = stripTrailingSlash(originalUri);
String requestUriPath = stripTrailingSlash(requestUri);

updateRequest(updated, originalUri, originalUriPath, requestUriPath);
updateRequest(updated, originalUri, originalUriPath, requestUriPath);

}
});
}
}
}

Expand Down
43 changes: 43 additions & 0 deletions .../springframework/cloud/gateway/server/mvc/filter/XForwardedRequestHeadersFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.cloud.gateway.server.mvc.filter;

import java.net.URI;
import java.util.Collections;

import org.assertj.core.api.Assertions;
Expand All @@ -28,6 +29,7 @@
import org.springframework.boot.tomcat.autoconfigure.servlet.TomcatServletWebServerAutoConfiguration;
import org.springframework.boot.webmvc.autoconfigure.WebMvcAutoConfiguration;
import org.springframework.cloud.gateway.server.mvc.GatewayServerMvcAutoConfiguration;
import org.springframework.cloud.gateway.server.mvc.common.MvcUtils;
import org.springframework.cloud.gateway.server.mvc.config.GatewayMvcProperties;
import org.springframework.cloud.gateway.server.mvc.predicate.PredicateAutoConfiguration;
import org.springframework.http.HttpHeaders;
Expand All @@ -39,6 +41,7 @@
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter.X_FORWARDED_FOR_HEADER;
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter.X_FORWARDED_HOST_HEADER;
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter.X_FORWARDED_PORT_HEADER;
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter.X_FORWARDED_PREFIX_HEADER;
import static org.springframework.cloud.gateway.server.mvc.filter.XForwardedRequestHeadersFilter.X_FORWARDED_PROTO_HEADER;

/**
Expand Down Expand Up @@ -162,4 +165,44 @@ public void remoteAdddressIsNullUnTrustedProxyNotAppended() {
assertThat(headers.getFirst(X_FORWARDED_FOR_HEADER)).doesNotContain("127.0.0.1");
}

@Test
public void prefixToInferOnceWhenChainedPathFiltersProcessRequest() {
MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost:8080/blue")
.remoteAddress("10.0.0.1:80")
.buildRequest(null);
ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());

// two chained path filters, e.g. StripPrefix=1 twice, add one entry each
MvcUtils.addOriginalRequestUrl(request, URI.create("http://localhost:8080/tenant/api/blue"));
MvcUtils.addOriginalRequestUrl(request, URI.create("http://localhost:8080/api/blue"));

XForwardedRequestHeadersFilter filter = new XForwardedRequestHeadersFilter(
new XForwardedRequestHeadersFilterProperties(), ".*");

HttpHeaders headers = filter.apply(request.headers().asHttpHeaders(), request);

assertThat(headers.headerNames()).contains(X_FORWARDED_PREFIX_HEADER);

assertThat(headers.getFirst(X_FORWARDED_PREFIX_HEADER)).isEqualTo("/tenant/api");
}

@Test
public void prefixAppendedToExistingHeaderOnceWhenChainedPathFiltersProcessRequest() {
MockHttpServletRequest servletRequest = MockMvcRequestBuilders.get("http://localhost:8080/blue")
.remoteAddress("10.0.0.1:80")
.header(X_FORWARDED_PREFIX_HEADER, "/upstream")
.buildRequest(null);
ServerRequest request = ServerRequest.create(servletRequest, Collections.emptyList());

MvcUtils.addOriginalRequestUrl(request, URI.create("http://localhost:8080/tenant/api/blue"));
MvcUtils.addOriginalRequestUrl(request, URI.create("http://localhost:8080/api/blue"));

XForwardedRequestHeadersFilter filter = new XForwardedRequestHeadersFilter(
new XForwardedRequestHeadersFilterProperties(), ".*");

HttpHeaders headers = filter.apply(request.headers().asHttpHeaders(), request);

assertThat(headers.getFirst(X_FORWARDED_PREFIX_HEADER)).isEqualTo("/upstream,/tenant/api");
}

}
Loading