1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/test/embedded_test_server/http_connect_proxy_handler.h"
#include <stdint.h>
#include <memory>
#include <optional>
#include <set>
#include "base/check_op.h"
#include "base/containers/unique_ptr_adapters.h"
#include "base/functional/bind.h"
#include "base/location.h"
#include "base/memory/raw_ptr.h"
#include "base/strings/strcat.h"
#include "base/task/sequenced_task_runner.h"
#include "net/base/address_list.h"
#include "net/base/host_port_pair.h"
#include "net/base/io_buffer.h"
#include "net/base/ip_address.h"
#include "net/base/net_errors.h"
#include "net/http/http_status_code.h"
#include "net/log/net_log_source.h"
#include "net/socket/stream_socket.h"
#include "net/socket/tcp_client_socket.h"
#include "net/test/embedded_test_server/http_connection.h"
#include "net/test/embedded_test_server/http_request.h"
#include "net/test/embedded_test_server/http_response.h"
#include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "url/origin.h"
namespace net::test_server {
class HttpConnectProxyHandler::ConnectTunnel {
public:
static constexpr size_t kCapacity = 32 * 1024;
using DeleteCallback = base::OnceCallback<void(ConnectTunnel*)>;
ConnectTunnel(HttpConnectProxyHandler* http_proxy_handler,
std::unique_ptr<StreamSocket> socket)
: http_proxy_handler_(http_proxy_handler), socket_(std::move(socket)) {}
~ConnectTunnel() = default;
// Tries to establish a connection to localhost on `dest_port`, and on
// success, tells the client socket a tunnel was successfully established, and
// starts tunnelling data between the connections.
void Start(uint16_t dest_port) {
dest_socket_ = std::make_unique<TCPClientSocket>(
AddressList::CreateFromIPAddress(IPAddress::IPv4Localhost(), dest_port),
/*socket_performance_watcher=*/nullptr,
/*network_quality_estimator=*/nullptr, /*net_log=*/nullptr,
NetLogSource());
int result = dest_socket_->Connect(base::BindOnce(
&ConnectTunnel::OnConnectComplete, base::Unretained(this)));
if (result != ERR_IO_PENDING) {
OnConnectComplete(result);
}
}
private:
void OnConnectComplete(int result) {
// If unable to connect, write a bad gateway error to `socket_` before
// deleting `this`.
if (result != OK) {
DVLOG(1) << "Failed to establish tunnel connection.";
BasicHttpResponse response;
response.set_code(HttpStatusCode::HTTP_BAD_GATEWAY);
response.set_reason("Bad Gateway");
std::string response_string = response.ToResponseString();
scoped_refptr<GrowableIOBuffer> buffer =
base::MakeRefCounted<GrowableIOBuffer>();
buffer->SetCapacity(response_string.size());
buffer->span().copy_prefix_from(base::as_byte_span(response_string));
DoWrite(/*src=*/nullptr, /*dest=*/socket_.get(), std::move(buffer),
response_string.size());
return;
}
// Write HTTP headers to client socket to indicate the connect succeeded,
// and then start tunnelling.
BasicHttpResponse response;
response.set_reason("Connection established");
StartTunneling(/*src=*/dest_socket_.get(), /*dest=*/socket_.get(),
response.ToResponseString());
// Start tunneling from client socket to destination immediately, no need to
// write anything else.
StartTunneling(/*src=*/socket_.get(), /*dest=*/dest_socket_.get());
}
// Starts reading from `src` and writing that data to `dest`. If
// `initial_data` is provided, writes that `dest` before writing to `src`.
// Since a CONNECT proxy passes data in both directions, this needs to be
// called twice, flipping `src` and `dest` between calls, to fully set up the
// tunnelling.
void StartTunneling(StreamSocket* src,
StreamSocket* dest,
std::string initial_data = {}) {
scoped_refptr<GrowableIOBuffer> buffer =
base::MakeRefCounted<GrowableIOBuffer>();
buffer->SetCapacity(std::max(kCapacity, initial_data.size()));
if (!initial_data.empty()) {
// Start with a write, if `initial_data` is provided.
buffer->span().copy_prefix_from(base::as_byte_span(initial_data));
DoWrite(src, dest, std::move(buffer), initial_data.size());
return;
}
DoRead(src, dest, std::move(buffer));
}
// Try to read data from `src`. Once data is read, write it all to `dest`, and
// then repeat the process, until an error is encountered. Uses
// GrowableIOBuffer because it can track an offset that indicates how much
// data has been written. DrainableIOBuffer can do the same, but requires a
// nested IOBuffer, so is a little more complicated to us.
void DoRead(StreamSocket* src,
StreamSocket* dest,
scoped_refptr<GrowableIOBuffer> buffer) {
int result =
src->Read(buffer.get(), buffer->size(),
base::BindOnce(&ConnectTunnel::OnReadComplete,
base::Unretained(this), src, dest, buffer));
if (result == ERR_IO_PENDING) {
return;
}
OnReadComplete(src, dest, std::move(buffer), result);
}
// Called when a read from `src` completes. On error, tears down the socket.
// Otherwise, starts writing the data to `dest`, and will start reading from
// `src` again, once all data is written.
void OnReadComplete(StreamSocket* src,
StreamSocket* dest,
scoped_refptr<GrowableIOBuffer> buffer,
int result) {
CHECK_NE(result, ERR_IO_PENDING);
if (result <= 0) {
// On error / close, close both sockets - this behavior is good enough,
// since the client side (Chrome's network stack) only closes the write
// pipe when it's done reading, and since this code doesn't read from the
// destination pipe (likely to another EmbeddedTestServer) while there's
// data in the buffer to write to the client pipe, all data will be
// written before the EmbeddedTestServer closing the pipe will be
// observed.
http_proxy_handler_->DeleteTunnel(this);
return;
}
DoWrite(src, dest, std::move(buffer), result);
}
// Writes `remaining_bytes` from `buffer` to `dest`. Once all data has been
// written, will start reading from `src` again. If `src` is nullptr, writes
// data to `dest`, and destroys the `ConnectTunnel` once everything has been
// written.
void DoWrite(StreamSocket* src,
StreamSocket* dest,
scoped_refptr<GrowableIOBuffer> buffer,
int remaining_bytes) {
CHECK_GE(remaining_bytes, 0);
int result = dest->Write(
buffer.get(), remaining_bytes,
base::BindOnce(&ConnectTunnel::OnWriteComplete, base::Unretained(this),
src, dest, buffer, remaining_bytes),
TRAFFIC_ANNOTATION_FOR_TESTS);
if (result == ERR_IO_PENDING) {
return;
}
OnWriteComplete(src, dest, std::move(buffer), remaining_bytes, result);
}
// Called once data has been written to `dest` or there was a write error. On
// error, tears down `this`. Otherwise, keeps writing until all data has been
// written, and then starts reading from `src` again.
void OnWriteComplete(StreamSocket* src,
StreamSocket* dest,
scoped_refptr<GrowableIOBuffer> buffer,
int remaining_bytes,
int result) {
CHECK_NE(result, ERR_IO_PENDING);
if (result < 0) {
// See OnReadComplete() for explanation on why this is ok to do.
http_proxy_handler_->DeleteTunnel(this);
return;
}
CHECK_LE(result, remaining_bytes);
buffer->DidConsume(result);
remaining_bytes -= result;
if (remaining_bytes > 0) {
DoWrite(src, dest, std::move(buffer), remaining_bytes);
return;
}
// `src` will be nullptr when writing a connect error. In that case, once
// everything has been written, delete `this` to close `socket_`.
if (!src) {
http_proxy_handler_->DeleteTunnel(this);
return;
}
buffer->set_offset(0);
DoRead(src, dest, std::move(buffer));
}
raw_ptr<HttpConnectProxyHandler> http_proxy_handler_;
// The socket to the client (Chrome's network stack).
std::unique_ptr<StreamSocket> socket_;
// The socket to the server (typically another EmbeddedTestServer instance).
std::unique_ptr<TCPClientSocket> dest_socket_;
};
HttpConnectProxyHandler::HttpConnectProxyHandler(
const uint16_t dest_port,
std::optional<HostPortPair> expected_dest)
: dest_port_(dest_port), expected_dest_(expected_dest) {}
HttpConnectProxyHandler::~HttpConnectProxyHandler() = default;
bool HttpConnectProxyHandler::HandleProxyRequest(HttpConnection& connection,
const HttpRequest& request) {
// This class only support HTTP/1.x.
CHECK_EQ(connection.protocol(), HttpConnection::Protocol::kHttp1);
if (request.method != METHOD_CONNECT) {
return false;
}
// For CONNECT requests, `relative_url` is actually a host and port.
HostPortPair dest = HostPortPair::FromString(request.relative_url);
std::unique_ptr<BasicHttpResponse> error_response;
if (dest.IsEmpty()) {
ADD_FAILURE() << "Invalid CONNECT destination: " << request.relative_url;
// Returning true on error will result in the socket being closed.
return true;
}
if (expected_dest_ && *expected_dest_ != dest) {
ADD_FAILURE() << "Unexpected CONNECT destination: " << dest.ToString();
// Returning true on error will result in the socket being closed.
return true;
}
auto tunnel = std::make_unique<ConnectTunnel>(this, connection.TakeSocket());
auto tunnel_it = connect_tunnels_.insert(std::move(tunnel)).first;
(*tunnel_it)->Start(dest_port_);
return true;
}
void HttpConnectProxyHandler::DeleteTunnel(ConnectTunnel* tunnel) {
auto tunnel_it = connect_tunnels_.find(tunnel);
CHECK(tunnel_it != connect_tunnels_.end());
connect_tunnels_.erase(tunnel_it);
}
} // namespace net::test_server
|