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

Keep encoded plus signs in query parameters intact #3448

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Keep encoded plus signs in query parameters intact #3448

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
27 changes: 1 addition & 26 deletions ...va/org/springframework/cloud/gateway/server/mvc/handler/ProxyExchangeHandlerFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,12 @@ private void init() {
@Override
public ServerResponse handle(ServerRequest serverRequest) {
URI uri = uriResolver.apply(serverRequest);
boolean encoded = containsEncodedQuery(serverRequest.uri(), serverRequest.params());
Copy link

Choose a reason for hiding this comment

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

Why is this check being removed? Can we assume URI is always encoded?

Copy link
Author

Choose a reason for hiding this comment

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

I am not sure why this check was added in the first place. In my opinion, spring-cloud-gateway should not encode or decode parameters or URI parts, but leave them untouched. A similar change is also proposed in https://github.com/spring-cloud/spring-cloud-gateway/pull/3437/files

Copy link

@gatewaynovice gatewaynovice Jul 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I think the intent may be if the incoming URI is already encoded, keep the encoding...otherwise don't. Not working that way though, I'm seeing the request is decoded by the time it reaches the backend.

The key is handling replaceQueryParms piece below, may be we need to encode the request parms if the request is already encoded ?

something like

    boolean encoded = containsEncodedQuery(serverRequest.uri(), serverRequest.params());
    var parms = serverRequest.params();;
    if(encoded) {
        //pseudo code
        parms = encode(serverRequest.params());
    }
URI url = UriComponentsBuilder.fromUri(serverRequest.uri())
			.scheme(uri.getScheme())
			.host(uri.getHost())
			.port(uri.getPort())
			.replaceQueryParams(parms))
			.build(encoded)
			.toUri();

// @formatter:off
URI url = UriComponentsBuilder.fromUri(serverRequest.uri())
.scheme(uri.getScheme())
.host(uri.getHost())
.port(uri.getPort())
.replaceQueryParams(serverRequest.params())
Copy link

@dmyronenko dmyronenko Jul 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

if you add/change some query params in pre filters they will not be added to request I guess

Copy link
Author

Choose a reason for hiding this comment

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

Good catch, I assumed query params were already included in serverRequest.uri(). I think this needs an additional integration test.

Copy link

Choose a reason for hiding this comment

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

I've been trying to fix this issue in our project aswell, and what I find to be working best is this

URI url = UriComponentsBuilder.fromUri(serverRequest.uri())
            .scheme(uri.getScheme())
            .host(uri.getHost())
            .port(uri.getPort())
            .replaceQueryParams(serverRequest.params())
            .encode()
            .build()
            .toUri();

It solves all cases we have found so far.

.build(encoded)
.build(true)
.toUri();
// @formatter:on

Expand Down Expand Up @@ -131,29 +129,6 @@ private <REQUEST_OR_RESPONSE> HttpHeaders filterHeaders(List<?> filters, HttpHea
return filtered;
}

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).replaceQueryParams(params).build(true);
return true;
}
catch (IllegalArgumentException ignored) {
if (log.isTraceEnabled()) {
log.trace("Error in containsEncodedParts", ignored);
}
}

return false;
}

return false;
}

public interface URIResolver extends Function<ServerRequest, URI> {

}
Expand Down
13 changes: 13 additions & 0 deletions ...src/test/java/org/springframework/cloud/gateway/server/mvc/ServerMvcIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -699,6 +699,19 @@ public void queryParamWithSpecialCharactersWorks() {
});
}

@Test
public void encodedPlusSignInQueryParamWorks() {
URI uri = URI.create("/get?myparam=123%2b456");
restClient.get().uri(uri).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("123+456");
});
}

@Test
public void clientResponseBodyAttributeWorks() {
restClient.get().uri("/anything/readresponsebody").header("X-Foo", "fooval").exchange().expectStatus().isOk()
Expand Down