Skip to content

Commit bc6b26f

Browse files
authored
fix(jsonrpc): don't print stacktrace in jsonrpc when request overload (#6867)
1 parent 7ab8945 commit bc6b26f

5 files changed

Lines changed: 90 additions & 13 deletions

File tree

‎framework/src/main/java/org/tron/core/services/filter/HttpInterceptor.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package org.tron.core.services.filter;
22

3-
import com.google.common.base.Strings;
43
import javax.servlet.Filter;
54
import javax.servlet.FilterChain;
65
import javax.servlet.FilterConfig;
@@ -9,6 +8,8 @@
98
import javax.servlet.http.HttpServletRequest;
109
import javax.servlet.http.HttpServletResponse;
1110
import lombok.extern.slf4j.Slf4j;
11+
import org.eclipse.jetty.http.BadMessageException;
12+
import org.eclipse.jetty.http.HttpStatus;
1213
import org.tron.common.prometheus.MetricKeys;
1314
import org.tron.common.prometheus.MetricLabels;
1415
import org.tron.common.prometheus.Metrics;
@@ -66,6 +67,10 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
6667
}
6768
MetricsUtil.meterMark(MetricsKey.NET_API_QPS, 1);
6869
MetricsUtil.meterMark(MetricsKey.NET_API_FAIL_QPS, 1);
70+
if (e instanceof BadMessageException
71+
&& ((BadMessageException) e).getCode() == HttpStatus.PAYLOAD_TOO_LARGE_413) {
72+
throw (BadMessageException) e;
73+
}
6974
}
7075
}
7176

@@ -75,4 +80,3 @@ public void destroy() {
7580
}
7681

7782

78-

‎framework/src/main/java/org/tron/core/services/http/RateLimiterServlet.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import javax.servlet.http.HttpServletRequest;
1515
import javax.servlet.http.HttpServletResponse;
1616
import lombok.extern.slf4j.Slf4j;
17+
import org.eclipse.jetty.http.BadMessageException;
1718
import org.springframework.beans.factory.annotation.Autowired;
1819
import org.tron.common.parameter.RateLimiterInitialization;
1920
import org.tron.common.prometheus.MetricKeys;
@@ -133,7 +134,7 @@ protected void service(HttpServletRequest req, HttpServletResponse resp)
133134
resp.getWriter()
134135
.println(Util.printErrorMsg(new IllegalAccessException("lack of computing resources")));
135136
}
136-
} catch (ServletException | IOException e) {
137+
} catch (ServletException | IOException | BadMessageException e) {
137138
throw e;
138139
} catch (Exception unexpected) {
139140
logger.error("Http Api {}, Method:{}. Error:", url, req.getMethod(), unexpected);
@@ -149,4 +150,4 @@ protected void service(HttpServletRequest req, HttpServletResponse resp)
149150
}
150151
}
151152
}
152-
}
153+
}

