CIDR

The CIDR component provides utilities for working with CIDR (Classless Inter-Domain Routing) notation. It supports both IPv4 and IPv6 addresses.

Containment requires the same address family. IPv6 blocks do not contain IPv4 addresses, and IPv4 blocks do not contain IPv4-mapped IPv6 addresses. Callers that need mapped matching must convert the candidate address first.

The constructor accepts host bits and masks them to the network prefix. For example, 192.168.1.5/24 denotes the same block as 192.168.1.0/24.

Usage

use Psl\CIDR;

$block = new CIDR\Block('192.168.1.0/24');
$block->contains('192.168.1.100'); // true
$block->contains('192.168.2.1'); // false

Block::contains() accepts either a string or an IP\Address object:

use Psl\CIDR;
use Psl\IP\Address;

$block = new CIDR\Block('192.168.1.0/24');

// Using a string
$block->contains('192.168.1.100'); // true

// Using an Address object
$addr = Address::parse('192.168.1.100');
$block->contains($addr); // true

Examples

IPv4

use Psl\CIDR;

$private = new CIDR\Block('10.0.0.0/8');
$private->contains('10.1.2.3'); // true
$private->contains('172.16.0.1'); // false
$private->contains('::ffff:10.1.2.3'); // false: different address family

$subnet = new CIDR\Block('192.168.1.5/24'); // Masks host bits to 192.168.1.0/24.
$subnet->contains('192.168.1.0'); // true
$subnet->contains('192.168.1.255'); // true

IPv6

use Psl\CIDR;

$loopback = new CIDR\Block('::1/128');
$loopback->contains('::1'); // true

Single Host

use Psl\CIDR;

$exact = new CIDR\Block('192.168.1.1/32');
$exact->contains('192.168.1.1'); // true
$exact->contains('192.168.1.2'); // false

See src/Psl/CIDR/ for the full API.