3 * Functions and constants to play with IP addresses and ranges
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Ashar Voultoiz <hashar at free dot fr>
24 // Some regex definition to "play" with IP address and IP address blocks
26 // An IP is made of 4 bytes from x00 to xFF which is d0 to d255
27 define( 'RE_IP_BYTE', '(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])' );
28 define( 'RE_IP_ADD' , RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
);
29 // An IPv4 block is an IP address and a prefix (d1 to d32)
30 define( 'RE_IP_PREFIX', '(3[0-2]|[12]?\d)' );
31 define( 'RE_IP_BLOCK', RE_IP_ADD
. '\/' . RE_IP_PREFIX
);
32 // For IPv6 canonicalization (NOT for strict validation; these are quite lax!)
33 define( 'RE_IPV6_WORD', '([0-9A-Fa-f]{1,4})' );
34 define( 'RE_IPV6_GAP', ':(?:0+:)*(?::(?:0+:)*)?' );
35 define( 'RE_IPV6_V4_PREFIX', '0*' . RE_IPV6_GAP
. '(?:ffff:)?' );
36 // An IPv6 block is an IP address and a prefix (d1 to d128)
37 define( 'RE_IPV6_PREFIX', '(12[0-8]|1[01][0-9]|[1-9]?\d)');
38 // An IPv6 address is made up of 8 octets. However, the "::" abbreviations can be used.
39 define( 'RE_IPV6_ADD',
40 '(' . // starts with "::" (includes the address "::")
41 '(::|:(:' . RE_IPV6_WORD
. '){1,7})' .
42 '|' . // ends with "::" (not including the address "::")
43 RE_IPV6_WORD
. '(:' . RE_IPV6_WORD
. '){0,6}::' .
45 RE_IPV6_WORD
. '(:' . RE_IPV6_WORD
. '){7}' .
46 '|' . // contains one "::" in the middle ("^" check always fails if no "::" found)
47 RE_IPV6_WORD
. '(:(?P<abbr>(?(abbr)|:))?' . RE_IPV6_WORD
. '){1,6}(?(abbr)|^)' .
50 define( 'RE_IPV6_BLOCK', RE_IPV6_ADD
. '\/' . RE_IPV6_PREFIX
);
51 // This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network
52 define( 'IP_ADDRESS_STRING',
54 RE_IP_ADD
. '(\/' . RE_IP_PREFIX
. '|)' . // IPv4
56 RE_IPV6_ADD
. '(\/' . RE_IPV6_PREFIX
. '|)' . // IPv6
61 * A collection of public static functions to play with IP address
66 * Given a string, determine if it as valid IP.
67 * Note: Unlike isValid(), this looks for networks too.
68 * @param $ip string possible IP address
71 public static function isIPAddress( $ip ) {
75 return preg_match( '/^' . IP_ADDRESS_STRING
. '$/', $ip );
79 * Given a string, determine if it as valid IP in IPv6 only.
80 * Note: Unlike isValid(), this looks for networks too.
81 * @param $ip string possible IP address
84 public static function isIPv6( $ip ) {
88 return preg_match( '/^' . RE_IPV6_ADD
. '(\/' . RE_IPV6_PREFIX
. '|)$/', $ip );
92 * Given a string, determine if it as valid IP in IPv4 only.
93 * Note: Unlike isValid(), this looks for networks too.
94 * @param $ip string possible IP address
97 public static function isIPv4( $ip ) {
101 return preg_match( '/^' . RE_IP_ADD
. '(\/' . RE_IP_PREFIX
. '|)$/', $ip );
105 * Given an IP address in dotted-quad notation, returns an IPv6 octet.
106 * See http://www.answers.com/topic/ipv4-compatible-address
107 * IPs with the first 92 bits as zeros are reserved from IPv6
108 * @param $ip quad-dotted IP address.
111 public static function IPv4toIPv6( $ip ) {
115 // Convert only if needed
116 if ( self
::isIPv6( $ip ) ) {
120 if ( strpos( $ip, '/' ) !== false ) {
121 $parts = explode( '/', $ip, 2 );
122 if ( count( $parts ) != 2 ) {
125 list( $network, $bits ) = $parts;
126 $network = self
::toUnsigned( $network );
127 if ( $network !== false && is_numeric( $bits ) && $bits >= 0 && $bits <= 32 ) {
129 return self
::toOctet( $network ) . "/$bits";
134 return self
::toOctet( self
::toUnsigned( $ip ) );
138 * Given an IPv6 address in octet notation, returns an unsigned integer.
139 * @param $ip octet ipv6 IP address.
142 public static function toUnsigned6( $ip ) {
146 $ip = explode( ':', self
::sanitizeIP( $ip ) );
148 foreach ( $ip as $v ) {
149 $r_ip .= str_pad( $v, 4, 0, STR_PAD_LEFT
);
151 $r_ip = wfBaseConvert( $r_ip, 16, 10 );
156 * Given an IPv6 address in octet notation, returns the expanded octet.
157 * IPv4 IPs will be trimmed, thats it...
158 * @param $ip string IP address in quad or octet form (CIDR or not).
161 public static function sanitizeIP( $ip ) {
166 if ( self
::isIPv4( $ip ) ||
!self
::isIPv6( $ip ) ) {
167 return $ip; // nothing else to do for IPv4 addresses or invalid ones
169 // Remove any whitespaces, convert to upper case
170 $ip = strtoupper( $ip );
171 // Expand zero abbreviations
172 $abbrevPos = strpos( $ip, '::' );
173 if ( $abbrevPos !== false ) {
174 // We know this is valid IPv6. Find the last index of the
175 // address before any CIDR number (e.g. "a:b:c::/24").
176 $CIDRStart = strpos( $ip, "/" );
177 $addressEnd = ( $CIDRStart !== false )
180 // If the '::' is at the beginning...
181 if( $abbrevPos == 0 ) {
183 $extra = ( $ip == '::' ) ?
'0' : ''; // for the address '::'
184 $pad = 9; // 7+2 (due to '::')
185 // If the '::' is at the end...
186 } elseif( $abbrevPos == ( $addressEnd - 1 ) ) {
189 $pad = 9; // 7+2 (due to '::')
190 // If the '::' is in the middle...
194 $pad = 8; // 6+2 (due to '::')
196 $ip = str_replace( '::',
197 str_repeat( $repeat, $pad - substr_count( $ip, ':' ) ) . $extra,
201 // Remove leading zereos from each bloc as needed
202 $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD
. '/', '$1$2', $ip );
207 * Given an unsigned integer, returns an IPv6 address in octet notation
208 * @param $ip_int integer IP address.
211 public static function toOctet( $ip_int ) {
212 // Convert to padded uppercase hex
213 $ip_hex = wfBaseConvert( $ip_int, 10, 16, 32, false );
214 // Separate into 8 octets
215 $ip_oct = substr( $ip_hex, 0, 4 );
216 for ( $n = 1; $n < 8; $n++
) {
217 $ip_oct .= ':' . substr( $ip_hex, 4 * $n, 4 );
220 $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD
. '/', '$1$2', $ip_oct );
225 * Convert an IPv4 or IPv6 hexadecimal representation back to readable format
226 * @param $hex string number, with "v6-" prefix if it is IPv6
227 * @return string quad-dotted (IPv4) or octet notation (IPv6)
229 public static function formatHex( $hex ) {
230 if ( substr( $hex, 0, 3 ) == 'v6-' ) { // IPv6
231 return self
::hexToOctet( substr( $hex, 3 ) );
233 return self
::hexToQuad( $hex );
238 * Converts a hexadecimal number to an IPv6 address in octet notation
239 * @param $ip_hex string hex IP
240 * @return string (of format a:b:c:d:e:f:g:h)
242 public static function hexToOctet( $ip_hex ) {
243 // Convert to padded uppercase hex
244 $ip_hex = str_pad( strtoupper( $ip_hex ), 32, '0' );
245 // Separate into 8 octets
246 $ip_oct = substr( $ip_hex, 0, 4 );
247 for ( $n = 1; $n < 8; $n++
) {
248 $ip_oct .= ':' . substr( $ip_hex, 4 * $n, 4 );
251 $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD
. '/', '$1$2', $ip_oct );
256 * Converts a hexadecimal number to an IPv4 address in quad-dotted notation
257 * @param $ip string Hex IP
258 * @return string (of format a.b.c.d)
260 public static function hexToQuad( $ip ) {
262 for ( $i = 0; $i < 4; $i++
) {
266 $s .= base_convert( substr( $ip, $i * 2, 2 ), 16, 10 );
272 * Convert a network specification in IPv6 CIDR notation to an
273 * integer network and a number of bits
274 * @return array(string, int)
276 public static function parseCIDR6( $range ) {
277 # Explode into <expanded IP,range>
278 $parts = explode( '/', IP
::sanitizeIP( $range ), 2 );
279 if ( count( $parts ) != 2 ) {
280 return array( false, false );
282 list( $network, $bits ) = $parts;
283 $network = self
::toUnsigned6( $network );
284 if ( $network !== false && is_numeric( $bits ) && $bits >= 0 && $bits <= 128 ) {
288 # Native 32 bit functions WONT work here!!!
289 # Convert to a padded binary number
290 $network = wfBaseConvert( $network, 10, 2, 128 );
291 # Truncate the last (128-$bits) bits and replace them with zeros
292 $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT
);
293 # Convert back to an integer
294 $network = wfBaseConvert( $network, 2, 10 );
300 return array( $network, (int)$bits );
304 * Given a string range in a number of formats, return the start and end of
305 * the range in hexadecimal. For IPv6.
308 * 2001:0db8:85a3::7344/96 CIDR
309 * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range
310 * 2001:0db8:85a3::7344/96 Single IP
311 * @return array(string, int)
313 public static function parseRange6( $range ) {
315 $range = IP
::sanitizeIP( $range );
317 if ( strpos( $range, '/' ) !== false ) {
318 list( $network, $bits ) = self
::parseCIDR6( $range );
319 if ( $network === false ) {
320 $start = $end = false;
322 $start = wfBaseConvert( $network, 10, 16, 32, false );
323 # Turn network to binary (again)
324 $end = wfBaseConvert( $network, 10, 2, 128 );
325 # Truncate the last (128-$bits) bits and replace them with ones
326 $end = str_pad( substr( $end, 0, $bits ), 128, 1, STR_PAD_RIGHT
);
328 $end = wfBaseConvert( $end, 2, 16, 32, false );
329 # see toHex() comment
330 $start = "v6-$start";
333 // Explicit range notation...
334 } elseif ( strpos( $range, '-' ) !== false ) {
335 list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) );
336 $start = self
::toUnsigned6( $start );
337 $end = self
::toUnsigned6( $end );
338 if ( $start > $end ) {
339 $start = $end = false;
341 $start = wfBaseConvert( $start, 10, 16, 32, false );
342 $end = wfBaseConvert( $end, 10, 16, 32, false );
344 # see toHex() comment
345 $start = "v6-$start";
349 $start = $end = self
::toHex( $range );
351 if ( $start === false ||
$end === false ) {
352 return array( false, false );
354 return array( $start, $end );
359 * Validate an IP address.
360 * @return boolean True if it is valid.
362 public static function isValid( $ip ) {
363 return ( preg_match( '/^' . RE_IP_ADD
. '$/', $ip ) ||
preg_match( '/^' . RE_IPV6_ADD
. '$/', $ip ) );
367 * Validate an IP Block.
368 * @return boolean True if it is valid.
370 public static function isValidBlock( $ipblock ) {
371 return ( count( self
::toArray( $ipblock ) ) == 1 +
5 );
375 * Determine if an IP address really is an IP address, and if it is public,
376 * i.e. not RFC 1918 or similar
377 * Comes from ProxyTools.php
379 public static function isPublic( $ip ) {
380 $n = self
::toUnsigned( $ip );
385 // ip2long accepts incomplete addresses, as well as some addresses
386 // followed by garbage characters. Check that it's really valid.
387 if( $ip != long2ip( $n ) ) {
391 static $privateRanges = false;
392 if ( !$privateRanges ) {
393 $privateRanges = array(
394 array( '10.0.0.0', '10.255.255.255' ), # RFC 1918 (private)
395 array( '172.16.0.0', '172.31.255.255' ), # "
396 array( '192.168.0.0', '192.168.255.255' ), # "
397 array( '0.0.0.0', '0.255.255.255' ), # this network
398 array( '127.0.0.0', '127.255.255.255' ), # loopback
402 foreach ( $privateRanges as $r ) {
403 $start = self
::toUnsigned( $r[0] );
404 $end = self
::toUnsigned( $r[1] );
405 if ( $n >= $start && $n <= $end ) {
413 * Split out an IP block as an array of 4 bytes and a mask,
414 * return false if it can't be determined
416 * @param $ipblock string A quad dotted/octet IP address
419 public static function toArray( $ipblock ) {
421 if( preg_match( '/^' . RE_IP_ADD
. '(?:\/(?:' . RE_IP_PREFIX
. '))?' . '$/', $ipblock, $matches ) ) {
423 } elseif ( preg_match( '/^' . RE_IPV6_ADD
. '(?:\/(?:' . RE_IPV6_PREFIX
. '))?' . '$/', $ipblock, $matches ) ) {
431 * Return a zero-padded hexadecimal representation of an IP address.
433 * Hexadecimal addresses are used because they can easily be extended to
434 * IPv6 support. To separate the ranges, the return value from this
435 * function for an IPv6 address will be prefixed with "v6-", a non-
436 * hexadecimal string which sorts after the IPv4 addresses.
438 * @param $ip Quad dotted/octet IP address.
439 * @return hexidecimal
441 public static function toHex( $ip ) {
442 $n = self
::toUnsigned( $ip );
443 if ( $n !== false ) {
444 $n = self
::isIPv6( $ip )
445 ?
'v6-' . wfBaseConvert( $n, 10, 16, 32, false )
446 : wfBaseConvert( $n, 10, 16, 8, false );
452 * Given an IP address in dotted-quad/octet notation, returns an unsigned integer.
453 * Like ip2long() except that it actually works and has a consistent error return value.
454 * Comes from ProxyTools.php
455 * @param $ip Quad dotted IP address.
458 public static function toUnsigned( $ip ) {
459 // Use IPv6 functions if needed
460 if ( self
::isIPv6( $ip ) ) {
461 return self
::toUnsigned6( $ip );
463 if ( $ip == '255.255.255.255' ) {
467 if ( $n == -1 ||
$n === false ) { # Return value on error depends on PHP version
478 * Convert a dotted-quad IP to a signed integer
479 * Returns false on failure
481 public static function toSigned( $ip ) {
482 if ( $ip == '255.255.255.255' ) {
494 * Convert a network specification in CIDR notation to an integer network and a number of bits
495 * @return array(int, int)
497 public static function parseCIDR( $range ) {
498 $parts = explode( '/', $range, 2 );
499 if ( count( $parts ) != 2 ) {
500 return array( false, false );
502 list( $network, $bits ) = $parts;
503 $network = self
::toSigned( $network );
504 if ( $network !== false && is_numeric( $bits ) && $bits >= 0 && $bits <= 32 ) {
508 $network &= ~
( ( 1 << ( 32 - $bits ) ) - 1);
510 # Convert to unsigned
511 if ( $network < 0 ) {
512 $network +
= pow( 2, 32 );
518 return array( $network, $bits );
522 * Given a string range in a number of formats, return the start and end of
523 * the range in hexadecimal.
527 * 1.2.3.4 - 1.2.3.5 Explicit range
530 * 2001:0db8:85a3::7344/96 CIDR
531 * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range
532 * 2001:0db8:85a3::7344 Single IP
533 * @return array(string, int)
535 public static function parseRange( $range ) {
536 // Use IPv6 functions if needed
537 if ( self
::isIPv6( $range ) ) {
538 return self
::parseRange6( $range );
540 if ( strpos( $range, '/' ) !== false ) {
542 list( $network, $bits ) = self
::parseCIDR( $range );
543 if ( $network === false ) {
544 $start = $end = false;
546 $start = sprintf( '%08X', $network );
547 $end = sprintf( '%08X', $network +
pow( 2, ( 32 - $bits ) ) - 1 );
549 } elseif ( strpos( $range, '-' ) !== false ) {
551 list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) );
552 if( self
::isIPAddress( $start ) && self
::isIPAddress( $end ) ) {
553 $start = self
::toUnsigned( $start );
554 $end = self
::toUnsigned( $end );
555 if ( $start > $end ) {
556 $start = $end = false;
558 $start = sprintf( '%08X', $start );
559 $end = sprintf( '%08X', $end );
562 $start = $end = false;
566 $start = $end = self
::toHex( $range );
568 if ( $start === false ||
$end === false ) {
569 return array( false, false );
571 return array( $start, $end );
576 * Determine if a given IPv4/IPv6 address is in a given CIDR network
577 * @param $addr The address to check against the given range.
578 * @param $range The range to check the given address against.
579 * @return bool Whether or not the given address is in the given range.
581 public static function isInRange( $addr, $range ) {
582 // Convert to IPv6 if needed
583 $hexIP = self
::toHex( $addr );
584 list( $start, $end ) = self
::parseRange( $range );
585 return ( strcmp( $hexIP, $start ) >= 0 &&
586 strcmp( $hexIP, $end ) <= 0 );
590 * Convert some unusual representations of IPv4 addresses to their
591 * canonical dotted quad representation.
593 * This currently only checks a few IPV4-to-IPv6 related cases. More
594 * unusual representations may be added later.
596 * @param $addr something that might be an IP address
597 * @return valid dotted quad IPv4 address or null
599 public static function canonicalize( $addr ) {
600 if ( self
::isValid( $addr ) ) {
604 // Turn mapped addresses from ::ce:ffff:1.2.3.4 to 1.2.3.4
605 if ( strpos( $addr, ':' ) !== false && strpos( $addr, '.' ) !== false ) {
606 $addr = substr( $addr, strrpos( $addr, ':' ) +
1 );
607 if( self
::isIPv4( $addr ) ) {
612 // IPv6 loopback address
614 if ( preg_match( '/^0*' . RE_IPV6_GAP
. '1$/', $addr, $m ) ) {
618 // IPv4-mapped and IPv4-compatible IPv6 addresses
619 if ( preg_match( '/^' . RE_IPV6_V4_PREFIX
. '(' . RE_IP_ADD
. ')$/i', $addr, $m ) ) {
622 if ( preg_match( '/^' . RE_IPV6_V4_PREFIX
. RE_IPV6_WORD
. ':' . RE_IPV6_WORD
. '$/i', $addr, $m ) ) {
623 return long2ip( ( hexdec( $m[1] ) << 16 ) +
hexdec( $m[2] ) );
626 return null; // give up