1 // Copyright 2012 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "net/socket/socks_client_socket.h"
6
7 #include <memory>
8 #include <utility>
9
10 #include "base/containers/span.h"
11 #include "base/memory/raw_ptr.h"
12 #include "build/build_config.h"
13 #include "net/base/address_list.h"
14 #include "net/base/test_completion_callback.h"
15 #include "net/base/winsock_init.h"
16 #include "net/dns/host_resolver.h"
17 #include "net/dns/mock_host_resolver.h"
18 #include "net/dns/public/secure_dns_policy.h"
19 #include "net/log/net_log_event_type.h"
20 #include "net/log/test_net_log.h"
21 #include "net/log/test_net_log_util.h"
22 #include "net/socket/client_socket_factory.h"
23 #include "net/socket/socket_test_util.h"
24 #include "net/socket/tcp_client_socket.h"
25 #include "net/test/gtest_util.h"
26 #include "net/test/test_with_task_environment.h"
27 #include "net/traffic_annotation/network_traffic_annotation_test_helper.h"
28 #include "testing/gmock/include/gmock/gmock.h"
29 #include "testing/gtest/include/gtest/gtest.h"
30 #include "testing/platform_test.h"
31
32 using net::test::IsError;
33 using net::test::IsOk;
34
35 //-----------------------------------------------------------------------------
36
37 namespace net {
38
39 class NetLog;
40
41 class SOCKSClientSocketTest : public PlatformTest, public WithTaskEnvironment {
42 public:
43 SOCKSClientSocketTest();
44 // Create a SOCKSClientSocket on top of a MockSocket.
45 std::unique_ptr<SOCKSClientSocket> BuildMockSocket(
46 base::span<const MockRead> reads,
47 base::span<const MockWrite> writes,
48 HostResolver* host_resolver,
49 const std::string& hostname,
50 int port,
51 NetLog* net_log);
52 void SetUp() override;
53
54 protected:
55 std::unique_ptr<MockHostResolver> host_resolver_;
56 std::unique_ptr<SocketDataProvider> data_;
57 std::unique_ptr<SOCKSClientSocket> user_sock_;
58 AddressList address_list_;
59 // Filled in by BuildMockSocket() and owned by its return value
60 // (which |user_sock| is set to).
61 raw_ptr<StreamSocket> tcp_sock_;
62 TestCompletionCallback callback_;
63 };
64
SOCKSClientSocketTest()65 SOCKSClientSocketTest::SOCKSClientSocketTest()
66 : host_resolver_(std::make_unique<MockHostResolver>()) {}
67
68 // Set up platform before every test case
SetUp()69 void SOCKSClientSocketTest::SetUp() {
70 PlatformTest::SetUp();
71 }
72
BuildMockSocket(base::span<const MockRead> reads,base::span<const MockWrite> writes,HostResolver * host_resolver,const std::string & hostname,int port,NetLog * net_log)73 std::unique_ptr<SOCKSClientSocket> SOCKSClientSocketTest::BuildMockSocket(
74 base::span<const MockRead> reads,
75 base::span<const MockWrite> writes,
76 HostResolver* host_resolver,
77 const std::string& hostname,
78 int port,
79 NetLog* net_log) {
80 TestCompletionCallback callback;
81 data_ = std::make_unique<StaticSocketDataProvider>(reads, writes);
82 auto socket = std::make_unique<MockTCPClientSocket>(address_list_, net_log,
83 data_.get());
84 socket->set_enable_read_if_ready(true);
85
86 int rv = socket->Connect(callback.callback());
87 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
88 rv = callback.WaitForResult();
89 EXPECT_THAT(rv, IsOk());
90 EXPECT_TRUE(socket->IsConnected());
91
92 // The SOCKSClientSocket takes ownership of |socket|, but |tcp_sock_| keeps a
93 // non-owning pointer to it.
94 tcp_sock_ = socket.get();
95 return std::make_unique<SOCKSClientSocket>(
96 std::move(socket), HostPortPair(hostname, port),
97 NetworkAnonymizationKey(), DEFAULT_PRIORITY, host_resolver,
98 SecureDnsPolicy::kAllow, TRAFFIC_ANNOTATION_FOR_TESTS);
99 }
100
101 // Tests a complete handshake and the disconnection.
TEST_F(SOCKSClientSocketTest,CompleteHandshake)102 TEST_F(SOCKSClientSocketTest, CompleteHandshake) {
103 // Run the test twice. Once with ReadIfReady() and once with Read().
104 for (bool use_read_if_ready : {true, false}) {
105 const std::string payload_write = "random data";
106 const std::string payload_read = "moar random data";
107
108 MockWrite data_writes[] = {
109 MockWrite(ASYNC, kSOCKS4OkRequestLocalHostPort80,
110 kSOCKS4OkRequestLocalHostPort80Length),
111 MockWrite(ASYNC, payload_write.data(), payload_write.size())};
112 MockRead data_reads[] = {
113 MockRead(ASYNC, kSOCKS4OkReply, kSOCKS4OkReplyLength),
114 MockRead(ASYNC, payload_read.data(), payload_read.size())};
115 RecordingNetLogObserver log_observer;
116
117 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
118 "localhost", 80, NetLog::Get());
119
120 // At this state the TCP connection is completed but not the SOCKS
121 // handshake.
122 EXPECT_TRUE(tcp_sock_->IsConnected());
123 EXPECT_FALSE(user_sock_->IsConnected());
124
125 int rv = user_sock_->Connect(callback_.callback());
126 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
127
128 auto entries = log_observer.GetEntries();
129 EXPECT_TRUE(
130 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
131 EXPECT_FALSE(user_sock_->IsConnected());
132
133 rv = callback_.WaitForResult();
134 EXPECT_THAT(rv, IsOk());
135 EXPECT_TRUE(user_sock_->IsConnected());
136 entries = log_observer.GetEntries();
137 EXPECT_TRUE(
138 LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
139
140 auto buffer = base::MakeRefCounted<IOBufferWithSize>(payload_write.size());
141 memcpy(buffer->data(), payload_write.data(), payload_write.size());
142 rv = user_sock_->Write(buffer.get(), payload_write.size(),
143 callback_.callback(), TRAFFIC_ANNOTATION_FOR_TESTS);
144 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
145 rv = callback_.WaitForResult();
146 EXPECT_EQ(static_cast<int>(payload_write.size()), rv);
147
148 buffer = base::MakeRefCounted<IOBufferWithSize>(payload_read.size());
149 if (use_read_if_ready) {
150 rv = user_sock_->ReadIfReady(buffer.get(), payload_read.size(),
151 callback_.callback());
152 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
153 rv = callback_.WaitForResult();
154 EXPECT_EQ(net::OK, rv);
155 rv = user_sock_->ReadIfReady(buffer.get(), payload_read.size(),
156 callback_.callback());
157 } else {
158 rv = user_sock_->Read(buffer.get(), payload_read.size(),
159 callback_.callback());
160 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
161 rv = callback_.WaitForResult();
162 }
163 EXPECT_EQ(static_cast<int>(payload_read.size()), rv);
164 EXPECT_EQ(payload_read, std::string(buffer->data(), payload_read.size()));
165
166 user_sock_->Disconnect();
167 EXPECT_FALSE(tcp_sock_->IsConnected());
168 EXPECT_FALSE(user_sock_->IsConnected());
169 }
170 }
171
TEST_F(SOCKSClientSocketTest,CancelPendingReadIfReady)172 TEST_F(SOCKSClientSocketTest, CancelPendingReadIfReady) {
173 const std::string payload_read = "random data";
174
175 MockWrite data_writes[] = {MockWrite(ASYNC, kSOCKS4OkRequestLocalHostPort80,
176 kSOCKS4OkRequestLocalHostPort80Length)};
177 MockRead data_reads[] = {
178 MockRead(ASYNC, kSOCKS4OkReply, kSOCKS4OkReplyLength),
179 MockRead(ASYNC, payload_read.data(), payload_read.size())};
180 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
181 "localhost", 80, nullptr);
182
183 // At this state the TCP connection is completed but not the SOCKS
184 // handshake.
185 EXPECT_TRUE(tcp_sock_->IsConnected());
186 EXPECT_FALSE(user_sock_->IsConnected());
187
188 int rv = user_sock_->Connect(callback_.callback());
189 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
190 rv = callback_.WaitForResult();
191 EXPECT_THAT(rv, IsOk());
192 EXPECT_TRUE(user_sock_->IsConnected());
193
194 auto buffer = base::MakeRefCounted<IOBufferWithSize>(payload_read.size());
195 rv = user_sock_->ReadIfReady(buffer.get(), payload_read.size(),
196 callback_.callback());
197 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
198 rv = user_sock_->CancelReadIfReady();
199 EXPECT_EQ(net::OK, rv);
200
201 user_sock_->Disconnect();
202 EXPECT_FALSE(tcp_sock_->IsConnected());
203 EXPECT_FALSE(user_sock_->IsConnected());
204 }
205
206 // List of responses from the socks server and the errors they should
207 // throw up are tested here.
TEST_F(SOCKSClientSocketTest,HandshakeFailures)208 TEST_F(SOCKSClientSocketTest, HandshakeFailures) {
209 const struct {
210 const char fail_reply[8];
211 Error fail_code;
212 } tests[] = {
213 // Failure of the server response code
214 {
215 { 0x01, 0x5A, 0x00, 0x00, 0, 0, 0, 0 },
216 ERR_SOCKS_CONNECTION_FAILED,
217 },
218 // Failure of the null byte
219 {
220 { 0x00, 0x5B, 0x00, 0x00, 0, 0, 0, 0 },
221 ERR_SOCKS_CONNECTION_FAILED,
222 },
223 };
224
225 //---------------------------------------
226 host_resolver_->rules()->AddRule("socks.test", "127.0.0.1");
227 for (const auto& test : tests) {
228 MockWrite data_writes[] = {
229 MockWrite(SYNCHRONOUS, kSOCKS4OkRequestLocalHostPort80,
230 kSOCKS4OkRequestLocalHostPort80Length)};
231 MockRead data_reads[] = {
232 MockRead(SYNCHRONOUS, test.fail_reply, std::size(test.fail_reply))};
233 RecordingNetLogObserver log_observer;
234
235 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
236 "socks.test", 80, NetLog::Get());
237
238 int rv = user_sock_->Connect(callback_.callback());
239 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
240
241 auto entries = log_observer.GetEntries();
242 EXPECT_TRUE(
243 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
244
245 rv = callback_.WaitForResult();
246 EXPECT_EQ(test.fail_code, rv);
247 EXPECT_FALSE(user_sock_->IsConnected());
248 EXPECT_TRUE(tcp_sock_->IsConnected());
249 entries = log_observer.GetEntries();
250 EXPECT_TRUE(
251 LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
252 }
253 }
254
255 // Tests scenario when the server sends the handshake response in
256 // more than one packet.
TEST_F(SOCKSClientSocketTest,PartialServerReads)257 TEST_F(SOCKSClientSocketTest, PartialServerReads) {
258 const char kSOCKSPartialReply1[] = { 0x00 };
259 const char kSOCKSPartialReply2[] = { 0x5A, 0x00, 0x00, 0, 0, 0, 0 };
260
261 MockWrite data_writes[] = {MockWrite(ASYNC, kSOCKS4OkRequestLocalHostPort80,
262 kSOCKS4OkRequestLocalHostPort80Length)};
263 MockRead data_reads[] = {
264 MockRead(ASYNC, kSOCKSPartialReply1, std::size(kSOCKSPartialReply1)),
265 MockRead(ASYNC, kSOCKSPartialReply2, std::size(kSOCKSPartialReply2))};
266 RecordingNetLogObserver log_observer;
267
268 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
269 "localhost", 80, NetLog::Get());
270
271 int rv = user_sock_->Connect(callback_.callback());
272 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
273 auto entries = log_observer.GetEntries();
274 EXPECT_TRUE(
275 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
276
277 rv = callback_.WaitForResult();
278 EXPECT_THAT(rv, IsOk());
279 EXPECT_TRUE(user_sock_->IsConnected());
280 entries = log_observer.GetEntries();
281 EXPECT_TRUE(LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
282 }
283
284 // Tests scenario when the client sends the handshake request in
285 // more than one packet.
TEST_F(SOCKSClientSocketTest,PartialClientWrites)286 TEST_F(SOCKSClientSocketTest, PartialClientWrites) {
287 const char kSOCKSPartialRequest1[] = { 0x04, 0x01 };
288 const char kSOCKSPartialRequest2[] = { 0x00, 0x50, 127, 0, 0, 1, 0 };
289
290 MockWrite data_writes[] = {
291 MockWrite(ASYNC, kSOCKSPartialRequest1, std::size(kSOCKSPartialRequest1)),
292 // simulate some empty writes
293 MockWrite(ASYNC, 0),
294 MockWrite(ASYNC, 0),
295 MockWrite(ASYNC, kSOCKSPartialRequest2, std::size(kSOCKSPartialRequest2)),
296 };
297 MockRead data_reads[] = {
298 MockRead(ASYNC, kSOCKS4OkReply, kSOCKS4OkReplyLength)};
299 RecordingNetLogObserver log_observer;
300
301 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
302 "localhost", 80, NetLog::Get());
303
304 int rv = user_sock_->Connect(callback_.callback());
305 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
306 auto entries = log_observer.GetEntries();
307 EXPECT_TRUE(
308 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
309
310 rv = callback_.WaitForResult();
311 EXPECT_THAT(rv, IsOk());
312 EXPECT_TRUE(user_sock_->IsConnected());
313 entries = log_observer.GetEntries();
314 EXPECT_TRUE(LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
315 }
316
317 // Tests the case when the server sends a smaller sized handshake data
318 // and closes the connection.
TEST_F(SOCKSClientSocketTest,FailedSocketRead)319 TEST_F(SOCKSClientSocketTest, FailedSocketRead) {
320 MockWrite data_writes[] = {MockWrite(ASYNC, kSOCKS4OkRequestLocalHostPort80,
321 kSOCKS4OkRequestLocalHostPort80Length)};
322 MockRead data_reads[] = {
323 MockRead(ASYNC, kSOCKS4OkReply, kSOCKS4OkReplyLength - 2),
324 // close connection unexpectedly
325 MockRead(SYNCHRONOUS, 0)};
326 RecordingNetLogObserver log_observer;
327
328 user_sock_ = BuildMockSocket(data_reads, data_writes, host_resolver_.get(),
329 "localhost", 80, NetLog::Get());
330
331 int rv = user_sock_->Connect(callback_.callback());
332 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
333 auto entries = log_observer.GetEntries();
334 EXPECT_TRUE(
335 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
336
337 rv = callback_.WaitForResult();
338 EXPECT_THAT(rv, IsError(ERR_CONNECTION_CLOSED));
339 EXPECT_FALSE(user_sock_->IsConnected());
340 entries = log_observer.GetEntries();
341 EXPECT_TRUE(LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
342 }
343
344 // Tries to connect to an unknown hostname. Should fail rather than
345 // falling back to SOCKS4a.
TEST_F(SOCKSClientSocketTest,FailedDNS)346 TEST_F(SOCKSClientSocketTest, FailedDNS) {
347 const char hostname[] = "unresolved.ipv4.address";
348
349 host_resolver_->rules()->AddSimulatedTimeoutFailure(hostname);
350
351 RecordingNetLogObserver log_observer;
352
353 user_sock_ =
354 BuildMockSocket(base::span<MockRead>(), base::span<MockWrite>(),
355 host_resolver_.get(), hostname, 80, NetLog::Get());
356
357 int rv = user_sock_->Connect(callback_.callback());
358 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
359 auto entries = log_observer.GetEntries();
360 EXPECT_TRUE(
361 LogContainsBeginEvent(entries, 0, NetLogEventType::SOCKS_CONNECT));
362
363 rv = callback_.WaitForResult();
364 EXPECT_THAT(rv, IsError(ERR_NAME_NOT_RESOLVED));
365 EXPECT_THAT(user_sock_->GetResolveErrorInfo().error,
366 IsError(ERR_DNS_TIMED_OUT));
367 EXPECT_FALSE(user_sock_->IsConnected());
368 entries = log_observer.GetEntries();
369 EXPECT_TRUE(LogContainsEndEvent(entries, -1, NetLogEventType::SOCKS_CONNECT));
370 }
371
372 // Calls Disconnect() while a host resolve is in progress. The outstanding host
373 // resolve should be cancelled.
TEST_F(SOCKSClientSocketTest,DisconnectWhileHostResolveInProgress)374 TEST_F(SOCKSClientSocketTest, DisconnectWhileHostResolveInProgress) {
375 auto hanging_resolver = std::make_unique<HangingHostResolver>();
376
377 // Doesn't matter what the socket data is, we will never use it -- garbage.
378 MockWrite data_writes[] = { MockWrite(SYNCHRONOUS, "", 0) };
379 MockRead data_reads[] = { MockRead(SYNCHRONOUS, "", 0) };
380
381 user_sock_ = BuildMockSocket(data_reads, data_writes, hanging_resolver.get(),
382 "foo", 80, nullptr);
383
384 // Start connecting (will get stuck waiting for the host to resolve).
385 int rv = user_sock_->Connect(callback_.callback());
386 EXPECT_THAT(rv, IsError(ERR_IO_PENDING));
387
388 EXPECT_FALSE(user_sock_->IsConnected());
389 EXPECT_FALSE(user_sock_->IsConnectedAndIdle());
390
391 // Disconnect the SOCKS socket -- this should cancel the outstanding resolve.
392 ASSERT_EQ(0, hanging_resolver->num_cancellations());
393 user_sock_->Disconnect();
394 EXPECT_EQ(1, hanging_resolver->num_cancellations());
395
396 EXPECT_FALSE(user_sock_->IsConnected());
397 EXPECT_FALSE(user_sock_->IsConnectedAndIdle());
398
399 // Need to delete `user_sock_` before the HostResolver it references.
400 tcp_sock_ = nullptr;
401 user_sock_.reset();
402 }
403
404 // Tries to connect to an IPv6 IP. Should fail, as SOCKS4 does not support
405 // IPv6.
TEST_F(SOCKSClientSocketTest,NoIPv6)406 TEST_F(SOCKSClientSocketTest, NoIPv6) {
407 const char kHostName[] = "::1";
408
409 user_sock_ = BuildMockSocket(base::span<MockRead>(), base::span<MockWrite>(),
410 host_resolver_.get(), kHostName, 80, nullptr);
411
412 EXPECT_EQ(ERR_NAME_NOT_RESOLVED,
413 callback_.GetResult(user_sock_->Connect(callback_.callback())));
414 }
415
416 // Same as above, but with a real resolver, to protect against regressions.
TEST_F(SOCKSClientSocketTest,NoIPv6RealResolver)417 TEST_F(SOCKSClientSocketTest, NoIPv6RealResolver) {
418 const char kHostName[] = "::1";
419
420 std::unique_ptr<HostResolver> host_resolver(
421 HostResolver::CreateStandaloneResolver(nullptr));
422
423 user_sock_ = BuildMockSocket(base::span<MockRead>(), base::span<MockWrite>(),
424 host_resolver.get(), kHostName, 80, nullptr);
425
426 EXPECT_EQ(ERR_NAME_NOT_RESOLVED,
427 callback_.GetResult(user_sock_->Connect(callback_.callback())));
428
429 // Need to delete `user_sock_` before the HostResolver it references.
430 tcp_sock_ = nullptr;
431 user_sock_.reset();
432 }
433
TEST_F(SOCKSClientSocketTest,Tag)434 TEST_F(SOCKSClientSocketTest, Tag) {
435 StaticSocketDataProvider data;
436 auto tagging_sock = std::make_unique<MockTaggingStreamSocket>(
437 std::make_unique<MockTCPClientSocket>(address_list_, NetLog::Get(),
438 &data));
439 auto* tagging_sock_ptr = tagging_sock.get();
440
441 auto connection = std::make_unique<ClientSocketHandle>();
442 // |connection| takes ownership of |tagging_sock|, but keep a
443 // non-owning pointer to it.
444 MockHostResolver host_resolver;
445 SOCKSClientSocket socket(
446 std::move(tagging_sock), HostPortPair("localhost", 80),
447 NetworkAnonymizationKey(), DEFAULT_PRIORITY, &host_resolver,
448 SecureDnsPolicy::kAllow, TRAFFIC_ANNOTATION_FOR_TESTS);
449
450 EXPECT_EQ(tagging_sock_ptr->tag(), SocketTag());
451 #if BUILDFLAG(IS_ANDROID)
452 SocketTag tag(0x12345678, 0x87654321);
453 socket.ApplySocketTag(tag);
454 EXPECT_EQ(tagging_sock_ptr->tag(), tag);
455 #endif // BUILDFLAG(IS_ANDROID)
456 }
457
TEST_F(SOCKSClientSocketTest,SetSecureDnsPolicy)458 TEST_F(SOCKSClientSocketTest, SetSecureDnsPolicy) {
459 for (auto secure_dns_policy :
460 {SecureDnsPolicy::kAllow, SecureDnsPolicy::kDisable}) {
461 StaticSocketDataProvider data;
462 MockHostResolver host_resolver;
463 host_resolver.rules()->AddRule("doh.test", "127.0.0.1");
464 SOCKSClientSocket socket(std::make_unique<MockTCPClientSocket>(
465 address_list_, NetLog::Get(), &data),
466 HostPortPair("doh.test", 80),
467 NetworkAnonymizationKey(), DEFAULT_PRIORITY,
468 &host_resolver, secure_dns_policy,
469 TRAFFIC_ANNOTATION_FOR_TESTS);
470
471 EXPECT_EQ(ERR_IO_PENDING, socket.Connect(callback_.callback()));
472 EXPECT_EQ(secure_dns_policy, host_resolver.last_secure_dns_policy());
473 }
474 }
475
476 } // namespace net
477