Issue #3608 - give 400 error response for missing Sec-WebSocket-Key

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2019-04-30 11:36:54 +10:00 committed by Greg Wilkins
parent ba2bdc1532
commit 8ddcf3685b
2 changed files with 173 additions and 5 deletions

View File

@ -0,0 +1,171 @@
//
// ========================================================================
// Copyright (c) 1995-2019 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.tests;
import java.io.EOFException;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetSocketAddress;
import java.net.Socket;
import java.nio.charset.StandardCharsets;
import org.eclipse.jetty.http.HttpFields;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.util.B64Code;
import org.eclipse.jetty.websocket.client.WebSocketClient;
import org.eclipse.jetty.websocket.servlet.WebSocketServlet;
import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.startsWith;
public class WebSocketNegotiationTest
{
public static class EchoServlet extends WebSocketServlet
{
@Override
public void configure(WebSocketServletFactory factory)
{
factory.register(EchoSocket.class);
}
}
private Server server;
private ServerConnector connector;
private WebSocketClient client;
@BeforeEach
public void start() throws Exception
{
server = new Server();
connector = new ServerConnector(server);
connector.setPort(0);
server.addConnector(connector);
ServletContextHandler contextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS);
contextHandler.setContextPath("/");
contextHandler.addServlet(EchoServlet.class, "/");
server.setHandler(contextHandler);
client = new WebSocketClient();
server.start();
client.start();
}
@AfterEach
public void stop() throws Exception
{
client.stop();
server.stop();
}
@Test
public void testValidUpgradeRequest() throws Exception
{
Socket client = new Socket();
client.connect(new InetSocketAddress("127.0.0.1", connector.getLocalPort()));
HttpFields httpFields = newUpgradeRequest(null);
httpFields.remove(HttpHeader.SEC_WEBSOCKET_SUBPROTOCOL);
httpFields.add(HttpHeader.SEC_WEBSOCKET_SUBPROTOCOL, "testInvalidUpgradeRequest");
String upgradeRequest = "GET / HTTP/1.1\r\n" + httpFields;
client.getOutputStream().write(upgradeRequest.getBytes(StandardCharsets.ISO_8859_1));
String response = getUpgradeResponse(client.getInputStream());
assertThat(response, startsWith("HTTP/1.1 101 Switching Protocols"));
assertThat(response, containsString("Sec-WebSocket-Accept: +WahVcVmeMLKQUMm0fvPrjSjwzI="));
}
@Test
public void testInvalidUpgradeRequestNoKey() throws Exception
{
Socket client = new Socket();
client.connect(new InetSocketAddress("127.0.0.1", connector.getLocalPort()));
HttpFields httpFields = newUpgradeRequest(null);
httpFields.remove(HttpHeader.SEC_WEBSOCKET_SUBPROTOCOL);
httpFields.add(HttpHeader.SEC_WEBSOCKET_SUBPROTOCOL, "testInvalidUpgradeRequest");
httpFields.remove(HttpHeader.SEC_WEBSOCKET_KEY);
String upgradeRequest = "GET / HTTP/1.1\r\n" + httpFields;
client.getOutputStream().write(upgradeRequest.getBytes(StandardCharsets.ISO_8859_1));
String response = getUpgradeResponse(client.getInputStream());
assertThat(response, containsString("400 Missing request header 'Sec-WebSocket-Key'"));
}
protected static HttpFields newUpgradeRequest(String extensions)
{
HttpFields fields = new HttpFields();
fields.add(HttpHeader.HOST, "127.0.0.1");
fields.add(HttpHeader.UPGRADE, "websocket");
fields.add(HttpHeader.CONNECTION, "Upgrade");
fields.add(HttpHeader.SEC_WEBSOCKET_KEY, new String(B64Code.encode("0123456701234567".getBytes())));
fields.add(HttpHeader.SEC_WEBSOCKET_VERSION, "13");
fields.add(HttpHeader.PRAGMA, "no-cache");
fields.add(HttpHeader.CACHE_CONTROL, "no-cache");
fields.add(HttpHeader.SEC_WEBSOCKET_SUBPROTOCOL, "test");
if (extensions != null)
fields.add(HttpHeader.SEC_WEBSOCKET_EXTENSIONS, extensions);
return fields;
}
protected static String getUpgradeResponse(InputStream in) throws IOException
{
int state = 0;
StringBuilder buffer = new StringBuilder();
while (state < 4)
{
int i = in.read();
if (i < 0)
throw new EOFException();
int b = (byte)(i & 0xff);
buffer.append((char)b);
switch (state)
{
case 0:
state = (b == '\r')?1:0;
break;
case 1:
state = (b == '\n')?2:0;
break;
case 2:
state = (b == '\r')?3:0;
break;
case 3:
state = (b == '\n')?4:0;
break;
default:
state = 0;
}
}
return buffer.toString();
}
}

View File

@ -19,9 +19,9 @@
package org.eclipse.jetty.websocket.server;
import java.io.IOException;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.http.BadMessageException;
import org.eclipse.jetty.websocket.common.AcceptHash;
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
@ -38,11 +38,8 @@ public class HandshakeRFC6455 implements WebSocketHandshake
public void doHandshakeResponse(ServletUpgradeRequest request, ServletUpgradeResponse response) throws IOException
{
String key = request.getHeader("Sec-WebSocket-Key");
if (key == null)
{
throw new IllegalStateException("Missing request header 'Sec-WebSocket-Key'");
}
throw new BadMessageException("Missing request header 'Sec-WebSocket-Key'");
// build response
response.setHeader("Upgrade","WebSocket");