A collection of public static functions to play with IP address and IP ranges. More...

Static Public Member Functions
static	canonicalize ( $addr)
	Convert some unusual representations of IPv4 addresses to their canonical dotted quad representation. More...

static	combineHostAndPort ( $host, $port, $defaultPort=false)
	Given a host name and a port, combine them into host/port string like you might find in a URL. More...

static	formatHex ( $hex)
	Convert an IPv4 or IPv6 hexadecimal representation back to readable format. More...

static	getSubnet ( $ip)
	Returns the subnet of a given IP. More...

static	hexToOctet ( $ip_hex)
	Converts a hexadecimal number to an IPv6 address in octet notation. More...

static	hexToQuad ( $ip_hex)
	Converts a hexadecimal number to an IPv4 address in quad-dotted notation. More...

static	isInRange ( $addr, $range)
	Determine if a given IPv4/IPv6 address is in a given CIDR network. More...

static	isInRanges ( $ip, $ranges)
	Determines if an IP address is a list of CIDR a.b.c.d/n ranges. More...

static	isIPAddress ( $ip)
	Determine if a string is as valid IP address or network (CIDR prefix). More...

static	isIPv4 ( $ip)
	Given a string, determine if it as valid IP in IPv4 only. More...

static	isIPv6 ( $ip)
	Given a string, determine if it as valid IP in IPv6 only. More...

static	isPublic ( $ip)
	Determine if an IP address really is an IP address, and if it is public, i.e. More...

static	isValid ( $ip)
	Validate an IP address. More...

static	isValidBlock ( $ipRange)
	Validate an IP range (valid address with a valid CIDR prefix). More...

static	isValidRange ( $ipRange)
	Validate an IP range (valid address with a valid CIDR prefix). More...

static	parseCIDR ( $range)
	Convert a network specification in CIDR notation to an integer network and a number of bits. More...

static	parseRange ( $range)
	Given a string range in a number of formats, return the start and end of the range in hexadecimal. More...

static	prettifyIP ( $ip)
	Prettify an IP for display to end users. More...

static	sanitizeIP ( $ip)
	Convert an IP into a verbose, uppercase, normalized form. More...

static	sanitizeRange ( $range)
	Gets rid of unneeded numbers in quad-dotted/octet IP strings For example, 127.111.113.151/24 -> 127.111.113.0/24. More...

static	splitHostAndPort ( $both)
	Given a host/port string, like one might find in the host part of a URL per RFC 2732, split the hostname part and the port part and return an array with an element for each. More...

static	toHex ( $ip)
	Return a zero-padded upper case hexadecimal representation of an IP address. More...

Static Private Member Functions
static	IPv6ToRawHex ( $ip)
	Given an IPv6 address in octet notation, returns a pure hex string. More...

static	parseCIDR6 ( $range)
	Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits. More...

static	parseRange6 ( $range)
	Given a string range in a number of formats, return the start and end of the range in hexadecimal. More...

Detailed Description

A collection of public static functions to play with IP address and IP ranges.

Definition at line 67 of file IP.php.

Member Function Documentation

◆ canonicalize()

static IP::canonicalize ( $addr )

static

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.

Parameters

string $addr Something that might be an IP address

Returns: string|null Valid dotted quad IPv4 address or null

Definition at line 687 of file IP.php.

Referenced by IPTest\testIPCanonicalizeMappedAddress(), and IPTest\testIPCanonicalizeOnValidIp().

◆ combineHostAndPort()

static IP::combineHostAndPort	(	$host,
		$port,
		$defaultPort = `false`
	)

static

Given a host name and a port, combine them into host/port string like you might find in a URL.

If the host contains a colon, wrap it in square brackets like in RFC 2732. If the port matches the default port, omit the port specification

Parameters

string	$host
int	$port
bool \| int	$defaultPort

Returns: string

Definition at line 315 of file IP.php.

Referenced by WebRequest\detectServer(), EtcdConfig\fetchAllFromEtcd(), and IPTest\testCombineHostAndPort().

◆ formatHex()

static IP::formatHex ( $hex )

static

