// Copyright 2013 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 "net/websockets/websocket_test_util.h" #include #include #include #include "base/strings/strcat.h" #include "base/strings/string_util.h" #include "base/strings/stringprintf.h" #include "net/base/ip_endpoint.h" #include "net/http/http_network_session.h" #include "net/proxy_resolution/configured_proxy_resolution_service.h" #include "net/socket/socket_test_util.h" #include "net/third_party/quiche/src/spdy/core/spdy_protocol.h" #include "net/traffic_annotation/network_traffic_annotation_test_helper.h" #include "net/websockets/websocket_basic_handshake_stream.h" #include "url/origin.h" namespace net { namespace { const uint64_t kA = (static_cast(0x5851f42d) << 32) + static_cast(0x4c957f2d); const uint64_t kC = 12345; const uint64_t kM = static_cast(1) << 48; } // namespace LinearCongruentialGenerator::LinearCongruentialGenerator(uint32_t seed) : current_(seed) {} uint32_t LinearCongruentialGenerator::Generate() { uint64_t result = current_; current_ = (current_ * kA + kC) % kM; return static_cast(result >> 16); } std::string WebSocketExtraHeadersToString( const WebSocketExtraHeaders& headers) { std::string answer; for (const auto& header : headers) { base::StrAppend(&answer, {header.first, ": ", header.second, "\r\n"}); } return answer; } HttpRequestHeaders WebSocketExtraHeadersToHttpRequestHeaders( const WebSocketExtraHeaders& headers) { HttpRequestHeaders headers_to_return; for (const auto& header : headers) headers_to_return.SetHeader(header.first, header.second); return headers_to_return; } std::string WebSocketStandardRequest( const std::string& path, const std::string& host, const url::Origin& origin, const std::string& send_additional_request_headers, const std::string& extra_headers) { return WebSocketStandardRequestWithCookies(path, host, origin, std::string(), send_additional_request_headers, extra_headers); } std::string WebSocketStandardRequestWithCookies( const std::string& path, const std::string& host, const url::Origin& origin, const std::string& cookies, const std::string& send_additional_request_headers, const std::string& extra_headers) { // Unrelated changes in net/http may change the order and default-values of // HTTP headers, causing WebSocket tests to fail. It is safe to update this // in that case. HttpRequestHeaders headers; std::stringstream request_headers; request_headers << base::StringPrintf("GET %s HTTP/1.1\r\n", path.c_str()); headers.SetHeader("Host", host); headers.SetHeader("Connection", "Upgrade"); headers.SetHeader("Pragma", "no-cache"); headers.SetHeader("Cache-Control", "no-cache"); headers.AddHeadersFromString(send_additional_request_headers); headers.SetHeader("Upgrade", "websocket"); headers.SetHeader("Origin", origin.Serialize()); headers.SetHeader("Sec-WebSocket-Version", "13"); if (!headers.HasHeader("User-Agent")) headers.SetHeader("User-Agent", ""); headers.SetHeader("Accept-Encoding", "gzip, deflate"); headers.SetHeader("Accept-Language", "en-us,fr"); headers.AddHeadersFromString(cookies); headers.SetHeader("Sec-WebSocket-Key", "dGhlIHNhbXBsZSBub25jZQ=="); headers.SetHeader("Sec-WebSocket-Extensions", "permessage-deflate; client_max_window_bits"); headers.AddHeadersFromString(extra_headers); request_headers << headers.ToString(); return request_headers.str(); } std::string WebSocketStandardResponse(const std::string& extra_headers) { return base::StringPrintf( "HTTP/1.1 101 Switching Protocols\r\n" "Upgrade: websocket\r\n" "Connection: Upgrade\r\n" "Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=\r\n" "%s\r\n", extra_headers.c_str()); } HttpRequestHeaders WebSocketCommonTestHeaders() { HttpRequestHeaders request_headers; request_headers.SetHeader("Host", "www.example.org"); request_headers.SetHeader("Connection", "Upgrade"); request_headers.SetHeader("Pragma", "no-cache"); request_headers.SetHeader("Cache-Control", "no-cache"); request_headers.SetHeader("Upgrade", "websocket"); request_headers.SetHeader("Origin", "http://origin.example.org"); request_headers.SetHeader("Sec-WebSocket-Version", "13"); request_headers.SetHeader("User-Agent", ""); request_headers.SetHeader("Accept-Encoding", "gzip, deflate"); request_headers.SetHeader("Accept-Language", "en-us,fr"); return request_headers; } spdy::SpdyHeaderBlock WebSocketHttp2Request( const std::string& path, const std::string& authority, const std::string& origin, const WebSocketExtraHeaders& extra_headers) { spdy::SpdyHeaderBlock request_headers; request_headers[spdy::kHttp2MethodHeader] = "CONNECT"; request_headers[spdy::kHttp2AuthorityHeader] = authority; request_headers[spdy::kHttp2SchemeHeader] = "https"; request_headers[spdy::kHttp2PathHeader] = path; request_headers[spdy::kHttp2ProtocolHeader] = "websocket"; request_headers["pragma"] = "no-cache"; request_headers["cache-control"] = "no-cache"; request_headers["origin"] = origin; request_headers["sec-websocket-version"] = "13"; request_headers["user-agent"] = ""; request_headers["accept-encoding"] = "gzip, deflate"; request_headers["accept-language"] = "en-us,fr"; request_headers["sec-websocket-extensions"] = "permessage-deflate; client_max_window_bits"; for (const auto& header : extra_headers) { request_headers[base::ToLowerASCII(header.first)] = header.second; } return request_headers; } spdy::SpdyHeaderBlock WebSocketHttp2Response( const WebSocketExtraHeaders& extra_headers) { spdy::SpdyHeaderBlock response_headers; response_headers[spdy::kHttp2StatusHeader] = "200"; for (const auto& header : extra_headers) { response_headers[base::ToLowerASCII(header.first)] = header.second; } return response_headers; } struct WebSocketMockClientSocketFactoryMaker::Detail { std::string expect_written; std::string return_to_read; std::vector reads; MockWrite write; std::vector> socket_data_vector; std::vector> ssl_socket_data_vector; MockClientSocketFactory factory; }; WebSocketMockClientSocketFactoryMaker::WebSocketMockClientSocketFactoryMaker() : detail_(std::make_unique()) {} WebSocketMockClientSocketFactoryMaker:: ~WebSocketMockClientSocketFactoryMaker() = default; MockClientSocketFactory* WebSocketMockClientSocketFactoryMaker::factory() { return &detail_->factory; } void WebSocketMockClientSocketFactoryMaker::SetExpectations( const std::string& expect_written, const std::string& return_to_read) { const size_t kHttpStreamParserBufferSize = 4096; // We need to extend the lifetime of these strings. detail_->expect_written = expect_written; detail_->return_to_read = return_to_read; int sequence = 0; detail_->write = MockWrite(SYNCHRONOUS, detail_->expect_written.data(), detail_->expect_written.size(), sequence++); // HttpStreamParser reads 4KB at a time. We need to take this implementation // detail into account if |return_to_read| is big enough. for (size_t place = 0; place < detail_->return_to_read.size(); place += kHttpStreamParserBufferSize) { detail_->reads.push_back( MockRead(SYNCHRONOUS, detail_->return_to_read.data() + place, std::min(detail_->return_to_read.size() - place, kHttpStreamParserBufferSize), sequence++)); } auto socket_data = std::make_unique( detail_->reads, base::make_span(&detail_->write, 1)); socket_data->set_connect_data(MockConnect(SYNCHRONOUS, OK)); AddRawExpectations(std::move(socket_data)); } void WebSocketMockClientSocketFactoryMaker::AddRawExpectations( std::unique_ptr socket_data) { detail_->factory.AddSocketDataProvider(socket_data.get()); detail_->socket_data_vector.push_back(std::move(socket_data)); } void WebSocketMockClientSocketFactoryMaker::AddSSLSocketDataProvider( std::unique_ptr ssl_socket_data) { detail_->factory.AddSSLSocketDataProvider(ssl_socket_data.get()); detail_->ssl_socket_data_vector.push_back(std::move(ssl_socket_data)); } WebSocketTestURLRequestContextHost::WebSocketTestURLRequestContextHost() : url_request_context_(true), url_request_context_initialized_(false) { url_request_context_.set_client_socket_factory(maker_.factory()); auto params = std::make_unique(); params->enable_spdy_ping_based_connection_checking = false; params->enable_quic = false; params->enable_websocket_over_http2 = true; params->disable_idle_sockets_close_on_memory_pressure = false; url_request_context_.set_http_network_session_params(std::move(params)); } WebSocketTestURLRequestContextHost::~WebSocketTestURLRequestContextHost() = default; void WebSocketTestURLRequestContextHost::AddRawExpectations( std::unique_ptr socket_data) { maker_.AddRawExpectations(std::move(socket_data)); } void WebSocketTestURLRequestContextHost::AddSSLSocketDataProvider( std::unique_ptr ssl_socket_data) { maker_.AddSSLSocketDataProvider(std::move(ssl_socket_data)); } void WebSocketTestURLRequestContextHost::SetProxyConfig( const std::string& proxy_rules) { DCHECK(!url_request_context_initialized_); proxy_resolution_service_ = ConfiguredProxyResolutionService::CreateFixed( proxy_rules, TRAFFIC_ANNOTATION_FOR_TESTS); url_request_context_.set_proxy_resolution_service( proxy_resolution_service_.get()); } int DummyConnectDelegate::OnAuthRequired( const AuthChallengeInfo& auth_info, scoped_refptr response_headers, const IPEndPoint& host_port_pair, base::OnceCallback callback, base::Optional* credentials) { return OK; } TestURLRequestContext* WebSocketTestURLRequestContextHost::GetURLRequestContext() { if (!url_request_context_initialized_) { url_request_context_.Init(); // A Network Delegate is required to make the URLRequest::Delegate work. url_request_context_.set_network_delegate(&network_delegate_); url_request_context_initialized_ = true; } return &url_request_context_; } void TestWebSocketStreamRequestAPI::OnBasicHandshakeStreamCreated( WebSocketBasicHandshakeStream* handshake_stream) { handshake_stream->SetWebSocketKeyForTesting("dGhlIHNhbXBsZSBub25jZQ=="); } void TestWebSocketStreamRequestAPI::OnHttp2HandshakeStreamCreated( WebSocketHttp2HandshakeStream* handshake_stream) {} } // namespace net