wikimedia/ip-utils

Parse, match, and analyze IP addresses and CIDR ranges

5.0.0 2023-09-28 00:40 UTC

Requires

• php: >=7.4.3
• wikimedia/base-convert: ^2.0.0

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 41.0.0
• mediawiki/mediawiki-phan-config: 0.13.0
• mediawiki/minus-x: 1.1.1
• ockcyp/covers-validator: 1.6.0
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.3.2
• phpunit/phpunit: 9.5.28

GPL-2.0-or-later

• MediaWiki developers

README

IPUtils

Parse, match, and analyze IP addresses and CIDR ranges. This library supports both IPv4 and IPv6.

Additional documentation about the library can be found on mediawiki.org.

Usage

use Wikimedia\IPUtils;

IPUtils::isIPAddress( '::1' );
IPUtils::isIPv4( '124.24.52.13' );

IPSet can be up to 100x faster than calling IPUtils::isInRange() over multiple CIDR specs.

use Wikimedia\IPSet;

// This will calculate an optimized data structure for the set
$ipset = new IPSet( [
    '208.80.154.0/26',
    '2620:0:861:1::/64',
    '10.64.0.0/22',
] );

// Run fast checks against the same re-usable IPSet object
if ( $ipset->match( $ip ) ) {
    // ...
}

Running tests

composer install --prefer-dist
composer test

History

The IPUtils class started life in 2006 as part of MediaWiki 1.7 (r15572). It was split out of the MediaWiki codebase and published as an independent library during the MediaWiki 1.34 development cycle.

The IPSet class was created by Brandon Black in 2014 as faster alternative to IPUtils::isInRange() (MediaWiki 1.24, change 131758). It was moved to a library during the MediaWiki 1.26 development cycle (change 221179, change 218384).