SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Prevent duplicate encoding issue in HTTP request parameter rewrite filter

Browse Source 
Signed-off-by: raccoonback <kosb15@naver.com>
This commit is contained in:
raccoonback
2024-11-18 08:45:13 +09:00
parent ff2c7e7ae8
commit 6415f1204f
2 changed files with 33 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactory.java
View File

@@ -26,10 +26,14 @@ import org.springframework.cloud.gateway.filter.GatewayFilter;
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
@@ -59,14 +63,25 @@ public class RewriteRequestParameterGatewayFilterFactory
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());
}
URI uri = uriComponentsBuilder.build().toUri();
ServerHttpRequest request = req.mutate().uri(uri).build();
try {
MultiValueMap<String, String> encodedQueryParams = UriUtils.encodeQueryParams(queryParams);
URI uri = uriComponentsBuilder.replaceQueryParams(unmodifiableMultiValueMap(encodedQueryParams))
.build(true)
.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

14
spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/filter/factory/RewriteRequestParameterGatewayFilterFactoryTests.java
View File

@@ -71,11 +71,23 @@ class RewriteRequestParameterGatewayFilterFactoryTests {
}
@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()