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

Fix: prevent duplicated encoding request parameters filter #3598

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix: prevent duplicated encoding request parameters filter #3598

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
004036c
Prevent duplicate encoding issue in HTTP request parameter rewrite fi…
raccoonback Nov 17, 2024
9af0d4c
Prevent duplicate encoding issue in HTTP request parameter remove filter
raccoonback Nov 17, 2024
adc3390
Remove unnecessary public modifiers from test methods
raccoonback Nov 17, 2024
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
20 changes: 13 additions & 7 deletions ...ingframework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.UriUtils;

import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;
Expand Down Expand Up @@ -57,14 +58,19 @@ public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(request.getQueryParams());
queryParams.remove(config.getName());
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ServerHttpRequest.getRequest() returns decoded query parameters as a response.
So, it finds the parameter in the decoded query parameters and removes them.


URI newUri = UriComponentsBuilder.fromUri(request.getURI())
.replaceQueryParams(unmodifiableMultiValueMap(queryParams))
.build()
.toUri();
try {
MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
Copy link
Contributor Author

@raccoonback raccoonback Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Encode only query parameters including replaced parameter.
(excluding uri paths, fragment, etc.)

URI newUri = UriComponentsBuilder.fromUri(request.getURI())
.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
.build(true)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indicates that it is encoded.

.toUri();

ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();

return chain.filter(exchange.mutate().request(updatedRequest).build());
ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();
return chain.filter(exchange.mutate().request(updatedRequest).build());
}
catch (IllegalArgumentException ex) {
throw new IllegalStateException("Invalid URI query: \"" + queryParams + "\"");
}
}

@Override
Expand Down
25 changes: 20 additions & 5 deletions ...ngframework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.UriUtils;

import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;

