1ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#ifndef NET_SOCKET_SOCKS_CLIENT_SOCKET_H_ 6c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#define NET_SOCKET_SOCKS_CLIENT_SOCKET_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <string> 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 113345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "base/basictypes.h" 123345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#include "base/gtest_prod_util.h" 13ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/memory/ref_counted.h" 14ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen#include "base/memory/scoped_ptr.h" 15c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "googleurl/src/gurl.h" 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/base/address_list.h" 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/base/completion_callback.h" 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/base/host_resolver.h" 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/base/net_errors.h" 20c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "net/base/net_log.h" 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "net/socket/client_socket.h" 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace net { 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ClientSocketHandle; 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass BoundNetLog; 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// The SOCKS client socket implementation 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottclass SOCKSClientSocket : public ClientSocket { 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott public: 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Takes ownership of the |transport_socket|, which should already be 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // connected by the time Connect() is called. 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // |req_info| contains the hostname and port to which the socket above will 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // communicate to via the socks layer. For testing the referrer is optional. 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch SOCKSClientSocket(ClientSocketHandle* transport_socket, 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch const HostResolver::RequestInfo& req_info, 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch HostResolver* host_resolver); 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Deprecated constructor (http://crbug.com/37810) that takes a ClientSocket. 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott SOCKSClientSocket(ClientSocket* transport_socket, 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const HostResolver::RequestInfo& req_info, 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott HostResolver* host_resolver); 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // On destruction Disconnect() is called. 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual ~SOCKSClientSocket(); 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // ClientSocket methods: 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Does the SOCKS handshake and completes the protocol. 517b9ca917061470268bf3395c8925d4b9cc52d8e1Kristian Monsen virtual int Connect(CompletionCallback* callback 527b9ca917061470268bf3395c8925d4b9cc52d8e1Kristian Monsen#ifdef ANDROID 537b9ca917061470268bf3395c8925d4b9cc52d8e1Kristian Monsen , bool wait_for_connect 54e14dcc5a172cad1c4716af7ab94121a73c0c698eAshish Sharma , bool valid_uid 55e14dcc5a172cad1c4716af7ab94121a73c0c698eAshish Sharma , uid_t calling_uid 567b9ca917061470268bf3395c8925d4b9cc52d8e1Kristian Monsen#endif 577b9ca917061470268bf3395c8925d4b9cc52d8e1Kristian Monsen ); 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual void Disconnect(); 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual bool IsConnected() const; 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual bool IsConnectedAndIdle() const; 6121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual const BoundNetLog& NetLog() const; 623345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick virtual void SetSubresourceSpeculation(); 633345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick virtual void SetOmniboxSpeculation(); 643345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick virtual bool WasEverUsed() const; 65513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch virtual bool UsingTCPFastOpen() const; 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Socket methods: 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual int Read(IOBuffer* buf, int buf_len, CompletionCallback* callback); 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual int Write(IOBuffer* buf, int buf_len, CompletionCallback* callback); 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual bool SetReceiveBufferSize(int32 size); 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott virtual bool SetSendBufferSize(int32 size); 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch virtual int GetPeerAddress(AddressList* address) const; 75ddb351dbec246cf1fab5ec20d2d5520909041de1Kristian Monsen virtual int GetLocalAddress(IPEndPoint* address) const; 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott private: 783345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(SOCKSClientSocketTest, CompleteHandshake); 793345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(SOCKSClientSocketTest, SOCKS4AFailedDNS); 803345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick FRIEND_TEST_ALL_PREFIXES(SOCKSClientSocketTest, SOCKS4AIfDomainInIPv6); 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 82c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott enum State { 83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_RESOLVE_HOST, 84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_RESOLVE_HOST_COMPLETE, 85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_HANDSHAKE_WRITE, 86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_HANDSHAKE_WRITE_COMPLETE, 87c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_HANDSHAKE_READ, 88c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_HANDSHAKE_READ_COMPLETE, 89c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott STATE_NONE, 90c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott }; 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 92c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void DoCallback(int result); 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott void OnIOComplete(int result); 94c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 95c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoLoop(int last_io_result); 96c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoResolveHost(); 97c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoResolveHostComplete(int result); 98c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoHandshakeRead(); 99c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoHandshakeReadComplete(int result); 100c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoHandshakeWrite(); 101c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott int DoHandshakeWriteComplete(int result); 102c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 103c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott const std::string BuildHandshakeWriteBuffer() const; 104c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 105c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott CompletionCallbackImpl<SOCKSClientSocket> io_callback_; 106c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 107c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Stores the underlying socket. 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch scoped_ptr<ClientSocketHandle> transport_; 109c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 110c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott State next_state_; 111c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 112c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Stores the callback to the layer above, called on completing Connect(). 113c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott CompletionCallback* user_callback_; 114c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 115c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // This IOBuffer is used by the class to read and write 116c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // SOCKS handshake data. The length contains the expected size to 117c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // read or write. 118c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott scoped_refptr<IOBuffer> handshake_buf_; 119c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 120c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // While writing, this buffer stores the complete write handshake data. 121c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // While reading, it stores the handshake information received so far. 122c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott std::string buffer_; 123c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 124c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // This becomes true when the SOCKS handshake has completed and the 125c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // overlying connection is free to communicate. 126c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott bool completed_handshake_; 127c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 128c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // These contain the bytes sent / received by the SOCKS handshake. 129c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott size_t bytes_sent_; 130c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott size_t bytes_received_; 131c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 132c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Used to resolve the hostname to which the SOCKS proxy will connect. 133c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott SingleRequestHostResolver host_resolver_; 134c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott AddressList addresses_; 135c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott HostResolver::RequestInfo host_request_info_; 136c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 137c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch BoundNetLog net_log_; 138c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 139c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott DISALLOW_COPY_AND_ASSIGN(SOCKSClientSocket); 140c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott}; 141c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 142c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace net 143c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 144c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#endif // NET_SOCKET_SOCKS_CLIENT_SOCKET_H_ 145