1 // Copyright 2012 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "net/socket/client_socket_pool_manager.h"
6
7 #include <memory>
8 #include <utility>
9
10 #include "base/check_op.h"
11 #include "base/metrics/field_trial_params.h"
12 #include "base/strings/string_piece.h"
13 #include "build/build_config.h"
14 #include "net/base/features.h"
15 #include "net/base/load_flags.h"
16 #include "net/dns/public/secure_dns_policy.h"
17 #include "net/http/http_stream_factory.h"
18 #include "net/proxy_resolution/proxy_info.h"
19 #include "net/socket/client_socket_handle.h"
20 #include "net/socket/client_socket_pool.h"
21 #include "net/socket/connect_job.h"
22 #include "net/ssl/ssl_config.h"
23 #include "third_party/abseil-cpp/absl/types/optional.h"
24 #include "url/gurl.h"
25 #include "url/scheme_host_port.h"
26 #include "url/url_constants.h"
27
28 namespace net {
29
30 namespace {
31
32 // Limit of sockets of each socket pool.
33 int g_max_sockets_per_pool[] = {
34 256, // NORMAL_SOCKET_POOL
35 256 // WEBSOCKET_SOCKET_POOL
36 };
37
38 static_assert(std::size(g_max_sockets_per_pool) ==
39 HttpNetworkSession::NUM_SOCKET_POOL_TYPES,
40 "max sockets per pool length mismatch");
41
42 // Default to allow up to 6 connections per host. Experiment and tuning may
43 // try other values (greater than 0). Too large may cause many problems, such
44 // as home routers blocking the connections!?!? See http://crbug.com/12066.
45 //
46 // WebSocket connections are long-lived, and should be treated differently
47 // than normal other connections. Use a limit of 255, so the limit for wss will
48 // be the same as the limit for ws. Also note that Firefox uses a limit of 200.
49 // See http://crbug.com/486800
50 int g_max_sockets_per_group[] = {
51 6, // NORMAL_SOCKET_POOL
52 255 // WEBSOCKET_SOCKET_POOL
53 };
54
55 static_assert(std::size(g_max_sockets_per_group) ==
56 HttpNetworkSession::NUM_SOCKET_POOL_TYPES,
57 "max sockets per group length mismatch");
58
59 // The max number of sockets to allow per proxy server. This applies both to
60 // http and SOCKS proxies. See http://crbug.com/12066 and
61 // http://crbug.com/44501 for details about proxy server connection limits.
62 int g_max_sockets_per_proxy_server[] = {
63 kDefaultMaxSocketsPerProxyServer, // NORMAL_SOCKET_POOL
64 kDefaultMaxSocketsPerProxyServer // WEBSOCKET_SOCKET_POOL
65 };
66
67 static_assert(std::size(g_max_sockets_per_proxy_server) ==
68 HttpNetworkSession::NUM_SOCKET_POOL_TYPES,
69 "max sockets per proxy server length mismatch");
70
71 // TODO(https://crbug.com/921369) In order to resolve longstanding issues
72 // related to pooling distinguishable sockets together, get rid of SocketParams
73 // entirely.
CreateSocketParams(const ClientSocketPool::GroupId & group_id,const ProxyServer & proxy_server,const SSLConfig & ssl_config_for_origin,const SSLConfig & ssl_config_for_proxy)74 scoped_refptr<ClientSocketPool::SocketParams> CreateSocketParams(
75 const ClientSocketPool::GroupId& group_id,
76 const ProxyServer& proxy_server,
77 const SSLConfig& ssl_config_for_origin,
78 const SSLConfig& ssl_config_for_proxy) {
79 bool using_ssl = GURL::SchemeIsCryptographic(group_id.destination().scheme());
80 bool using_proxy_ssl = proxy_server.is_secure_http_like();
81 return base::MakeRefCounted<ClientSocketPool::SocketParams>(
82 using_ssl ? std::make_unique<SSLConfig>(ssl_config_for_origin) : nullptr,
83 using_proxy_ssl ? std::make_unique<SSLConfig>(ssl_config_for_proxy)
84 : nullptr);
85 }
86
InitSocketPoolHelper(url::SchemeHostPort endpoint,int request_load_flags,RequestPriority request_priority,HttpNetworkSession * session,const ProxyInfo & proxy_info,const SSLConfig & ssl_config_for_origin,const SSLConfig & ssl_config_for_proxy,bool is_for_websockets,PrivacyMode privacy_mode,NetworkAnonymizationKey network_anonymization_key,SecureDnsPolicy secure_dns_policy,const SocketTag & socket_tag,const NetLogWithSource & net_log,int num_preconnect_streams,ClientSocketHandle * socket_handle,HttpNetworkSession::SocketPoolType socket_pool_type,CompletionOnceCallback callback,const ClientSocketPool::ProxyAuthCallback & proxy_auth_callback)87 int InitSocketPoolHelper(
88 url::SchemeHostPort endpoint,
89 int request_load_flags,
90 RequestPriority request_priority,
91 HttpNetworkSession* session,
92 const ProxyInfo& proxy_info,
93 const SSLConfig& ssl_config_for_origin,
94 const SSLConfig& ssl_config_for_proxy,
95 bool is_for_websockets,
96 PrivacyMode privacy_mode,
97 NetworkAnonymizationKey network_anonymization_key,
98 SecureDnsPolicy secure_dns_policy,
99 const SocketTag& socket_tag,
100 const NetLogWithSource& net_log,
101 int num_preconnect_streams,
102 ClientSocketHandle* socket_handle,
103 HttpNetworkSession::SocketPoolType socket_pool_type,
104 CompletionOnceCallback callback,
105 const ClientSocketPool::ProxyAuthCallback& proxy_auth_callback) {
106 DCHECK(endpoint.IsValid());
107
108 bool using_ssl = GURL::SchemeIsCryptographic(endpoint.scheme());
109 if (!using_ssl && session->params().testing_fixed_http_port != 0) {
110 endpoint = url::SchemeHostPort(endpoint.scheme(), endpoint.host(),
111 session->params().testing_fixed_http_port);
112 } else if (using_ssl && session->params().testing_fixed_https_port != 0) {
113 endpoint = url::SchemeHostPort(endpoint.scheme(), endpoint.host(),
114 session->params().testing_fixed_https_port);
115 }
116
117 ClientSocketPool::GroupId connection_group(
118 std::move(endpoint), privacy_mode, std::move(network_anonymization_key),
119 secure_dns_policy);
120 scoped_refptr<ClientSocketPool::SocketParams> socket_params =
121 CreateSocketParams(connection_group, proxy_info.proxy_server(),
122 ssl_config_for_origin, ssl_config_for_proxy);
123
124 ClientSocketPool* pool =
125 session->GetSocketPool(socket_pool_type, proxy_info.proxy_server());
126 ClientSocketPool::RespectLimits respect_limits =
127 ClientSocketPool::RespectLimits::ENABLED;
128 if ((request_load_flags & LOAD_IGNORE_LIMITS) != 0)
129 respect_limits = ClientSocketPool::RespectLimits::DISABLED;
130
131 absl::optional<NetworkTrafficAnnotationTag> proxy_annotation =
132 proxy_info.is_direct() ? absl::nullopt
133 : absl::optional<NetworkTrafficAnnotationTag>(
134 proxy_info.traffic_annotation());
135 if (num_preconnect_streams) {
136 return pool->RequestSockets(connection_group, std::move(socket_params),
137 proxy_annotation, num_preconnect_streams,
138 std::move(callback), net_log);
139 }
140
141 return socket_handle->Init(connection_group, std::move(socket_params),
142 proxy_annotation, request_priority, socket_tag,
143 respect_limits, std::move(callback),
144 proxy_auth_callback, pool, net_log);
145 }
146
147 } // namespace
148
149 ClientSocketPoolManager::ClientSocketPoolManager() = default;
150 ClientSocketPoolManager::~ClientSocketPoolManager() = default;
151
152 // static
max_sockets_per_pool(HttpNetworkSession::SocketPoolType pool_type)153 int ClientSocketPoolManager::max_sockets_per_pool(
154 HttpNetworkSession::SocketPoolType pool_type) {
155 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
156 return g_max_sockets_per_pool[pool_type];
157 }
158
159 // static
set_max_sockets_per_pool(HttpNetworkSession::SocketPoolType pool_type,int socket_count)160 void ClientSocketPoolManager::set_max_sockets_per_pool(
161 HttpNetworkSession::SocketPoolType pool_type,
162 int socket_count) {
163 DCHECK_LT(0, socket_count);
164 DCHECK_GT(1000, socket_count); // Sanity check.
165 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
166 g_max_sockets_per_pool[pool_type] = socket_count;
167 DCHECK_GE(g_max_sockets_per_pool[pool_type],
168 g_max_sockets_per_group[pool_type]);
169 }
170
171 // static
max_sockets_per_group(HttpNetworkSession::SocketPoolType pool_type)172 int ClientSocketPoolManager::max_sockets_per_group(
173 HttpNetworkSession::SocketPoolType pool_type) {
174 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
175 return g_max_sockets_per_group[pool_type];
176 }
177
178 // static
set_max_sockets_per_group(HttpNetworkSession::SocketPoolType pool_type,int socket_count)179 void ClientSocketPoolManager::set_max_sockets_per_group(
180 HttpNetworkSession::SocketPoolType pool_type,
181 int socket_count) {
182 DCHECK_LT(0, socket_count);
183 // The following is a sanity check... but we should NEVER be near this value.
184 DCHECK_GT(100, socket_count);
185 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
186 g_max_sockets_per_group[pool_type] = socket_count;
187
188 DCHECK_GE(g_max_sockets_per_pool[pool_type],
189 g_max_sockets_per_group[pool_type]);
190 DCHECK_GE(g_max_sockets_per_proxy_server[pool_type],
191 g_max_sockets_per_group[pool_type]);
192 }
193
194 // static
max_sockets_per_proxy_server(HttpNetworkSession::SocketPoolType pool_type)195 int ClientSocketPoolManager::max_sockets_per_proxy_server(
196 HttpNetworkSession::SocketPoolType pool_type) {
197 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
198 return g_max_sockets_per_proxy_server[pool_type];
199 }
200
201 // static
set_max_sockets_per_proxy_server(HttpNetworkSession::SocketPoolType pool_type,int socket_count)202 void ClientSocketPoolManager::set_max_sockets_per_proxy_server(
203 HttpNetworkSession::SocketPoolType pool_type,
204 int socket_count) {
205 DCHECK_LT(0, socket_count);
206 DCHECK_GT(100, socket_count); // Sanity check.
207 DCHECK_LT(pool_type, HttpNetworkSession::NUM_SOCKET_POOL_TYPES);
208 // Assert this case early on. The max number of sockets per group cannot
209 // exceed the max number of sockets per proxy server.
210 DCHECK_LE(g_max_sockets_per_group[pool_type], socket_count);
211 g_max_sockets_per_proxy_server[pool_type] = socket_count;
212 }
213
214 // static
unused_idle_socket_timeout(HttpNetworkSession::SocketPoolType pool_type)215 base::TimeDelta ClientSocketPoolManager::unused_idle_socket_timeout(
216 HttpNetworkSession::SocketPoolType pool_type) {
217 return base::Seconds(base::GetFieldTrialParamByFeatureAsInt(
218 net::features::kNetUnusedIdleSocketTimeout,
219 "unused_idle_socket_timeout_seconds", 60));
220 }
221
InitSocketHandleForHttpRequest(url::SchemeHostPort endpoint,int request_load_flags,RequestPriority request_priority,HttpNetworkSession * session,const ProxyInfo & proxy_info,const SSLConfig & ssl_config_for_origin,const SSLConfig & ssl_config_for_proxy,PrivacyMode privacy_mode,NetworkAnonymizationKey network_anonymization_key,SecureDnsPolicy secure_dns_policy,const SocketTag & socket_tag,const NetLogWithSource & net_log,ClientSocketHandle * socket_handle,CompletionOnceCallback callback,const ClientSocketPool::ProxyAuthCallback & proxy_auth_callback)222 int InitSocketHandleForHttpRequest(
223 url::SchemeHostPort endpoint,
224 int request_load_flags,
225 RequestPriority request_priority,
226 HttpNetworkSession* session,
227 const ProxyInfo& proxy_info,
228 const SSLConfig& ssl_config_for_origin,
229 const SSLConfig& ssl_config_for_proxy,
230 PrivacyMode privacy_mode,
231 NetworkAnonymizationKey network_anonymization_key,
232 SecureDnsPolicy secure_dns_policy,
233 const SocketTag& socket_tag,
234 const NetLogWithSource& net_log,
235 ClientSocketHandle* socket_handle,
236 CompletionOnceCallback callback,
237 const ClientSocketPool::ProxyAuthCallback& proxy_auth_callback) {
238 DCHECK(socket_handle);
239 return InitSocketPoolHelper(
240 std::move(endpoint), request_load_flags, request_priority, session,
241 proxy_info, ssl_config_for_origin, ssl_config_for_proxy,
242 false /* is_for_websockets */, privacy_mode,
243 std::move(network_anonymization_key), secure_dns_policy, socket_tag,
244 net_log, 0, socket_handle, HttpNetworkSession::NORMAL_SOCKET_POOL,
245 std::move(callback), proxy_auth_callback);
246 }
247
InitSocketHandleForWebSocketRequest(url::SchemeHostPort endpoint,int request_load_flags,RequestPriority request_priority,HttpNetworkSession * session,const ProxyInfo & proxy_info,const SSLConfig & ssl_config_for_origin,const SSLConfig & ssl_config_for_proxy,PrivacyMode privacy_mode,NetworkAnonymizationKey network_anonymization_key,const NetLogWithSource & net_log,ClientSocketHandle * socket_handle,CompletionOnceCallback callback,const ClientSocketPool::ProxyAuthCallback & proxy_auth_callback)248 int InitSocketHandleForWebSocketRequest(
249 url::SchemeHostPort endpoint,
250 int request_load_flags,
251 RequestPriority request_priority,
252 HttpNetworkSession* session,
253 const ProxyInfo& proxy_info,
254 const SSLConfig& ssl_config_for_origin,
255 const SSLConfig& ssl_config_for_proxy,
256 PrivacyMode privacy_mode,
257 NetworkAnonymizationKey network_anonymization_key,
258 const NetLogWithSource& net_log,
259 ClientSocketHandle* socket_handle,
260 CompletionOnceCallback callback,
261 const ClientSocketPool::ProxyAuthCallback& proxy_auth_callback) {
262 DCHECK(socket_handle);
263
264 // QUIC proxies are currently not supported through this method.
265 DCHECK(!proxy_info.is_quic());
266
267 // Expect websocket schemes (ws and wss) to be converted to the http(s)
268 // equivalent.
269 DCHECK(endpoint.scheme() == url::kHttpScheme ||
270 endpoint.scheme() == url::kHttpsScheme);
271
272 return InitSocketPoolHelper(
273 std::move(endpoint), request_load_flags, request_priority, session,
274 proxy_info, ssl_config_for_origin, ssl_config_for_proxy,
275 true /* is_for_websockets */, privacy_mode,
276 std::move(network_anonymization_key), SecureDnsPolicy::kAllow,
277 SocketTag(), net_log, 0, socket_handle,
278 HttpNetworkSession::WEBSOCKET_SOCKET_POOL, std::move(callback),
279 proxy_auth_callback);
280 }
281
PreconnectSocketsForHttpRequest(url::SchemeHostPort endpoint,int request_load_flags,RequestPriority request_priority,HttpNetworkSession * session,const ProxyInfo & proxy_info,const SSLConfig & ssl_config_for_origin,const SSLConfig & ssl_config_for_proxy,PrivacyMode privacy_mode,NetworkAnonymizationKey network_anonymization_key,SecureDnsPolicy secure_dns_policy,const NetLogWithSource & net_log,int num_preconnect_streams,CompletionOnceCallback callback)282 int PreconnectSocketsForHttpRequest(
283 url::SchemeHostPort endpoint,
284 int request_load_flags,
285 RequestPriority request_priority,
286 HttpNetworkSession* session,
287 const ProxyInfo& proxy_info,
288 const SSLConfig& ssl_config_for_origin,
289 const SSLConfig& ssl_config_for_proxy,
290 PrivacyMode privacy_mode,
291 NetworkAnonymizationKey network_anonymization_key,
292 SecureDnsPolicy secure_dns_policy,
293 const NetLogWithSource& net_log,
294 int num_preconnect_streams,
295 CompletionOnceCallback callback) {
296 // QUIC proxies are currently not supported through this method.
297 DCHECK(!proxy_info.is_quic());
298
299 // Expect websocket schemes (ws and wss) to be converted to the http(s)
300 // equivalent.
301 DCHECK(endpoint.scheme() == url::kHttpScheme ||
302 endpoint.scheme() == url::kHttpsScheme);
303
304 return InitSocketPoolHelper(
305 std::move(endpoint), request_load_flags, request_priority, session,
306 proxy_info, ssl_config_for_origin, ssl_config_for_proxy,
307 false /* force_tunnel */, privacy_mode,
308 std::move(network_anonymization_key), secure_dns_policy, SocketTag(),
309 net_log, num_preconnect_streams, nullptr,
310 HttpNetworkSession::NORMAL_SOCKET_POOL, std::move(callback),
311 ClientSocketPool::ProxyAuthCallback());
312 }
313
314 } // namespace net
315