2026-11-15 11:40:06 -08:00
|
|
|
<?php
|
|
|
|
|
declare( strict_types=1 );
|
|
|
|
|
|
|
|
|
|
namespace StreamGoals\Tests\Unit;
|
|
|
|
|
|
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
|
use StreamGoals\Core\ClientIp;
|
|
|
|
|
|
|
|
|
|
final class ClientIpTest extends TestCase {
|
|
|
|
|
|
|
|
|
|
private const PROXY = '172.70.1.1';
|
|
|
|
|
private const CLIENT = '203.0.113.9';
|
|
|
|
|
|
|
|
|
|
public function test_direct_mode_uses_remote_addr_and_ignores_headers(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => self::CLIENT, 'HTTP_CF_CONNECTING_IP' => '1.2.3.4', 'HTTP_X_FORWARDED_FOR' => '5.6.7.8' );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, ClientIp::MODE_DIRECT ) );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_cloudflare_mode_uses_cf_header(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_CF_CONNECTING_IP' => self::CLIENT );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, ClientIp::MODE_CLOUDFLARE ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_cloudflare_mode_without_header_falls_back_to_remote_addr(): void {
|
|
|
|
|
$this->assertSame( self::PROXY, ClientIp::resolve( array( 'REMOTE_ADDR' => self::PROXY ), ClientIp::MODE_CLOUDFLARE ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_invalid_header_values_are_ignored(): void {
|
|
|
|
|
foreach ( array( 'not-an-ip', '999.1.1.1', '', '1.2.3.4, 5.6.7.8', '<script>', "1.2.3.4\r\nX: y" ) as $bad ) {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_CF_CONNECTING_IP' => $bad );
|
|
|
|
|
$this->assertSame( self::PROXY, ClientIp::resolve( $srv, ClientIp::MODE_CLOUDFLARE ), "accepted bad value: $bad" );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_x_real_ip_mode(): void {
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_X_REAL_IP' => self::CLIENT ), ClientIp::MODE_REAL_IP ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_forwarded_mode_takes_the_last_entry_not_the_spoofable_first(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_X_FORWARDED_FOR' => '6.6.6.6, ' . self::CLIENT );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, ClientIp::MODE_FORWARDED ) );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_X_FORWARDED_FOR' => self::CLIENT ), ClientIp::MODE_FORWARDED ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_ipv6_is_accepted(): void {
|
|
|
|
|
$this->assertSame( '2001:db8::1', ClientIp::resolve( array( 'REMOTE_ADDR' => self::PROXY, 'HTTP_CF_CONNECTING_IP' => '2001:db8::1' ), ClientIp::MODE_CLOUDFLARE ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_unknown_when_nothing_valid(): void {
|
|
|
|
|
$this->assertSame( 'unknown', ClientIp::resolve( array(), ClientIp::MODE_CLOUDFLARE ) );
|
|
|
|
|
$this->assertSame( 'unknown', ClientIp::resolve( array( 'REMOTE_ADDR' => 'garbage' ) ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_unrecognised_mode_behaves_like_direct(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => self::CLIENT, 'HTTP_CF_CONNECTING_IP' => '1.2.3.4' );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, 'something_else' ) );
|
|
|
|
|
}
|
2026-11-15 12:54:10 -08:00
|
|
|
|
|
|
|
|
public function test_auto_mode_trusts_cf_header_only_from_a_cloudflare_connection(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => '172.70.1.1', 'HTTP_CF_CONNECTING_IP' => self::CLIENT );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, ClientIp::MODE_AUTO ) );
|
|
|
|
|
$v6 = array( 'REMOTE_ADDR' => '2606:4700:3030::1', 'HTTP_CF_CONNECTING_IP' => self::CLIENT );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $v6, ClientIp::MODE_AUTO ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_auto_mode_ignores_a_forged_header_from_a_non_cloudflare_connection(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => '47.151.185.180', 'HTTP_CF_CONNECTING_IP' => '6.6.6.6', 'HTTP_X_FORWARDED_FOR' => '7.7.7.7' );
|
|
|
|
|
$this->assertSame( '47.151.185.180', ClientIp::resolve( $srv, ClientIp::MODE_AUTO ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_auto_mode_falls_back_when_header_missing_or_invalid(): void {
|
|
|
|
|
$this->assertSame( '172.70.1.1', ClientIp::resolve( array( 'REMOTE_ADDR' => '172.70.1.1' ), ClientIp::MODE_AUTO ) );
|
|
|
|
|
$this->assertSame( '172.70.1.1', ClientIp::resolve( array( 'REMOTE_ADDR' => '172.70.1.1', 'HTTP_CF_CONNECTING_IP' => 'nope' ), ClientIp::MODE_AUTO ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_auto_mode_extra_ranges_from_the_filter(): void {
|
|
|
|
|
$srv = array( 'REMOTE_ADDR' => '198.18.0.5', 'HTTP_CF_CONNECTING_IP' => self::CLIENT );
|
|
|
|
|
$this->assertSame( '198.18.0.5', ClientIp::resolve( $srv, ClientIp::MODE_AUTO ) );
|
|
|
|
|
$this->assertSame( self::CLIENT, ClientIp::resolve( $srv, ClientIp::MODE_AUTO, array( '198.18.0.0/15' ) ) );
|
|
|
|
|
}
|
|
|
|
|
|
2026-11-15 14:07:44 -08:00
|
|
|
public function test_bucket_key_ipv4_unchanged_and_unknown_stays(): void {
|
|
|
|
|
$this->assertSame( '203.0.113.9', ClientIp::bucketKey( '203.0.113.9' ) );
|
|
|
|
|
$this->assertSame( 'unknown', ClientIp::bucketKey( 'unknown' ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_bucket_key_ipv6_collapses_to_slash_64(): void {
|
|
|
|
|
$a = ClientIp::bucketKey( '2001:db8:abcd:12::1' );
|
|
|
|
|
$b = ClientIp::bucketKey( '2001:0db8:abcd:0012:ffff:eeee:dddd:cccc' );
|
|
|
|
|
$this->assertSame( $a, $b, 'same /64 must share a bucket' );
|
|
|
|
|
$this->assertSame( '20010db8abcd0012/64', $a );
|
|
|
|
|
$this->assertNotSame( $a, ClientIp::bucketKey( '2001:db8:abcd:13::1' ), 'different /64 must differ' );
|
|
|
|
|
$this->assertNotSame( $a, ClientIp::bucketKey( '203.0.113.9' ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_bucket_key_ipv4_mapped_ipv6_maps_to_the_ipv4(): void {
|
|
|
|
|
$this->assertSame( '203.0.113.9', ClientIp::bucketKey( '::ffff:203.0.113.9' ) );
|
|
|
|
|
$this->assertSame( '203.0.113.9', ClientIp::bucketKey( '::ffff:cb00:7109' ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function test_bucket_key_garbage_becomes_unknown(): void {
|
|
|
|
|
foreach ( array( '', 'garbage', '999.1.1.1', '<script>', 'fe80::1%eth0' ) as $g ) {
|
|
|
|
|
$this->assertSame( 'unknown', ClientIp::bucketKey( $g ), $g );
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|