Convert an IPv4 or IPv6 hexadecimal representation back to readable format.

Parameters

string $hex Number, with "v6-" prefix if it is IPv6

Returns: string Quad-dotted (IPv4) or octet notation (IPv6)

Definition at line 332 of file IP.php.

Referenced by ApiQueryBlocks\execute().

◆ getSubnet()

static IP::getSubnet ( $ip )

static

Returns the subnet of a given IP.

Parameters

string $ip

Returns: string|false

Definition at line 742 of file IP.php.

Referenced by User\pingLimiter().

◆ hexToOctet()

static IP::hexToOctet ( $ip_hex )

static

Converts a hexadecimal number to an IPv6 address in octet notation.

Parameters

string $ip_hex Pure hex (no v6- prefix)

Returns: string (of format a:b:c:d:e:f:g:h)

Definition at line 346 of file IP.php.

Referenced by IPTest\testHexToOctet().

◆ hexToQuad()

static IP::hexToQuad ( $ip_hex )

static

Converts a hexadecimal number to an IPv4 address in quad-dotted notation.

Parameters

string $ip_hex Pure hex

Returns: string (of format a.b.c.d)

Definition at line 366 of file IP.php.

Referenced by IPTest\testHexToQuad().

◆ IPv6ToRawHex()

static IP::IPv6ToRawHex ( $ip )

staticprivate

Given an IPv6 address in octet notation, returns a pure hex string.

Parameters

string $ip Octet ipv6 IP address.

Returns: string|bool Pure hex (uppercase); false on failure

Definition at line 450 of file IP.php.

◆ isInRange()

static IP::isInRange	(	$addr,
		$range
	)

static

Determine if a given IPv4/IPv6 address is in a given CIDR network.

Parameters

string	$addr	The address to check against the given range.
string	$range	The range to check the given address against.

Returns: bool Whether or not the given address is in the given range.

Note: This can return unexpected results for invalid arguments! Make sure you pass a valid IP address and IP range.

Definition at line 650 of file IP.php.

Referenced by Autopromote\checkCondition(), MWRestrictions\checkIP(), Block\isWhitelistedFromAutoblocks(), and IPTest\testIPIsInRange().

◆ isInRanges()

static IP::isInRanges	(	$ip,
		$ranges
	)

static

Determines if an IP address is a list of CIDR a.b.c.d/n ranges.

Since: 1.25

Parameters

string	$ip	the IP to check
array	$ranges	the IP ranges, each element a range

Returns: bool true if the specified adress belongs to the specified range; otherwise, false.

Definition at line 668 of file IP.php.

Referenced by User\getBlockedStatus(), SimpleCaptcha\isIPWhitelisted(), and User\isPingLimitable().

◆ isIPAddress()

static IP::isIPAddress ( $ip )

static

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.

Parameters

string $ip Possible IP address

Returns: bool

Definition at line 77 of file IP.php.

Referenced by SimpleCaptcha\buildValidIPs(), RecentChange\checkIPAddress(), SpecialContributions\execute(), DeletedContributionsPage\execute(), User\getGlobalBlock(), ManualLogEntry\getRecentChange(), SpecialBlock\getTargetUserTitle(), User\isLocallyBlockedProxy(), MWRestrictions\loadFromArray(), ConfirmEditHooks\onAlternateEditPreview(), RevDelList\setVisibility(), IPTest\testisIPAddress(), IPTest\testIsNotIPAddress(), HTMLRestrictionsField\validate(), and ApiBase\validateUser().

◆ isIPv4()

static IP::isIPv4 ( $ip )

static

Given a string, determine if it as valid IP in IPv4 only.

Note: Unlike isValid(), this looks for networks too.

Parameters

string $ip Possible IP address

Returns: bool

Definition at line 99 of file IP.php.

Referenced by ApiQueryBlocks\execute(), SpecialContributions\execute(), SquidPurgeClient\getIP(), User\inDnsBlacklist(), ContribsPager\isQueryableRange(), HTMLUserTextField\isValidIPRange(), UDPTransport\newFromString(), IPTest\testIsIPv4(), IPTest\testisNotIPv4(), and SpecialBlock\validateTarget().

