| | | 1 | | // Licensed to the .NET Foundation under one or more agreements. |
| | | 2 | | // The .NET Foundation licenses this file to you under the MIT license. |
| | | 3 | | |
| | | 4 | | using System.Collections.Concurrent; |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using System.Diagnostics; |
| | | 7 | | using System.Diagnostics.CodeAnalysis; |
| | | 8 | | using System.Net.NetworkInformation; |
| | | 9 | | using System.Runtime.ExceptionServices; |
| | | 10 | | using System.Threading; |
| | | 11 | | using System.Threading.Tasks; |
| | | 12 | | |
| | | 13 | | namespace System.Net.Http |
| | | 14 | | { |
| | | 15 | | // General flow of requests through the various layers: |
| | | 16 | | // |
| | | 17 | | // (1) HttpConnectionPoolManager.SendAsync: Does proxy lookup |
| | | 18 | | // (2) HttpConnectionPoolManager.SendAsyncCore: Find or create connection pool |
| | | 19 | | // (3) HttpConnectionPool.SendAsync: Handle basic/digest request auth |
| | | 20 | | // (4) HttpConnectionPool.SendWithProxyAuthAsync: Handle basic/digest proxy auth |
| | | 21 | | // (5) HttpConnectionPool.SendWithRetryAsync: Retrieve connection from pool, or create new |
| | | 22 | | // Also, handle retry for failures on connection reuse |
| | | 23 | | // (6) HttpConnection.SendAsync: Handle negotiate/ntlm connection auth |
| | | 24 | | // (7) HttpConnection.SendWithNtProxyAuthAsync: Handle negotiate/ntlm proxy auth |
| | | 25 | | // (8) HttpConnection.SendAsyncCore: Write request to connection and read response |
| | | 26 | | // Also, handle cookie processing |
| | | 27 | | // |
| | | 28 | | // Redirect and decompression handling are done above HttpConnectionPoolManager, |
| | | 29 | | // in RedirectHandler and DecompressionHandler respectively. |
| | | 30 | | |
| | | 31 | | /// <summary>Provides a set of connection pools, each for its own endpoint.</summary> |
| | | 32 | | internal sealed class HttpConnectionPoolManager : IDisposable |
| | | 33 | | { |
| | | 34 | | /// <summary>How frequently an operation should be initiated to clean out old pools and connections in those poo |
| | | 35 | | private readonly TimeSpan _cleanPoolTimeout; |
| | | 36 | | /// <summary>The pools, indexed by endpoint.</summary> |
| | | 37 | | private readonly ConcurrentDictionary<HttpConnectionKey, HttpConnectionPool> _pools; |
| | | 38 | | /// <summary>Timer used to initiate cleaning of the pools.</summary> |
| | | 39 | | private readonly Timer? _cleaningTimer; |
| | | 40 | | /// <summary>Heart beat timer currently used for Http2 ping only. Not stopped by <see cref="Dispose"/>; it stops |
| | | 41 | | private readonly Timer? _heartBeatTimer; |
| | | 42 | | |
| | | 43 | | private readonly HttpConnectionSettings _settings; |
| | | 44 | | private readonly IWebProxy? _proxy; |
| | | 45 | | private readonly ICredentials? _proxyCredentials; |
| | | 46 | | |
| | | 47 | | private NetworkChangeCleanup? _networkChangeCleanup; |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Keeps track of whether or not the cleanup timer is running. It helps us avoid the expensive |
| | | 51 | | /// <see cref="ConcurrentDictionary{TKey,TValue}.IsEmpty"/> call. |
| | | 52 | | /// </summary> |
| | | 53 | | private bool _timerIsRunning; |
| | | 54 | | /// <summary>Whether <see cref="Dispose"/> has been called.</summary> |
| | | 55 | | private bool _disposed; |
| | | 56 | | /// <summary>Object used to synchronize access to state in the pool.</summary> |
| | 0 | 57 | | private object SyncObj => _pools; |
| | | 58 | | |
| | | 59 | | /// <summary>Initializes the pools.</summary> |
| | 0 | 60 | | public HttpConnectionPoolManager(HttpConnectionSettings settings) |
| | 0 | 61 | | { |
| | 0 | 62 | | _settings = settings; |
| | 0 | 63 | | _pools = new ConcurrentDictionary<HttpConnectionKey, HttpConnectionPool>(); |
| | | 64 | | |
| | | 65 | | // As an optimization, we can sometimes avoid the overheads associated with |
| | | 66 | | // storing connections. This is possible when we would immediately terminate |
| | | 67 | | // connections anyway due to either the idle timeout or the lifetime being |
| | | 68 | | // set to zero, as in that case the timeout effectively immediately expires. |
| | | 69 | | // However, we can only do such optimizations if we're not also tracking |
| | | 70 | | // connections per server, as we use data in the associated data structures |
| | | 71 | | // to do that tracking. |
| | | 72 | | // Additionally, we should not avoid storing connections if keep-alive ping is configured, |
| | | 73 | | // as the heartbeat timer is needed for ping functionality. |
| | 0 | 74 | | bool avoidStoringConnections = |
| | 0 | 75 | | settings._maxConnectionsPerServer == int.MaxValue && |
| | 0 | 76 | | (settings._pooledConnectionIdleTimeout == TimeSpan.Zero || |
| | 0 | 77 | | settings._pooledConnectionLifetime == TimeSpan.Zero) && |
| | 0 | 78 | | settings._keepAlivePingDelay == Timeout.InfiniteTimeSpan; |
| | | 79 | | |
| | | 80 | | // Start out with the timer not running, since we have no pools. |
| | | 81 | | // When it does run, run it with a frequency based on the idle timeout. |
| | 0 | 82 | | if (!avoidStoringConnections) |
| | 0 | 83 | | { |
| | 0 | 84 | | if (settings._pooledConnectionIdleTimeout == Timeout.InfiniteTimeSpan) |
| | 0 | 85 | | { |
| | | 86 | | const int DefaultScavengeSeconds = 30; |
| | 0 | 87 | | _cleanPoolTimeout = TimeSpan.FromSeconds(DefaultScavengeSeconds); |
| | 0 | 88 | | } |
| | | 89 | | else |
| | 0 | 90 | | { |
| | | 91 | | const int ScavengesPerIdle = 4; |
| | | 92 | | const int MinScavengeSeconds = 1; |
| | 0 | 93 | | TimeSpan timerPeriod = settings._pooledConnectionIdleTimeout / ScavengesPerIdle; |
| | 0 | 94 | | _cleanPoolTimeout = timerPeriod.TotalSeconds >= MinScavengeSeconds ? timerPeriod : TimeSpan.FromSeco |
| | 0 | 95 | | } |
| | | 96 | | |
| | | 97 | | // The connection eviction callback is invoked from this timer. If one is set, make sure the timer |
| | | 98 | | // fires at least this often so eviction decisions happen on a predictable cadence, regardless of |
| | | 99 | | // how large (or infinite) the idle timeout is, which would otherwise drive the period alone. |
| | 0 | 100 | | if (settings._shouldEvictConnection is not null) |
| | 0 | 101 | | { |
| | | 102 | | const int MaxEvictionIntervalSeconds = 5; |
| | 0 | 103 | | if (_cleanPoolTimeout.TotalSeconds > MaxEvictionIntervalSeconds) |
| | 0 | 104 | | { |
| | 0 | 105 | | _cleanPoolTimeout = TimeSpan.FromSeconds(MaxEvictionIntervalSeconds); |
| | 0 | 106 | | } |
| | 0 | 107 | | } |
| | | 108 | | |
| | 0 | 109 | | using (ExecutionContext.SuppressFlow()) // Don't capture the current ExecutionContext and its AsyncLocal |
| | 0 | 110 | | { |
| | | 111 | | // Create the timer. Ensure the Timer has a weak reference to this manager; otherwise, it |
| | | 112 | | // can introduce a cycle that keeps the HttpConnectionPoolManager rooted by the Timer |
| | | 113 | | // implementation until the handler is Disposed (or indefinitely if it's not). |
| | 0 | 114 | | var thisRef = new WeakReference<HttpConnectionPoolManager>(this); |
| | | 115 | | |
| | 0 | 116 | | _cleaningTimer = new Timer(static s => |
| | 0 | 117 | | { |
| | 0 | 118 | | var wr = (WeakReference<HttpConnectionPoolManager>)s!; |
| | 0 | 119 | | if (wr.TryGetTarget(out HttpConnectionPoolManager? thisRef)) |
| | 0 | 120 | | { |
| | 0 | 121 | | thisRef.RemoveStalePools(); |
| | 0 | 122 | | } |
| | 0 | 123 | | }, thisRef, Timeout.Infinite, Timeout.Infinite); |
| | | 124 | | |
| | | 125 | | |
| | | 126 | | // For now heart beat is used only for ping functionality. |
| | 0 | 127 | | if (_settings._keepAlivePingDelay != Timeout.InfiniteTimeSpan) |
| | 0 | 128 | | { |
| | 0 | 129 | | long heartBeatInterval = (long)Math.Max(1000, Math.Min(_settings._keepAlivePingDelay.TotalMillis |
| | | 130 | | |
| | | 131 | | // Unlike the cleaning timer, this one is deliberately not stopped by Dispose. |
| | | 132 | | // Requests that were already in flight keep running after the handler is disposed, |
| | | 133 | | // and they must keep sending keep alive PINGs to detect an unresponsive server. |
| | | 134 | | // Instead, the timer stops itself once the manager has been disposed and has no |
| | | 135 | | // connections left. If the manager becomes unreachable without ever being disposed, |
| | | 136 | | // the timer becomes unreachable with it and is stopped by its own finalizer. |
| | 0 | 137 | | _heartBeatTimer = new Timer(static state => |
| | 0 | 138 | | { |
| | 0 | 139 | | var wr = (WeakReference<HttpConnectionPoolManager>)state!; |
| | 0 | 140 | | if (wr.TryGetTarget(out HttpConnectionPoolManager? manager) && |
| | 0 | 141 | | !manager.HeartBeat() && |
| | 0 | 142 | | manager._disposed) |
| | 0 | 143 | | { |
| | 0 | 144 | | manager._heartBeatTimer?.Dispose(); |
| | 0 | 145 | | } |
| | 0 | 146 | | }, thisRef, heartBeatInterval, heartBeatInterval); |
| | 0 | 147 | | } |
| | 0 | 148 | | } |
| | 0 | 149 | | } |
| | | 150 | | |
| | | 151 | | // Figure out proxy stuff. |
| | 0 | 152 | | if (settings._useProxy) |
| | 0 | 153 | | { |
| | 0 | 154 | | _proxy = settings._proxy ?? HttpClient.DefaultProxy; |
| | 0 | 155 | | if (_proxy != null) |
| | 0 | 156 | | { |
| | 0 | 157 | | _proxyCredentials = _proxy.Credentials ?? settings._defaultProxyCredentials; |
| | 0 | 158 | | } |
| | 0 | 159 | | } |
| | 0 | 160 | | } |
| | | 161 | | |
| | | 162 | | /// <summary> |
| | | 163 | | /// Starts monitoring for network changes. Upon a change, <see cref="HttpConnectionPool.OnNetworkChanged"/> will |
| | | 164 | | /// called for every <see cref="HttpConnectionPool"/> in the <see cref="HttpConnectionPoolManager"/>. |
| | | 165 | | /// </summary> |
| | | 166 | | public void StartMonitoringNetworkChanges() |
| | 0 | 167 | | { |
| | 0 | 168 | | if (_networkChangeCleanup != null) |
| | 0 | 169 | | { |
| | 0 | 170 | | return; |
| | | 171 | | } |
| | | 172 | | |
| | | 173 | | // Monitor network changes to invalidate Alt-Svc headers. |
| | | 174 | | // A weak reference is used to avoid NetworkChange.NetworkAddressChanged keeping a non-disposed connection p |
| | | 175 | | NetworkAddressChangedEventHandler networkChangedDelegate; |
| | 0 | 176 | | { // scope to avoid closure if _networkChangeCleanup != null |
| | 0 | 177 | | var poolsRef = new WeakReference<ConcurrentDictionary<HttpConnectionKey, HttpConnectionPool>>(_pools); |
| | 0 | 178 | | networkChangedDelegate = delegate |
| | 0 | 179 | | { |
| | 0 | 180 | | if (poolsRef.TryGetTarget(out ConcurrentDictionary<HttpConnectionKey, HttpConnectionPool>? pools)) |
| | 0 | 181 | | { |
| | 0 | 182 | | foreach (HttpConnectionPool pool in pools.Values) |
| | 0 | 183 | | { |
| | 0 | 184 | | pool.OnNetworkChanged(); |
| | 0 | 185 | | } |
| | 0 | 186 | | } |
| | 0 | 187 | | }; |
| | 0 | 188 | | } |
| | | 189 | | |
| | 0 | 190 | | var cleanup = new NetworkChangeCleanup(networkChangedDelegate); |
| | | 191 | | |
| | 0 | 192 | | if (Interlocked.CompareExchange(ref _networkChangeCleanup, cleanup, null) != null) |
| | 0 | 193 | | { |
| | | 194 | | // We lost a race, another thread already started monitoring. |
| | 0 | 195 | | GC.SuppressFinalize(cleanup); |
| | 0 | 196 | | return; |
| | | 197 | | } |
| | | 198 | | |
| | | 199 | | // RFC: https://tools.ietf.org/html/rfc7838#section-2.2 |
| | | 200 | | // When alternative services are used to send a client to the most |
| | | 201 | | // optimal server, a change in network configuration can result in |
| | | 202 | | // cached values becoming suboptimal. Therefore, clients SHOULD remove |
| | | 203 | | // from cache all alternative services that lack the "persist" flag with |
| | | 204 | | // the value "1" when they detect such a change, when information about |
| | | 205 | | // network state is available. |
| | | 206 | | try |
| | 0 | 207 | | { |
| | 0 | 208 | | using (ExecutionContext.SuppressFlow()) |
| | 0 | 209 | | { |
| | 0 | 210 | | NetworkChange.NetworkAddressChanged += networkChangedDelegate; |
| | 0 | 211 | | } |
| | 0 | 212 | | } |
| | 0 | 213 | | catch (NetworkInformationException e) |
| | 0 | 214 | | { |
| | 0 | 215 | | if (NetEventSource.Log.IsEnabled()) NetEventSource.Error(this, $"Exception when subscribing to NetworkCh |
| | | 216 | | |
| | | 217 | | // We can't monitor network changes, so technically "information |
| | | 218 | | // about network state is not available" and we can just keep |
| | | 219 | | // all Alt-Svc entries until their expiration time. |
| | | 220 | | // |
| | | 221 | | // keep the _networkChangeCleanup field assigned so we don't try again needlessly |
| | 0 | 222 | | } |
| | 0 | 223 | | } |
| | | 224 | | |
| | | 225 | | private sealed class NetworkChangeCleanup : IDisposable |
| | | 226 | | { |
| | | 227 | | private readonly NetworkAddressChangedEventHandler _handler; |
| | | 228 | | |
| | 0 | 229 | | public NetworkChangeCleanup(NetworkAddressChangedEventHandler handler) |
| | 0 | 230 | | { |
| | 0 | 231 | | _handler = handler; |
| | 0 | 232 | | } |
| | | 233 | | |
| | | 234 | | // If user never disposes the HttpClient, use finalizer to remove from NetworkChange.NetworkAddressChanged. |
| | | 235 | | // _handler will be rooted in NetworkChange, so should be safe to use here. |
| | 0 | 236 | | ~NetworkChangeCleanup() => NetworkChange.NetworkAddressChanged -= _handler; |
| | | 237 | | |
| | | 238 | | public void Dispose() |
| | 0 | 239 | | { |
| | 0 | 240 | | NetworkChange.NetworkAddressChanged -= _handler; |
| | 0 | 241 | | GC.SuppressFinalize(this); |
| | 0 | 242 | | } |
| | | 243 | | } |
| | | 244 | | |
| | 0 | 245 | | public HttpConnectionSettings Settings => _settings; |
| | 0 | 246 | | public ICredentials? ProxyCredentials => _proxyCredentials; |
| | | 247 | | |
| | | 248 | | private HttpConnectionKey GetConnectionKey(HttpRequestMessage request, Uri? proxyUri, bool isProxyConnect) |
| | 0 | 249 | | { |
| | 0 | 250 | | Uri? uri = request.RequestUri; |
| | 0 | 251 | | Debug.Assert(uri != null); |
| | | 252 | | |
| | 0 | 253 | | if (isProxyConnect) |
| | 0 | 254 | | { |
| | 0 | 255 | | Debug.Assert(uri == proxyUri); |
| | 0 | 256 | | return new HttpConnectionKey(HttpConnectionKind.ProxyConnect, uri.IdnHost, uri.Port, null, proxyUri, Get |
| | | 257 | | } |
| | | 258 | | |
| | 0 | 259 | | string? sslHostName = null; |
| | 0 | 260 | | if (HttpUtilities.IsSupportedSecureScheme(uri.Scheme)) |
| | 0 | 261 | | { |
| | 0 | 262 | | string? hostHeader = request.Headers.Host; |
| | 0 | 263 | | if (hostHeader != null) |
| | 0 | 264 | | { |
| | 0 | 265 | | sslHostName = HttpUtilities.ParseHostNameFromHeader(hostHeader); |
| | 0 | 266 | | } |
| | | 267 | | else |
| | 0 | 268 | | { |
| | | 269 | | // No explicit Host header. Use host from uri. |
| | 0 | 270 | | sslHostName = uri.IdnHost; |
| | 0 | 271 | | } |
| | 0 | 272 | | } |
| | | 273 | | |
| | 0 | 274 | | string identity = GetIdentityIfDefaultCredentialsUsed(proxyUri != null ? _settings._defaultCredentialsUsedFo |
| | | 275 | | |
| | 0 | 276 | | if (proxyUri != null) |
| | 0 | 277 | | { |
| | 0 | 278 | | Debug.Assert(HttpUtilities.IsSupportedProxyScheme(proxyUri.Scheme)); |
| | 0 | 279 | | if (HttpUtilities.IsSocksScheme(proxyUri.Scheme)) |
| | 0 | 280 | | { |
| | | 281 | | // Socks proxy |
| | 0 | 282 | | if (sslHostName != null) |
| | 0 | 283 | | { |
| | 0 | 284 | | return new HttpConnectionKey(HttpConnectionKind.SslSocksTunnel, uri.IdnHost, uri.Port, sslHostNa |
| | | 285 | | } |
| | | 286 | | else |
| | 0 | 287 | | { |
| | 0 | 288 | | return new HttpConnectionKey(HttpConnectionKind.SocksTunnel, uri.IdnHost, uri.Port, null, proxyU |
| | | 289 | | } |
| | | 290 | | } |
| | 0 | 291 | | else if (sslHostName == null) |
| | 0 | 292 | | { |
| | | 293 | | // Both non-secure WebSockets (WS) and cleartext HTTP/2 (h2c) need a CONNECT tunnel to the destinati |
| | | 294 | | // because they can't be expressed using the absolute-form request line an HTTP proxy expects. |
| | | 295 | | // h2c is only tunneled when HTTP/2 is required or preferred; requests that allow downgrading to |
| | | 296 | | // HTTP/1.1 (RequestVersionOrLower) keep using the shared HTTP/1.1 proxy pool below. |
| | 0 | 297 | | if (HttpUtilities.IsNonSecureWebSocketScheme(uri.Scheme) || |
| | 0 | 298 | | (request.Version.Major == 2 && request.VersionPolicy != HttpVersionPolicy.RequestVersionOrLower) |
| | 0 | 299 | | { |
| | 0 | 300 | | return new HttpConnectionKey(HttpConnectionKind.ProxyTunnel, uri.IdnHost, uri.Port, null, proxyU |
| | | 301 | | } |
| | | 302 | | else |
| | 0 | 303 | | { |
| | | 304 | | // Standard HTTP proxy usage for non-secure requests |
| | | 305 | | // The destination host and port are ignored here, since these connections |
| | | 306 | | // will be shared across any requests that use the proxy. |
| | 0 | 307 | | return new HttpConnectionKey(HttpConnectionKind.Proxy, null, 0, null, proxyUri, identity); |
| | | 308 | | } |
| | | 309 | | } |
| | | 310 | | else |
| | 0 | 311 | | { |
| | | 312 | | // Tunnel SSL connection through proxy to the destination. |
| | 0 | 313 | | return new HttpConnectionKey(HttpConnectionKind.SslProxyTunnel, uri.IdnHost, uri.Port, sslHostName, |
| | | 314 | | } |
| | | 315 | | } |
| | 0 | 316 | | else if (sslHostName != null) |
| | 0 | 317 | | { |
| | 0 | 318 | | return new HttpConnectionKey(HttpConnectionKind.Https, uri.IdnHost, uri.Port, sslHostName, null, identit |
| | | 319 | | } |
| | | 320 | | else |
| | 0 | 321 | | { |
| | 0 | 322 | | return new HttpConnectionKey(HttpConnectionKind.Http, uri.IdnHost, uri.Port, null, null, identity); |
| | | 323 | | } |
| | 0 | 324 | | } |
| | | 325 | | |
| | | 326 | | // Picks the value of the 'server.address' tag following rules specified in |
| | | 327 | | // https://github.com/open-telemetry/semantic-conventions/blob/728e5d1/docs/http/http-spans.md#http-client-span |
| | | 328 | | // When there is no proxy, we need to prioritize the contents of the Host header. |
| | | 329 | | private static string? GetTelemetryServerAddress(HttpRequestMessage request, HttpConnectionKey key) |
| | 0 | 330 | | { |
| | 0 | 331 | | if (GlobalHttpSettings.MetricsHandler.IsGloballyEnabled || GlobalHttpSettings.DiagnosticsHandler.EnableActiv |
| | 0 | 332 | | { |
| | 0 | 333 | | Uri? uri = request.RequestUri; |
| | 0 | 334 | | Debug.Assert(uri is not null); |
| | | 335 | | |
| | 0 | 336 | | if (key.SslHostName is not null) |
| | 0 | 337 | | { |
| | 0 | 338 | | return key.SslHostName; |
| | | 339 | | } |
| | | 340 | | |
| | 0 | 341 | | if (key.ProxyUri is not null && key.Kind == HttpConnectionKind.Proxy) |
| | 0 | 342 | | { |
| | | 343 | | // In case there is no tunnel, return the proxy address since the connection is shared. |
| | 0 | 344 | | return key.ProxyUri.IdnHost; |
| | | 345 | | } |
| | | 346 | | |
| | 0 | 347 | | string? hostHeader = request.Headers.Host; |
| | 0 | 348 | | return hostHeader is null ? uri.IdnHost : HttpUtilities.ParseHostNameFromHeader(hostHeader); |
| | | 349 | | } |
| | | 350 | | |
| | 0 | 351 | | return null; |
| | 0 | 352 | | } |
| | | 353 | | |
| | | 354 | | public ValueTask<HttpResponseMessage> SendAsyncCore(HttpRequestMessage request, Uri? proxyUri, bool async, bool |
| | 0 | 355 | | { |
| | 0 | 356 | | HttpConnectionKey key = GetConnectionKey(request, proxyUri, isProxyConnect); |
| | | 357 | | |
| | 0 | 358 | | string? sslHostName = key.SslHostName; |
| | | 359 | | |
| | 0 | 360 | | if (sslHostName is not null && request.IsConnectionPoolPartitioningBySniDisabled()) |
| | 0 | 361 | | { |
| | | 362 | | // The request is using HTTPS, but has opted out of partitioning the connection pool by SNI. |
| | | 363 | | // The connection pool will be shared by requests to the same Uri Host, regardless of the Host header. |
| | | 364 | | // This enables requests where the Uri is set to an IP of shared infrastructure to share connections eve |
| | | 365 | | // This is a dangerous opt-in where the caller is responsible for ensuring that the server certificate i |
| | 0 | 366 | | key = new HttpConnectionKey(key.Kind, key.Host, key.Port, sslHostName: null, key.ProxyUri, key.Identity) |
| | 0 | 367 | | } |
| | | 368 | | |
| | | 369 | | HttpConnectionPool? pool; |
| | 0 | 370 | | while (!_pools.TryGetValue(key, out pool)) |
| | 0 | 371 | | { |
| | 0 | 372 | | pool = new HttpConnectionPool(this, key.Kind, key.Host, key.Port, sslHostName, key.ProxyUri, GetTelemetr |
| | | 373 | | |
| | 0 | 374 | | if (_cleaningTimer == null) |
| | 0 | 375 | | { |
| | | 376 | | // There's no cleaning timer, which means we're not adding connections into pools, but we still need |
| | | 377 | | // the pool object for this request. We don't need or want to add the pool to the pools, though, |
| | | 378 | | // since we don't want it to sit there forever, which it would without the cleaning timer. |
| | 0 | 379 | | break; |
| | | 380 | | } |
| | | 381 | | |
| | 0 | 382 | | if (_pools.TryAdd(key, pool)) |
| | 0 | 383 | | { |
| | | 384 | | // We need to ensure the cleanup timer is running if it isn't |
| | | 385 | | // already now that we added a new connection pool. |
| | 0 | 386 | | lock (SyncObj) |
| | 0 | 387 | | { |
| | 0 | 388 | | if (!_timerIsRunning) |
| | 0 | 389 | | { |
| | 0 | 390 | | SetCleaningTimer(_cleanPoolTimeout); |
| | 0 | 391 | | } |
| | 0 | 392 | | } |
| | 0 | 393 | | break; |
| | | 394 | | } |
| | | 395 | | |
| | | 396 | | // We created a pool and tried to add it to our pools, but some other thread got there before us. |
| | | 397 | | // We don't need to Dispose the pool, as that's only needed when it contains connections |
| | | 398 | | // that need to be closed. |
| | 0 | 399 | | } |
| | | 400 | | |
| | 0 | 401 | | return pool.SendAsync(request, async, doRequestAuth, cancellationToken); |
| | 0 | 402 | | } |
| | | 403 | | |
| | | 404 | | public ValueTask<HttpResponseMessage> SendProxyConnectAsync(HttpRequestMessage request, Uri proxyUri, bool async |
| | 0 | 405 | | { |
| | 0 | 406 | | return SendAsyncCore(request, proxyUri, async, doRequestAuth: false, isProxyConnect: true, cancellationToken |
| | 0 | 407 | | } |
| | | 408 | | |
| | | 409 | | public ValueTask<HttpResponseMessage> SendAsync(HttpRequestMessage request, bool async, bool doRequestAuth, Canc |
| | 0 | 410 | | { |
| | 0 | 411 | | if (_proxy == null) |
| | 0 | 412 | | { |
| | 0 | 413 | | return SendAsyncCore(request, null, async, doRequestAuth, isProxyConnect: false, cancellationToken); |
| | | 414 | | } |
| | | 415 | | |
| | | 416 | | // Do proxy lookup. |
| | 0 | 417 | | Uri? proxyUri = null; |
| | | 418 | | try |
| | 0 | 419 | | { |
| | 0 | 420 | | Debug.Assert(request.RequestUri != null); |
| | 0 | 421 | | if (!_proxy.IsBypassed(request.RequestUri)) |
| | 0 | 422 | | { |
| | 0 | 423 | | if (_proxy is IMultiWebProxy multiWebProxy) |
| | 0 | 424 | | { |
| | 0 | 425 | | MultiProxy multiProxy = multiWebProxy.GetMultiProxy(request.RequestUri); |
| | | 426 | | |
| | 0 | 427 | | if (multiProxy.ReadNext(out proxyUri, out bool isFinalProxy) && !isFinalProxy) |
| | 0 | 428 | | { |
| | 0 | 429 | | return SendAsyncMultiProxy(request, async, doRequestAuth, multiProxy, proxyUri, cancellation |
| | | 430 | | } |
| | 0 | 431 | | } |
| | | 432 | | else |
| | 0 | 433 | | { |
| | 0 | 434 | | proxyUri = _proxy.GetProxy(request.RequestUri); |
| | 0 | 435 | | } |
| | 0 | 436 | | } |
| | 0 | 437 | | } |
| | 0 | 438 | | catch (Exception ex) |
| | 0 | 439 | | { |
| | | 440 | | // Eat any exception from the IWebProxy and just treat it as no proxy. |
| | | 441 | | // This matches the behavior of other handlers. |
| | 0 | 442 | | if (NetEventSource.Log.IsEnabled()) NetEventSource.Error(this, $"Exception from {_proxy.GetType().Name}. |
| | 0 | 443 | | } |
| | | 444 | | |
| | 0 | 445 | | if (proxyUri != null && !HttpUtilities.IsSupportedProxyScheme(proxyUri.Scheme)) |
| | 0 | 446 | | { |
| | 0 | 447 | | throw new NotSupportedException(SR.net_http_invalid_proxy_scheme); |
| | | 448 | | } |
| | | 449 | | |
| | 0 | 450 | | return SendAsyncCore(request, proxyUri, async, doRequestAuth, isProxyConnect: false, cancellationToken); |
| | 0 | 451 | | } |
| | | 452 | | |
| | | 453 | | /// <summary> |
| | | 454 | | /// Iterates a request over a set of proxies until one works, or all proxies have failed. |
| | | 455 | | /// </summary> |
| | | 456 | | /// <param name="request">The request message.</param> |
| | | 457 | | /// <param name="async">Whether to execute the request synchronously or asynchronously.</param> |
| | | 458 | | /// <param name="doRequestAuth">Whether to perform request authentication.</param> |
| | | 459 | | /// <param name="multiProxy">The set of proxies to use.</param> |
| | | 460 | | /// <param name="firstProxy">The first proxy try.</param> |
| | | 461 | | /// <param name="cancellationToken">The cancellation token to use for the operation.</param> |
| | | 462 | | private async ValueTask<HttpResponseMessage> SendAsyncMultiProxy(HttpRequestMessage request, bool async, bool do |
| | 0 | 463 | | { |
| | | 464 | | HttpRequestException rethrowException; |
| | | 465 | | |
| | | 466 | | // Save the original ProxyAuthorization header value so we can restore it when retrying with a different pro |
| | | 467 | | // This ensures that any proxy credentials set from the credential cache during a failed attempt are cleared |
| | | 468 | | // before trying the next proxy, while preserving any user-set credentials. |
| | 0 | 469 | | Headers.AuthenticationHeaderValue? originalProxyAuthorization = request.Headers.ProxyAuthorization; |
| | | 470 | | |
| | | 471 | | do |
| | 0 | 472 | | { |
| | | 473 | | try |
| | 0 | 474 | | { |
| | 0 | 475 | | return await SendAsyncCore(request, firstProxy, async, doRequestAuth, isProxyConnect: false, cancell |
| | | 476 | | } |
| | 0 | 477 | | catch (HttpRequestException ex) when (ex.AllowRetry != RequestRetryType.NoRetry) |
| | 0 | 478 | | { |
| | 0 | 479 | | rethrowException = ex; |
| | | 480 | | |
| | | 481 | | // Clear any proxy-auth credentials that were set from the proxy credential cache for the previous p |
| | | 482 | | // Restore the original value before retrying with the next proxy. |
| | 0 | 483 | | request.Headers.ProxyAuthorization = originalProxyAuthorization; |
| | 0 | 484 | | } |
| | 0 | 485 | | } |
| | 0 | 486 | | while (multiProxy.ReadNext(out firstProxy, out _)); |
| | | 487 | | |
| | 0 | 488 | | ExceptionDispatchInfo.Throw(rethrowException); |
| | | 489 | | return null; // should never be reached: VS doesn't realize Throw() never returns. |
| | 0 | 490 | | } |
| | | 491 | | |
| | | 492 | | /// <summary>Disposes of the pools, disposing of each individual pool.</summary> |
| | | 493 | | public void Dispose() |
| | 0 | 494 | | { |
| | 0 | 495 | | _disposed = true; |
| | 0 | 496 | | _cleaningTimer?.Dispose(); |
| | 0 | 497 | | foreach (KeyValuePair<HttpConnectionKey, HttpConnectionPool> pool in _pools) |
| | 0 | 498 | | { |
| | 0 | 499 | | pool.Value.Dispose(); |
| | 0 | 500 | | } |
| | | 501 | | |
| | 0 | 502 | | _networkChangeCleanup?.Dispose(); |
| | 0 | 503 | | } |
| | | 504 | | |
| | | 505 | | /// <summary>Sets <see cref="_cleaningTimer"/> and <see cref="_timerIsRunning"/> based on the specified timeout. |
| | | 506 | | private void SetCleaningTimer(TimeSpan timeout) |
| | 0 | 507 | | { |
| | 0 | 508 | | if (_cleaningTimer!.Change(timeout, Timeout.InfiniteTimeSpan)) |
| | 0 | 509 | | { |
| | 0 | 510 | | _timerIsRunning = timeout != Timeout.InfiniteTimeSpan; |
| | 0 | 511 | | } |
| | 0 | 512 | | } |
| | | 513 | | |
| | | 514 | | /// <summary>Removes unusable connections from each pool, and removes stale pools entirely.</summary> |
| | | 515 | | private void RemoveStalePools() |
| | 0 | 516 | | { |
| | 0 | 517 | | Debug.Assert(_cleaningTimer != null); |
| | | 518 | | |
| | | 519 | | // Iterate through each pool in the set of pools. For each, ask it to clear out |
| | | 520 | | // any unusable connections (e.g. those which have expired, those which have been closed, etc.) |
| | | 521 | | // The pool may detect that it's empty and long unused, in which case it'll dispose of itself, |
| | | 522 | | // such that any connections returned to the pool to be cached will be disposed of. In such |
| | | 523 | | // a case, we also remove the pool from the set of pools to avoid a leak. |
| | 0 | 524 | | foreach (KeyValuePair<HttpConnectionKey, HttpConnectionPool> entry in _pools) |
| | 0 | 525 | | { |
| | 0 | 526 | | if (entry.Value.CleanCacheAndDisposeIfUnused()) |
| | 0 | 527 | | { |
| | 0 | 528 | | _pools.TryRemove(entry.Key, out _); |
| | 0 | 529 | | } |
| | 0 | 530 | | } |
| | | 531 | | |
| | | 532 | | // Restart the timer if we have any pools to clean up. |
| | 0 | 533 | | lock (SyncObj) |
| | 0 | 534 | | { |
| | 0 | 535 | | SetCleaningTimer(!_pools.IsEmpty ? _cleanPoolTimeout : Timeout.InfiniteTimeSpan); |
| | 0 | 536 | | } |
| | | 537 | | |
| | | 538 | | // NOTE: There is a possible race condition with regards to a pool getting cleaned up at the same |
| | | 539 | | // time it's about to be used for another request. The timer cleanup could start running, see that |
| | | 540 | | // a pool is empty, and initiate its disposal. Concurrently, the pools could hand out the pool |
| | | 541 | | // to a request looking to get a connection, because the pool may not have been removed yet |
| | | 542 | | // from the pools. Worst case here is that connection will end up getting returned to an |
| | | 543 | | // already disposed pool, in which case the connection will also end up getting disposed rather |
| | | 544 | | // than reused. This should be a rare occurrence, so for now we don't worry about it. In the |
| | | 545 | | // future, there are a variety of possible ways to address it, such as allowing connections to |
| | | 546 | | // be returned to pools they weren't associated with. |
| | 0 | 547 | | } |
| | | 548 | | |
| | | 549 | | /// <summary>Sends keep alive PINGs on all pooled connections, and reports whether any connections remain.</summ |
| | | 550 | | private bool HeartBeat() |
| | 0 | 551 | | { |
| | 0 | 552 | | bool anyLiveConnections = false; |
| | | 553 | | |
| | 0 | 554 | | foreach (KeyValuePair<HttpConnectionKey, HttpConnectionPool> pool in _pools) |
| | 0 | 555 | | { |
| | 0 | 556 | | anyLiveConnections |= pool.Value.HeartBeat(); |
| | 0 | 557 | | } |
| | | 558 | | |
| | 0 | 559 | | return anyLiveConnections; |
| | 0 | 560 | | } |
| | | 561 | | |
| | | 562 | | private static string GetIdentityIfDefaultCredentialsUsed(bool defaultCredentialsUsed) |
| | 0 | 563 | | { |
| | 0 | 564 | | return defaultCredentialsUsed ? CurrentUserIdentityProvider.GetIdentity() : string.Empty; |
| | 0 | 565 | | } |
| | | 566 | | |
| | | 567 | | internal readonly struct HttpConnectionKey : IEquatable<HttpConnectionKey> |
| | | 568 | | { |
| | | 569 | | public readonly HttpConnectionKind Kind; |
| | | 570 | | public readonly string? Host; |
| | | 571 | | public readonly int Port; |
| | | 572 | | public readonly string? SslHostName; // null if not SSL |
| | | 573 | | public readonly Uri? ProxyUri; |
| | | 574 | | public readonly string Identity; |
| | | 575 | | |
| | | 576 | | public HttpConnectionKey(HttpConnectionKind kind, string? host, int port, string? sslHostName, Uri? proxyUri |
| | 0 | 577 | | { |
| | 0 | 578 | | Kind = kind; |
| | 0 | 579 | | Host = host; |
| | 0 | 580 | | Port = port; |
| | 0 | 581 | | SslHostName = sslHostName; |
| | 0 | 582 | | ProxyUri = proxyUri; |
| | 0 | 583 | | Identity = identity; |
| | 0 | 584 | | } |
| | | 585 | | |
| | | 586 | | // In the common case, SslHostName (when present) is equal to Host. If so, don't include in hash. |
| | | 587 | | public override int GetHashCode() => |
| | 0 | 588 | | (SslHostName == Host ? |
| | 0 | 589 | | HashCode.Combine(Kind, Host, Port, ProxyUri, Identity) : |
| | 0 | 590 | | HashCode.Combine(Kind, Host, Port, SslHostName, ProxyUri, Identity)); |
| | | 591 | | |
| | | 592 | | public override bool Equals([NotNullWhen(true)] object? obj) => |
| | 0 | 593 | | obj is HttpConnectionKey hck && |
| | 0 | 594 | | Equals(hck); |
| | | 595 | | |
| | | 596 | | public bool Equals(HttpConnectionKey other) => |
| | 0 | 597 | | Kind == other.Kind && |
| | 0 | 598 | | Host == other.Host && |
| | 0 | 599 | | Port == other.Port && |
| | 0 | 600 | | ProxyUri == other.ProxyUri && |
| | 0 | 601 | | SslHostName == other.SslHostName && |
| | 0 | 602 | | Identity == other.Identity; |
| | | 603 | | } |
| | | 604 | | } |
| | | 605 | | } |
| | | 606 | | |