‎framework/src/test/java/org/tron/core/jsonrpc/JsonrpcServiceTest.java‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import org.apache.http.impl.client.HttpClients;
2727
import org.apache.http.util.EntityUtils;
2828
import org.bouncycastle.util.encoders.Hex;
29+
import org.eclipse.jetty.http.HttpStatus;
2930
import org.junit.Assert;
3031
import org.junit.Before;
3132
import org.junit.Test;
@@ -1572,8 +1573,7 @@ public void testWeb3ClientVersion() {
15721573
* Verifies SizeLimitHandler integration with the real JsonRpcServlet + jsonrpc4j stack.
15731574
*
15741575
* Covers: normal request no regression, Content-Length oversized 413,
1575-
* and chunked oversized handled gracefully (body truncated, 200 + empty body
1576-
* because jsonrpc4j absorbs the BadMessageException).
1576+
* and chunked oversized 413 during streaming body reads.
15771577
*/
15781578
@Test
15791579
public void testJsonRpcSizeLimitIntegration() {
@@ -1609,22 +1609,20 @@ public void testJsonRpcSizeLimitIntegration() {
16091609
overPost.setEntity(new StringEntity(
16101610
new String(new char[(int) testLimit + 1]).replace('\0', 'x')));
16111611
resp = httpClient.execute(overPost);
1612-
Assert.assertEquals(413, resp.getStatusLine().getStatusCode());
1612+
Assert.assertEquals(HttpStatus.PAYLOAD_TOO_LARGE_413,
1613+
resp.getStatusLine().getStatusCode());
16131614
resp.close();
16141615

1615-
// Chunked oversized -> BadMessageException thrown during body read,
1616-
// absorbed by jsonrpc4j catch(Exception) -> 200 with empty body.
1616+
// Chunked oversized -> BadMessageException thrown during body read.
16171617
// Body read IS truncated at the limit - OOM protection effective.
16181618
byte[] chunkedData = new String(new char[(int) testLimit * 2])
16191619
.replace('\0', 'x').getBytes("UTF-8");
16201620
HttpPost chunkedPost = new HttpPost(url);
16211621
chunkedPost.setEntity(new InputStreamEntity(
16221622
new ByteArrayInputStream(chunkedData), -1));
16231623
resp = httpClient.execute(chunkedPost);
1624-
Assert.assertEquals(200, resp.getStatusLine().getStatusCode());
1625-
body = EntityUtils.toString(resp.getEntity());
1626-
Assert.assertTrue("Chunked oversized should return empty body"
1627-
+ " (jsonrpc4j absorbs BadMessageException)", body.isEmpty());
1624+
Assert.assertEquals(HttpStatus.PAYLOAD_TOO_LARGE_413,
1625+
resp.getStatusLine().getStatusCode());
16281626
resp.close();
16291627
}
16301628
} catch (Exception e) {
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
package org.tron.core.services.filter;
2+
3+
import static org.junit.Assert.assertThrows;
4+
5+
import javax.servlet.FilterChain;
6+
import javax.servlet.ServletException;
7+
import org.eclipse.jetty.http.BadMessageException;
8+
import org.eclipse.jetty.http.HttpStatus;
9+
import org.junit.Test;
10+
import org.springframework.mock.web.MockHttpServletRequest;
11+
import org.springframework.mock.web.MockHttpServletResponse;
12+
13+
public class HttpInterceptorTest {
14+
15+
private final HttpInterceptor interceptor = new HttpInterceptor();
16+
17+
@Test
18+
public void testOversizedBadMessagePropagates() {
19+
MockHttpServletRequest request = new MockHttpServletRequest("POST", "/jsonrpc");
20+
request.setServletPath("/jsonrpc");
21+
MockHttpServletResponse response = new MockHttpServletResponse();
22+
FilterChain chain = (req, resp) -> {
23+
throw new BadMessageException(HttpStatus.PAYLOAD_TOO_LARGE_413,
24+
"Request body is too large");
25+
};
26+
27+
BadMessageException e = assertThrows(BadMessageException.class,
28+
() -> interceptor.doFilter(request, response, chain));
29+
30+
org.junit.Assert.assertEquals(HttpStatus.PAYLOAD_TOO_LARGE_413, e.getCode());
31+
}
32+
33+
@Test
34+
public void testNonOversizedExceptionIsStillSwallowed() throws Exception {
35+
MockHttpServletRequest request = new MockHttpServletRequest("POST", "/jsonrpc");
36+
request.setServletPath("/jsonrpc");
37+
MockHttpServletResponse response = new MockHttpServletResponse();
38+
FilterChain chain = (req, resp) -> {
39+
throw new ServletException("expected");
40+
};
41+
42+
interceptor.doFilter(request, response, chain);
43+
}
44+
}

‎framework/src/test/java/org/tron/core/services/http/RateLimiterServletTest.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
import java.util.Map;
1717
import javax.servlet.http.HttpServletRequest;
1818
import javax.servlet.http.HttpServletResponse;
19+
import org.eclipse.jetty.http.BadMessageException;
20+
import org.eclipse.jetty.http.HttpStatus;
1921
import org.junit.AfterClass;
2022
import org.junit.Before;
2123
import org.junit.Test;
@@ -69,6 +71,14 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
6971
}
7072
}
7173

74+
static class OversizedRequestServlet extends RateLimiterServlet {
75+
@Override
76+
protected void doPost(HttpServletRequest req, HttpServletResponse resp) {
77+
throw new BadMessageException(HttpStatus.PAYLOAD_TOO_LARGE_413,
78+
"Request body is too large");
79+
}
80+
}
81+
7282
/**
7383
* GlobalRateLimiter's static initializer calls Args.getInstance().getRateLimiterGlobalQps().
7484
* Without Args being initialized the default QPS is 0, causing RateLimiter.create(0) to throw.
@@ -250,4 +260,24 @@ public void testNullRateLimiterConsultsOnlyGlobal() throws Exception {
250260
globalMock.verify(() -> GlobalRateLimiter.acquirePermit(any()), times(1));
251261
}
252262
}
263+
264+
@Test
265+
public void testOversizedRequestBadMessagePropagates() throws Exception {
266+
OversizedRequestServlet oversizedServlet = new OversizedRequestServlet();
267+
Field f = RateLimiterServlet.class.getDeclaredField("container");
268+
f.setAccessible(true);
269+
f.set(oversizedServlet, container);
270+
MockHttpServletRequest postRequest = new MockHttpServletRequest("POST", "/jsonrpc");
271+
postRequest.setRemoteAddr("10.0.0.1");
272+
postRequest.setServletPath("/jsonrpc");
273+
274+
try (MockedStatic<GlobalRateLimiter> globalMock = mockStatic(GlobalRateLimiter.class)) {
275+
globalMock.when(() -> GlobalRateLimiter.acquirePermit(any())).thenReturn(true);
276+
277+
BadMessageException e = assertThrows(BadMessageException.class,
278+
() -> oversizedServlet.service(postRequest, response));
279+
280+
assertEquals(HttpStatus.PAYLOAD_TOO_LARGE_413, e.getCode());
281+
}
282+
}
253283
}

0 commit comments

Comments
 (0)