◆ isIPv6()

static IP::isIPv6 ( $ip )

static

Given a string, determine if it as valid IP in IPv6 only.

Note: Unlike isValid(), this looks for networks too.

Parameters

string $ip Possible IP address

Returns: bool

Definition at line 88 of file IP.php.

Referenced by ApiQueryBlocks\execute(), SquidPurgeClient\getIP(), FileCacheBase\incrMissesRecent(), User\isIP(), ContribsPager\isQueryableRange(), HTMLUserTextField\isValidIPRange(), IPTest\testisIPv6(), and SpecialBlock\validateTarget().

◆ isPublic()

static IP::isPublic ( $ip )

static

Determine if an IP address really is an IP address, and if it is public, i.e.

not RFC 1918 or similar

Parameters

string $ip

Returns: bool

Definition at line 388 of file IP.php.

Referenced by IPTest\testIsPublic().

◆ isValid()

static IP::isValid ( $ip )

static

Validate an IP address.

Ranges are NOT considered valid. SIIT IPv4-translated addresses are rejected.

Note: canonicalize() tries to convert translated addresses to IPv4.

Parameters

string $ip

Returns: bool True if it is valid

Definition at line 111 of file IP.php.

Referenced by WikiPage\archiveRevisions(), PopulateIpChanges\doDBUpdates(), GetLagTimes\execute(), ResetAuthenticationThrottle\execute(), Block\getBlocksForIPList(), Article\getRobotPolicy(), RequestContext\importScopedSession(), FileCacheBase\incrMissesRecent(), Revision\RevisionStore\insertIpChangesRow(), Block\parseTarget(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\providerAllowsAuthenticationDataChange(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\sendPasswordResetEmail(), Article\showViewFooter(), IPTest\testInvalidIPs(), IPTest\testValidIPs(), HTMLUserTextField\validate(), and XmlDumpWriter\writeContributor().

◆ isValidBlock()

static IP::isValidBlock ( $ipRange )

static

Validate an IP range (valid address with a valid CIDR prefix).

SIIT IPv4-translated addresses are rejected.

Note: canonicalize() tries to convert translated addresses to IPv4.

Deprecated:: since 1.30. Use the equivalent IP::isValidRange().

Parameters

string $ipRange

Returns: bool True if it is valid

Definition at line 125 of file IP.php.

Referenced by HTMLUserTextField\isValidIPRange().

◆ isValidRange()

static IP::isValidRange ( $ipRange )

static

Validate an IP range (valid address with a valid CIDR prefix).

SIIT IPv4-translated addresses are rejected.

Note: canonicalize() tries to convert translated addresses to IPv4.

Parameters

string $ipRange

Returns: bool True if it is valid

Since: 1.30

Definition at line 138 of file IP.php.

Referenced by SpecialContributions\execute(), User\isIPRange(), NukeHooks\nukeContributionsLinks(), Block\parseTarget(), IPTest\testInvalidRanges(), and IPTest\testValidRanges().

◆ parseCIDR()

static IP::parseCIDR ( $range )

static

Convert a network specification in CIDR notation to an integer network and a number of bits.

Parameters

string $range IP with CIDR prefix

Returns: array(int or string, int)

Definition at line 470 of file IP.php.

Referenced by IPTest\assertFalseCIDR(), IPTest\assertNet(), ApiQueryBlocks\execute(), ContribsPager\isQueryableRange(), and IPTest\testCIDRParsing().

◆ parseCIDR6()

static IP::parseCIDR6 ( $range )

staticprivate

Convert a network specification in IPv6 CIDR notation to an integer network and a number of bits.

Parameters

string $range

Returns: array(string, int)

Definition at line 560 of file IP.php.

◆ parseRange()

static IP::parseRange ( $range )

static

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 1.2.3.4 - 1.2.3.5 Explicit range 1.2.3.4 Single IP

2001:0db8:85a3::7344/96 CIDR 2001:0db8:85a3::7344 - 2001:0db8:85a3::7344 Explicit range 2001:0db8:85a3::7344 Single IP

Parameters

string $range IP range

Returns: array [ string, string ]

Definition at line 513 of file IP.php.

Referenced by ApiQueryBlocks\execute(), SpecialBlockList\getBlockListPager(), ContribsPager\getIpRangeConds(), Block\getRangeEnd(), Block\getRangeStart(), and Block\newLoad().

◆ parseRange6()

static IP::parseRange6 ( $range )

staticprivate

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

Parameters

string $range

Returns: array(string, string)

Definition at line 601 of file IP.php.

◆ prettifyIP()

static IP::prettifyIP ( $ip )

static

Prettify an IP for display to end users.

This will make it more compact and lower-case.

Parameters

string $ip

Returns: string

Definition at line 213 of file IP.php.

Referenced by IPTest\testPrettifyIP(), and Linker\userLink().

◆ sanitizeIP()

static IP::sanitizeIP ( $ip )

static

Convert an IP into a verbose, uppercase, normalized form.

Both IPv4 and IPv6 addresses are trimmed. Additionally, IPv6 addresses in octet notation are expanded to 8 words; IPv4 addresses have leading zeros, in each octet, removed.

Parameters

string $ip IP address in quad or octet form (CIDR or not).

Returns: string

Definition at line 152 of file IP.php.

Referenced by BlockTest\addXffBlocks(), User\getBlockedStatus(), User\getName(), Block\parseTarget(), MediaWikiTitleCodec\splitTitleString(), IPTest\testSanitizeIP(), and ApiBase\validateUser().

◆ sanitizeRange()

static IP::sanitizeRange ( $range )

static

Gets rid of unneeded numbers in quad-dotted/octet IP strings For example, 127.111.113.151/24 -> 127.111.113.0/24.

Parameters

string $range IP address to normalize

Returns: string

Definition at line 725 of file IP.php.

Referenced by BlockTest\addXffBlocks(), FileCacheBase\incrMissesRecent(), Block\parseTarget(), and IPTest\testSanitizeRange().

◆ splitHostAndPort()

static IP::splitHostAndPort ( $both )

static

Given a host/port string, like one might find in the host part of a URL per RFC 2732, split the hostname part and the port part and return an array with an element for each.

If there is no port part, the array will have false in place of the port. If the string was invalid in some way, false is returned.

This was easy with IPv4 and was generally done in an ad-hoc way, but with IPv6 it's somewhat more complicated due to the need to parse the square brackets and colons.

A bare IPv6 address is accepted despite the lack of square brackets.

Parameters

string $both The string with the host and port

Returns: array|false Array normally, false on certain failures

Definition at line 266 of file IP.php.

Referenced by WebRequest\detectServer(), Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect(), MysqlMaintenance\runMysql(), and IPTest\testSplitHostAndPort().

◆ toHex()

static IP::toHex ( $ip )

static

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.

Parameters

string $ip Quad dotted/octet IP address.

Returns: string|bool False on failure

Definition at line 417 of file IP.php.

Referenced by Block\chooseBlock(), PopulateIpChanges\doDBUpdates(), Block\getBlocksForIPList(), Block\getRangeEnd(), Block\getRangeStart(), Revision\RevisionStore\insertIpChangesRow(), Block\newLoad(), RevisionDbTestBase\testInsertOn(), IPTest\testToHex(), and PageArchiveTestBase\testUndeleteRevisions().

The documentation for this class was generated from the following file:

includes/libs/IP.php

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ canonicalize()

◆ combineHostAndPort()

◆ formatHex()

◆ getSubnet()

◆ hexToOctet()

◆ hexToQuad()

◆ IPv6ToRawHex()

◆ isInRange()

◆ isInRanges()

◆ isIPAddress()

◆ isIPv4()

◆ isIPv6()

◆ isPublic()

◆ isValid()

◆ isValidBlock()

◆ isValidRange()

◆ parseCIDR()

◆ parseCIDR6()

◆ parseRange()

◆ parseRange6()

◆ prettifyIP()

◆ sanitizeIP()

◆ sanitizeRange()

◆ splitHostAndPort()

◆ toHex()