From 9db190c7e736ec8d063187d4241b59feaf7dc2d1 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 22 Jun 2011 11:28:20 +0200 Subject: update to MediaWiki 1.17.0 --- includes/IP.php | 676 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 365 insertions(+), 311 deletions(-) (limited to 'includes/IP.php') diff --git a/includes/IP.php b/includes/IP.php index bbe70339..5f492c66 100644 --- a/includes/IP.php +++ b/includes/IP.php @@ -1,39 +1,69 @@ - * @License GPL v2 or later +/** + * Functions and constants to play with IP addresses and ranges + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + * @author Ashar Voultoiz , Aaron Schulz */ // Some regex definition to "play" with IP address and IP address blocks -// An IP is made of 4 bytes from x00 to xFF which is d0 to d255 -define( 'RE_IP_BYTE', '(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])'); -define( 'RE_IP_ADD' , RE_IP_BYTE . '\.' . RE_IP_BYTE . '\.' . RE_IP_BYTE . '\.' . RE_IP_BYTE ); +// An IPv4 address is made of 4 bytes from x00 to xFF which is d0 to d255 +define( 'RE_IP_BYTE', '(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])' ); +define( 'RE_IP_ADD', RE_IP_BYTE . '\.' . RE_IP_BYTE . '\.' . RE_IP_BYTE . '\.' . RE_IP_BYTE ); // An IPv4 block is an IP address and a prefix (d1 to d32) -define( 'RE_IP_PREFIX', '(3[0-2]|[12]?\d)'); -define( 'RE_IP_BLOCK', RE_IP_ADD . '\/' . RE_IP_PREFIX); -// For IPv6 canonicalization (NOT for strict validation; these are quite lax!) +define( 'RE_IP_PREFIX', '(3[0-2]|[12]?\d)' ); +define( 'RE_IP_BLOCK', RE_IP_ADD . '\/' . RE_IP_PREFIX ); + +// An IPv6 address is made up of 8 words (each x0000 to xFFFF). +// However, the "::" abbreviation can be used on consecutive x0000 words. define( 'RE_IPV6_WORD', '([0-9A-Fa-f]{1,4})' ); -define( 'RE_IPV6_GAP', ':(?:0+:)*(?::(?:0+:)*)?' ); -define( 'RE_IPV6_V4_PREFIX', '0*' . RE_IPV6_GAP . '(?:ffff:)?' ); -// An IPv6 block is an IP address and a prefix (d1 to d128) define( 'RE_IPV6_PREFIX', '(12[0-8]|1[01][0-9]|[1-9]?\d)'); -// An IPv6 IP is made up of 8 octets. However abbreviations like "::" can be used. -// This is lax! Number of octets/double colons validation not done. define( 'RE_IPV6_ADD', - '(' . - ':(:' . RE_IPV6_WORD . '){1,7}' . // IPs that start with ":" - '|' . - RE_IPV6_WORD . '(:{1,2}' . RE_IPV6_WORD . '|::$){1,7}' . // IPs that don't start with ":" + '(?:' . // starts with "::" (including "::") + ':(?::|(?::' . RE_IPV6_WORD . '){1,7})' . + '|' . // ends with "::" (except "::") + RE_IPV6_WORD . '(?::' . RE_IPV6_WORD . '){0,6}::' . + '|' . // contains one "::" in the middle, ending in "::WORD" + RE_IPV6_WORD . '(?::' . RE_IPV6_WORD . '){0,5}' . '::' . RE_IPV6_WORD . + '|' . // contains one "::" in the middle, not ending in "::WORD" (regex for PCRE 4.0+) + RE_IPV6_WORD . '(?::(?P:(?P))?' . RE_IPV6_WORD . '(?!:(?P=abn))){1,5}' . + ':' . RE_IPV6_WORD . '(?P=iabn)' . + // NOTE: (?!(?P=abn)) fails iff "::" used twice; (?P=iabn) passes iff a "::" was found. + '|' . // contains no "::" + RE_IPV6_WORD . '(?::' . RE_IPV6_WORD . '){7}' . ')' + // NOTE: With PCRE 7.2+, we can combine the two '"::" in the middle' cases into: + // RE_IPV6_WORD . '(?::((?(-1)|:))?' . RE_IPV6_WORD . '){1,6}(?(-2)|^)' + // This also improves regex concatenation by using relative references. ); +// An IPv6 block is an IP address and a prefix (d1 to d128) define( 'RE_IPV6_BLOCK', RE_IPV6_ADD . '\/' . RE_IPV6_PREFIX ); +// For IPv6 canonicalization (NOT for strict validation; these are quite lax!) +define( 'RE_IPV6_GAP', ':(?:0+:)*(?::(?:0+:)*)?' ); +define( 'RE_IPV6_V4_PREFIX', '0*' . RE_IPV6_GAP . '(?:ffff:)?' ); + // This might be useful for regexps used elsewhere, matches any IPv6 or IPv6 address or network define( 'IP_ADDRESS_STRING', '(?:' . - RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)' . // IPv4 + RE_IP_ADD . '(?:\/' . RE_IP_PREFIX . ')?' . // IPv4 '|' . - RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)' . // IPv6 + RE_IPV6_ADD . '(?:\/' . RE_IPV6_PREFIX . ')?' . // IPv6 ')' ); @@ -43,284 +73,193 @@ define( 'IP_ADDRESS_STRING', */ class IP { /** - * Given a string, determine if it as valid IP - * Unlike isValid(), this looks for networks too - * @param $ip IP address. - * @return string + * Determine if a string is as valid IP address or network (CIDR prefix). + * SIIT IPv4-translated addresses are rejected. + * Note: canonicalize() tries to convert translated addresses to IPv4. + * + * @param $ip String: possible IP address + * @return Boolean */ public static function isIPAddress( $ip ) { - if ( !$ip ) return false; - if ( is_array( $ip ) ) { - throw new MWException( "invalid value passed to " . __METHOD__ ); - } - // IPv6 IPs with two "::" strings are ambiguous and thus invalid - return preg_match( '/^' . IP_ADDRESS_STRING . '$/', $ip) && ( substr_count($ip, '::') < 2 ); + return (bool)preg_match( '/^' . IP_ADDRESS_STRING . '$/', $ip ); } + /** + * Given a string, determine if it as valid IP in IPv6 only. + * Note: Unlike isValid(), this looks for networks too. + * + * @param $ip String: possible IP address + * @return Boolean + */ public static function isIPv6( $ip ) { - if ( !$ip ) return false; - if( is_array( $ip ) ) { - throw new MWException( "invalid value passed to " . __METHOD__ ); - } - $doubleColons = substr_count($ip, '::'); - // IPv6 IPs with two "::" strings are ambiguous and thus invalid - return preg_match( '/^' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)$/', $ip) - && ( $doubleColons == 1 || substr_count($ip,':') == 7 ); + return (bool)preg_match( '/^' . RE_IPV6_ADD . '(?:\/' . RE_IPV6_PREFIX . ')?$/', $ip ); } + /** + * Given a string, determine if it as valid IP in IPv4 only. + * Note: Unlike isValid(), this looks for networks too. + * + * @param $ip String: possible IP address + * @return Boolean + */ public static function isIPv4( $ip ) { - if ( !$ip ) return false; - return preg_match( '/^' . RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)$/', $ip); + return (bool)preg_match( '/^' . RE_IP_ADD . '(?:\/' . RE_IP_PREFIX . ')?$/', $ip ); } /** - * Given an IP address in dotted-quad notation, returns an IPv6 octet. - * See http://www.answers.com/topic/ipv4-compatible-address - * IPs with the first 92 bits as zeros are reserved from IPv6 - * @param $ip quad-dotted IP address. - * @return string + * Validate an IP address. Ranges are NOT considered valid. + * SIIT IPv4-translated addresses are rejected. + * Note: canonicalize() tries to convert translated addresses to IPv4. + * + * @param $ip String + * @return Boolean: True if it is valid. */ - public static function IPv4toIPv6( $ip ) { - if ( !$ip ) return null; - // Convert only if needed - if ( self::isIPv6( $ip ) ) return $ip; - // IPv4 CIDRs - if ( strpos( $ip, '/' ) !== false ) { - $parts = explode( '/', $ip, 2 ); - if ( count( $parts ) != 2 ) { - return false; - } - $network = self::toUnsigned( $parts[0] ); - if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 32 ) { - $bits = $parts[1] + 96; - return self::toOctet( $network ) . "/$bits"; - } else { - return false; - } - } - return self::toOctet( self::toUnsigned( $ip ) ); + public static function isValid( $ip ) { + return ( preg_match( '/^' . RE_IP_ADD . '$/', $ip ) + || preg_match( '/^' . RE_IPV6_ADD . '$/', $ip ) ); } /** - * Given an IPv6 address in octet notation, returns an unsigned integer. - * @param $ip octet ipv6 IP address. - * @return string + * Validate an IP Block (valid address WITH a valid prefix). + * SIIT IPv4-translated addresses are rejected. + * Note: canonicalize() tries to convert translated addresses to IPv4. + * + * @param $ipblock String + * @return Boolean: True if it is valid. */ - public static function toUnsigned6( $ip ) { - if ( !$ip ) return null; - $ip = explode(':', self::sanitizeIP( $ip ) ); - $r_ip = ''; - foreach ($ip as $v) { - $r_ip .= str_pad( $v, 4, 0, STR_PAD_LEFT ); - } - $r_ip = wfBaseConvert( $r_ip, 16, 10 ); - return $r_ip; + public static function isValidBlock( $ipblock ) { + return ( preg_match( '/^' . RE_IPV6_BLOCK . '$/', $ipblock ) + || preg_match( '/^' . RE_IP_BLOCK . '$/', $ipblock ) ); } /** - * Given an IPv6 address in octet notation, returns the expanded octet. - * IPv4 IPs will be trimmed, thats it... - * @param $ip octet ipv6 IP address. - * @return string + * Convert an IP into a nice standard form. + * IPv6 addresses in octet notation are expanded to 8 words. + * IPv4 addresses are just trimmed. + * + * @param $ip String: IP address in quad or octet form (CIDR or not). + * @return String */ public static function sanitizeIP( $ip ) { $ip = trim( $ip ); - if ( $ip === '' ) return null; - // Trim and return IPv4 addresses - if ( self::isIPv4($ip) ) return $ip; - // Only IPv6 addresses can be expanded - if ( !self::isIPv6($ip) ) return $ip; + if ( $ip === '' ) { + return null; + } + if ( self::isIPv4( $ip ) || !self::isIPv6( $ip ) ) { + return $ip; // nothing else to do for IPv4 addresses or invalid ones + } // Remove any whitespaces, convert to upper case $ip = strtoupper( $ip ); // Expand zero abbreviations $abbrevPos = strpos( $ip, '::' ); if ( $abbrevPos !== false ) { + // We know this is valid IPv6. Find the last index of the + // address before any CIDR number (e.g. "a:b:c::/24"). + $CIDRStart = strpos( $ip, "/" ); + $addressEnd = ( $CIDRStart !== false ) + ? $CIDRStart - 1 + : strlen( $ip ) - 1; // If the '::' is at the beginning... - if( $abbrevPos == 0 ) { - $repeat = '0:'; $extra = ''; $pad = 9; // 7+2 (due to '::') - // If the '::' is at the end... - } else if( $abbrevPos == (strlen($ip)-2) ) { - $repeat = ':0'; $extra = ''; $pad = 9; // 7+2 (due to '::') + if ( $abbrevPos == 0 ) { + $repeat = '0:'; + $extra = ( $ip == '::' ) ? '0' : ''; // for the address '::' + $pad = 9; // 7+2 (due to '::') // If the '::' is at the end... + } elseif ( $abbrevPos == ( $addressEnd - 1 ) ) { + $repeat = ':0'; + $extra = ''; + $pad = 9; // 7+2 (due to '::') + // If the '::' is in the middle... } else { - $repeat = ':0'; $extra = ':'; $pad = 8; // 6+2 (due to '::') + $repeat = ':0'; + $extra = ':'; + $pad = 8; // 6+2 (due to '::') } - $ip = str_replace('::', str_repeat($repeat, $pad-substr_count($ip,':')).$extra, $ip); + $ip = str_replace( '::', + str_repeat( $repeat, $pad - substr_count( $ip, ':' ) ) . $extra, + $ip + ); } // Remove leading zereos from each bloc as needed - $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip ); + $ip = preg_replace( '/(^|:)0+(' . RE_IPV6_WORD . ')/', '$1$2', $ip ); return $ip; } /** * Given an unsigned integer, returns an IPv6 address in octet notation - * @param $ip integer IP address. - * @return string + * + * @param $ip_int String: IP address. + * @return String */ public static function toOctet( $ip_int ) { - // Convert to padded uppercase hex - $ip_hex = wfBaseConvert($ip_int, 10, 16, 32, false); - // Separate into 8 octets - $ip_oct = substr( $ip_hex, 0, 4 ); - for ($n=1; $n < 8; $n++) { - $ip_oct .= ':' . substr($ip_hex, 4*$n, 4); - } - // NO leading zeroes - $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip_oct ); - return $ip_oct; + return self::hexToOctet( wfBaseConvert( $ip_int, 10, 16, 32, false ) ); } /** * Convert an IPv4 or IPv6 hexadecimal representation back to readable format + * + * @param $hex String: number, with "v6-" prefix if it is IPv6 + * @return String: quad-dotted (IPv4) or octet notation (IPv6) */ public static function formatHex( $hex ) { - if ( substr( $hex, 0, 3 ) == 'v6-' ) { - return self::hexToOctet( $hex ); - } else { + if ( substr( $hex, 0, 3 ) == 'v6-' ) { // IPv6 + return self::hexToOctet( substr( $hex, 3 ) ); + } else { // IPv4 return self::hexToQuad( $hex ); } } - + /** - * Given a hexadecimal number, returns to an IPv6 address in octet notation - * @param $ip string hex IP - * @return string + * Converts a hexadecimal number to an IPv6 address in octet notation + * + * @param $ip_hex String: pure hex (no v6- prefix) + * @return String (of format a:b:c:d:e:f:g:h) */ - public static function hextoOctet( $ip_hex ) { - // Convert to padded uppercase hex - $ip_hex = str_pad( strtoupper($ip_hex), 32, '0'); - // Separate into 8 octets - $ip_oct = substr( $ip_hex, 0, 4 ); - for ($n=1; $n < 8; $n++) { - $ip_oct .= ':' . substr($ip_hex, 4*$n, 4); - } - // NO leading zeroes - $ip_oct = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip_oct ); + public static function hexToOctet( $ip_hex ) { + // Pad hex to 32 chars (128 bits) + $ip_hex = str_pad( strtoupper( $ip_hex ), 32, '0', STR_PAD_LEFT ); + // Separate into 8 words + $ip_oct = substr( $ip_hex, 0, 4 ); + for ( $n = 1; $n < 8; $n++ ) { + $ip_oct .= ':' . substr( $ip_hex, 4 * $n, 4 ); + } + // NO leading zeroes + $ip_oct = preg_replace( '/(^|:)0+(' . RE_IPV6_WORD . ')/', '$1$2', $ip_oct ); return $ip_oct; } - + /** - * Converts a hexadecimal number to an IPv4 address in octet notation - * @param $ip string Hex IP - * @return string - */ - public static function hexToQuad( $ip ) { - // Converts a hexadecimal IP to nnn.nnn.nnn.nnn format + * Converts a hexadecimal number to an IPv4 address in quad-dotted notation + * + * @param $ip_hex String: pure hex + * @return String (of format a.b.c.d) + */ + public static function hexToQuad( $ip_hex ) { + // Pad hex to 8 chars (32 bits) + $ip_hex = str_pad( strtoupper( $ip_hex ), 8, '0', STR_PAD_LEFT ); + // Separate into four quads $s = ''; for ( $i = 0; $i < 4; $i++ ) { if ( $s !== '' ) { $s .= '.'; } - $s .= base_convert( substr( $ip, $i * 2, 2 ), 16, 10 ); + $s .= base_convert( substr( $ip_hex, $i * 2, 2 ), 16, 10 ); } return $s; } - /** - * Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits - * @return array(string, int) - */ - public static function parseCIDR6( $range ) { - # Expand any IPv6 IP - $parts = explode( '/', IP::sanitizeIP( $range ), 2 ); - if ( count( $parts ) != 2 ) { - return array( false, false ); - } - $network = self::toUnsigned6( $parts[0] ); - if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 128 ) { - $bits = $parts[1]; - if ( $bits == 0 ) { - $network = 0; - } else { - # Native 32 bit functions WONT work here!!! - # Convert to a padded binary number - $network = wfBaseConvert( $network, 10, 2, 128 ); - # Truncate the last (128-$bits) bits and replace them with zeros - $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT ); - # Convert back to an integer - $network = wfBaseConvert( $network, 2, 10 ); - } - } else { - $network = false; - $bits = false; - } - return array( $network, $bits ); - } - - /** - * Given a string range in a number of formats, return the start and end of - * the range in hexadecimal. For IPv6. - * - * Formats are: - * 2001:0db8:85a3::7344/96 CIDR - * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range - * 2001:0db8:85a3::7344/96 Single IP - * @return array(string, int) - */ - public static function parseRange6( $range ) { - # Expand any IPv6 IP - $range = IP::sanitizeIP( $range ); - if ( strpos( $range, '/' ) !== false ) { - # CIDR - list( $network, $bits ) = self::parseCIDR6( $range ); - if ( $network === false ) { - $start = $end = false; - } else { - $start = wfBaseConvert( $network, 10, 16, 32, false ); - # Turn network to binary (again) - $end = wfBaseConvert( $network, 10, 2, 128 ); - # Truncate the last (128-$bits) bits and replace them with ones - $end = str_pad( substr( $end, 0, $bits ), 128, 1, STR_PAD_RIGHT ); - # Convert to hex - $end = wfBaseConvert( $end, 2, 16, 32, false ); - # see toHex() comment - $start = "v6-$start"; $end = "v6-$end"; - } - } elseif ( strpos( $range, '-' ) !== false ) { - # Explicit range - list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) ); - $start = self::toUnsigned6( $start ); $end = self::toUnsigned6( $end ); - if ( $start > $end ) { - $start = $end = false; - } else { - $start = wfBaseConvert( $start, 10, 16, 32, false ); - $end = wfBaseConvert( $end, 10, 16, 32, false ); - } - # see toHex() comment - $start = "v6-$start"; $end = "v6-$end"; - } else { - # Single IP - $start = $end = self::toHex( $range ); - } - if ( $start === false || $end === false ) { - return array( false, false ); - } else { - return array( $start, $end ); - } - } - - /** - * Validate an IP address. - * @return boolean True if it is valid. - */ - public static function isValid( $ip ) { - return ( preg_match( '/^' . RE_IP_ADD . '$/', $ip) || preg_match( '/^' . RE_IPV6_ADD . '$/', $ip) ); - } - - /** - * Validate an IP Block. - * @return boolean True if it is valid. - */ - public static function isValidBlock( $ipblock ) { - return ( count(self::toArray($ipblock)) == 1 + 5 ); - } - /** * Determine if an IP address really is an IP address, and if it is public, * i.e. not RFC 1918 or similar * Comes from ProxyTools.php + * + * @param $ip String + * @return Boolean */ public static function isPublic( $ip ) { + if ( self::isIPv6( $ip ) ) { + return self::isPublic6( $ip ); + } $n = self::toUnsigned( $ip ); if ( !$n ) { return false; @@ -328,7 +267,7 @@ class IP { // ip2long accepts incomplete addresses, as well as some addresses // followed by garbage characters. Check that it's really valid. - if( $ip != long2ip( $n ) ) { + if ( $ip != long2ip( $n ) ) { return false; } @@ -354,100 +293,118 @@ class IP { } /** - * Split out an IP block as an array of 4 bytes and a mask, - * return false if it can't be determined + * Determine if an IPv6 address really is an IP address, and if it is public, + * i.e. not RFC 4193 or similar * - * @param $ip string A quad dotted/octet IP address - * @return array + * @param $ip String + * @return Boolean */ - public static function toArray( $ipblock ) { - $matches = array(); - if( preg_match( '/^' . RE_IP_ADD . '(?:\/(?:'.RE_IP_PREFIX.'))?' . '$/', $ipblock, $matches ) ) { - return $matches; - } else if ( preg_match( '/^' . RE_IPV6_ADD . '(?:\/(?:'.RE_IPV6_PREFIX.'))?' . '$/', $ipblock, $matches ) ) { - return $matches; - } else { - return false; + private static function isPublic6( $ip ) { + static $privateRanges = false; + if ( !$privateRanges ) { + $privateRanges = array( + array( 'fc::', 'fdff:ffff:ffff:ffff:ffff:ffff:ffff:ffff' ), # RFC 4193 (local) + array( '0:0:0:0:0:0:0:1', '0:0:0:0:0:0:0:1' ), # loopback + ); } + $n = self::toHex( $ip ); + foreach ( $privateRanges as $r ) { + $start = self::toHex( $r[0] ); + $end = self::toHex( $r[1] ); + if ( $n >= $start && $n <= $end ) { + return false; + } + } + return true; } /** - * Return a zero-padded hexadecimal representation of an IP address. + * Return a zero-padded upper case hexadecimal representation of an IP address. * * Hexadecimal addresses are used because they can easily be extended to * IPv6 support. To separate the ranges, the return value from this * function for an IPv6 address will be prefixed with "v6-", a non- * hexadecimal string which sorts after the IPv4 addresses. * - * @param $ip Quad dotted/octet IP address. - * @return hexidecimal + * @param $ip String: quad dotted/octet IP address. + * @return String */ public static function toHex( $ip ) { - $n = self::toUnsigned( $ip ); - if ( $n !== false ) { - $n = self::isIPv6($ip) ? "v6-" . wfBaseConvert( $n, 10, 16, 32, false ) : wfBaseConvert( $n, 10, 16, 8, false ); + if ( self::isIPv6( $ip ) ) { + $n = 'v6-' . self::IPv6ToRawHex( $ip ); + } else { + $n = self::toUnsigned( $ip ); + if ( $n !== false ) { + $n = wfBaseConvert( $n, 10, 16, 8, false ); + } } return $n; } + /** + * Given an IPv6 address in octet notation, returns a pure hex string. + * + * @param $ip String: octet ipv6 IP address. + * @return String: pure hex (uppercase) + */ + private static function IPv6ToRawHex( $ip ) { + $ip = self::sanitizeIP( $ip ); + if ( !$ip ) { + return null; + } + $r_ip = ''; + foreach ( explode( ':', $ip ) as $v ) { + $r_ip .= str_pad( $v, 4, 0, STR_PAD_LEFT ); + } + return $r_ip; + } + /** * Given an IP address in dotted-quad/octet notation, returns an unsigned integer. * Like ip2long() except that it actually works and has a consistent error return value. * Comes from ProxyTools.php - * @param $ip Quad dotted IP address. - * @return integer + * + * @param $ip String: quad dotted IP address. + * @return Mixed: string/int/false */ public static function toUnsigned( $ip ) { - // Use IPv6 functions if needed if ( self::isIPv6( $ip ) ) { - return self::toUnsigned6( $ip ); - } - if ( $ip == '255.255.255.255' ) { - $n = -1; + $n = self::toUnsigned6( $ip ); } else { $n = ip2long( $ip ); - if ( $n == -1 || $n === false ) { # Return value on error depends on PHP version - $n = false; + if ( $n < 0 ) { + $n += pow( 2, 32 ); } } - if ( $n < 0 ) { - $n += pow( 2, 32 ); - } return $n; } - /** - * Convert a dotted-quad IP to a signed integer - * Returns false on failure - */ - public static function toSigned( $ip ) { - if ( $ip == '255.255.255.255' ) { - $n = -1; - } else { - $n = ip2long( $ip ); - if ( $n == -1 ) { - $n = false; - } - } - return $n; + private static function toUnsigned6( $ip ) { + return wfBaseConvert( self::IPv6ToRawHex( $ip ), 16, 10 ); } /** - * Convert a network specification in CIDR notation to an integer network and a number of bits - * @return array(string, int) + * Convert a network specification in CIDR notation + * to an integer network and a number of bits + * + * @param $range String: IP with CIDR prefix + * @return array(int or string, int) */ public static function parseCIDR( $range ) { + if ( self::isIPv6( $range ) ) { + return self::parseCIDR6( $range ); + } $parts = explode( '/', $range, 2 ); if ( count( $parts ) != 2 ) { return array( false, false ); } - $network = self::toSigned( $parts[0] ); - if ( $network !== false && is_numeric( $parts[1] ) && $parts[1] >= 0 && $parts[1] <= 32 ) { - $bits = $parts[1]; + list( $network, $bits ) = $parts; + $network = ip2long( $network ); + if ( $network !== false && is_numeric( $bits ) && $bits >= 0 && $bits <= 32 ) { if ( $bits == 0 ) { $network = 0; } else { - $network &= ~((1 << (32 - $bits)) - 1); + $network &= ~( ( 1 << ( 32 - $bits ) ) - 1); } # Convert to unsigned if ( $network < 0 ) { @@ -461,8 +418,8 @@ class IP { } /** - * Given a string range in a number of formats, return the start and end of - * the range in hexadecimal. + * Given a string range in a number of formats, + * return the start and end of the range in hexadecimal. * * Formats are: * 1.2.3.4/24 CIDR @@ -472,27 +429,31 @@ class IP { * 2001:0db8:85a3::7344/96 CIDR * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range * 2001:0db8:85a3::7344 Single IP - * @return array(string, int) + * @param $range String: IP range + * @return array(string, string) */ public static function parseRange( $range ) { - // Use IPv6 functions if needed - if ( self::isIPv6( $range ) ) { - return self::parseRange6( $range ); - } + // CIDR notation if ( strpos( $range, '/' ) !== false ) { - # CIDR + if ( self::isIPv6( $range ) ) { + return self::parseRange6( $range ); + } list( $network, $bits ) = self::parseCIDR( $range ); if ( $network === false ) { $start = $end = false; } else { $start = sprintf( '%08X', $network ); - $end = sprintf( '%08X', $network + pow( 2, (32 - $bits) ) - 1 ); + $end = sprintf( '%08X', $network + pow( 2, ( 32 - $bits ) ) - 1 ); } + // Explicit range } elseif ( strpos( $range, '-' ) !== false ) { - # Explicit range list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) ); - if( self::isIPAddress( $start ) && self::isIPAddress( $end ) ) { - $start = self::toUnsigned( $start ); $end = self::toUnsigned( $end ); + if ( self::isIPv6( $start ) && self::isIPv6( $end ) ) { + return self::parseRange6( $range ); + } + if ( self::isIPv4( $start ) && self::isIPv4( $end ) ) { + $start = self::toUnsigned( $start ); + $end = self::toUnsigned( $end ); if ( $start > $end ) { $start = $end = false; } else { @@ -513,18 +474,106 @@ class IP { } } + /** + * Convert a network specification in IPv6 CIDR notation to an + * integer network and a number of bits + * + * @return array(string, int) + */ + private static function parseCIDR6( $range ) { + # Explode into + $parts = explode( '/', IP::sanitizeIP( $range ), 2 ); + if ( count( $parts ) != 2 ) { + return array( false, false ); + } + list( $network, $bits ) = $parts; + $network = self::IPv6ToRawHex( $network ); + if ( $network !== false && is_numeric( $bits ) && $bits >= 0 && $bits <= 128 ) { + if ( $bits == 0 ) { + $network = "0"; + } else { + # Native 32 bit functions WONT work here!!! + # Convert to a padded binary number + $network = wfBaseConvert( $network, 16, 2, 128 ); + # Truncate the last (128-$bits) bits and replace them with zeros + $network = str_pad( substr( $network, 0, $bits ), 128, 0, STR_PAD_RIGHT ); + # Convert back to an integer + $network = wfBaseConvert( $network, 2, 10 ); + } + } else { + $network = false; + $bits = false; + } + return array( $network, (int)$bits ); + } + + /** + * Given a string range in a number of formats, return the + * start and end of the range in hexadecimal. For IPv6. + * + * Formats are: + * 2001:0db8:85a3::7344/96 CIDR + * 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range + * 2001:0db8:85a3::7344/96 Single IP + * @return array(string, string) + */ + private static function parseRange6( $range ) { + # Expand any IPv6 IP + $range = IP::sanitizeIP( $range ); + // CIDR notation... + if ( strpos( $range, '/' ) !== false ) { + list( $network, $bits ) = self::parseCIDR6( $range ); + if ( $network === false ) { + $start = $end = false; + } else { + $start = wfBaseConvert( $network, 10, 16, 32, false ); + # Turn network to binary (again) + $end = wfBaseConvert( $network, 10, 2, 128 ); + # Truncate the last (128-$bits) bits and replace them with ones + $end = str_pad( substr( $end, 0, $bits ), 128, 1, STR_PAD_RIGHT ); + # Convert to hex + $end = wfBaseConvert( $end, 2, 16, 32, false ); + # see toHex() comment + $start = "v6-$start"; + $end = "v6-$end"; + } + // Explicit range notation... + } elseif ( strpos( $range, '-' ) !== false ) { + list( $start, $end ) = array_map( 'trim', explode( '-', $range, 2 ) ); + $start = self::toUnsigned6( $start ); + $end = self::toUnsigned6( $end ); + if ( $start > $end ) { + $start = $end = false; + } else { + $start = wfBaseConvert( $start, 10, 16, 32, false ); + $end = wfBaseConvert( $end, 10, 16, 32, false ); + } + # see toHex() comment + $start = "v6-$start"; + $end = "v6-$end"; + } else { + # Single IP + $start = $end = self::toHex( $range ); + } + if ( $start === false || $end === false ) { + return array( false, false ); + } else { + return array( $start, $end ); + } + } + /** * Determine if a given IPv4/IPv6 address is in a given CIDR network - * @param $addr The address to check against the given range. - * @param $range The range to check the given address against. - * @return bool Whether or not the given address is in the given range. + * + * @param $addr String: the address to check against the given range. + * @param $range String: the range to check the given address against. + * @return Boolean: whether or not the given address is in the given range. */ public static function isInRange( $addr, $range ) { - // Convert to IPv6 if needed $hexIP = self::toHex( $addr ); list( $start, $end ) = self::parseRange( $range ); - return (strcmp($hexIP, $start) >= 0 && - strcmp($hexIP, $end) <= 0); + return ( strcmp( $hexIP, $start ) >= 0 && + strcmp( $hexIP, $end ) <= 0 ); } /** @@ -534,29 +583,34 @@ class IP { * This currently only checks a few IPV4-to-IPv6 related cases. More * unusual representations may be added later. * - * @param $addr something that might be an IP address - * @return valid dotted quad IPv4 address or null + * @param $addr String: something that might be an IP address + * @return String: valid dotted quad IPv4 address or null */ public static function canonicalize( $addr ) { - if ( self::isValid( $addr ) ) + if ( self::isValid( $addr ) ) { return $addr; - + } // Turn mapped addresses from ::ce:ffff:1.2.3.4 to 1.2.3.4 - if ( strpos($addr,':') !==false && strpos($addr,'.') !==false ) { - $addr = substr( $addr, strrpos($addr,':')+1 ); - if( self::isIPv4($addr) ) return $addr; + if ( strpos( $addr, ':' ) !== false && strpos( $addr, '.' ) !== false ) { + $addr = substr( $addr, strrpos( $addr, ':' ) + 1 ); + if ( self::isIPv4( $addr ) ) { + return $addr; + } } - // IPv6 loopback address $m = array(); - if ( preg_match( '/^0*' . RE_IPV6_GAP . '1$/', $addr, $m ) ) - return '127.0.0.1'; - + if ( preg_match( '/^0*' . RE_IPV6_GAP . '1$/', $addr, $m ) ) { + return '127.0.0.1'; + } // IPv4-mapped and IPv4-compatible IPv6 addresses - if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . '(' . RE_IP_ADD . ')$/i', $addr, $m ) ) + if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . '(' . RE_IP_ADD . ')$/i', $addr, $m ) ) { return $m[1]; - if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . RE_IPV6_WORD . ':' . RE_IPV6_WORD . '$/i', $addr, $m ) ) + } + if ( preg_match( '/^' . RE_IPV6_V4_PREFIX . RE_IPV6_WORD . + ':' . RE_IPV6_WORD . '$/i', $addr, $m ) ) + { return long2ip( ( hexdec( $m[1] ) << 16 ) + hexdec( $m[2] ) ); + } return null; // give up } -- cgit v1.2.2