<?php
-/*
- * @Author "Ashar Voultoiz" <hashar@altern.org>
- * @License GPL v2 or later
+/**
+ * Functions and constants to play with IP addresses and ranges
+ *
+ * @file
+ * @author Ashar Voultoiz <hashar@altern.org>
+ * @license GPL v2 or later
*/
// 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_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);
+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_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!
-define( 'RE_IPV6_ADD', '(:(:' . RE_IPV6_WORD . '){1,7}|' . RE_IPV6_WORD . '(:{1,2}' . RE_IPV6_WORD . '|::$){1,7})' );
+// 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 ":"
+ ')'
+);
define( 'RE_IPV6_BLOCK', RE_IPV6_ADD . '\/' . RE_IPV6_PREFIX );
// 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 . '|)' .
+ RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)' . // IPv4
'|' .
- RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)' .
- ')' );
+ RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)' . // IPv6
+ ')'
+);
/**
* A collection of public static functions to play with IP address
* @return string
*/
public static function isIPAddress( $ip ) {
- if ( !$ip ) return false;
+ if ( !$ip ) {
+ return false;
+ }
if ( is_array( $ip ) ) {
- throw new MWException( "invalid value passed to " . __METHOD__ );
+ 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 preg_match( '/^' . IP_ADDRESS_STRING . '$/', $ip ) && ( substr_count( $ip, '::' ) < 2 );
}
public static function isIPv6( $ip ) {
- if ( !$ip ) return false;
+ if ( !$ip ) {
+ return false;
+ }
if( is_array( $ip ) ) {
- throw new MWException( "invalid value passed to " . __METHOD__ );
+ 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) && ( substr_count($ip, '::') < 2);
+ return preg_match( '/^' . RE_IPV6_ADD . '(\/' . RE_IPV6_PREFIX . '|)$/', $ip )
+ && ( $doubleColons == 1 || substr_count( $ip, ':' ) == 7 );
}
public static function isIPv4( $ip ) {
- if ( !$ip ) return false;
+ if ( !$ip ) {
+ return false;
+ }
return preg_match( '/^' . RE_IP_ADD . '(\/' . RE_IP_PREFIX . '|)$/', $ip);
}
* @return string
*/
public static function IPv4toIPv6( $ip ) {
- if ( !$ip ) return null;
+ if ( !$ip ) {
+ return null;
+ }
// Convert only if needed
- if ( self::isIPv6( $ip ) ) return $ip;
+ if ( self::isIPv6( $ip ) ) {
+ return $ip;
+ }
// IPv4 CIDRs
if ( strpos( $ip, '/' ) !== false ) {
$parts = explode( '/', $ip, 2 );
* @return string
*/
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;
+ 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 sanitizeIP( $ip ) {
$ip = trim( $ip );
- if ( $ip === '' ) return null;
+ if ( $ip === '' ) {
+ return null;
+ }
// Trim and return IPv4 addresses
- if ( self::isIPv4($ip) ) return $ip;
+ if ( self::isIPv4( $ip ) ) {
+ return $ip;
+ }
// Only IPv6 addresses can be expanded
- if ( !self::isIPv6($ip) ) return $ip;
+ if ( !self::isIPv6( $ip ) ) {
+ return $ip;
+ }
// Remove any whitespaces, convert to upper case
$ip = strtoupper( $ip );
// Expand zero abbreviations
- if ( strpos( $ip, '::' ) !== false ) {
- $ip = str_replace('::', str_repeat(':0', 8 - substr_count($ip, ':')) . ':', $ip);
- }
- // For IPs that start with "::", correct the final IP so that it starts with '0' and not ':'
- if ( $ip[0] == ':' ) $ip = "0$ip";
- // Remove leading zereos from each bloc as needed
- $ip = preg_replace( '/(^|:)0+' . RE_IPV6_WORD . '/', '$1$2', $ip );
- return $ip;
+ $abbrevPos = strpos( $ip, '::' );
+ if ( $abbrevPos !== false ) {
+ // If the '::' is at the beginning...
+ if( $abbrevPos == 0 ) {
+ $repeat = '0:';
+ $extra = '';
+ $pad = 9; // 7+2 (due to '::')
+ // If the '::' is at the end...
+ } elseif( $abbrevPos == ( strlen( $ip ) - 2 ) ) {
+ $repeat = ':0';
+ $extra = '';
+ $pad = 9; // 7+2 (due to '::')
+ // If the '::' is at the end...
+ } else {
+ $repeat = ':0';
+ $extra = ':';
+ $pad = 8; // 6+2 (due to '::')
+ }
+ $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 );
+ return $ip;
}
/**
* Given an unsigned integer, returns an IPv6 address in octet notation
- * @param $ip integer IP address.
+ * @param $ip_int integer IP address.
* @return string
*/
public static function toOctet( $ip_int ) {
- // Convert to padded uppercase hex
- $ip_hex = wfBaseConvert($ip_int, 10, 16, 32, false);
- // Seperate 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;
+ // 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;
+ }
+
+ /**
+ * Convert an IPv4 or IPv6 hexadecimal representation back to readable format
+ */
+ public static function formatHex( $hex ) {
+ if ( substr( $hex, 0, 3 ) == 'v6-' ) {
+ return self::hexToOctet( $hex );
+ } else {
+ return self::hexToQuad( $hex );
+ }
+ }
+
+ /**
+ * Given a hexadecimal number, returns to an IPv6 address in octet notation
+ * @param $ip_hex string hex IP
+ * @return string
+ */
+ 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 );
+ 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
+ $s = '';
+ for ( $i = 0; $i < 4; $i++ ) {
+ if ( $s !== '' ) {
+ $s .= '.';
+ }
+ $s .= base_convert( substr( $ip, $i * 2, 2 ), 16, 10 );
+ }
+ return $s;
}
/**
# Convert to hex
$end = wfBaseConvert( $end, 2, 16, 32, false );
# see toHex() comment
- $start = "v6-$start"; $end = "v6-$end";
+ $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 );
+ $start = self::toUnsigned6( $start );
+ $end = self::toUnsigned6( $end );
if ( $start > $end ) {
$start = $end = false;
} else {
$end = wfBaseConvert( $end, 10, 16, 32, false );
}
# see toHex() comment
- $start = "v6-$start"; $end = "v6-$end";
+ $start = "v6-$start";
+ $end = "v6-$end";
} else {
# Single IP
$start = $end = self::toHex( $range );
} 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) );
+ return ( preg_match( '/^' . RE_IP_ADD . '$/', $ip ) || preg_match( '/^' . RE_IPV6_ADD . '$/', $ip ) );
}
/**
* @return boolean True if it is valid.
*/
public static function isValidBlock( $ipblock ) {
- return ( count(self::toArray($ipblock)) == 1 + 5 );
+ return ( count( self::toArray( $ipblock ) ) == 1 + 5 );
}
/**
* Split out an IP block as an array of 4 bytes and a mask,
* return false if it can't be determined
*
- * @param $ip string A quad dotted/octet IP address
+ * @param $ipblock string A quad dotted/octet IP address
* @return array
*/
public static function toArray( $ipblock ) {
$matches = array();
- if( preg_match( '/^' . RE_IP_ADD . '(?:\/(?:'.RE_IP_PREFIX.'))?' . '$/', $ipblock, $matches ) ) {
+ 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 ) ) {
+ } elseif ( preg_match( '/^' . RE_IPV6_ADD . '(?:\/(?:' . RE_IPV6_PREFIX . '))?' . '$/', $ipblock, $matches ) ) {
return $matches;
} else {
return false;
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 );
+ $n = self::isIPv6( $ip ) ? 'v6-' . wfBaseConvert( $n, 10, 16, 32, false ) : wfBaseConvert( $n, 10, 16, 8, false );
}
return $n;
}
if ( $bits == 0 ) {
$network = 0;
} else {
- $network &= ~((1 << (32 - $bits)) - 1);
+ $network &= ~( ( 1 << ( 32 - $bits ) ) - 1);
}
# Convert to unsigned
if ( $network < 0 ) {
$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 );
}
} 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 );
+ $start = self::toUnsigned( $start );
+ $end = self::toUnsigned( $end );
if ( $start > $end ) {
$start = $end = false;
} else {
} 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.
- */
- public static function isInRange( $addr, $range ) {
- // Convert to IPv6 if needed
- $unsignedIP = self::toHex( $addr );
- list( $start, $end ) = self::parseRange( $range );
- return (($unsignedIP >= $start) && ($unsignedIP <= $end));
- }
-
- /**
- * Convert some unusual representations of IPv4 addresses to their
- * canonical dotted quad representation.
- *
- * 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
- */
- public static function canonicalize( $addr ) {
- if ( self::isValid( $addr ) )
+ }
+
+ /**
+ * 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.
+ */
+ 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 );
+ }
+
+ /**
+ * Convert some unusual representations of IPv4 addresses to their
+ * canonical dotted quad representation.
+ *
+ * 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
+ */
+ public static function canonicalize( $addr ) {
+ if ( self::isValid( $addr ) ) {
return $addr;
+ }
- // Annoying IPv6 representations like ::ffff:1.2.3.4
- if ( strpos($addr,':') !==false && strpos($addr,'.') !==false ) {
- $addr = str_replace( '.', ':', $addr );
- if( IP::isIPv6( $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;
+ }
}
// IPv6 loopback address
$m = array();
- if ( preg_match( '/^0*' . RE_IPV6_GAP . '1$/', $addr, $m ) )
+ 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 ) )
- return $m[1];
- 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] ) );
+ 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 ) ) {
+ return long2ip( ( hexdec( $m[1] ) << 16 ) + hexdec( $m[2] ) );
+ }
return null; // give up
- }
+ }
}