Skip to content

Commit 49b6d0a

Browse files
committed
Prevent duplicate encoding issue in HTTP request parameter remove filter
Signed-off-by: raccoonback <kosb15@naver.com>
1 parent 6415f12 commit 49b6d0a

File tree

2 files changed

+50
-7
lines changed

2 files changed

+50
-7
lines changed

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactory.java

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import org.springframework.util.MultiValueMap;
3030
import org.springframework.web.server.ServerWebExchange;
3131
import org.springframework.web.util.UriComponentsBuilder;
32+
import org.springframework.web.util.UriUtils;
3233

3334
import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
3435
import static org.springframework.util.CollectionUtils.unmodifiableMultiValueMap;
@@ -57,14 +58,19 @@ public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
5758
MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>(request.getQueryParams());
5859
queryParams.remove(config.getName());
5960

60-
URI newUri = UriComponentsBuilder.fromUri(request.getURI())
61-
.replaceQueryParams(unmodifiableMultiValueMap(queryParams))
62-
.build()
63-
.toUri();
61+
try {
62+
MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
63+
URI newUri = UriComponentsBuilder.fromUri(request.getURI())
64+
.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
65+
.build(true)
66+
.toUri();
6467

65-
ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();
66-
67-
return chain.filter(exchange.mutate().request(updatedRequest).build());
68+
ServerHttpRequest updatedRequest = exchange.getRequest().mutate().uri(newUri).build();
69+
return chain.filter(exchange.mutate().request(updatedRequest).build());
70+
}
71+
catch (IllegalArgumentException ex) {
72+
throw new IllegalStateException("Invalid URI query: \"" + queryParams + "\"");
73+
}
6874
}
6975

7076
@Override

spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/factory/RemoveRequestParameterGatewayFilterFactoryTests.java

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,41 @@ public void removeRequestParameterFilterShouldHandleRemainingParamsWhichRequirin
123123
assertThat(actualRequest.getQueryParams()).containsEntry("ccc", singletonList(",xyz"));
124124
}
125125

126+
127+
@Test
128+
public void removeRequestParameterFilterShouldHandleEncodedParameterName() {
129+
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
130+
.queryParam("foo", "bar")
131+
.queryParam("baz[]", "qux")
132+
.build();
133+
exchange = MockServerWebExchange.from(request);
134+
NameConfig config = new NameConfig();
135+
config.setName("baz[]");
136+
GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);
137+
138+
filter.filter(exchange, filterChain);
139+
140+
ServerHttpRequest actualRequest = captor.getValue().getRequest();
141+
assertThat(actualRequest.getQueryParams()).doesNotContainKey("baz[]");
142+
assertThat(actualRequest.getQueryParams()).containsEntry("foo", singletonList("bar"));
143+
}
144+
145+
@Test
146+
public void removeRequestParameterFilterShouldMaintainEncodedParameters() {
147+
MockServerHttpRequest request = MockServerHttpRequest.get("http://localhost")
148+
.queryParam("foo", "bar")
149+
.queryParam("baz[]", "qux")
150+
.build();
151+
exchange = MockServerWebExchange.from(request);
152+
NameConfig config = new NameConfig();
153+
config.setName("foo");
154+
GatewayFilter filter = new RemoveRequestParameterGatewayFilterFactory().apply(config);
155+
156+
filter.filter(exchange, filterChain);
157+
158+
ServerHttpRequest actualRequest = captor.getValue().getRequest();
159+
assertThat(actualRequest.getQueryParams()).doesNotContainKey("foo");
160+
assertThat(actualRequest.getQueryParams()).containsEntry("baz[]", singletonList("qux"));
161+
}
162+
126163
}

0 commit comments

Comments
 (0)