/**
* @author Fredrich Ombico
Expand Down Expand Up @@ -59,14 +63,25 @@ public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest req = exchange.getRequest();

UriComponentsBuilder uriComponentsBuilder = UriComponentsBuilder.fromUri(req.getURI());
if (req.getQueryParams().containsKey(config.getName())) {
uriComponentsBuilder.replaceQueryParam(config.getName(), config.getReplacement());

MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(req.getQueryParams());
if (queryParams.containsKey(config.getName())) {
queryParams.remove(config.getName());
queryParams.add(config.getName(), config.getReplacement());
}
Comment on lines 63 to 71
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ServerHttpRequest.getQueryParams() method returns the decoded query parameters.
Therefore, it can replace new parameter in the decoded query parameters.


URI uri = uriComponentsBuilder.build().toUri();
ServerHttpRequest request = req.mutate().uri(uri).build();
try {
MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
Copy link
Contributor Author

@raccoonback raccoonback Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Encode only query parameters including replaced parameter.
(excluding uri paths, fragment, etc.)

URI uri = uriComponentsBuilder.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
.build(true)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indicates that it is encoded.

.toUri();

return chain.filter(exchange.mutate().request(request).build());
ServerHttpRequest request = req.mutate().uri(uri).build();
return chain.filter(exchange.mutate().request(request).build());
}
catch (IllegalArgumentException ex) {
throw new IllegalStateException("Invalid URI query: \"" + queryParams + "\"");
}
}

@Override
Expand Down
48 changes: 42 additions & 6 deletions ...amework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
/**
* @author Thirunavukkarasu Ravichandran
*/
public class RemoveRequestParameterGatewayFilterFactoryTests {
class RemoveRequestParameterGatewayFilterFactoryTests {

private ServerWebExchange exchange;

Expand All @@ -46,15 +46,15 @@ public class RemoveRequestParameterGatewayFilterFactoryTests {
private ArgumentCaptor<ServerWebExchange> captor;

@BeforeEach
public void setUp() {
void setUp() {
filterChain = mock(GatewayFilterChain.class);
captor = ArgumentCaptor.forClass(ServerWebExchange.class);
when(filterChain.filter(captor.capture())).thenReturn(Mono.empty());

}

@Test
public void removeRequestParameterFilterWorks() {
void removeRequestParameterFilterWorks() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
.queryParam("foo", singletonList("bar"))
.build();
Expand All @@ -70,7 +70,7 @@ public void removeRequestParameterFilterWorks() {
}

@Test
public void removeRequestParameterFilterWorksWhenParamIsNotPresentInRequest() {
void removeRequestParameterFilterWorksWhenParamIsNotPresentInRequest() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost").build();
exchange = MockServerWebExchange.from(request);
NameConfig config = new NameConfig();
Expand All @@ -84,7 +84,7 @@ public void removeRequestParameterFilterWorksWhenParamIsNotPresentInRequest() {
}

@Test
public void removeRequestParameterFilterShouldOnlyRemoveSpecifiedParam() {
void removeRequestParameterFilterShouldOnlyRemoveSpecifiedParam() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
.queryParam("foo", "bar")
.queryParam("abc", "xyz")
Expand All @@ -102,7 +102,7 @@ public void removeRequestParameterFilterShouldOnlyRemoveSpecifiedParam() {
}

@Test
public void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequiringEncoding() {
void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequiringEncoding() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
.queryParam("foo", "bar")
.queryParam("aaa", "abc xyz")
Expand All @@ -123,4 +123,40 @@ public void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequirin
assertThat(actualRequest.getQueryParams()).containsEntry("ccc", singletonList(",xyz"));
}

@Test
void removeRequestParameterFilterShouldHandleEncodedParameterName() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
.queryParam("foo", "bar")
.queryParam("baz[]", "qux")
.build();
exchange = MockServerWebExchange.from(request);
NameConfig config = new NameConfig();
config.setName("baz[]");
GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);

filter.filter(exchange, filterChain);

ServerHttpRequest actualRequest = captor.getValue().getRequest();
assertThat(actualRequest.getQueryParams()).doesNotContainKey("baz[]");
assertThat(actualRequest.getQueryParams()).containsEntry("foo", singletonList("bar"));
}

@Test
void removeRequestParameterFilterShouldMaintainEncodedParameters() {
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
.queryParam("foo", "bar")
.queryParam("baz[]", "qux")
.build();
exchange = MockServerWebExchange.from(request);
NameConfig config = new NameConfig();
config.setName("foo");
GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);

filter.filter(exchange, filterChain);

ServerHttpRequest actualRequest = captor.getValue().getRequest();
assertThat(actualRequest.getQueryParams()).doesNotContainKey("foo");
assertThat(actualRequest.getQueryParams()).containsEntry("baz[]", singletonList("qux"));
}

}
14 changes: 13 additions & 1 deletion ...mework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,23 @@ void rewriteRequestParameterFilterDoesNotAddParamIfNameNotFound() {
}

@Test
void rewriteRequestParameterFilterWorksWithSpecialCharacters() {
void rewriteRequestParameterFilterWithSpecialCharactersInParameterValue() {
testRewriteRequestParameterFilter("campaign", "black friday~(1.A-B_C!)", "campaign=old&color=green",
Map.of("campaign", List.of("black friday~(1.A-B_C!)"), "color", List.of("green")));
}

@Test
void rewriteRequestParameterFilterWithSpecialCharactersInParameterName() {
testRewriteRequestParameterFilter("campaign[]", "red", "campaign%5B%5D=blue&color=green",
Map.of("campaign[]", List.of("red"), "color", List.of("green")));
}

@Test
void rewriteRequestParameterFilterKeepsOtherParamsEncoded() {
testRewriteRequestParameterFilter("color", "white", "campaign%5B%5D=blue&color=green",
Map.of("campaign[]", List.of("blue"), "color", List.of("white")));
}

private void testRewriteRequestParameterFilter(String name, String replacement, String query,
Map<String, List<String>> expectedQueryParams) {
GatewayFilter filter = new RewriteRequestParameterGatewayFilterFactory()
Expand Down