2 // System.Net.IPAddress.cs
5 // Miguel de Icaza (miguel@ximian.com)
6 // Lawrence Pit (loz@cable.a2000.nl)
8 // (C) Ximian, Inc. http://www.ximian.com
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:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
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.
31 using System.Globalization;
32 using System.Net.Sockets;
33 using System.Runtime.InteropServices;
35 namespace System.Net {
38 /// Encapsulates an IP Address.
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;
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 ("::");
59 private static short SwapShort (short number)
61 return (short) ( ((number >> 8) & 0xFF) | ((number << 8) & 0xFF00) );
64 private static int SwapInt (int number)
66 return (((number >> 24) & 0xFF)
67 | ((number >> 08) & 0xFF00)
68 | ((number << 08) & 0xFF0000)
72 private static long SwapLong(long number)
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)
84 public static short HostToNetworkOrder(short host) {
85 if (!BitConverter.IsLittleEndian)
88 return SwapShort (host);
91 public static int HostToNetworkOrder(int host) {
92 if (!BitConverter.IsLittleEndian)
95 return SwapInt (host);
98 public static long HostToNetworkOrder(long host) {
99 if (!BitConverter.IsLittleEndian)
102 return SwapLong (host);
105 public static short NetworkToHostOrder(short network) {
106 if (!BitConverter.IsLittleEndian)
109 return SwapShort (network);
112 public static int NetworkToHostOrder(int network) {
113 if (!BitConverter.IsLittleEndian)
116 return SwapInt (network);
119 public static long NetworkToHostOrder(long network) {
120 if (!BitConverter.IsLittleEndian)
123 return SwapLong (network);
127 /// Constructor from a 32-bit constant with the address bytes in
128 /// little-endian order (the lower order bytes contain the netid)
130 public IPAddress (long newAddress)
132 m_Address = newAddress;
133 m_Family = AddressFamily.InterNetwork;
136 public IPAddress (byte[] address)
139 throw new ArgumentNullException ("address");
141 int len = address.Length;
143 if (len != 16 && len != 4)
144 throw new ArgumentException ("An invalid IP address was specified.",
148 m_Numbers = new ushort [8];
149 Buffer.BlockCopy(address, 0, m_Numbers, 0, 16);
150 m_Family = AddressFamily.InterNetworkV6;
153 m_Address = ((uint) address [3] << 24) + (address [2] << 16) +
154 (address [1] << 8) + address [0];
155 m_Family = AddressFamily.InterNetwork;
159 public IPAddress(byte[] address, long scopeid)
162 throw new ArgumentNullException ("address");
164 if (address.Length != 16)
165 throw new ArgumentException ("An invalid IP address was specified.",
168 m_Numbers = new ushort [8];
169 Buffer.BlockCopy(address, 0, m_Numbers, 0, 16);
170 m_Family = AddressFamily.InterNetworkV6;
174 internal IPAddress(ushort[] address, long scopeId)
178 for(int i=0; i<8; i++)
179 m_Numbers[i] = (ushort)HostToNetworkOrder((short)m_Numbers[i]);
181 m_Family = AddressFamily.InterNetworkV6;
185 public static IPAddress Parse (string ipString)
187 if (ipString == null)
188 throw new ArgumentNullException("ipString");
191 if (TryParse (ipString, out ret))
193 throw new FormatException ("An invalid IP address was specified.");
196 public static bool TryParse (string ipString, out IPAddress address)
198 if (ipString == null)
204 if ((address = ParseIPV4 (ipString)) == null)
205 if ((address = ParseIPV6 (ipString)) == null)
210 private static IPAddress ParseIPV4 (string ip)
213 int pos = ip.IndexOf (' ');
215 string [] nets = ip.Substring (pos + 1).Split (new char [] {'.'});
216 if (nets.Length > 0) {
217 string lastNet = nets [nets.Length - 1];
218 if (lastNet.Length == 0)
220 foreach (char c in lastNet)
221 if (!Uri.IsHexDigit (c))
224 ip = ip.Substring (0, pos);
227 if (ip.Length == 0 || ip [ip.Length - 1] == '.')
230 string [] ips = ip.Split (new char [] {'.'});
234 // Make the number in network order
238 for (int i = 0; i < ips.Length; i++) {
239 string subnet = ips [i];
240 if ((3 <= subnet.Length && subnet.Length <= 4) &&
241 (subnet [0] == '0') && (subnet [1] == 'x' || subnet [1] == 'X')) {
242 if (subnet.Length == 3)
243 val = (byte) Uri.FromHex (subnet [2]);
245 val = (byte) ((Uri.FromHex (subnet [2]) << 4) | Uri.FromHex (subnet [3]));
246 } else if (subnet.Length == 0)
248 else if (subnet [0] == '0') {
251 for (int j = 1; j < subnet.Length; j++) {
252 if ('0' <= subnet [j] && subnet [j] <= '7')
253 val = (val << 3) + subnet [j] - '0';
259 if (!Int64.TryParse (subnet, NumberStyles.None, null, out val))
263 if (i == (ips.Length - 1)) {
264 if (i != 0 && val >= (256 << ((3 - i) * 8)))
266 else if (val > 0xffffffff)
269 } else if (val >= 0x100)
271 for (int j = 0; val > 0; j++, val /= 0x100)
272 a |= (val & 0xFF) << ((i - j) << 3);
275 return (new IPAddress (a));
276 } catch (Exception) {
281 private static IPAddress ParseIPV6 (string ip)
283 IPv6Address newIPv6Address;
285 if (IPv6Address.TryParse(ip, out newIPv6Address))
286 return new IPAddress (newIPv6Address.Address, newIPv6Address.ScopeId);
290 [Obsolete("This property is obsolete. Use GetAddressBytes.")]
294 if(m_Family != AddressFamily.InterNetwork)
295 throw new Exception("The attempted operation is not supported for the type of object referenced");
300 /* no need to do this test, ms.net accepts any value.
301 if (value < 0 || value > 0x00000000FFFFFFFF)
302 throw new ArgumentOutOfRangeException (
303 "the address must be between 0 and 0xFFFFFFFF");
306 if(m_Family != AddressFamily.InterNetwork)
307 throw new Exception("The attempted operation is not supported for the type of object referenced");
313 internal long InternalIPv4Address {
314 get { return m_Address; }
317 public bool IsIPv6LinkLocal {
319 if (m_Family == AddressFamily.InterNetwork)
321 int v = NetworkToHostOrder ((short) m_Numbers [0]) & 0xFFF0;
322 return 0xFE80 <= v && v < 0xFEC0;
326 public bool IsIPv6SiteLocal {
328 if (m_Family == AddressFamily.InterNetwork)
330 int v = NetworkToHostOrder ((short) m_Numbers [0]) & 0xFFF0;
331 return 0xFEC0 <= v && v < 0xFF00;
335 public bool IsIPv6Multicast {
337 return m_Family != AddressFamily.InterNetwork &&
338 ((ushort) NetworkToHostOrder ((short) m_Numbers [0]) & 0xFF00) == 0xFF00;
342 public bool IsIPv6Teredo {
344 return m_Family != AddressFamily.InterNetwork &&
345 NetworkToHostOrder ((short) m_Numbers [0]) == 0x2001 &&
350 public long ScopeId {
352 if (m_Family != AddressFamily.InterNetworkV6)
353 throw new SocketException ((int) SocketError.OperationNotSupported);
358 if (m_Family != AddressFamily.InterNetworkV6)
359 throw new SocketException ((int) SocketError.OperationNotSupported);
360 if ((value < 0) || (value > UInt32.MaxValue))
361 throw new ArgumentOutOfRangeException ();
367 public byte [] GetAddressBytes ()
369 if(m_Family == AddressFamily.InterNetworkV6) {
370 byte [] addressBytes = new byte [16];
371 Buffer.BlockCopy (m_Numbers, 0, addressBytes, 0, 16);
374 return new byte [4] { (byte)(m_Address & 0xFF),
375 (byte)((m_Address >> 8) & 0xFF),
376 (byte)((m_Address >> 16) & 0xFF),
377 (byte)(m_Address >> 24) };
381 public AddressFamily AddressFamily
390 public IPAddress MapToIPv4 ()
392 if (AddressFamily == AddressFamily.InterNetwork)
394 if (AddressFamily != AddressFamily.InterNetworkV6)
395 throw new Exception ("Only AddressFamily.InterNetworkV6 can be converted to IPv4");
397 //Test for 0000 0000 0000 0000 0000 FFFF xxxx xxxx
398 for (int i = 0; i < 5; i++) {
399 if (m_Numbers [i] != 0x0000)
400 throw new Exception ("Address does not have the ::FFFF prefix");
402 if (m_Numbers [5] != 0xFFFF)
403 throw new Exception ("Address does not have the ::FFFF prefix");
405 //We've got an IPv4 address
406 byte [] ipv4Bytes = new byte [4];
407 Buffer.BlockCopy (m_Numbers, 12, ipv4Bytes, 0, 4);
408 return new IPAddress (ipv4Bytes);
411 public IPAddress MapToIPv6 ()
413 if (AddressFamily == AddressFamily.InterNetworkV6)
415 if (AddressFamily != AddressFamily.InterNetwork)
416 throw new Exception ("Only AddressFamily.InterNetworkV4 can be converted to IPv6");
418 byte [] ipv4Bytes = GetAddressBytes ();
419 byte [] ipv6Bytes = new byte [16] {
420 0,0, 0,0, 0,0, 0,0, 0,0, 0xFF,0xFF,
421 ipv4Bytes [0], ipv4Bytes [1], ipv4Bytes [2], ipv4Bytes [3]
423 return new IPAddress (ipv6Bytes);
429 /// Used to tell whether an address is a loopback.
430 /// All IP addresses of the form 127.X.Y.Z, where X, Y, and Z are in
431 /// the range 0-255, are loopback addresses.
433 /// <param name="addr">Address to compare</param>
434 /// <returns></returns>
435 public static bool IsLoopback (IPAddress address)
437 if(address.m_Family == AddressFamily.InterNetwork)
438 return (address.m_Address & 0xFF) == 127;
440 for(int i=0; i<6; i++) {
441 if(address.m_Numbers[i] != 0)
445 return NetworkToHostOrder((short)address.m_Numbers[7]) == 1;
450 /// Overrides System.Object.ToString to return
451 /// this object rendered in a quad-dotted notation
453 public override string ToString ()
455 if(m_Family == AddressFamily.InterNetwork)
456 return ToString (m_Address);
459 ushort[] numbers = m_Numbers.Clone() as ushort[];
461 for(int i=0; i<numbers.Length; i++)
462 numbers[i] = (ushort)NetworkToHostOrder((short)numbers[i]);
464 IPv6Address v6 = new IPv6Address(numbers);
465 v6.ScopeId = ScopeId;
466 return v6.ToString();
471 /// Returns this object rendered in a quad-dotted notation
473 static string ToString (long addr)
475 // addr is in network order
476 return (addr & 0xff).ToString () + "." +
477 ((addr >> 8) & 0xff).ToString () + "." +
478 ((addr >> 16) & 0xff).ToString () + "." +
479 ((addr >> 24) & 0xff).ToString ();
483 /// Whether both objects are equal.
485 public override bool Equals (object comparand)
487 IPAddress otherAddr = comparand as IPAddress;
488 if (otherAddr != null){
489 if(AddressFamily != otherAddr.AddressFamily)
492 if(AddressFamily == AddressFamily.InterNetwork) {
493 return m_Address == otherAddr.m_Address;
495 ushort[] vals = otherAddr.m_Numbers;
497 for(int i=0; i<8; i++)
498 if(m_Numbers[i] != vals[i])
507 public override int GetHashCode ()
509 if(m_Family == AddressFamily.InterNetwork)
510 return (int)m_Address;
512 return Hash (((((int) m_Numbers[0]) << 16) + m_Numbers [1]),
513 ((((int) m_Numbers [2]) << 16) + m_Numbers [3]),
514 ((((int) m_Numbers [4]) << 16) + m_Numbers [5]),
515 ((((int) m_Numbers [6]) << 16) + m_Numbers [7]));
518 private static int Hash (int i, int j, int k, int l)
520 return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25);
523 #pragma warning disable 169
524 // Added for serialization compatibility with MS.NET
525 private int m_HashCode;
526 #pragma warning restore