mcs/class/System/System.Net/IPAddress.cs

   1 //
   2 // System.Net.IPAddress.cs
   3 //
   4 // Author:
   5 //   Miguel de Icaza (miguel@ximian.com)
   6 //   Lawrence Pit (loz@cable.a2000.nl)
   7 //
   8 // (C) Ximian, Inc.  http://www.ximian.com
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29
  30 using System;
  31 using System.Globalization;
  32 using System.Net.Sockets;
  33 using System.Runtime.InteropServices;
  34
  35 namespace System.Net {
  36
  37         /// <remarks>
  38         ///   Encapsulates an IP Address.
  39         /// </remarks>
  40         [Serializable]
  41         public class IPAddress {
  42                 // Don't change the name of this field without also
  43                 // changing socket-io.c in the runtime
  44                 // The IP address is stored in little-endian order inside the int,
  45                 // meaning the lower order bytes contain the netid
  46                 private long m_Address;
  47                 private AddressFamily m_Family;
  48                 private ushort[] m_Numbers;     /// ip6 Stored in network order (as ip4)
  49                 private long m_ScopeId;
  50
  51                 public static readonly IPAddress Any = new IPAddress(0);
  52                 public static readonly IPAddress Broadcast = IPAddress.Parse ("255.255.255.255");
  53                 public static readonly IPAddress Loopback = IPAddress.Parse ("127.0.0.1");
  54                 public static readonly IPAddress None = IPAddress.Parse ("255.255.255.255");
  55                 public static readonly IPAddress IPv6Any = IPAddress.ParseIPV6 ("::");
  56                 public static readonly IPAddress IPv6Loopback = IPAddress.ParseIPV6 ("::1");
  57                 public static readonly IPAddress IPv6None = IPAddress.ParseIPV6 ("::");
  58
  59                 private static short SwapShort (short number)
  60                 {
  61                         return (short) ( ((number >> 8) & 0xFF) | ((number << 8) & 0xFF00) );
  62                 }
  63
  64                 private static int SwapInt (int number)
  65                 {
  66                         return (((number >> 24) & 0xFF)
  67                                   | ((number >> 08) & 0xFF00)
  68                                   | ((number << 08) & 0xFF0000)
  69                                   | ((number << 24)));
  70                 }
  71
  72                 private static long SwapLong(long number)
  73                 {
  74                         return (((number >> 56) & 0xFF)
  75                                   | ((number >> 40) & 0xFF00)
  76                                   | ((number >> 24) & 0xFF0000)
  77                                   | ((number >> 08) & 0xFF000000)
  78                                   | ((number << 08) & 0xFF00000000)
  79                                   | ((number << 24) & 0xFF0000000000)
  80                                   | ((number << 40) & 0xFF000000000000)
  81                                   | ((number << 56)));
  82                 }
  83
  84                 public static short HostToNetworkOrder(short host) {
  85                         if (!BitConverter.IsLittleEndian)
  86                                 return(host);
  87
  88                         return SwapShort (host);
  89                 }
  90
  91                 public static int HostToNetworkOrder(int host) {
  92                         if (!BitConverter.IsLittleEndian)
  93                                 return(host);
  94
  95                         return SwapInt (host);
  96                 }
  97
  98                 public static long HostToNetworkOrder(long host) {
  99                         if (!BitConverter.IsLittleEndian)
 100                                 return(host);
 101
 102                         return SwapLong (host);
 103                 }
 104
 105                 public static short NetworkToHostOrder(short network) {
 106                         if (!BitConverter.IsLittleEndian)
 107                                 return(network);
 108
 109                         return SwapShort (network);
 110                 }
 111
 112                 public static int NetworkToHostOrder(int network) {
 113                         if (!BitConverter.IsLittleEndian)
 114                                 return(network);
 115
 116                         return SwapInt (network);
 117                 }
 118
 119                 public static long NetworkToHostOrder(long network) {
 120                         if (!BitConverter.IsLittleEndian)
 121                                 return(network);
 122
 123                         return SwapLong (network);
 124                 }
 125
 126                 /// <summary>
 127                 ///   Constructor from a 32-bit constant with the address bytes in
 128                 ///   little-endian order (the lower order bytes contain the netid)
 129                 /// </summary>
 130                 public IPAddress (long newAddress)
 131                 {
 132                         m_Address = newAddress;
 133                         m_Family = AddressFamily.InterNetwork;
 134                 }
 135
 136                 public IPAddress (byte[] address)
 137                 {
 138                         if (address == null)
 139                                 throw new ArgumentNullException ("address");
 140
 141                         int len = address.Length;
 142
 143                         if (len != 16 && len != 4)
 144                                 throw new ArgumentException ("An invalid IP address was specified.",
 145                                         "address");
 146
 147                         if (len == 16) {
 148                                 m_Numbers = new ushort [8];
 149                                 Buffer.BlockCopy(address, 0, m_Numbers, 0, 16);
 150                                 m_Family = AddressFamily.InterNetworkV6;
 151                                 m_ScopeId = 0;
 152                         } else {
 153                                 m_Address = ((uint) address [3] << 24) + (address [2] << 16) +
 154                                         (address [1] << 8) + address [0];
 155                                 m_Family = AddressFamily.InterNetwork;
 156                         }
 157                 }
 158
 159                 public IPAddress(byte[] address, long scopeid)
 160                 {
 161                         if (address == null)
 162                                 throw new ArgumentNullException ("address");
 163
 164                         if (address.Length != 16)
 165                                 throw new ArgumentException ("An invalid IP address was specified.",
 166                                         "address");
 167
 168                         m_Numbers = new ushort [8];
 169                         Buffer.BlockCopy(address, 0, m_Numbers, 0, 16);
 170                         m_Family = AddressFamily.InterNetworkV6;
 171                         m_ScopeId = scopeid;
 172                 }
 173
 174                 internal IPAddress(ushort[] address, long scopeId)
 175                 {
 176                         m_Numbers = address;
 177
 178                         for(int i=0; i<8; i++)
 179                                 m_Numbers[i] = (ushort)HostToNetworkOrder((short)m_Numbers[i]);
 180
 181                         m_Family = AddressFamily.InterNetworkV6;
 182                         m_ScopeId = scopeId;
 183                 }
 184
 185                 public static IPAddress Parse (string ipString)
 186                 {
 187                         IPAddress ret;
 188                         if (TryParse (ipString, out ret))
 189                                 return ret;
 190                         throw new FormatException ("An invalid IP address was specified.");
 191                 }
 192
 193                 public static bool TryParse (string ipString, out IPAddress address)
 194                 {
 195                         if (ipString == null)
 196                                 throw new ArgumentNullException ("ipString");
 197
 198                         if ((address = ParseIPV4 (ipString)) == null)
 199                                 if ((address = ParseIPV6 (ipString)) == null)
 200                                         return false;
 201                         return true;
 202                 }
 203
 204                 private static IPAddress ParseIPV4 (string ip)
 205                 {
 206
 207                         int pos = ip.IndexOf (' ');
 208                         if (pos != -1) {
 209                                 string [] nets = ip.Substring (pos + 1).Split (new char [] {'.'});
 210                                 if (nets.Length > 0) {
 211                                         string lastNet = nets [nets.Length - 1];
 212                                         if (lastNet.Length == 0)
 213                                                 return null;
 214                                         foreach (char c in lastNet)
 215                                                 if (!Uri.IsHexDigit (c))
 216                                                         return null;
 217                                 }
 218                                 ip = ip.Substring (0, pos);
 219                         }
 220
 221                         if (ip.Length == 0 || ip [ip.Length - 1] == '.')
 222                                 return null;
 223
 224                         string [] ips = ip.Split (new char [] {'.'});
 225                         if (ips.Length > 4)
 226                                 return null;
 227
 228                         // Make the number in network order
 229                         try {
 230                                 long a = 0;
 231                                 long val = 0;
 232                                 for (int i = 0; i < ips.Length; i++) {
 233                                         string subnet = ips [i];
 234                                         if ((3 <= subnet.Length && subnet.Length <= 4) &&
 235                                             (subnet [0] == '0') && (subnet [1] == 'x' || subnet [1] == 'X')) {
 236                                                 if (subnet.Length == 3)
 237                                                         val = (byte) Uri.FromHex (subnet [2]);
 238                                                 else
 239                                                         val = (byte) ((Uri.FromHex (subnet [2]) << 4) | Uri.FromHex (subnet [3]));
 240                                         } else if (subnet.Length == 0)
 241                                                 return null;
 242                                         else if (subnet [0] == '0') {
 243                                                 // octal
 244                                                 val = 0;
 245                                                 for (int j = 1; j < subnet.Length; j++) {
 246                                                         if ('0' <= subnet [j] && subnet [j] <= '7')
 247                                                                 val = (val << 3) + subnet [j] - '0';
 248                                                         else
 249                                                                 return null;
 250                                                 }
 251                                         }
 252                                         else {
 253                                                 if (!Int64.TryParse (subnet, NumberStyles.None, null, out val))
 254                                                         return null;
 255                                         }
 256
 257                                         if (i == (ips.Length - 1)) {
 258                                                 if (i != 0  && val >= (256 << ((3 - i) * 8)))
 259                                                         return null;
 260                                                 else if (val > 0x3fffffffe) // this is the last number that parses correctly with MS
 261                                                         return null;
 262                                                 i = 3;
 263                                         } else if (val >= 0x100)
 264                                                 return null;
 265                                         for (int j = 0; val > 0; j++, val /= 0x100)
 266                                                 a |= (val & 0xFF) << ((i - j) << 3);
 267                                 }
 268
 269                                 return (new IPAddress (a));
 270                         } catch (Exception) {
 271                                 return null;
 272                         }
 273                 }
 274
 275                 private static IPAddress ParseIPV6 (string ip)
 276                 {
 277                         IPv6Address newIPv6Address;
 278
 279                         if (IPv6Address.TryParse(ip, out newIPv6Address))
 280                                 return  new IPAddress (newIPv6Address.Address, newIPv6Address.ScopeId);
 281                         return null;
 282                 }
 283
 284                 [Obsolete("This property is obsolete. Use GetAddressBytes.")]
 285                 public long Address
 286                 {
 287                         get {
 288                                 if(m_Family != AddressFamily.InterNetwork)
 289                                         throw new Exception("The attempted operation is not supported for the type of object referenced");
 290
 291                                 return m_Address;
 292                         }
 293                         set {
 294                                 /* no need to do this test, ms.net accepts any value.
 295                                 if (value < 0 || value > 0x00000000FFFFFFFF)
 296                                         throw new ArgumentOutOfRangeException (
 297                                                 "the address must be between 0 and 0xFFFFFFFF");
 298                                 */
 299
 300                                 if(m_Family != AddressFamily.InterNetwork)
 301                                         throw new Exception("The attempted operation is not supported for the type of object referenced");
 302
 303                                 m_Address = value;
 304                         }
 305                 }
 306
 307                 internal long InternalIPv4Address {
 308                         get { return m_Address; }
 309                 }
 310
 311                 public bool IsIPv6LinkLocal {
 312                         get {
 313                                 if (m_Family == AddressFamily.InterNetwork)
 314                                         return false;
 315                                 int v = NetworkToHostOrder ((short) m_Numbers [0]) & 0xFFF0;
 316                                 return 0xFE80 <= v && v < 0xFEC0;
 317                         }
 318                 }
 319
 320                 public bool IsIPv6SiteLocal {
 321                         get {
 322                                 if (m_Family == AddressFamily.InterNetwork)
 323                                         return false;
 324                                 int v = NetworkToHostOrder ((short) m_Numbers [0]) & 0xFFF0;
 325                                 return 0xFEC0 <= v && v < 0xFF00;
 326                         }
 327                 }
 328
 329                 public bool IsIPv6Multicast {
 330                         get {
 331                                 return m_Family != AddressFamily.InterNetwork &&
 332                                         ((ushort) NetworkToHostOrder ((short) m_Numbers [0]) & 0xFF00) == 0xFF00;
 333                         }
 334                 }
 335
 336 #if NET_4_0
 337                 public bool IsIPv6Teredo {
 338                         get {
 339                                 return m_Family != AddressFamily.InterNetwork &&
 340                                         NetworkToHostOrder ((short) m_Numbers [0]) == 0x2001 &&
 341                                         m_Numbers[1] == 0;
 342                         }
 343                 }
 344 #endif
 345
 346                 public long ScopeId {
 347                         get {
 348                                 if (m_Family != AddressFamily.InterNetworkV6)
 349                                         throw new SocketException ((int) SocketError.OperationNotSupported);
 350
 351                                 return m_ScopeId;
 352                         }
 353                         set {
 354                                 if (m_Family != AddressFamily.InterNetworkV6)
 355                                         throw new SocketException ((int) SocketError.OperationNotSupported);
 356                                 if ((value < 0) || (value > UInt32.MaxValue))
 357                                         throw new ArgumentOutOfRangeException ();
 358
 359                                 m_ScopeId = value;
 360                         }
 361                 }
 362
 363                 public byte [] GetAddressBytes ()
 364                 {
 365                         if(m_Family == AddressFamily.InterNetworkV6) {
 366                                 byte [] addressBytes = new byte [16];
 367                                 Buffer.BlockCopy (m_Numbers, 0, addressBytes, 0, 16);
 368                                 return addressBytes;
 369                         } else {
 370                                 return new byte [4] { (byte)(m_Address & 0xFF),
 371                                                      (byte)((m_Address >> 8) & 0xFF),
 372                                                      (byte)((m_Address >> 16) & 0xFF),
 373                                                      (byte)(m_Address >> 24) };
 374                         }
 375                 }
 376
 377                 public AddressFamily AddressFamily
 378                 {
 379                         get {
 380                                 return m_Family;
 381                         }
 382                 }
 383
 384
 385                 /// <summary>
 386                 ///   Used to tell whether an address is a loopback.
 387                 ///   All IP addresses of the form 127.X.Y.Z, where X, Y, and Z are in
 388                 ///   the range 0-255, are loopback addresses.
 389                 /// </summary>
 390                 /// <param name="addr">Address to compare</param>
 391                 /// <returns></returns>
 392                 public static bool IsLoopback (IPAddress address)
 393                 {
 394                         if(address.m_Family == AddressFamily.InterNetwork)
 395                                 return (address.m_Address & 0xFF) == 127;
 396                         else {
 397                                 for(int i=0; i<6; i++) {
 398                                         if(address.m_Numbers[i] != 0)
 399                                                 return false;
 400                                 }
 401
 402                                 return NetworkToHostOrder((short)address.m_Numbers[7]) == 1;
 403                         }
 404                 }
 405
 406                 /// <summary>
 407                 ///   Overrides System.Object.ToString to return
 408                 ///   this object rendered in a quad-dotted notation
 409                 /// </summary>
 410                 public override string ToString ()
 411                 {
 412                         if(m_Family == AddressFamily.InterNetwork)
 413                                 return ToString (m_Address);
 414                         else
 415                         {
 416                                 ushort[] numbers = m_Numbers.Clone() as ushort[];
 417
 418                                 for(int i=0; i<numbers.Length; i++)
 419                                         numbers[i] = (ushort)NetworkToHostOrder((short)numbers[i]);
 420
 421                                 IPv6Address v6 = new IPv6Address(numbers);
 422                                 v6.ScopeId = ScopeId;
 423                                 return v6.ToString();
 424                         }
 425                 }
 426
 427                 /// <summary>
 428                 ///   Returns this object rendered in a quad-dotted notation
 429                 /// </summary>
 430                 static string ToString (long addr)
 431                 {
 432                         // addr is in network order
 433                         return  (addr & 0xff).ToString () + "." +
 434                                 ((addr >> 8) & 0xff).ToString () + "." +
 435                                 ((addr >> 16) & 0xff).ToString () + "." +
 436                                 ((addr >> 24) & 0xff).ToString ();
 437                 }
 438
 439                 /// <returns>
 440                 ///   Whether both objects are equal.
 441                 /// </returns>
 442                 public override bool Equals (object comparand)
 443                 {
 444                         IPAddress otherAddr = comparand as IPAddress;
 445                         if (otherAddr != null){
 446                                 if(AddressFamily != otherAddr.AddressFamily)
 447                                         return false;
 448
 449                                 if(AddressFamily == AddressFamily.InterNetwork) {
 450                                         return m_Address == otherAddr.m_Address;
 451                                 } else {
 452                                         ushort[] vals = otherAddr.m_Numbers;
 453
 454                                         for(int i=0; i<8; i++)
 455                                                 if(m_Numbers[i] != vals[i])
 456                                                         return false;
 457
 458                                         return true;
 459                                 }
 460                         }
 461                         return false;
 462                 }
 463
 464                 public override int GetHashCode ()
 465                 {
 466                         if(m_Family == AddressFamily.InterNetwork)
 467                                 return (int)m_Address;
 468                         else
 469                                 return Hash (((((int) m_Numbers[0]) << 16) + m_Numbers [1]),
 470                                         ((((int) m_Numbers [2]) << 16) + m_Numbers [3]),
 471                                         ((((int) m_Numbers [4]) << 16) + m_Numbers [5]),
 472                                         ((((int) m_Numbers [6]) << 16) + m_Numbers [7]));
 473                 }
 474
 475                 private static int Hash (int i, int j, int k, int l)
 476                 {
 477                         return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25);
 478                 }
 479
 480 #pragma warning disable 169
 481                 // Added for serialization compatibility with MS.NET
 482                 private int m_HashCode;
 483 #pragma warning restore
 484
 485         }
 486 }