forked from line/armeria
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reject DATA Frames for invalid path requests (line#4405)
Motivation: If a request with an invalid path such as `/?download=../../secret.txt` and a DATA Frame is received, a `ClassCastException` can be raised. ``` java.lang.ClassCastException: class com.linecorp.armeria.server.EmptyContentDecodedHttpRequest cannot be cast to class com.linecorp.armeria.server.DecodedHttpRequestWriter (com.linecorp.armeria.server.EmptyContentDecodedHttpRequest and com.linecorp.armeria.server.DecodedHttpRequestWriter are in unnamed module of loader org.springframework.boot.loader.LaunchedURLClassLoader @301eda63) at com.linecorp.armeria.server.Http2RequestDecoder.onDataRead(Http2RequestDecoder.java:265) at io.netty.handler.codec.http2.Http2FrameListenerDecorator.onDataRead(Http2FrameListenerDecorator.java:36) at io.netty.handler.codec.http2.Http2EmptyDataFrameListener.onDataRead(Http2EmptyDataFrameListener.java:49) at io.netty.handler.codec.http2.DefaultHttp2ConnectionDecoder$FrameReadListener.onDataRead(DefaultHttp2ConnectionDecoder.java:307) at io.netty.handler.codec.http2.Http2InboundFrameLogger$1.onDataRead(Http2InboundFrameLogger.java:48) ``` Although a response is immediately sent by `HttpServerHandler` for the invalid path when the headers are received and try to close the stream, `onDataRead()` callback could be triggered by the following DATA frame. Because the stream could not be closed yet. https://github.com/line/armeria/blob/b9dc1ad1c6f4cfee8aba8e50a61d203c37eb94cc/core/src/main/java/com/linecorp/armeria/server/Http2RequestDecoder.java?rgh-link-date=2022-09-01T06%3A34%3A32Z#L242-L244 Modifications: - Rejects the following DATA frames and HEADERS frames of invalid path requests with `PROTOCOL_ERROR`. Result: You no longer see `ClassCastException` when an invalid path request is received.
- Loading branch information
Showing
7 changed files
with
127 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
core/src/test/java12/com/linecorp/armeria/server/InvalidPathWithDataTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Copyright 2022 LINE Corporation | ||
| * | ||
| * LINE Corporation licenses this file to you under the Apache License, | ||
| * version 2.0 (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at: | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package com.linecorp.armeria.server; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.awaitility.Awaitility.await; | ||
|
|
||
| import java.net.http.HttpClient; | ||
| import java.net.http.HttpClient.Version; | ||
| import java.net.http.HttpResponse.BodyHandlers; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.linecorp.armeria.common.HttpResponse; | ||
| import com.linecorp.armeria.internal.common.PathAndQuery; | ||
| import com.linecorp.armeria.server.logging.LoggingService; | ||
| import com.linecorp.armeria.testing.junit5.server.ServerExtension; | ||
|
|
||
| import ch.qos.logback.classic.Level; | ||
| import ch.qos.logback.classic.Logger; | ||
| import ch.qos.logback.classic.spi.ILoggingEvent; | ||
| import ch.qos.logback.core.read.ListAppender; | ||
|
|
||
| class InvalidPathWithDataTest { | ||
|
|
||
| @RegisterExtension | ||
| static ServerExtension server = new ServerExtension() { | ||
| @Override | ||
| protected void configure(ServerBuilder sb) { | ||
| sb.requestTimeoutMillis(0); | ||
| sb.decorator(LoggingService.newDecorator()); | ||
| sb.service("/foo", (ctx, req) -> { | ||
| return HttpResponse.from(req.aggregate().thenApply(agg -> HttpResponse.of(agg.contentUtf8()))); | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| @Test | ||
| void invalidPath() throws Exception { | ||
| final String invalidPath = "/foo?download=../../secret.txt"; | ||
| final PathAndQuery pathAndQuery = PathAndQuery.parse(invalidPath); | ||
| assertThat(pathAndQuery).isNull(); | ||
|
|
||
| final HttpClient client = HttpClient.newHttpClient(); | ||
|
|
||
| // Send a normal request to complete an upgrade request successfully. | ||
| final java.net.http.HttpRequest normalRequest = | ||
| java.net.http.HttpRequest.newBuilder() | ||
| .version(Version.HTTP_2) | ||
| .uri(server.httpUri().resolve("/foo")) | ||
| .GET() | ||
| .build(); | ||
|
|
||
| final ListAppender<ILoggingEvent> logWatcher = new ListAppender<>(); | ||
| logWatcher.start(); | ||
| final Logger logger = (Logger) LoggerFactory.getLogger(Http2RequestDecoder.class); | ||
| logger.setLevel(Level.DEBUG); | ||
| logger.addAppender(logWatcher); | ||
|
|
||
| final String bodyNormal = client.send(normalRequest, BodyHandlers.ofString()).body(); | ||
| assertThat(bodyNormal).isEmpty(); | ||
|
|
||
| final java.net.http.HttpRequest invalidRequest = | ||
| java.net.http.HttpRequest.newBuilder() | ||
| .version(Version.HTTP_2) | ||
| .uri(server.httpUri().resolve(invalidPath)) | ||
| .POST(java.net.http.HttpRequest.BodyPublishers.ofString( | ||
| "Hello Armeria!")) | ||
| .build(); | ||
|
|
||
| final java.net.http.HttpResponse<String> response = | ||
| client.send(invalidRequest, BodyHandlers.ofString()); | ||
| assertThat(response.statusCode()).isEqualTo(400); | ||
| assertThat(response.body()).contains("Invalid request path"); | ||
|
|
||
| await().untilAsserted(() -> { | ||
| assertThat(logWatcher.list) | ||
| .anyMatch(event -> { | ||
| final String logMessage = event.getFormattedMessage(); | ||
| return event.getLevel().equals(Level.DEBUG) && | ||
| logMessage.contains("received a DATA Frame for an invalid stream") && | ||
| logMessage.contains(invalidPath); | ||
| }); | ||
| }); | ||
| } | ||
| } |