net/http/http_network_session.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_NETWORK_SESSION_H_
   6 #define NET_HTTP_HTTP_NETWORK_SESSION_H_
   7
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/threading/non_thread_safe.h"
  16 #include "net/base/host_port_pair.h"
  17 #include "net/base/net_export.h"
  18 #include "net/dns/host_resolver.h"
  19 #include "net/http/http_auth_cache.h"
  20 #include "net/http/http_stream_factory.h"
  21 #include "net/quic/quic_stream_factory.h"
  22 #include "net/socket/next_proto.h"
  23 #include "net/spdy/spdy_session_pool.h"
  24 #include "net/ssl/ssl_client_auth_cache.h"
  25
  26 namespace base {
  27 class Value;
  28 }
  29
  30 namespace net {
  31
  32 class CertPolicyEnforcer;
  33 class CertVerifier;
  34 class ChannelIDService;
  35 class ClientSocketFactory;
  36 class ClientSocketPoolManager;
  37 class CTVerifier;
  38 class HostResolver;
  39 class HttpAuthHandlerFactory;
  40 class HttpNetworkSessionPeer;
  41 class HttpProxyClientSocketPool;
  42 class HttpResponseBodyDrainer;
  43 class HttpServerProperties;
  44 class NetLog;
  45 class NetworkDelegate;
  46 class ProxyDelegate;
  47 class ProxyService;
  48 class QuicClock;
  49 class QuicCryptoClientStreamFactory;
  50 class QuicServerInfoFactory;
  51 class SOCKSClientSocketPool;
  52 class SSLClientSocketPool;
  53 class SSLConfigService;
  54 class TransportClientSocketPool;
  55 class TransportSecurityState;
  56
  57 // This class holds session objects used by HttpNetworkTransaction objects.
  58 class NET_EXPORT HttpNetworkSession
  59     : public base::RefCounted<HttpNetworkSession>,
  60       NON_EXPORTED_BASE(public base::NonThreadSafe) {
  61  public:
  62   struct NET_EXPORT Params {
  63     Params();
  64     ~Params();
  65
  66     ClientSocketFactory* client_socket_factory;
  67     HostResolver* host_resolver;
  68     CertVerifier* cert_verifier;
  69     CertPolicyEnforcer* cert_policy_enforcer;
  70     ChannelIDService* channel_id_service;
  71     TransportSecurityState* transport_security_state;
  72     CTVerifier* cert_transparency_verifier;
  73     ProxyService* proxy_service;
  74     std::string ssl_session_cache_shard;
  75     SSLConfigService* ssl_config_service;
  76     HttpAuthHandlerFactory* http_auth_handler_factory;
  77     NetworkDelegate* network_delegate;
  78     base::WeakPtr<HttpServerProperties> http_server_properties;
  79     NetLog* net_log;
  80     HostMappingRules* host_mapping_rules;
  81     bool ignore_certificate_errors;
  82     bool use_stale_while_revalidate;
  83     uint16 testing_fixed_http_port;
  84     uint16 testing_fixed_https_port;
  85     bool enable_tcp_fast_open_for_ssl;
  86
  87     bool force_spdy_single_domain;
  88     bool enable_spdy_compression;
  89     bool enable_spdy_ping_based_connection_checking;
  90     NextProto spdy_default_protocol;
  91     // The protocols supported by NPN (next protocol negotiation) during the
  92     // SSL handshake as well as by HTTP Alternate-Protocol.
  93     // TODO(mmenke):  This is currently empty by default, and alternate
  94     //                protocols are disabled.  We should use some reasonable
  95     //                defaults.
  96     NextProtoVector next_protos;
  97     size_t spdy_stream_initial_recv_window_size;
  98     size_t spdy_initial_max_concurrent_streams;
  99     size_t spdy_max_concurrent_streams_limit;
 100     SpdySessionPool::TimeFunc time_func;
 101     std::string trusted_spdy_proxy;
 102     // Controls whether or not ssl is used when in SPDY mode.
 103     bool force_spdy_over_ssl;
 104     // Controls whether or not SPDY is used without NPN.
 105     bool force_spdy_always;
 106     // URLs to exclude from forced SPDY.
 107     std::set<HostPortPair> forced_spdy_exclusions;
 108     // Noe: Using this in the case of NPN for HTTP only results in the browser
 109     // trying SSL and then falling back to http.
 110     bool use_alternate_protocols;
 111     double alternate_protocol_probability_threshold;
 112
 113     bool enable_quic;
 114     bool enable_quic_for_proxies;
 115     bool enable_quic_port_selection;
 116     bool quic_always_require_handshake_confirmation;
 117     bool quic_disable_connection_pooling;
 118     float quic_load_server_info_timeout_srtt_multiplier;
 119     bool quic_enable_connection_racing;
 120     bool quic_enable_non_blocking_io;
 121     bool quic_disable_disk_cache;
 122     int quic_socket_receive_buffer_size;
 123     HostPortPair origin_to_force_quic_on;
 124     QuicClock* quic_clock;  // Will be owned by QuicStreamFactory.
 125     QuicRandom* quic_random;
 126     size_t quic_max_packet_length;
 127     std::string quic_user_agent_id;
 128     bool enable_user_alternate_protocol_ports;
 129     QuicCryptoClientStreamFactory* quic_crypto_client_stream_factory;
 130     QuicVersionVector quic_supported_versions;
 131     QuicTagVector quic_connection_options;
 132     ProxyDelegate* proxy_delegate;
 133   };
 134
 135   enum SocketPoolType {
 136     NORMAL_SOCKET_POOL,
 137     WEBSOCKET_SOCKET_POOL,
 138     NUM_SOCKET_POOL_TYPES
 139   };
 140
 141   explicit HttpNetworkSession(const Params& params);
 142
 143   HttpAuthCache* http_auth_cache() { return &http_auth_cache_; }
 144   SSLClientAuthCache* ssl_client_auth_cache() {
 145     return &ssl_client_auth_cache_;
 146   }
 147
 148   void AddResponseDrainer(HttpResponseBodyDrainer* drainer);
 149
 150   void RemoveResponseDrainer(HttpResponseBodyDrainer* drainer);
 151
 152   TransportClientSocketPool* GetTransportSocketPool(SocketPoolType pool_type);
 153   SSLClientSocketPool* GetSSLSocketPool(SocketPoolType pool_type);
 154   SOCKSClientSocketPool* GetSocketPoolForSOCKSProxy(
 155       SocketPoolType pool_type,
 156       const HostPortPair& socks_proxy);
 157   HttpProxyClientSocketPool* GetSocketPoolForHTTPProxy(
 158       SocketPoolType pool_type,
 159       const HostPortPair& http_proxy);
 160   SSLClientSocketPool* GetSocketPoolForSSLWithProxy(
 161       SocketPoolType pool_type,
 162       const HostPortPair& proxy_server);
 163
 164   CertVerifier* cert_verifier() { return cert_verifier_; }
 165   ProxyService* proxy_service() { return proxy_service_; }
 166   SSLConfigService* ssl_config_service() { return ssl_config_service_.get(); }
 167   SpdySessionPool* spdy_session_pool() { return &spdy_session_pool_; }
 168   QuicStreamFactory* quic_stream_factory() { return &quic_stream_factory_; }
 169   HttpAuthHandlerFactory* http_auth_handler_factory() {
 170     return http_auth_handler_factory_;
 171   }
 172   NetworkDelegate* network_delegate() {
 173     return network_delegate_;
 174   }
 175   base::WeakPtr<HttpServerProperties> http_server_properties() {
 176     return http_server_properties_;
 177   }
 178   HttpStreamFactory* http_stream_factory() {
 179     return http_stream_factory_.get();
 180   }
 181   HttpStreamFactory* http_stream_factory_for_websocket() {
 182     return http_stream_factory_for_websocket_.get();
 183   }
 184   NetLog* net_log() {
 185     return net_log_;
 186   }
 187
 188   // Creates a Value summary of the state of the socket pools. The caller is
 189   // responsible for deleting the returned value.
 190   base::Value* SocketPoolInfoToValue() const;
 191
 192   // Creates a Value summary of the state of the SPDY sessions. The caller is
 193   // responsible for deleting the returned value.
 194   base::Value* SpdySessionPoolInfoToValue() const;
 195
 196   // Creates a Value summary of the state of the QUIC sessions and
 197   // configuration. The caller is responsible for deleting the returned value.
 198   base::Value* QuicInfoToValue() const;
 199
 200   void CloseAllConnections();
 201   void CloseIdleConnections();
 202
 203   // Returns the original Params used to construct this session.
 204   const Params& params() const { return params_; }
 205
 206   bool IsProtocolEnabled(AlternateProtocol protocol) const;
 207
 208   // Populates |*next_protos| with protocols.
 209   void GetNextProtos(NextProtoVector* next_protos) const;
 210
 211   // Convenience function for searching through |params_| for
 212   // |forced_spdy_exclusions|.
 213   bool HasSpdyExclusion(HostPortPair host_port_pair) const;
 214
 215  private:
 216   friend class base::RefCounted<HttpNetworkSession>;
 217   friend class HttpNetworkSessionPeer;
 218
 219   ~HttpNetworkSession();
 220
 221   ClientSocketPoolManager* GetSocketPoolManager(SocketPoolType pool_type);
 222
 223   NetLog* const net_log_;
 224   NetworkDelegate* const network_delegate_;
 225   const base::WeakPtr<HttpServerProperties> http_server_properties_;
 226   CertVerifier* const cert_verifier_;
 227   HttpAuthHandlerFactory* const http_auth_handler_factory_;
 228
 229   // Not const since it's modified by HttpNetworkSessionPeer for testing.
 230   ProxyService* proxy_service_;
 231   const scoped_refptr<SSLConfigService> ssl_config_service_;
 232
 233   HttpAuthCache http_auth_cache_;
 234   SSLClientAuthCache ssl_client_auth_cache_;
 235   scoped_ptr<ClientSocketPoolManager> normal_socket_pool_manager_;
 236   scoped_ptr<ClientSocketPoolManager> websocket_socket_pool_manager_;
 237   QuicStreamFactory quic_stream_factory_;
 238   SpdySessionPool spdy_session_pool_;
 239   scoped_ptr<HttpStreamFactory> http_stream_factory_;
 240   scoped_ptr<HttpStreamFactory> http_stream_factory_for_websocket_;
 241   std::set<HttpResponseBodyDrainer*> response_drainers_;
 242
 243   NextProtoVector next_protos_;
 244   bool enabled_protocols_[NUM_VALID_ALTERNATE_PROTOCOLS];
 245
 246   Params params_;
 247 };
 248
 249 }  // namespace net
 250
 251 #endif  // NET_HTTP_HTTP_NETWORK_SESSION_H_