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 > 0xffffffff)
 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                 public bool IsIPv6Teredo {
 337                         get {
 338                                 return m_Family != AddressFamily.InterNetwork &&
 339                                         NetworkToHostOrder ((short) m_Numbers [0]) == 0x2001 &&
 340                                         m_Numbers[1] == 0;
 341                         }
 342                 }
 343
 344                 public long ScopeId {
 345                         get {
 346                                 if (m_Family != AddressFamily.InterNetworkV6)
 347                                         throw new SocketException ((int) SocketError.OperationNotSupported);
 348
 349                                 return m_ScopeId;
 350                         }
 351                         set {
 352                                 if (m_Family != AddressFamily.InterNetworkV6)
 353                                         throw new SocketException ((int) SocketError.OperationNotSupported);
 354                                 if ((value < 0) || (value > UInt32.MaxValue))
 355                                         throw new ArgumentOutOfRangeException ();
 356
 357                                 m_ScopeId = value;
 358                         }
 359                 }
 360
 361                 public byte [] GetAddressBytes ()
 362                 {
 363                         if(m_Family == AddressFamily.InterNetworkV6) {
 364                                 byte [] addressBytes = new byte [16];
 365                                 Buffer.BlockCopy (m_Numbers, 0, addressBytes, 0, 16);
 366                                 return addressBytes;
 367                         } else {
 368                                 return new byte [4] { (byte)(m_Address & 0xFF),
 369                                                      (byte)((m_Address >> 8) & 0xFF),
 370                                                      (byte)((m_Address >> 16) & 0xFF),
 371                                                      (byte)(m_Address >> 24) };
 372                         }
 373                 }
 374
 375                 public AddressFamily AddressFamily
 376                 {
 377                         get {
 378                                 return m_Family;
 379                         }
 380                 }
 381
 382 #if NET_4_5
 383
 384                 public IPAddress MapToIPv4 ()
 385                 {
 386                         if (AddressFamily == AddressFamily.InterNetwork)
 387                                 return this;
 388                         if (AddressFamily != AddressFamily.InterNetworkV6)
 389                                 throw new Exception ("Only AddressFamily.InterNetworkV6 can be converted to IPv4");
 390
 391                         //Test for 0000 0000 0000 0000 0000 FFFF xxxx xxxx
 392                         for (int i = 0; i < 5; i++) {
 393                                 if (m_Numbers [i] != 0x0000)
 394                                         throw new Exception ("Address does not have the ::FFFF prefix");
 395                         }
 396                         if (m_Numbers [5] != 0xFFFF)
 397                                 throw new Exception ("Address does not have the ::FFFF prefix");
 398
 399                         //We've got an IPv4 address
 400                         byte [] ipv4Bytes = new byte [4];
 401                         Buffer.BlockCopy (m_Numbers, 12, ipv4Bytes, 0, 4);
 402                         return new IPAddress (ipv4Bytes);
 403                 }
 404
 405                 public IPAddress MapToIPv6 ()
 406                 {
 407                         if (AddressFamily == AddressFamily.InterNetworkV6)
 408                                 return this;
 409                         if (AddressFamily != AddressFamily.InterNetwork)
 410                                 throw new Exception ("Only AddressFamily.InterNetworkV4 can be converted to IPv6");
 411
 412                         byte [] ipv4Bytes = GetAddressBytes ();
 413                         byte [] ipv6Bytes = new byte [16] {
 414                                 0,0, 0,0, 0,0, 0,0, 0,0, 0xFF,0xFF,
 415                                 ipv4Bytes [0], ipv4Bytes [1], ipv4Bytes [2], ipv4Bytes [3]
 416                         };
 417                         return new IPAddress (ipv6Bytes);
 418                 }
 419
 420 #endif
 421
 422                 /// <summary>
 423                 ///   Used to tell whether an address is a loopback.
 424                 ///   All IP addresses of the form 127.X.Y.Z, where X, Y, and Z are in
 425                 ///   the range 0-255, are loopback addresses.
 426                 /// </summary>
 427                 /// <param name="addr">Address to compare</param>
 428                 /// <returns></returns>
 429                 public static bool IsLoopback (IPAddress address)
 430                 {
 431                         if(address.m_Family == AddressFamily.InterNetwork)
 432                                 return (address.m_Address & 0xFF) == 127;
 433                         else {
 434                                 for(int i=0; i<6; i++) {
 435                                         if(address.m_Numbers[i] != 0)
 436                                                 return false;
 437                                 }
 438
 439                                 return NetworkToHostOrder((short)address.m_Numbers[7]) == 1;
 440                         }
 441                 }
 442
 443                 /// <summary>
 444                 ///   Overrides System.Object.ToString to return
 445                 ///   this object rendered in a quad-dotted notation
 446                 /// </summary>
 447                 public override string ToString ()
 448                 {
 449                         if(m_Family == AddressFamily.InterNetwork)
 450                                 return ToString (m_Address);
 451                         else
 452                         {
 453                                 ushort[] numbers = m_Numbers.Clone() as ushort[];
 454
 455                                 for(int i=0; i<numbers.Length; i++)
 456                                         numbers[i] = (ushort)NetworkToHostOrder((short)numbers[i]);
 457
 458                                 IPv6Address v6 = new IPv6Address(numbers);
 459                                 v6.ScopeId = ScopeId;
 460                                 return v6.ToString();
 461                         }
 462                 }
 463
 464                 /// <summary>
 465                 ///   Returns this object rendered in a quad-dotted notation
 466                 /// </summary>
 467                 static string ToString (long addr)
 468                 {
 469                         // addr is in network order
 470                         return  (addr & 0xff).ToString () + "." +
 471                                 ((addr >> 8) & 0xff).ToString () + "." +
 472                                 ((addr >> 16) & 0xff).ToString () + "." +
 473                                 ((addr >> 24) & 0xff).ToString ();
 474                 }
 475
 476                 /// <returns>
 477                 ///   Whether both objects are equal.
 478                 /// </returns>
 479                 public override bool Equals (object comparand)
 480                 {
 481                         IPAddress otherAddr = comparand as IPAddress;
 482                         if (otherAddr != null){
 483                                 if(AddressFamily != otherAddr.AddressFamily)
 484                                         return false;
 485
 486                                 if(AddressFamily == AddressFamily.InterNetwork) {
 487                                         return m_Address == otherAddr.m_Address;
 488                                 } else {
 489                                         ushort[] vals = otherAddr.m_Numbers;
 490
 491                                         for(int i=0; i<8; i++)
 492                                                 if(m_Numbers[i] != vals[i])
 493                                                         return false;
 494
 495                                         return true;
 496                                 }
 497                         }
 498                         return false;
 499                 }
 500
 501                 public override int GetHashCode ()
 502                 {
 503                         if(m_Family == AddressFamily.InterNetwork)
 504                                 return (int)m_Address;
 505                         else
 506                                 return Hash (((((int) m_Numbers[0]) << 16) + m_Numbers [1]),
 507                                         ((((int) m_Numbers [2]) << 16) + m_Numbers [3]),
 508                                         ((((int) m_Numbers [4]) << 16) + m_Numbers [5]),
 509                                         ((((int) m_Numbers [6]) << 16) + m_Numbers [7]));
 510                 }
 511
 512                 private static int Hash (int i, int j, int k, int l)
 513                 {
 514                         return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25);
 515                 }
 516
 517 #pragma warning disable 169
 518                 // Added for serialization compatibility with MS.NET
 519                 private int m_HashCode;
 520 #pragma warning restore
 521
 522         }
 523 }