3 * Collection of public static functions to play with IP address
6 * @Author "Ashar Voultoiz" <hashar@altern.org>
7 * @License GPL v2 or later
10 // Some regex definition to "play" with IP address and IP address blocks
12 // An IP is made of 4 bytes from x00 to xFF which is d0 to d255
13 define( 'RE_IP_BYTE', '(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])');
14 define( 'RE_IP_ADD' , RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
. '\.' . RE_IP_BYTE
);
15 // An IPv4 block is an IP address and a prefix (d1 to d32)
16 define( 'RE_IP_PREFIX', '(3[0-2]|[12]?\d)');
17 define( 'RE_IP_BLOCK', RE_IP_ADD
. '\/' . RE_IP_PREFIX
);
18 // For IPv6 canonicalization (NOT for strict validation; these are quite lax!)
19 define( 'RE_IPV6_WORD', '([0-9A-Fa-f]{1,4})' );
20 define( 'RE_IPV6_GAP', ':(?:0+:)*(?::(?:0+:)*)?' );
21 define( 'RE_IPV6_V4_PREFIX', '0*' . RE_IPV6_GAP
. '(?:ffff:)?' );
22 // An IPv6 block is an IP address and a prefix (d1 to d128)
23 define( 'RE_IPV6_PREFIX', '(12[0-8]|1[01][0-9]|[1-9]?\d)');
24 // An IPv6 IP is made up of 8 octets. However abbreviations like "::" can be used. This is lax!
25 define( 'RE_IPV6_ADD', '(:(:' . RE_IPV6_WORD
. '){1,7}|' . RE_IPV6_WORD
. '(:{1,2}' . RE_IPV6_WORD
. '|::$){1,7})' );
26 define( 'RE_IPV6_BLOCK', RE_IPV6_ADD
. '\/' . RE_IPV6_PREFIX
);
27 // This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network
28 define( 'IP_ADDRESS_STRING', RE_IP_ADD
. '(\/' . RE_IP_PREFIX
. '|)|' . RE_IPV6_ADD
. '(\/' . RE_IPV6_PREFIX
. '|)');
32 * Given a string, determine if it as valid IP
33 * Unlike isValid(), this looks for networks too
34 * @param $ip IP address.
37 public static function isIPAddress( $ip ) {
38 if ( !$ip ) return false;
39 // IPv6 IPs with two "::" strings are ambiguous and thus invalid
40 return preg_match( '/^' . IP_ADDRESS_STRING
. '$/', $ip) && ( substr_count($ip, '::') < 2 );
43 public static function isIPv6( $ip ) {
44 if ( !$ip ) return false;
45 // IPv6 IPs with two "::" strings are ambiguous and thus invalid
46 return preg_match( '/^' . RE_IPV6_ADD
. '(\/' . RE_IPV6_PREFIX
. '|)$/', $ip) && ( substr_count($ip, '::') < 2);
49 public static function isIPv4( $ip ) {
50 if ( !$ip ) return false;
51 return preg_match( '/^' . RE_IP_ADD
. '(\/' . RE_IP_PREFIX
. '|)$/', $ip);
55 * Given an IP address in dotted-quad notation, returns an IPv6 octet.
56 * See http://www.answers.com/topic/ipv4-compatible-address
57 * IPs with the first 92 bits as zeros are reserved from IPv6
58 * @param $ip quad-dotted IP address.
61 public static function IPv4toIPv6( $ip ) {
62 if ( !$ip ) return null;
63 // Convert only if needed
64 if ( self
::isIPv6( $ip ) ) return $ip;
66 if ( strpos( $ip, '/' ) !== false ) {
67 $parts = explode( '/', $ip, 2 );
68 if ( count( $parts ) != 2 ) {
71 $network = self
::toUnsigned( $parts[0] );
72 if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 32 ) {
73 $bits = $parts[1] +
96;
74 return self
::toOctet( $network ) . "/$bits";
79 return self
::toOctet( self
::toUnsigned( $ip ) );
83 * Given an IPv6 address in octet notation, returns an unsigned integer.
84 * @param $ip octet ipv6 IP address.
87 public static function toUnsigned6( $ip ) {
88 if ( !$ip ) return null;
89 $ip = explode(':', self
::sanitizeIP( $ip ) );
92 $r_ip .= str_pad( $v, 4, 0, STR_PAD_LEFT
);
94 $r_ip = wfBaseConvert( $r_ip, 16, 10 );
99 * Given an IPv6 address in octet notation, returns the expanded octet.
100 * IPv4 IPs will be trimmed, thats it...
101 * @param $ip octet ipv6 IP address.
104 public static function sanitizeIP( $ip ) {
105 if ( !$ip ) return null;
106 // Trim and return IPv4 addresses
107 if ( self
::isIPv4($ip) ) return trim($ip);
108 // Only IPv6 addresses can be expanded
109 if ( !self
::isIPv6($ip) ) return $ip;
110 // Remove any whitespaces, convert to upper case
111 $ip = strtoupper( trim($ip) );
112 // Expand zero abbreviations
113 if ( strpos( $ip, '::' ) !== false ) {
114 $ip = str_replace('::', str_repeat(':0', 8 - substr_count($ip, ':')) . ':', $ip);
116 // For IPs that start with "::", correct the final IP so that it starts with '0' and not ':'
117 if ( $ip[0] == ':' ) $ip = "0$ip";
118 // Remove leading zereos from each bloc as needed
119 $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD
. '/', '$1$2', $ip );
124 * Given an unsigned integer, returns an IPv6 address in octet notation
125 * @param $ip integer IP address.
128 public static function toOctet( $ip_int ) {
129 // Convert to padded uppercase hex
130 $ip_hex = wfBaseConvert($ip_int, 10, 16, 32, false);
131 // Seperate into 8 octets
132 $ip_oct = substr( $ip_hex, 0, 4 );
133 for ($n=1; $n < 8; $n++
) {
134 $ip_oct .= ':' . substr($ip_hex, 4*$n, 4);
137 $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD
. '/', '$1$2', $ip_oct );
142 * Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits
143 * @return array(string, int)
145 public static function parseCIDR6( $range ) {
147 $parts = explode( '/', IP
::sanitizeIP( $range ), 2 );
148 if ( count( $parts ) != 2 ) {
149 return array( false, false );
151 $network = self
::toUnsigned6( $parts[0] );
152 if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 128 ) {
157 # Native 32 bit functions WONT work here!!!
158 # Convert to a padded binary number
159 $network = wfBaseConvert( $network, 10, 2, 128 );
160 # Truncate the last (128-$bits) bits and replace them with zeros
161 $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT
);
162 # Convert back to an integer
163 $network = wfBaseConvert( $network, 2, 10 );
169 return array( $network, $bits );
173 * Given a string range in a number of formats, return the start and end of
174 * the range in hexadecimal. For IPv6.
177 * 2001:0db8:85a3::7344/96 CIDR
178 * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range
179 * 2001:0db8:85a3::7344/96 Single IP
180 * @return array(string, int)
182 public static function parseRange6( $range ) {
184 $range = IP
::sanitizeIP( $range );
185 if ( strpos( $range, '/' ) !== false ) {
187 list( $network, $bits ) = self
::parseCIDR6( $range );
188 if ( $network === false ) {
189 $start = $end = false;
191 $start = wfBaseConvert( $network, 10, 16, 32, false );
192 # Turn network to binary (again)
193 $end = wfBaseConvert( $network, 10, 2, 128 );
194 # Truncate the last (128-$bits) bits and replace them with ones
195 $end = str_pad( substr( $end, 0, $bits ), 128, 1, STR_PAD_RIGHT
);
197 $end = wfBaseConvert( $end, 2, 16, 32, false );
198 # see toHex() comment
199 $start = "ipv6-$start"; $end = "ipv6-$end";
201 } elseif ( strpos( $range, '-' ) !== false ) {
203 list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) );
204 $start = self
::toUnsigned6( $start ); $end = self
::toUnsigned6( $end );
205 if ( $start > $end ) {
206 $start = $end = false;
208 $start = wfBaseConvert( $start, 10, 16, 32, false );
209 $end = wfBaseConvert( $end, 10, 16, 32, false );
211 # see toHex() comment
212 $start = "ipv6-$start"; $end = "ipv6-$end";
215 $start = $end = self
::toHex( $range );
217 if ( $start === false ||
$end === false ) {
218 return array( false, false );
220 return array( $start, $end );
225 * Validate an IP address.
226 * @return boolean True if it is valid.
228 public static function isValid( $ip ) {
229 return ( preg_match( '/^' . RE_IP_ADD
. '$/', $ip) ||
preg_match( '/^' . RE_IPV6_ADD
. '$/', $ip) );
233 * Validate an IP Block.
234 * @return boolean True if it is valid.
236 public static function isValidBlock( $ipblock ) {
237 return ( count(self
::toArray($ipblock)) == 1 +
5 );
241 * Determine if an IP address really is an IP address, and if it is public,
242 * i.e. not RFC 1918 or similar
243 * Comes from ProxyTools.php
245 public static function isPublic( $ip ) {
246 $n = self
::toUnsigned( $ip );
251 // ip2long accepts incomplete addresses, as well as some addresses
252 // followed by garbage characters. Check that it's really valid.
253 if( $ip != long2ip( $n ) ) {
257 static $privateRanges = false;
258 if ( !$privateRanges ) {
259 $privateRanges = array(
260 array( '10.0.0.0', '10.255.255.255' ), # RFC 1918 (private)
261 array( '172.16.0.0', '172.31.255.255' ), # "
262 array( '192.168.0.0', '192.168.255.255' ), # "
263 array( '0.0.0.0', '0.255.255.255' ), # this network
264 array( '127.0.0.0', '127.255.255.255' ), # loopback
268 foreach ( $privateRanges as $r ) {
269 $start = self
::toUnsigned( $r[0] );
270 $end = self
::toUnsigned( $r[1] );
271 if ( $n >= $start && $n <= $end ) {
279 * Split out an IP block as an array of 4 bytes and a mask,
280 * return false if it can't be determined
282 * @parameter $ip string A quad dotted/octet IP address
285 public static function toArray( $ipblock ) {
287 if( preg_match( '/^' . RE_IP_ADD
. '(?:\/(?:'.RE_IP_PREFIX
.'))?' . '$/', $ipblock, $matches ) ) {
289 } else if ( preg_match( '/^' . RE_IPV6_ADD
. '(?:\/(?:'.RE_IPV6_PREFIX
.'))?' . '$/', $ipblock, $matches ) ) {
297 * Return a zero-padded hexadecimal representation of an IP address.
299 * Hexadecimal addresses are used because they can easily be extended to
300 * IPv6 support. To separate the ranges, the return value from this
301 * function for an IPv6 address will be prefixed with "v6-", a non-
302 * hexadecimal string which sorts after the IPv4 addresses.
304 * @param $ip Quad dotted/octet IP address.
305 * @return hexidecimal
307 public static function toHex( $ip ) {
308 $n = self
::toUnsigned( $ip );
309 if ( $n !== false ) {
310 $n = ( self
::isIPv6($ip) ) ?
"v6-" . wfBaseConvert( $n, 10, 16, 32, false ) : wfBaseConvert( $n, 10, 16, 8, false );
316 * Given an IP address in dotted-quad/octet notation, returns an unsigned integer.
317 * Like ip2long() except that it actually works and has a consistent error return value.
318 * Comes from ProxyTools.php
319 * @param $ip Quad dotted IP address.
322 public static function toUnsigned( $ip ) {
323 // Use IPv6 functions if needed
324 if ( self
::isIPv6( $ip ) ) {
325 return self
::toUnsigned6( $ip );
327 if ( $ip == '255.255.255.255' ) {
331 if ( $n == -1 ||
$n === false ) { # Return value on error depends on PHP version
342 * Convert a dotted-quad IP to a signed integer
343 * Returns false on failure
345 public static function toSigned( $ip ) {
346 if ( $ip == '255.255.255.255' ) {
358 * Convert a network specification in CIDR notation to an integer network and a number of bits
359 * @return array(string, int)
361 public static function parseCIDR( $range ) {
362 $parts = explode( '/', $range, 2 );
363 if ( count( $parts ) != 2 ) {
364 return array( false, false );
366 $network = self
::toSigned( $parts[0] );
367 if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 32 ) {
372 $network &= ~
((1 << (32 - $bits)) - 1);
374 # Convert to unsigned
375 if ( $network < 0 ) {
376 $network +
= pow( 2, 32 );
382 return array( $network, $bits );
386 * Given a string range in a number of formats, return the start and end of
387 * the range in hexadecimal.
391 * 1.2.3.4 - 1.2.3.5 Explicit range
394 * 2001:0db8:85a3::7344/96 CIDR
395 * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range
396 * 2001:0db8:85a3::7344/96 Single IP
397 * @return array(string, int)
399 public static function parseRange( $range ) {
400 // Use IPv6 functions if needed
401 if ( self
::isIPv6( $range ) ) {
402 return self
::parseRange6( $range );
404 if ( strpos( $range, '/' ) !== false ) {
406 list( $network, $bits ) = self
::parseCIDR( $range );
407 if ( $network === false ) {
408 $start = $end = false;
410 $start = sprintf( '%08X', $network );
411 $end = sprintf( '%08X', $network +
pow( 2, (32 - $bits) ) - 1 );
413 } elseif ( strpos( $range, '-' ) !== false ) {
415 list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) );
416 $start = self
::toUnsigned( $start ); $end = self
::toUnsigned( $end );
417 if ( $start > $end ) {
418 $start = $end = false;
420 $start = sprintf( '%08X', $start );
421 $end = sprintf( '%08X', $end );
425 $start = $end = self
::toHex( $range );
427 if ( $start === false ||
$end === false ) {
428 return array( false, false );
430 return array( $start, $end );
435 * Determine if a given IPv4/IPv6 address is in a given CIDR network
436 * @param $addr The address to check against the given range.
437 * @param $range The range to check the given address against.
438 * @return bool Whether or not the given address is in the given range.
440 public static function isInRange( $addr, $range ) {
441 // Convert to IPv6 if needed
442 $unsignedIP = self
::toHex( $addr );
443 list( $start, $end ) = self
::parseRange( $range );
444 return (($unsignedIP >= $start) && ($unsignedIP <= $end));
448 * Convert some unusual representations of IPv4 addresses to their
449 * canonical dotted quad representation.
451 * This currently only checks a few IPV4-to-IPv6 related cases. More
452 * unusual representations may be added later.
454 * @param $addr something that might be an IP address
455 * @return valid dotted quad IPv4 address or null
457 public static function canonicalize( $addr ) {
458 if ( self
::isValid( $addr ) )
461 // IPv6 loopback address
463 if ( preg_match( '/^0*' . RE_IPV6_GAP
. '1$/', $addr, $m ) )
466 // IPv4-mapped and IPv4-compatible IPv6 addresses
467 if ( preg_match( '/^' . RE_IPV6_V4_PREFIX
. '(' . RE_IP_ADD
. ')$/i', $addr, $m ) )
469 if ( preg_match( '/^' . RE_IPV6_V4_PREFIX
. RE_IPV6_WORD
. ':' . RE_IPV6_WORD
. '$/i', $addr, $m ) )
470 return long2ip( ( hexdec( $m[1] ) << 16 ) +
hexdec( $m[2] ) );
472 return null; // give up