net/http/http_proxy_client_socket_pool.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef NET_HTTP_HTTP_PROXY_CLIENT_SOCKET_POOL_H_
   6 #define NET_HTTP_HTTP_PROXY_CLIENT_SOCKET_POOL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/time/time.h"
  15 #include "net/base/host_port_pair.h"
  16 #include "net/base/net_export.h"
  17 #include "net/http/http_auth.h"
  18 #include "net/http/http_response_info.h"
  19 #include "net/http/proxy_client_socket.h"
  20 #include "net/socket/client_socket_pool.h"
  21 #include "net/socket/client_socket_pool_base.h"
  22 #include "net/socket/client_socket_pool_histograms.h"
  23 #include "net/socket/ssl_client_socket.h"
  24 #include "net/spdy/spdy_session.h"
  25
  26 namespace net {
  27
  28 class HostResolver;
  29 class HttpAuthCache;
  30 class HttpAuthHandlerFactory;
  31 class ProxyDelegate;
  32 class SSLClientSocketPool;
  33 class SSLSocketParams;
  34 class SpdySessionPool;
  35 class SpdyStream;
  36 class TransportClientSocketPool;
  37 class TransportSocketParams;
  38
  39 // HttpProxySocketParams only needs the socket params for one of the proxy
  40 // types.  The other param must be NULL.  When using an HTTP Proxy,
  41 // |transport_params| must be set.  When using an HTTPS Proxy, |ssl_params|
  42 // must be set.
  43 class NET_EXPORT_PRIVATE HttpProxySocketParams
  44     : public base::RefCounted<HttpProxySocketParams> {
  45  public:
  46   HttpProxySocketParams(
  47       const scoped_refptr<TransportSocketParams>& transport_params,
  48       const scoped_refptr<SSLSocketParams>& ssl_params,
  49       const GURL& request_url,
  50       const std::string& user_agent,
  51       const HostPortPair& endpoint,
  52       HttpAuthCache* http_auth_cache,
  53       HttpAuthHandlerFactory* http_auth_handler_factory,
  54       SpdySessionPool* spdy_session_pool,
  55       bool tunnel,
  56       ProxyDelegate* proxy_delegate);
  57
  58   const scoped_refptr<TransportSocketParams>& transport_params() const {
  59     return transport_params_;
  60   }
  61   const scoped_refptr<SSLSocketParams>& ssl_params() const {
  62     return ssl_params_;
  63   }
  64   const GURL& request_url() const { return request_url_; }
  65   const std::string& user_agent() const { return user_agent_; }
  66   const HostPortPair& endpoint() const { return endpoint_; }
  67   HttpAuthCache* http_auth_cache() const { return http_auth_cache_; }
  68   HttpAuthHandlerFactory* http_auth_handler_factory() const {
  69     return http_auth_handler_factory_;
  70   }
  71   SpdySessionPool* spdy_session_pool() {
  72     return spdy_session_pool_;
  73   }
  74   const HostResolver::RequestInfo& destination() const;
  75   bool tunnel() const { return tunnel_; }
  76   bool ignore_limits() const { return ignore_limits_; }
  77
  78   ProxyDelegate* proxy_delegate() const {
  79     return proxy_delegate_;
  80   }
  81
  82  private:
  83   friend class base::RefCounted<HttpProxySocketParams>;
  84   ~HttpProxySocketParams();
  85
  86   const scoped_refptr<TransportSocketParams> transport_params_;
  87   const scoped_refptr<SSLSocketParams> ssl_params_;
  88   SpdySessionPool* spdy_session_pool_;
  89   const GURL request_url_;
  90   const std::string user_agent_;
  91   const HostPortPair endpoint_;
  92   HttpAuthCache* const http_auth_cache_;
  93   HttpAuthHandlerFactory* const http_auth_handler_factory_;
  94   const bool tunnel_;
  95   bool ignore_limits_;
  96   ProxyDelegate* proxy_delegate_;
  97
  98   DISALLOW_COPY_AND_ASSIGN(HttpProxySocketParams);
  99 };
 100
 101 // HttpProxyConnectJob optionally establishes a tunnel through the proxy
 102 // server after connecting the underlying transport socket.
 103 class HttpProxyConnectJob : public ConnectJob {
 104  public:
 105   HttpProxyConnectJob(const std::string& group_name,
 106                       RequestPriority priority,
 107                       const scoped_refptr<HttpProxySocketParams>& params,
 108                       const base::TimeDelta& timeout_duration,
 109                       TransportClientSocketPool* transport_pool,
 110                       SSLClientSocketPool* ssl_pool,
 111                       HostResolver* host_resolver,
 112                       Delegate* delegate,
 113                       NetLog* net_log);
 114   ~HttpProxyConnectJob() override;
 115
 116   // ConnectJob methods.
 117   LoadState GetLoadState() const override;
 118
 119   void GetAdditionalErrorState(ClientSocketHandle* handle) override;
 120
 121  private:
 122   enum State {
 123     STATE_TCP_CONNECT,
 124     STATE_TCP_CONNECT_COMPLETE,
 125     STATE_SSL_CONNECT,
 126     STATE_SSL_CONNECT_COMPLETE,
 127     STATE_HTTP_PROXY_CONNECT,
 128     STATE_HTTP_PROXY_CONNECT_COMPLETE,
 129     STATE_SPDY_PROXY_CREATE_STREAM,
 130     STATE_SPDY_PROXY_CREATE_STREAM_COMPLETE,
 131     STATE_SPDY_PROXY_CONNECT_COMPLETE,
 132     STATE_NONE,
 133   };
 134
 135   void OnIOComplete(int result);
 136
 137   // Runs the state transition loop.
 138   int DoLoop(int result);
 139
 140   // Connecting to HTTP Proxy
 141   int DoTransportConnect();
 142   int DoTransportConnectComplete(int result);
 143   // Connecting to HTTPS Proxy
 144   int DoSSLConnect();
 145   int DoSSLConnectComplete(int result);
 146
 147   int DoHttpProxyConnect();
 148   int DoHttpProxyConnectComplete(int result);
 149
 150   int DoSpdyProxyCreateStream();
 151   int DoSpdyProxyCreateStreamComplete(int result);
 152
 153   void NotifyProxyDelegateOfCompletion(int result);
 154
 155   // Begins the tcp connection and the optional Http proxy tunnel.  If the
 156   // request is not immediately servicable (likely), the request will return
 157   // ERR_IO_PENDING. An OK return from this function or the callback means
 158   // that the connection is established; ERR_PROXY_AUTH_REQUESTED means
 159   // that the tunnel needs authentication credentials, the socket will be
 160   // returned in this case, and must be release back to the pool; or
 161   // a standard net error code will be returned.
 162   int ConnectInternal() override;
 163
 164   scoped_refptr<HttpProxySocketParams> params_;
 165   TransportClientSocketPool* const transport_pool_;
 166   SSLClientSocketPool* const ssl_pool_;
 167   HostResolver* const resolver_;
 168
 169   State next_state_;
 170   CompletionCallback callback_;
 171   scoped_ptr<ClientSocketHandle> transport_socket_handle_;
 172   scoped_ptr<ProxyClientSocket> transport_socket_;
 173   bool using_spdy_;
 174   // Protocol negotiated with the server.
 175   NextProto protocol_negotiated_;
 176
 177   HttpResponseInfo error_response_info_;
 178
 179   SpdyStreamRequest spdy_stream_request_;
 180
 181   base::WeakPtrFactory<HttpProxyConnectJob> weak_ptr_factory_;
 182
 183   DISALLOW_COPY_AND_ASSIGN(HttpProxyConnectJob);
 184 };
 185
 186 class NET_EXPORT_PRIVATE HttpProxyClientSocketPool
 187     : public ClientSocketPool,
 188       public HigherLayeredPool {
 189  public:
 190   typedef HttpProxySocketParams SocketParams;
 191
 192   HttpProxyClientSocketPool(
 193       int max_sockets,
 194       int max_sockets_per_group,
 195       ClientSocketPoolHistograms* histograms,
 196       HostResolver* host_resolver,
 197       TransportClientSocketPool* transport_pool,
 198       SSLClientSocketPool* ssl_pool,
 199       const ProxyDelegate* proxy_delegate,
 200       NetLog* net_log);
 201
 202   ~HttpProxyClientSocketPool() override;
 203
 204   // ClientSocketPool implementation.
 205   int RequestSocket(const std::string& group_name,
 206                     const void* connect_params,
 207                     RequestPriority priority,
 208                     ClientSocketHandle* handle,
 209                     const CompletionCallback& callback,
 210                     const BoundNetLog& net_log) override;
 211
 212   void RequestSockets(const std::string& group_name,
 213                       const void* params,
 214                       int num_sockets,
 215                       const BoundNetLog& net_log) override;
 216
 217   void CancelRequest(const std::string& group_name,
 218                      ClientSocketHandle* handle) override;
 219
 220   void ReleaseSocket(const std::string& group_name,
 221                      scoped_ptr<StreamSocket> socket,
 222                      int id) override;
 223
 224   void FlushWithError(int error) override;
 225
 226   void CloseIdleSockets() override;
 227
 228   int IdleSocketCount() const override;
 229
 230   int IdleSocketCountInGroup(const std::string& group_name) const override;
 231
 232   LoadState GetLoadState(const std::string& group_name,
 233                          const ClientSocketHandle* handle) const override;
 234
 235   base::DictionaryValue* GetInfoAsValue(
 236       const std::string& name,
 237       const std::string& type,
 238       bool include_nested_pools) const override;
 239
 240   base::TimeDelta ConnectionTimeout() const override;
 241
 242   ClientSocketPoolHistograms* histograms() const override;
 243
 244   // LowerLayeredPool implementation.
 245   bool IsStalled() const override;
 246
 247   void AddHigherLayeredPool(HigherLayeredPool* higher_pool) override;
 248
 249   void RemoveHigherLayeredPool(HigherLayeredPool* higher_pool) override;
 250
 251   // HigherLayeredPool implementation.
 252   bool CloseOneIdleConnection() override;
 253
 254  private:
 255   typedef ClientSocketPoolBase<HttpProxySocketParams> PoolBase;
 256
 257   class HttpProxyConnectJobFactory : public PoolBase::ConnectJobFactory {
 258    public:
 259     HttpProxyConnectJobFactory(
 260         TransportClientSocketPool* transport_pool,
 261         SSLClientSocketPool* ssl_pool,
 262         HostResolver* host_resolver,
 263         const ProxyDelegate* proxy_delegate,
 264         NetLog* net_log);
 265
 266     // ClientSocketPoolBase::ConnectJobFactory methods.
 267     scoped_ptr<ConnectJob> NewConnectJob(
 268         const std::string& group_name,
 269         const PoolBase::Request& request,
 270         ConnectJob::Delegate* delegate) const override;
 271
 272     base::TimeDelta ConnectionTimeout() const override;
 273
 274    private:
 275     TransportClientSocketPool* const transport_pool_;
 276     SSLClientSocketPool* const ssl_pool_;
 277     HostResolver* const host_resolver_;
 278     const ProxyDelegate* proxy_delegate_;
 279     NetLog* net_log_;
 280     base::TimeDelta timeout_;
 281
 282     DISALLOW_COPY_AND_ASSIGN(HttpProxyConnectJobFactory);
 283   };
 284
 285   TransportClientSocketPool* const transport_pool_;
 286   SSLClientSocketPool* const ssl_pool_;
 287   PoolBase base_;
 288
 289   DISALLOW_COPY_AND_ASSIGN(HttpProxyClientSocketPool);
 290 };
 291
 292 }  // namespace net
 293
 294 #endif  // NET_HTTP_HTTP_PROXY_CLIENT_SOCKET_POOL_H_