Skip to content

Fixes overlapping X-Forwarded-Prefix for chained path filters [webflux] #4239

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
+64 −11
Open

Fixes overlapping X-Forwarded-Prefix for chained path filters [webflux] #4239

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
23 changes: 12 additions & 11 deletions ...c/main/java/org/springframework/cloud/gateway/filter/headers/XForwardedHeadersFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,22 +261,23 @@ public HttpHeaders filter(HttpHeaders input, ServerWebExchange exchange) {
LinkedHashSet<URI> originalUris = exchange.getAttribute(GATEWAY_ORIGINAL_REQUEST_URL_ATTR);
URI requestUri = exchange.getAttribute(GATEWAY_REQUEST_URL_ATTR);

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-4236)
URI originalUri = originalUris.iterator().next();

if (originalUri != null && originalUri.getPath() != null) {
String prefix = originalUri.getPath();
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);
// 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
52 changes: 52 additions & 0 deletions ...t/java/org/springframework/cloud/gateway/filter/headers/XForwardedHeadersFilterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,58 @@ public void prefixToInfer() throws Exception {
assertThat(headers.getFirst(X_FORWARDED_PREFIX_HEADER)).isEqualTo("/prefix");
}

@Test
public void prefixToInferOnceWhenChainedPathFiltersProcessRequest() throws Exception {
MockServerHttpRequest request = MockServerHttpRequest.get("https://originalhost:8080/tenant/api/blue")
.remoteAddress(new InetSocketAddress(InetAddress.getByName("10.0.0.1"), 80))
.build();

XForwardedHeadersFilter filter = new XForwardedHeadersFilter(ALLOW_ALL_REGEX);
filter.setPrefixAppend(true);
filter.setPrefixEnabled(true);

ServerWebExchange exchange = MockServerWebExchange.from(request);
LinkedHashSet<URI> originalUris = new LinkedHashSet<>();
// two chained path filters, e.g. StripPrefix=1 twice, add one entry each
originalUris
.add(UriComponentsBuilder.fromUriString("https://originalhost:8080/tenant/api/blue").build().toUri());
originalUris.add(UriComponentsBuilder.fromUriString("https://originalhost:8080/api/blue").build().toUri());
exchange.getAttributes().put(GATEWAY_ORIGINAL_REQUEST_URL_ATTR, originalUris);
URI requestUri = UriComponentsBuilder.fromUriString("https://routedservice:8090/blue").build().toUri();
exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUri);

HttpHeaders headers = filter.filter(request.getHeaders(), exchange);

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

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

@Test
public void prefixAppendedToExistingHeaderOnceWhenChainedPathFiltersProcessRequest() throws Exception {
MockServerHttpRequest request = MockServerHttpRequest.get("https://originalhost:8080/tenant/api/blue")
.remoteAddress(new InetSocketAddress(InetAddress.getByName("10.0.0.1"), 80))
.header(X_FORWARDED_PREFIX_HEADER, "/upstream")
.build();

XForwardedHeadersFilter filter = new XForwardedHeadersFilter(ALLOW_ALL_REGEX);
filter.setPrefixAppend(true);
filter.setPrefixEnabled(true);

ServerWebExchange exchange = MockServerWebExchange.from(request);
LinkedHashSet<URI> originalUris = new LinkedHashSet<>();
originalUris
.add(UriComponentsBuilder.fromUriString("https://originalhost:8080/tenant/api/blue").build().toUri());
originalUris.add(UriComponentsBuilder.fromUriString("https://originalhost:8080/api/blue").build().toUri());
exchange.getAttributes().put(GATEWAY_ORIGINAL_REQUEST_URL_ATTR, originalUris);
URI requestUri = UriComponentsBuilder.fromUriString("https://routedservice:8090/blue").build().toUri();
exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUri);

HttpHeaders headers = filter.filter(request.getHeaders(), exchange);

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

@Test
public void prefixToInferWhenEqualsResource() throws Exception {
MockServerHttpRequest request = MockServerHttpRequest.get("https://originalhost:8080/resource/resource/")
Expand Down
Loading