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

Allow for non-encoded special characters in urls

Browse Source 
Fixes gh-3185
This commit is contained in:
sgibb
2024-03-06 13:59:18 -05:00
parent 4ec55dbcad
commit b38499e049
2 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/handler/ProxyExchangeHandlerFunction.java
View File

@@ -29,6 +29,7 @@ import org.springframework.cloud.gateway.server.mvc.filter.HttpHeadersFilter;
import org.springframework.cloud.gateway.server.mvc.filter.HttpHeadersFilter.RequestHttpHeadersFilter;
import org.springframework.cloud.gateway.server.mvc.filter.HttpHeadersFilter.ResponseHttpHeadersFilter;
import org.springframework.http.HttpHeaders;
import org.springframework.util.MultiValueMap;
import org.springframework.web.servlet.function.HandlerFunction;
import org.springframework.web.servlet.function.ServerRequest;
import org.springframework.web.servlet.function.ServerResponse;
@@ -66,7 +67,7 @@ public class ProxyExchangeHandlerFunction implements HandlerFunction<ServerRespo
@Override
public ServerResponse handle(ServerRequest serverRequest) {
URI uri = uriResolver.apply(serverRequest);
boolean encoded = containsEncodedQuery(serverRequest.uri());
boolean encoded = containsEncodedQuery(serverRequest.uri(), serverRequest.params());
// @formatter:off
URI url = UriComponentsBuilder.fromUri(serverRequest.uri())
.scheme(uri.getScheme())
@@ -113,14 +114,15 @@ public class ProxyExchangeHandlerFunction implements HandlerFunction<ServerRespo
return filtered;
}
private static boolean containsEncodedQuery(URI uri) {
boolean encoded = (uri.getRawQuery() != null && uri.getRawQuery().contains("%"))
private static boolean containsEncodedQuery(URI uri, MultiValueMap<String, String> params) {
String rawQuery = uri.getRawQuery();
boolean encoded = (rawQuery != null && rawQuery.contains("%"))
|| (uri.getRawPath() != null && uri.getRawPath().contains("%"));
// Verify if it is really fully encoded. Treat partial encoded as unencoded.
if (encoded) {
try {
UriComponentsBuilder.fromUri(uri).build(true);
UriComponentsBuilder.fromUri(uri).replaceQueryParams(params).build(true);
return true;
}
catch (IllegalArgumentException ignored) {
@@ -132,7 +134,7 @@ public class ProxyExchangeHandlerFunction implements HandlerFunction<ServerRespo
return false;
}
return encoded;
return false;
}
public interface URIResolver extends Function<ServerRequest, URI> {

15
spring-cloud-gateway-server-mvc/src/test/java/org/springframework/cloud/gateway/server/mvc/ServerMvcIntegrationTests.java
View File

@@ -670,6 +670,21 @@ public class ServerMvcIntegrationTests {
});
}
@SuppressWarnings("rawtypes")
@Test
public void queryParamWithSpecialCharactersWorks() {
restClient.get().uri("/get?myparam= &intlparam=æøå").exchange().expectStatus().isOk().expectBody(Map.class)
.consumeWith(result -> {
Map responseBody = result.getResponseBody();
assertThat(responseBody).containsKey("args");
Map args = getMap(responseBody, "args");
assertThat(args).containsKey("myparam");
assertThat(args.get("myparam")).isEqualTo(" ");
assertThat(args).containsKey("intlparam");
assertThat(args.get("intlparam")).isEqualTo("æøå");
});
}
@SpringBootConfiguration
@EnableAutoConfiguration
@LoadBalancerClient(name = "httpbin", configuration = TestLoadBalancerConfig.Httpbin.class)