mcs/class/System/System.Net/ServicePointManager.cs

   1 //
   2 // System.Net.ServicePointManager
   3 //
   4 // Authors:
   5 //   Lawrence Pit (loz@cable.a2000.nl)
   6 //   Gonzalo Paniagua Javier (gonzalo@novell.com)
   7 //
   8 // Copyright (c) 2003-2010 Novell, Inc (http://www.novell.com)
   9 //
  10
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 using System;
  33 using System.Threading;
  34 using System.Collections;
  35 using System.Collections.Generic;
  36 using System.Collections.Specialized;
  37 using System.Configuration;
  38 using System.Net.Configuration;
  39 using System.Security.Cryptography.X509Certificates;
  40
  41 using System.Globalization;
  42 using System.Net.Security;
  43 using System.Diagnostics;
  44
  45 //
  46 // notes:
  47 // A service point manager manages service points (duh!).
  48 // A service point maintains a list of connections (per scheme + authority).
  49 // According to HttpWebRequest.ConnectionGroupName each connection group
  50 // creates additional connections. therefor, a service point has a hashtable
  51 // of connection groups where each value is a list of connections.
  52 //
  53 // when we need to make an HttpWebRequest, we need to do the following:
  54 // 1. find service point, given Uri and Proxy
  55 // 2. find connection group, given service point and group name
  56 // 3. find free connection in connection group, or create one (if ok due to limits)
  57 // 4. lease connection
  58 // 5. execute request
  59 // 6. when finished, return connection
  60 //
  61
  62
  63 namespace System.Net
  64 {
  65         public partial class ServicePointManager {
  66                 class SPKey {
  67                         Uri uri; // schema/host/port
  68                         Uri proxy;
  69                         bool use_connect;
  70
  71                         public SPKey (Uri uri, Uri proxy, bool use_connect) {
  72                                 this.uri = uri;
  73                                 this.proxy = proxy;
  74                                 this.use_connect = use_connect;
  75                         }
  76
  77                         public Uri Uri {
  78                                 get { return uri; }
  79                         }
  80
  81                         public bool UseConnect {
  82                                 get { return use_connect; }
  83                         }
  84
  85                         public bool UsesProxy {
  86                                 get { return proxy != null; }
  87                         }
  88
  89                         public override int GetHashCode () {
  90                                 int hash = 23;
  91                                 hash = hash * 31 + ((use_connect) ? 1 : 0);
  92                                 hash = hash * 31 + uri.GetHashCode ();
  93                                 hash = hash * 31 + (proxy != null ? proxy.GetHashCode () : 0);
  94                                 return hash;
  95                         }
  96
  97                         public override bool Equals (object obj) {
  98                                 SPKey other = obj as SPKey;
  99                                 if (obj == null) {
 100                                         return false;
 101                                 }
 102
 103                                 if (!uri.Equals (other.uri))
 104                                         return false;
 105                                 if (use_connect != other.use_connect || UsesProxy != other.UsesProxy)
 106                                         return false;
 107                                 if (UsesProxy && !proxy.Equals (other.proxy))
 108                                         return false;
 109                                 return true;
 110                         }
 111                 }
 112
 113                 private static HybridDictionary servicePoints = new HybridDictionary ();
 114
 115                 // Static properties
 116
 117                 private static ICertificatePolicy policy = new DefaultCertificatePolicy ();
 118                 private static int defaultConnectionLimit = DefaultPersistentConnectionLimit;
 119                 private static int maxServicePointIdleTime = 100000; // 100 seconds
 120                 private static int maxServicePoints = 0;
 121                 private static int dnsRefreshTimeout = 2 * 60 * 1000;
 122                 private static bool _checkCRL = false;
 123                 private static SecurityProtocolType _securityProtocol = SecurityProtocolType.Ssl3 | SecurityProtocolType.Tls;
 124
 125                 static bool expectContinue = true;
 126                 static bool useNagle;
 127                 static ServerCertValidationCallback server_cert_cb;
 128                 static bool tcp_keepalive;
 129                 static int tcp_keepalive_time;
 130                 static int tcp_keepalive_interval;
 131
 132                 // Fields
 133
 134                 public const int DefaultNonPersistentConnectionLimit = 4;
 135 #if MONOTOUCH
 136                 public const int DefaultPersistentConnectionLimit = 10;
 137 #else
 138                 public const int DefaultPersistentConnectionLimit = 2;
 139 #endif
 140
 141 #if !NET_2_1
 142                 const string configKey = "system.net/connectionManagement";
 143                 static ConnectionManagementData manager;
 144 #endif
 145
 146                 static ServicePointManager ()
 147                 {
 148 #if !NET_2_1
 149 #if CONFIGURATION_DEP
 150                         object cfg = ConfigurationManager.GetSection (configKey);
 151                         ConnectionManagementSection s = cfg as ConnectionManagementSection;
 152                         if (s != null) {
 153                                 manager = new ConnectionManagementData (null);
 154                                 foreach (ConnectionManagementElement e in s.ConnectionManagement)
 155                                         manager.Add (e.Address, e.MaxConnection);
 156
 157                                 defaultConnectionLimit = (int) manager.GetMaxConnections ("*");
 158                                 return;
 159                         }
 160 #endif
 161                         manager = (ConnectionManagementData) ConfigurationSettings.GetConfig (configKey);
 162                         if (manager != null) {
 163                                 defaultConnectionLimit = (int) manager.GetMaxConnections ("*");
 164                         }
 165 #endif
 166                 }
 167
 168                 // Constructors
 169                 private ServicePointManager ()
 170                 {
 171                 }
 172
 173                 // Properties
 174
 175                 [Obsolete ("Use ServerCertificateValidationCallback instead", false)]
 176                 public static ICertificatePolicy CertificatePolicy {
 177                         get { return policy; }
 178                         set { policy = value; }
 179                 }
 180
 181                 internal static ICertificatePolicy GetLegacyCertificatePolicy ()
 182                 {
 183                         return policy;
 184                 }
 185
 186                 [MonoTODO("CRL checks not implemented")]
 187                 public static bool CheckCertificateRevocationList {
 188                         get { return _checkCRL; }
 189                         set { _checkCRL = false; }      // TODO - don't yet accept true
 190                 }
 191
 192                 public static int DefaultConnectionLimit {
 193                         get { return defaultConnectionLimit; }
 194                         set {
 195                                 if (value <= 0)
 196                                         throw new ArgumentOutOfRangeException ("value");
 197
 198                                 defaultConnectionLimit = value;
 199 #if !NET_2_1
 200                 if (manager != null)
 201                                         manager.Add ("*", defaultConnectionLimit);
 202 #endif
 203                         }
 204                 }
 205
 206                 static Exception GetMustImplement ()
 207                 {
 208                         return new NotImplementedException ();
 209                 }
 210
 211                 public static int DnsRefreshTimeout
 212                 {
 213                         get {
 214                                 return dnsRefreshTimeout;
 215                         }
 216                         set {
 217                                 dnsRefreshTimeout = Math.Max (-1, value);
 218                         }
 219                 }
 220
 221                 [MonoTODO]
 222                 public static bool EnableDnsRoundRobin
 223                 {
 224                         get {
 225                                 throw GetMustImplement ();
 226                         }
 227                         set {
 228                                 throw GetMustImplement ();
 229                         }
 230                 }
 231
 232                 public static int MaxServicePointIdleTime {
 233                         get {
 234                                 return maxServicePointIdleTime;
 235                         }
 236                         set {
 237                                 if (value < -2 || value > Int32.MaxValue)
 238                                         throw new ArgumentOutOfRangeException ("value");
 239                                 maxServicePointIdleTime = value;
 240                         }
 241                 }
 242
 243                 public static int MaxServicePoints {
 244                         get {
 245                                 return maxServicePoints;
 246                         }
 247                         set {
 248                                 if (value < 0)
 249                                         throw new ArgumentException ("value");
 250
 251                                 maxServicePoints = value;
 252                         }
 253                 }
 254
 255                 public static SecurityProtocolType SecurityProtocol {
 256                         get { return _securityProtocol; }
 257                         set { _securityProtocol = value; }
 258                 }
 259
 260                 internal static ServerCertValidationCallback ServerCertValidationCallback {
 261                         get { return server_cert_cb; }
 262                 }
 263
 264                 public static RemoteCertificateValidationCallback ServerCertificateValidationCallback {
 265                         get {
 266                                 if (server_cert_cb == null)
 267                                         return null;
 268                                 return server_cert_cb.ValidationCallback;
 269                         }
 270                         set
 271                         {
 272                                 if (value == null)
 273                                         server_cert_cb = null;
 274                                 else
 275                                         server_cert_cb = new ServerCertValidationCallback (value);
 276                         }
 277                 }
 278
 279                 public static bool Expect100Continue {
 280                         get { return expectContinue; }
 281                         set { expectContinue = value; }
 282                 }
 283
 284                 public static bool UseNagleAlgorithm {
 285                         get { return useNagle; }
 286                         set { useNagle = value; }
 287                 }
 288
 289                 internal static bool DisableStrongCrypto {
 290                         get { return false; }
 291                 }
 292
 293                 // Methods
 294                 public static void SetTcpKeepAlive (bool enabled, int keepAliveTime, int keepAliveInterval)
 295                 {
 296                         if (enabled) {
 297                                 if (keepAliveTime <= 0)
 298                                         throw new ArgumentOutOfRangeException ("keepAliveTime", "Must be greater than 0");
 299                                 if (keepAliveInterval <= 0)
 300                                         throw new ArgumentOutOfRangeException ("keepAliveInterval", "Must be greater than 0");
 301                         }
 302
 303                         tcp_keepalive = enabled;
 304                         tcp_keepalive_time = keepAliveTime;
 305                         tcp_keepalive_interval = keepAliveInterval;
 306                 }
 307
 308                 public static ServicePoint FindServicePoint (Uri address)
 309                 {
 310                         return FindServicePoint (address, GlobalProxySelection.Select);
 311                 }
 312
 313                 public static ServicePoint FindServicePoint (string uriString, IWebProxy proxy)
 314                 {
 315                         return FindServicePoint (new Uri(uriString), proxy);
 316                 }
 317
 318                 public static ServicePoint FindServicePoint (Uri address, IWebProxy proxy)
 319                 {
 320                         if (address == null)
 321                                 throw new ArgumentNullException ("address");
 322
 323                         var origAddress = new Uri (address.Scheme + "://" + address.Authority);
 324
 325                         bool usesProxy = false;
 326                         bool useConnect = false;
 327                         if (proxy != null && !proxy.IsBypassed(address)) {
 328                                 usesProxy = true;
 329                                 bool isSecure = address.Scheme == "https";
 330                                 address = proxy.GetProxy (address);
 331                                 if (address.Scheme != "http" && !isSecure)
 332                                         throw new NotSupportedException ("Proxy scheme not supported.");
 333
 334                                 if (isSecure && address.Scheme == "http")
 335                                         useConnect = true;
 336                         }
 337
 338                         address = new Uri (address.Scheme + "://" + address.Authority);
 339
 340                         ServicePoint sp = null;
 341                         SPKey key = new SPKey (origAddress, usesProxy ? address : null, useConnect);
 342                         lock (servicePoints) {
 343                                 sp = servicePoints [key] as ServicePoint;
 344                                 if (sp != null)
 345                                         return sp;
 346
 347                                 if (maxServicePoints > 0 && servicePoints.Count >= maxServicePoints)
 348                                         throw new InvalidOperationException ("maximum number of service points reached");
 349
 350                                 int limit;
 351 #if NET_2_1
 352                                 limit = defaultConnectionLimit;
 353 #else
 354                                 string addr = address.ToString ();
 355                                 limit = (int) manager.GetMaxConnections (addr);
 356 #endif
 357                                 sp = new ServicePoint (address, limit, maxServicePointIdleTime);
 358                                 sp.Expect100Continue = expectContinue;
 359                                 sp.UseNagleAlgorithm = useNagle;
 360                                 sp.UsesProxy = usesProxy;
 361                                 sp.UseConnect = useConnect;
 362                                 sp.SetTcpKeepAlive (tcp_keepalive, tcp_keepalive_time, tcp_keepalive_interval);
 363                                 servicePoints.Add (key, sp);
 364                         }
 365
 366                         return sp;
 367                 }
 368
 369                 internal static void CloseConnectionGroup (string connectionGroupName)
 370                 {
 371                         lock (servicePoints) {
 372                                 foreach (ServicePoint sp in servicePoints.Values) {
 373                                         sp.CloseConnectionGroup (connectionGroupName);
 374                                 }
 375                         }
 376                 }
 377         }
 378 }
 379