net/socket/ssl_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_SOCKET_SSL_CLIENT_SOCKET_POOL_H_
   6 #define NET_SOCKET_SSL_CLIENT_SOCKET_POOL_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/ref_counted.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/time/time.h"
  13 #include "net/base/privacy_mode.h"
  14 #include "net/http/http_response_info.h"
  15 #include "net/socket/client_socket_pool.h"
  16 #include "net/socket/client_socket_pool_base.h"
  17 #include "net/socket/ssl_client_socket.h"
  18 #include "net/ssl/ssl_config_service.h"
  19
  20 namespace net {
  21
  22 class CertPolicyEnforcer;
  23 class CertVerifier;
  24 class ClientSocketFactory;
  25 class ConnectJobFactory;
  26 class CTVerifier;
  27 class HostPortPair;
  28 class HttpProxyClientSocketPool;
  29 class HttpProxySocketParams;
  30 class SOCKSClientSocketPool;
  31 class SOCKSSocketParams;
  32 class SSLClientSocket;
  33 class TransportClientSocketPool;
  34 class TransportSecurityState;
  35 class TransportSocketParams;
  36
  37 class NET_EXPORT_PRIVATE SSLSocketParams
  38     : public base::RefCounted<SSLSocketParams> {
  39  public:
  40   enum ConnectionType { DIRECT, SOCKS_PROXY, HTTP_PROXY };
  41
  42   // Exactly one of |direct_params|, |socks_proxy_params|, and
  43   // |http_proxy_params| must be non-NULL.
  44   SSLSocketParams(
  45       const scoped_refptr<TransportSocketParams>& direct_params,
  46       const scoped_refptr<SOCKSSocketParams>& socks_proxy_params,
  47       const scoped_refptr<HttpProxySocketParams>& http_proxy_params,
  48       const HostPortPair& host_and_port,
  49       const SSLConfig& ssl_config,
  50       PrivacyMode privacy_mode,
  51       int load_flags,
  52       bool force_spdy_over_ssl,
  53       bool want_spdy_over_npn);
  54
  55   // Returns the type of the underlying connection.
  56   ConnectionType GetConnectionType() const;
  57
  58   // Must be called only when GetConnectionType() returns DIRECT.
  59   const scoped_refptr<TransportSocketParams>&
  60       GetDirectConnectionParams() const;
  61
  62   // Must be called only when GetConnectionType() returns SOCKS_PROXY.
  63   const scoped_refptr<SOCKSSocketParams>&
  64       GetSocksProxyConnectionParams() const;
  65
  66   // Must be called only when GetConnectionType() returns HTTP_PROXY.
  67   const scoped_refptr<HttpProxySocketParams>&
  68       GetHttpProxyConnectionParams() const;
  69
  70   const HostPortPair& host_and_port() const { return host_and_port_; }
  71   const SSLConfig& ssl_config() const { return ssl_config_; }
  72   PrivacyMode privacy_mode() const { return privacy_mode_; }
  73   int load_flags() const { return load_flags_; }
  74   bool force_spdy_over_ssl() const { return force_spdy_over_ssl_; }
  75   bool want_spdy_over_npn() const { return want_spdy_over_npn_; }
  76   bool ignore_limits() const { return ignore_limits_; }
  77
  78  private:
  79   friend class base::RefCounted<SSLSocketParams>;
  80   ~SSLSocketParams();
  81
  82   const scoped_refptr<TransportSocketParams> direct_params_;
  83   const scoped_refptr<SOCKSSocketParams> socks_proxy_params_;
  84   const scoped_refptr<HttpProxySocketParams> http_proxy_params_;
  85   const HostPortPair host_and_port_;
  86   const SSLConfig ssl_config_;
  87   const PrivacyMode privacy_mode_;
  88   const int load_flags_;
  89   const bool force_spdy_over_ssl_;
  90   const bool want_spdy_over_npn_;
  91   bool ignore_limits_;
  92
  93   DISALLOW_COPY_AND_ASSIGN(SSLSocketParams);
  94 };
  95
  96 // SSLConnectJob handles the SSL handshake after setting up the underlying
  97 // connection as specified in the params.
  98 class SSLConnectJob : public ConnectJob {
  99  public:
 100   // Note: the SSLConnectJob does not own |messenger| so it must outlive the
 101   // job.
 102   SSLConnectJob(const std::string& group_name,
 103                 RequestPriority priority,
 104                 const scoped_refptr<SSLSocketParams>& params,
 105                 const base::TimeDelta& timeout_duration,
 106                 TransportClientSocketPool* transport_pool,
 107                 SOCKSClientSocketPool* socks_pool,
 108                 HttpProxyClientSocketPool* http_proxy_pool,
 109                 ClientSocketFactory* client_socket_factory,
 110                 const SSLClientSocketContext& context,
 111                 Delegate* delegate,
 112                 NetLog* net_log);
 113   ~SSLConnectJob() override;
 114
 115   // ConnectJob methods.
 116   LoadState GetLoadState() const override;
 117
 118   void GetAdditionalErrorState(ClientSocketHandle* handle) override;
 119
 120  private:
 121   enum State {
 122     STATE_TRANSPORT_CONNECT,
 123     STATE_TRANSPORT_CONNECT_COMPLETE,
 124     STATE_SOCKS_CONNECT,
 125     STATE_SOCKS_CONNECT_COMPLETE,
 126     STATE_TUNNEL_CONNECT,
 127     STATE_TUNNEL_CONNECT_COMPLETE,
 128     STATE_SSL_CONNECT,
 129     STATE_SSL_CONNECT_COMPLETE,
 130     STATE_NONE,
 131   };
 132
 133   void OnIOComplete(int result);
 134
 135   // Runs the state transition loop.
 136   int DoLoop(int result);
 137
 138   int DoTransportConnect();
 139   int DoTransportConnectComplete(int result);
 140   int DoSOCKSConnect();
 141   int DoSOCKSConnectComplete(int result);
 142   int DoTunnelConnect();
 143   int DoTunnelConnectComplete(int result);
 144   int DoSSLConnect();
 145   int DoSSLConnectComplete(int result);
 146
 147   // Returns the initial state for the state machine based on the
 148   // |connection_type|.
 149   static State GetInitialState(SSLSocketParams::ConnectionType connection_type);
 150
 151   // Starts the SSL connection process.  Returns OK on success and
 152   // ERR_IO_PENDING if it cannot immediately service the request.
 153   // Otherwise, it returns a net error code.
 154   int ConnectInternal() override;
 155
 156   scoped_refptr<SSLSocketParams> params_;
 157   TransportClientSocketPool* const transport_pool_;
 158   SOCKSClientSocketPool* const socks_pool_;
 159   HttpProxyClientSocketPool* const http_proxy_pool_;
 160   ClientSocketFactory* const client_socket_factory_;
 161
 162   const SSLClientSocketContext context_;
 163
 164   State next_state_;
 165   CompletionCallback callback_;
 166   scoped_ptr<ClientSocketHandle> transport_socket_handle_;
 167   scoped_ptr<SSLClientSocket> ssl_socket_;
 168
 169   HttpResponseInfo error_response_info_;
 170
 171   DISALLOW_COPY_AND_ASSIGN(SSLConnectJob);
 172 };
 173
 174 class NET_EXPORT_PRIVATE SSLClientSocketPool
 175     : public ClientSocketPool,
 176       public HigherLayeredPool,
 177       public SSLConfigService::Observer {
 178  public:
 179   typedef SSLSocketParams SocketParams;
 180
 181   // Only the pools that will be used are required. i.e. if you never
 182   // try to create an SSL over SOCKS socket, |socks_pool| may be NULL.
 183   SSLClientSocketPool(int max_sockets,
 184                       int max_sockets_per_group,
 185                       CertVerifier* cert_verifier,
 186                       ChannelIDService* channel_id_service,
 187                       TransportSecurityState* transport_security_state,
 188                       CTVerifier* cert_transparency_verifier,
 189                       CertPolicyEnforcer* cert_policy_enforcer,
 190                       const std::string& ssl_session_cache_shard,
 191                       ClientSocketFactory* client_socket_factory,
 192                       TransportClientSocketPool* transport_pool,
 193                       SOCKSClientSocketPool* socks_pool,
 194                       HttpProxyClientSocketPool* http_proxy_pool,
 195                       SSLConfigService* ssl_config_service,
 196                       NetLog* net_log);
 197
 198   ~SSLClientSocketPool() override;
 199
 200   // ClientSocketPool implementation.
 201   int RequestSocket(const std::string& group_name,
 202                     const void* connect_params,
 203                     RequestPriority priority,
 204                     ClientSocketHandle* handle,
 205                     const CompletionCallback& callback,
 206                     const BoundNetLog& net_log) override;
 207
 208   void RequestSockets(const std::string& group_name,
 209                       const void* params,
 210                       int num_sockets,
 211                       const BoundNetLog& net_log) override;
 212
 213   void CancelRequest(const std::string& group_name,
 214                      ClientSocketHandle* handle) override;
 215
 216   void ReleaseSocket(const std::string& group_name,
 217                      scoped_ptr<StreamSocket> socket,
 218                      int id) override;
 219
 220   void FlushWithError(int error) override;
 221
 222   void CloseIdleSockets() override;
 223
 224   int IdleSocketCount() const override;
 225
 226   int IdleSocketCountInGroup(const std::string& group_name) const override;
 227
 228   LoadState GetLoadState(const std::string& group_name,
 229                          const ClientSocketHandle* handle) const override;
 230
 231   base::DictionaryValue* GetInfoAsValue(
 232       const std::string& name,
 233       const std::string& type,
 234       bool include_nested_pools) const override;
 235
 236   base::TimeDelta ConnectionTimeout() const override;
 237
 238   // LowerLayeredPool implementation.
 239   bool IsStalled() const override;
 240
 241   void AddHigherLayeredPool(HigherLayeredPool* higher_pool) override;
 242
 243   void RemoveHigherLayeredPool(HigherLayeredPool* higher_pool) override;
 244
 245   // HigherLayeredPool implementation.
 246   bool CloseOneIdleConnection() override;
 247
 248  private:
 249   typedef ClientSocketPoolBase<SSLSocketParams> PoolBase;
 250
 251   // SSLConfigService::Observer implementation.
 252
 253   // When the user changes the SSL config, we flush all idle sockets so they
 254   // won't get re-used.
 255   void OnSSLConfigChanged() override;
 256
 257   class SSLConnectJobFactory : public PoolBase::ConnectJobFactory {
 258    public:
 259     SSLConnectJobFactory(
 260         TransportClientSocketPool* transport_pool,
 261         SOCKSClientSocketPool* socks_pool,
 262         HttpProxyClientSocketPool* http_proxy_pool,
 263         ClientSocketFactory* client_socket_factory,
 264         const SSLClientSocketContext& context,
 265         NetLog* net_log);
 266
 267     ~SSLConnectJobFactory() override;
 268
 269     // ClientSocketPoolBase::ConnectJobFactory methods.
 270     scoped_ptr<ConnectJob> NewConnectJob(
 271         const std::string& group_name,
 272         const PoolBase::Request& request,
 273         ConnectJob::Delegate* delegate) const override;
 274
 275     base::TimeDelta ConnectionTimeout() const override;
 276
 277    private:
 278     TransportClientSocketPool* const transport_pool_;
 279     SOCKSClientSocketPool* const socks_pool_;
 280     HttpProxyClientSocketPool* const http_proxy_pool_;
 281     ClientSocketFactory* const client_socket_factory_;
 282     const SSLClientSocketContext context_;
 283     base::TimeDelta timeout_;
 284     NetLog* net_log_;
 285
 286     DISALLOW_COPY_AND_ASSIGN(SSLConnectJobFactory);
 287   };
 288
 289   TransportClientSocketPool* const transport_pool_;
 290   SOCKSClientSocketPool* const socks_pool_;
 291   HttpProxyClientSocketPool* const http_proxy_pool_;
 292   PoolBase base_;
 293   const scoped_refptr<SSLConfigService> ssl_config_service_;
 294
 295   DISALLOW_COPY_AND_ASSIGN(SSLClientSocketPool);
 296 };
 297
 298 }  // namespace net
 299
 300 #endif  // NET_SOCKET_SSL_CLIENT_SOCKET_POOL_H_