// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/string_util.h"
#include "googleurl/src/gurl.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_util.h"
#include "net/websockets/websocket_handshake_handler.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "testing/platform_test.h"
namespace {
const char* const kCookieHeaders[] = {
"cookie", "cookie2"
};
const char* const kSetCookieHeaders[] = {
"set-cookie", "set-cookie2"
};
}
namespace net {
TEST(WebSocketHandshakeRequestHandlerTest, SimpleRequest) {
WebSocketHandshakeRequestHandler handler;
static const char* kHandshakeRequestMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_TRUE(handler.ParseRequest(kHandshakeRequestMessage,
strlen(kHandshakeRequestMessage)));
handler.RemoveHeaders(kCookieHeaders, arraysize(kCookieHeaders));
EXPECT_EQ(kHandshakeRequestMessage, handler.GetRawRequest());
}
TEST(WebSocketHandshakeRequestHandlerTest, ReplaceRequestCookies) {
WebSocketHandshakeRequestHandler handler;
static const char* kHandshakeRequestMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"Cookie: WK-websocket-test=1\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_TRUE(handler.ParseRequest(kHandshakeRequestMessage,
strlen(kHandshakeRequestMessage)));
handler.RemoveHeaders(kCookieHeaders, arraysize(kCookieHeaders));
handler.AppendHeaderIfMissing("Cookie",
"WK-websocket-test=1; "
"WK-websocket-test-httponly=1");
static const char* kHandshakeRequestExpectedMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"Cookie: WK-websocket-test=1; WK-websocket-test-httponly=1\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_EQ(kHandshakeRequestExpectedMessage, handler.GetRawRequest());
}
TEST(WebSocketHandshakeResponseHandlerTest, SimpleResponse) {
WebSocketHandshakeResponseHandler handler;
static const char* kHandshakeResponseMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Origin: http://example.com\r\n"
"Sec-WebSocket-Location: ws://example.com/demo\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(strlen(kHandshakeResponseMessage),
handler.ParseRawResponse(kHandshakeResponseMessage,
strlen(kHandshakeResponseMessage)));
EXPECT_TRUE(handler.HasResponse());
handler.RemoveHeaders(kCookieHeaders, arraysize(kCookieHeaders));
EXPECT_EQ(kHandshakeResponseMessage, handler.GetResponse());
}
TEST(WebSocketHandshakeResponseHandlerTest, ReplaceResponseCookies) {
WebSocketHandshakeResponseHandler handler;
static const char* kHandshakeResponseMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Origin: http://example.com\r\n"
"Sec-WebSocket-Location: ws://example.com/demo\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Set-Cookie: WK-websocket-test-1\r\n"
"Set-Cookie: WK-websocket-test-httponly=1; HttpOnly\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(strlen(kHandshakeResponseMessage),
handler.ParseRawResponse(kHandshakeResponseMessage,
strlen(kHandshakeResponseMessage)));
EXPECT_TRUE(handler.HasResponse());
std::vector<std::string> cookies;
handler.GetHeaders(kSetCookieHeaders, arraysize(kSetCookieHeaders), &cookies);
ASSERT_EQ(2U, cookies.size());
EXPECT_EQ("WK-websocket-test-1", cookies[0]);
EXPECT_EQ("WK-websocket-test-httponly=1; HttpOnly", cookies[1]);
handler.RemoveHeaders(kSetCookieHeaders, arraysize(kSetCookieHeaders));
static const char* kHandshakeResponseExpectedMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Origin: http://example.com\r\n"
"Sec-WebSocket-Location: ws://example.com/demo\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(kHandshakeResponseExpectedMessage, handler.GetResponse());
}
TEST(WebSocketHandshakeResponseHandlerTest, BadResponse) {
WebSocketHandshakeResponseHandler handler;
static const char* kBadMessage = "\n\n\r\net-Location: w";
EXPECT_EQ(strlen(kBadMessage),
handler.ParseRawResponse(kBadMessage, strlen(kBadMessage)));
EXPECT_TRUE(handler.HasResponse());
EXPECT_EQ(kBadMessage, handler.GetResponse());
}
TEST(WebSocketHandshakeResponseHandlerTest, BadResponse2) {
WebSocketHandshakeResponseHandler handler;
static const char* kBadMessage = "\n\r\n\r\net-Location: w";
EXPECT_EQ(strlen(kBadMessage),
handler.ParseRawResponse(kBadMessage, strlen(kBadMessage)));
EXPECT_TRUE(handler.HasResponse());
EXPECT_EQ(kBadMessage, handler.GetResponse());
}
TEST(WebSocketHandshakeHandlerTest, HttpRequestResponse) {
WebSocketHandshakeRequestHandler request_handler;
static const char* kHandshakeRequestMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_TRUE(request_handler.ParseRequest(kHandshakeRequestMessage,
strlen(kHandshakeRequestMessage)));
GURL url("ws://example.com/demo");
std::string challenge;
const HttpRequestInfo& request_info =
request_handler.GetRequestInfo(url, &challenge);
EXPECT_EQ(url, request_info.url);
EXPECT_EQ("GET", request_info.method);
EXPECT_FALSE(request_info.extra_headers.HasHeader("Upgrade"));
EXPECT_FALSE(request_info.extra_headers.HasHeader("Connection"));
EXPECT_FALSE(request_info.extra_headers.HasHeader("Sec-WebSocket-Key1"));
EXPECT_FALSE(request_info.extra_headers.HasHeader("Sec-WebSocket-Key2"));
std::string value;
EXPECT_TRUE(request_info.extra_headers.GetHeader("Host", &value));
EXPECT_EQ("example.com", value);
EXPECT_TRUE(request_info.extra_headers.GetHeader("Origin", &value));
EXPECT_EQ("http://example.com", value);
EXPECT_TRUE(request_info.extra_headers.GetHeader("Sec-WebSocket-Protocol",
&value));
EXPECT_EQ("sample", value);
const char expected_challenge[] = "\x31\x6e\x41\x13\x0f\x7e\xd6\x3c^n:ds[4U";
EXPECT_EQ(expected_challenge, challenge);
static const char* kHandshakeResponseHeader =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Sec-WebSocket-Origin: http://example.com\r\n"
"Sec-WebSocket-Location: ws://example.com/demo\r\n"
"Sec-WebSocket-Protocol: sample\r\n";
std::string raw_headers =
HttpUtil::AssembleRawHeaders(kHandshakeResponseHeader,
strlen(kHandshakeResponseHeader));
HttpResponseInfo response_info;
response_info.headers = new HttpResponseHeaders(raw_headers);
EXPECT_TRUE(StartsWithASCII(response_info.headers->GetStatusLine(),
"HTTP/1.1 101 ", false));
EXPECT_FALSE(response_info.headers->HasHeader("Upgrade"));
EXPECT_FALSE(response_info.headers->HasHeader("Connection"));
EXPECT_TRUE(response_info.headers->HasHeaderValue("Sec-WebSocket-Origin",
"http://example.com"));
EXPECT_TRUE(response_info.headers->HasHeaderValue("Sec-WebSocket-Location",
"ws://example.com/demo"));
EXPECT_TRUE(response_info.headers->HasHeaderValue("Sec-WebSocket-Protocol",
"sample"));
WebSocketHandshakeResponseHandler response_handler;
EXPECT_TRUE(response_handler.ParseResponseInfo(response_info, challenge));
EXPECT_TRUE(response_handler.HasResponse());
static const char* kHandshakeResponseExpectedMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Origin: http://example.com\r\n"
"Sec-WebSocket-Location: ws://example.com/demo\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(kHandshakeResponseExpectedMessage, response_handler.GetResponse());
}
TEST(WebSocketHandshakeHandlerTest, SpdyRequestResponse) {
WebSocketHandshakeRequestHandler request_handler;
static const char* kHandshakeRequestMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"X-bogus-header: X\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"X-bogus-header: Y\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_TRUE(request_handler.ParseRequest(kHandshakeRequestMessage,
strlen(kHandshakeRequestMessage)));
GURL url("ws://example.com/demo");
std::string challenge;
spdy::SpdyHeaderBlock headers;
ASSERT_TRUE(request_handler.GetRequestHeaderBlock(url, &headers, &challenge));
EXPECT_EQ(url.spec(), headers["url"]);
EXPECT_TRUE(headers.find("upgrade") == headers.end());
EXPECT_TRUE(headers.find("Upgrade") == headers.end());
EXPECT_TRUE(headers.find("connection") == headers.end());
EXPECT_TRUE(headers.find("Connection") == headers.end());
EXPECT_TRUE(headers.find("Sec-WebSocket-Key1") == headers.end());
EXPECT_TRUE(headers.find("sec-websocket-key1") == headers.end());
EXPECT_TRUE(headers.find("Sec-WebSocket-Key2") == headers.end());
EXPECT_TRUE(headers.find("sec-websocket-key2") == headers.end());
EXPECT_EQ("example.com", headers["host"]);
EXPECT_EQ("http://example.com", headers["origin"]);
EXPECT_EQ("sample", headers["sec-websocket-protocol"]);
const char bogus_header[] = "X\0Y";
std::string bogus_header_str(bogus_header, sizeof(bogus_header) - 1);
EXPECT_EQ(bogus_header_str, headers["x-bogus-header"]);
const char expected_challenge[] = "\x31\x6e\x41\x13\x0f\x7e\xd6\x3c^n:ds[4U";
EXPECT_EQ(expected_challenge, challenge);
headers.clear();
headers["sec-websocket-origin"] = "http://example.com";
headers["sec-websocket-location"] = "ws://example.com/demo";
headers["sec-websocket-protocol"] = "sample";
WebSocketHandshakeResponseHandler response_handler;
EXPECT_TRUE(response_handler.ParseResponseHeaderBlock(headers, challenge));
EXPECT_TRUE(response_handler.HasResponse());
// Note that order of sec-websocket-* is sensitive with hash_map order.
static const char* kHandshakeResponseExpectedMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"sec-websocket-location: ws://example.com/demo\r\n"
"sec-websocket-origin: http://example.com\r\n"
"sec-websocket-protocol: sample\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(kHandshakeResponseExpectedMessage, response_handler.GetResponse());
}
TEST(WebSocketHandshakeHandlerTest, SpdyRequestResponseWithCookies) {
WebSocketHandshakeRequestHandler request_handler;
// Note that websocket won't use multiple headers in request now.
static const char* kHandshakeRequestMessage =
"GET /demo HTTP/1.1\r\n"
"Host: example.com\r\n"
"Connection: Upgrade\r\n"
"Sec-WebSocket-Key2: 12998 5 Y3 1 .P00\r\n"
"Sec-WebSocket-Protocol: sample\r\n"
"Upgrade: WebSocket\r\n"
"Sec-WebSocket-Key1: 4 @1 46546xW%0l 1 5\r\n"
"Origin: http://example.com\r\n"
"Cookie: WK-websocket-test=1; WK-websocket-test-httponly=1\r\n"
"\r\n"
"^n:ds[4U";
EXPECT_TRUE(request_handler.ParseRequest(kHandshakeRequestMessage,
strlen(kHandshakeRequestMessage)));
GURL url("ws://example.com/demo");
std::string challenge;
spdy::SpdyHeaderBlock headers;
ASSERT_TRUE(request_handler.GetRequestHeaderBlock(url, &headers, &challenge));
EXPECT_EQ(url.spec(), headers["url"]);
EXPECT_TRUE(headers.find("upgrade") == headers.end());
EXPECT_TRUE(headers.find("Upgrade") == headers.end());
EXPECT_TRUE(headers.find("connection") == headers.end());
EXPECT_TRUE(headers.find("Connection") == headers.end());
EXPECT_TRUE(headers.find("Sec-WebSocket-Key1") == headers.end());
EXPECT_TRUE(headers.find("sec-websocket-key1") == headers.end());
EXPECT_TRUE(headers.find("Sec-WebSocket-Key2") == headers.end());
EXPECT_TRUE(headers.find("sec-websocket-key2") == headers.end());
EXPECT_EQ("example.com", headers["host"]);
EXPECT_EQ("http://example.com", headers["origin"]);
EXPECT_EQ("sample", headers["sec-websocket-protocol"]);
EXPECT_EQ("WK-websocket-test=1; WK-websocket-test-httponly=1",
headers["cookie"]);
const char expected_challenge[] = "\x31\x6e\x41\x13\x0f\x7e\xd6\x3c^n:ds[4U";
EXPECT_EQ(expected_challenge, challenge);
headers.clear();
headers["sec-websocket-origin"] = "http://example.com";
headers["sec-websocket-location"] = "ws://example.com/demo";
headers["sec-websocket-protocol"] = "sample";
std::string cookie = "WK-websocket-test=1";
cookie.append(1, '\0');
cookie += "WK-websocket-test-httponly=1; HttpOnly";
headers["set-cookie"] = cookie;
WebSocketHandshakeResponseHandler response_handler;
EXPECT_TRUE(response_handler.ParseResponseHeaderBlock(headers, challenge));
EXPECT_TRUE(response_handler.HasResponse());
// Note that order of sec-websocket-* is sensitive with hash_map order.
static const char* kHandshakeResponseExpectedMessage =
"HTTP/1.1 101 WebSocket Protocol Handshake\r\n"
"Upgrade: WebSocket\r\n"
"Connection: Upgrade\r\n"
"sec-websocket-location: ws://example.com/demo\r\n"
"sec-websocket-origin: http://example.com\r\n"
"sec-websocket-protocol: sample\r\n"
"set-cookie: WK-websocket-test=1\r\n"
"set-cookie: WK-websocket-test-httponly=1; HttpOnly\r\n"
"\r\n"
"8jKS'y:G*Co,Wxa-";
EXPECT_EQ(kHandshakeResponseExpectedMessage, response_handler.GetResponse());
}
} // namespace net