Form request parameters become garbled texts if non-UTF8 encoding #3572

rshindo · 2024-10-27T04:17:13Z

Versions

spring-cloud-gateway-mvc:4.1.5
spring-cloud-gateway-server-mvc:4.1.5

Bugs

Cannot read ServletInputSream with form request encoding when using ProxyExchange.

For example, a form parameter "こんにちは世界" (hello, world) encoded with Shift-JIS will be %EF%BF%BD%EF%BF%BD%EF%BF%BD%EF%BF%BD%C9%82%EF%BF%BD%EF%BF%BD%CD%90%EF%BF%BD%EF%BF%BDE. This is not an encoded value with Shift-JIS nor UTF-8.

Sample

Spring code

package com.example.gatewaymvc;

import java.io.IOException;
import java.nio.charset.Charset;

import org.springframework.cloud.gateway.mvc.ProxyExchange;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;

import jakarta.servlet.http.HttpServletRequest;

@Controller
public class RouteController {

	@PostMapping("/form")
	public ResponseEntity<?> formRoute(ProxyExchange<byte[]> proxy, HttpServletRequest request)
			throws IOException {
		request.setCharacterEncoding("Shift-JIS"); // This encoding is ignored
		byte[] body = request.getInputStream().readAllBytes();
		System.out.println(new String(body, Charset.forName("Shift-JIS"))); // Garbled!
		return proxy.uri("https://httpbin.org/post").post();
	}
}

Post request from this HTML

<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="Shift_JIS" />
    <title>Example</title>
</head>
<body>

<form method="POST" action="http://localhost:8080/form">
    <label for="item">Item:</label><br>
    <input type="text" id="item" name="item"><br>
    <input type="submit" value="Submit">
</form>

</body>
</html>

The text was updated successfully, but these errors were encountered:

rshindo · 2024-11-10T06:10:38Z

I confirmed that same issue occurred even if not using ServletInputStream.

@Bean
public RouterFunction<ServerResponse> formRoute() {
	return route("form")
			.POST("/form", http("https://httpbin.org"))
			.before(rewritePath("/form", "/post"))
			.build();
}

I think FormFilter read request body with UTF-8 regardless of request encoding, so Shift-JIS parameter will be garbled text. FormFilter use the encoding by getCharacterEncoding(), this problem will be ok.

spring-cloud-gateway/spring-cloud-gateway-server-mvc/src/main/java/org/springframework/cloud/gateway/server/mvc/filter/FormFilter.java

Lines 111 to 113 in 031e249

    
           static HttpServletRequest getRequestWithBodyFromRequestParameters(HttpServletRequest request) throws IOException { 
        
           	ByteArrayOutputStream bos = new ByteArrayOutputStream(1024); 
        
           	Writer writer = new OutputStreamWriter(bos, FORM_CHARSET);

rshindo added the waiting-for-triage label Oct 27, 2024

rshindo changed the title ~~Cannot read ServletInputSream with form request encoding when using ProxyExchange~~ Form request parameters become garbled texts if non-UTF8 encoding Nov 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Form request parameters become garbled texts if non-UTF8 encoding #3572

Form request parameters become garbled texts if non-UTF8 encoding #3572

rshindo commented Oct 27, 2024

rshindo commented Nov 10, 2024

Form request parameters become garbled texts if non-UTF8 encoding #3572

Form request parameters become garbled texts if non-UTF8 encoding #3572

Comments

rshindo commented Oct 27, 2024

Versions

Bugs

Sample

rshindo commented Nov 10, 2024