andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

adjust validation logic when websocket server check starts with '/' (#11191)

Browse Source 
Motivation:

When create a WebSocketServerProtocolConfig to check URI path starts from '/',
only '/' or '//subPath' can be passed by the checker,but '/subPath' should be
passed as well

Modifications:

in `WebSocketServerProtocolHandshakeHandler.isWebSocketPath()` treat '/' a special case

Result:
'/subPath' can be passed
This commit is contained in:
roy 2021-04-26 16:32:10 +08:00 committed by GitHub
parent a98c60283b
commit c1b922b224
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolHandshakeHandler.java
View File

@ -117,7 +117,7 @@ class WebSocketServerProtocolHandshakeHandler extends ChannelInboundHandlerAdapt
String websocketPath = serverConfig.websocketPath();
String uri = req.uri();
boolean checkStartUri = uri.startsWith(websocketPath);
boolean checkNextUri = checkNextUri(uri, websocketPath);
boolean checkNextUri = "/".equals(websocketPath) || checkNextUri(uri, websocketPath);
return serverConfig.checkStartsWith() ? (checkStartUri && checkNextUri) : uri.equals(websocketPath);
}

36
codec-http/src/test/java/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolHandlerTest.java
View File

@ -195,6 +195,38 @@ public class WebSocketServerProtocolHandlerTest {
assertFalse(ch.finish());
}
@Test
public void testCheckWebSocketPathStartWithSlash() {
WebSocketRequestBuilder builder = new WebSocketRequestBuilder().httpVersion(HTTP_1_1)
.method(HttpMethod.GET)
.key(HttpHeaderNames.SEC_WEBSOCKET_KEY)
.connection("Upgrade")
.upgrade(HttpHeaderValues.WEBSOCKET)
.version13();
WebSocketServerProtocolConfig config = WebSocketServerProtocolConfig.newBuilder()
.websocketPath("/")
.checkStartsWith(true)
.build();
FullHttpResponse response;
createChannel(config, null).writeInbound(builder.uri("/test").build());
response = responses.remove();
assertEquals(SWITCHING_PROTOCOLS, response.status());
response.release();
createChannel(config, null).writeInbound(builder.uri("/?q=v").build());
response = responses.remove();
assertEquals(SWITCHING_PROTOCOLS, response.status());
response.release();
createChannel(config, null).writeInbound(builder.uri("/").build());
response = responses.remove();
assertEquals(SWITCHING_PROTOCOLS, response.status());
response.release();
}
@Test
public void testCheckValidWebSocketPath() {
HttpRequest httpRequest = new WebSocketRequestBuilder().httpVersion(HTTP_1_1)
@ -402,6 +434,10 @@ public class WebSocketServerProtocolHandlerTest {
.websocketPath("/test")
.sendCloseFrame(null)
.build();
return createChannel(serverConfig, handler);
}
private EmbeddedChannel createChannel(WebSocketServerProtocolConfig serverConfig, ChannelHandler handler) {
return new EmbeddedChannel(
new WebSocketServerProtocolHandler(serverConfig),
new HttpRequestDecoder(),