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 enable_spdy_compression;
  88     bool enable_spdy_ping_based_connection_checking;
  89     NextProto spdy_default_protocol;
  90     // The protocols supported by NPN (next protocol negotiation) during the
  91     // SSL handshake as well as by HTTP Alternate-Protocol.
  92     // TODO(mmenke):  This is currently empty by default, and alternate
  93     //                protocols are disabled.  We should use some reasonable
  94     //                defaults.
  95     NextProtoVector next_protos;
  96     size_t spdy_session_max_recv_window_size;
  97     size_t spdy_stream_max_recv_window_size;
  98     size_t spdy_initial_max_concurrent_streams;
  99     SpdySessionPool::TimeFunc time_func;
 100     std::string trusted_spdy_proxy;
 101     // URLs to exclude from forced SPDY.
 102     std::set<HostPortPair> forced_spdy_exclusions;
 103     // Noe: Using this in the case of NPN for HTTP only results in the browser
 104     // trying SSL and then falling back to http.
 105     bool use_alternate_protocols;
 106     double alternative_service_probability_threshold;
 107
 108     bool enable_quic;
 109     bool disable_insecure_quic;
 110     bool enable_quic_for_proxies;
 111     bool enable_quic_port_selection;
 112     bool quic_always_require_handshake_confirmation;
 113     bool quic_disable_connection_pooling;
 114     float quic_load_server_info_timeout_srtt_multiplier;
 115     bool quic_enable_connection_racing;
 116     bool quic_enable_non_blocking_io;
 117     bool quic_disable_disk_cache;
 118     int quic_max_number_of_lossy_connections;
 119     float quic_packet_loss_threshold;
 120     int quic_socket_receive_buffer_size;
 121     HostPortPair origin_to_force_quic_on;
 122     QuicClock* quic_clock;  // Will be owned by QuicStreamFactory.
 123     QuicRandom* quic_random;
 124     size_t quic_max_packet_length;
 125     std::string quic_user_agent_id;
 126     bool enable_user_alternate_protocol_ports;
 127     QuicCryptoClientStreamFactory* quic_crypto_client_stream_factory;
 128     QuicVersionVector quic_supported_versions;
 129     QuicTagVector quic_connection_options;
 130     ProxyDelegate* proxy_delegate;
 131   };
 132
 133   enum SocketPoolType {
 134     NORMAL_SOCKET_POOL,
 135     WEBSOCKET_SOCKET_POOL,
 136     NUM_SOCKET_POOL_TYPES
 137   };
 138
 139   explicit HttpNetworkSession(const Params& params);
 140
 141   HttpAuthCache* http_auth_cache() { return &http_auth_cache_; }
 142   SSLClientAuthCache* ssl_client_auth_cache() {
 143     return &ssl_client_auth_cache_;
 144   }
 145
 146   void AddResponseDrainer(HttpResponseBodyDrainer* drainer);
 147
 148   void RemoveResponseDrainer(HttpResponseBodyDrainer* drainer);
 149
 150   TransportClientSocketPool* GetTransportSocketPool(SocketPoolType pool_type);
 151   SSLClientSocketPool* GetSSLSocketPool(SocketPoolType pool_type);
 152   SOCKSClientSocketPool* GetSocketPoolForSOCKSProxy(
 153       SocketPoolType pool_type,
 154       const HostPortPair& socks_proxy);
 155   HttpProxyClientSocketPool* GetSocketPoolForHTTPProxy(
 156       SocketPoolType pool_type,
 157       const HostPortPair& http_proxy);
 158   SSLClientSocketPool* GetSocketPoolForSSLWithProxy(
 159       SocketPoolType pool_type,
 160       const HostPortPair& proxy_server);
 161
 162   CertVerifier* cert_verifier() { return cert_verifier_; }
 163   ProxyService* proxy_service() { return proxy_service_; }
 164   SSLConfigService* ssl_config_service() { return ssl_config_service_.get(); }
 165   SpdySessionPool* spdy_session_pool() { return &spdy_session_pool_; }
 166   QuicStreamFactory* quic_stream_factory() { return &quic_stream_factory_; }
 167   HttpAuthHandlerFactory* http_auth_handler_factory() {
 168     return http_auth_handler_factory_;
 169   }
 170   NetworkDelegate* network_delegate() {
 171     return network_delegate_;
 172   }
 173   base::WeakPtr<HttpServerProperties> http_server_properties() {
 174     return http_server_properties_;
 175   }
 176   HttpStreamFactory* http_stream_factory() {
 177     return http_stream_factory_.get();
 178   }
 179   HttpStreamFactory* http_stream_factory_for_websocket() {
 180     return http_stream_factory_for_websocket_.get();
 181   }
 182   NetLog* net_log() {
 183     return net_log_;
 184   }
 185
 186   // Creates a Value summary of the state of the socket pools.
 187   scoped_ptr<base::Value> SocketPoolInfoToValue() const;
 188
 189   // Creates a Value summary of the state of the SPDY sessions.
 190   scoped_ptr<base::Value> SpdySessionPoolInfoToValue() const;
 191
 192   // Creates a Value summary of the state of the QUIC sessions and
 193   // configuration.
 194   scoped_ptr<base::Value> QuicInfoToValue() const;
 195
 196   void CloseAllConnections();
 197   void CloseIdleConnections();
 198
 199   // Returns the original Params used to construct this session.
 200   const Params& params() const { return params_; }
 201
 202   bool IsProtocolEnabled(AlternateProtocol protocol) const;
 203
 204   // Populates |*next_protos| with protocols.
 205   void GetNextProtos(NextProtoVector* next_protos) const;
 206
 207   // Convenience function for searching through |params_| for
 208   // |forced_spdy_exclusions|.
 209   bool HasSpdyExclusion(HostPortPair host_port_pair) const;
 210
 211  private:
 212   friend class base::RefCounted<HttpNetworkSession>;
 213   friend class HttpNetworkSessionPeer;
 214
 215   ~HttpNetworkSession();
 216
 217   ClientSocketPoolManager* GetSocketPoolManager(SocketPoolType pool_type);
 218
 219   NetLog* const net_log_;
 220   NetworkDelegate* const network_delegate_;
 221   const base::WeakPtr<HttpServerProperties> http_server_properties_;
 222   CertVerifier* const cert_verifier_;
 223   HttpAuthHandlerFactory* const http_auth_handler_factory_;
 224
 225   // Not const since it's modified by HttpNetworkSessionPeer for testing.
 226   ProxyService* proxy_service_;
 227   const scoped_refptr<SSLConfigService> ssl_config_service_;
 228
 229   HttpAuthCache http_auth_cache_;
 230   SSLClientAuthCache ssl_client_auth_cache_;
 231   scoped_ptr<ClientSocketPoolManager> normal_socket_pool_manager_;
 232   scoped_ptr<ClientSocketPoolManager> websocket_socket_pool_manager_;
 233   QuicStreamFactory quic_stream_factory_;
 234   SpdySessionPool spdy_session_pool_;
 235   scoped_ptr<HttpStreamFactory> http_stream_factory_;
 236   scoped_ptr<HttpStreamFactory> http_stream_factory_for_websocket_;
 237   std::set<HttpResponseBodyDrainer*> response_drainers_;
 238
 239   NextProtoVector next_protos_;
 240   bool enabled_protocols_[NUM_VALID_ALTERNATE_PROTOCOLS];
 241
 242   Params params_;
 243 };
 244
 245 }  // namespace net
 246
 247 #endif  // NET_HTTP_HTTP_NETWORK_SESSION_H_