ProxyLookup.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Request;
 
use BagOStuff;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use Wikimedia\IPSet;
 
class ProxyLookup {
 
    private $proxyServers;
 
    private $proxyServersComplex;
 
    private $proxyIPSet;
 
    private $hookRunner;
 
    private $cache;
 
    public function __construct(
        $proxyServers,
        $proxyServersComplex,
        HookContainer $hookContainer,
        BagOStuff $cache
    ) {
        $this->proxyServers = $proxyServers;
        $this->proxyServersComplex = $proxyServersComplex;
        $this->hookRunner = new HookRunner( $hookContainer );
        $this->cache = $cache;
    }
 
    private function getIPSet() {
        if ( $this->proxyIPSet ) {
            return $this->proxyIPSet;
        }
 
        $this->proxyIPSet = $this->cache->getWithSetCallback(
            $this->cache->makeGlobalKey( 'ProxyLookup', 'ipset', crc32( json_encode( $this->proxyServersComplex ) ) ),
            BagOStuff::TTL_INDEFINITE,
            fn () => new IPSet( $this->proxyServersComplex )
        );
 
        return $this->proxyIPSet;
    }
 
    public function isConfiguredProxy( $ip ) {
        // Quick check of known singular proxy servers
        if ( in_array( $ip, $this->proxyServers, true ) ) {
            return true;
        }
 
        // Check against addresses and CIDR nets in the complex list
        return $this->getIPSet()->match( $ip );
    }
 
    public function isTrustedProxy( $ip ) {
        $trusted = $this->isConfiguredProxy( $ip );
        $this->hookRunner->onIsTrustedProxy( $ip, $trusted );
        return $trusted;
    }
}
 
class_alias( ProxyLookup::class, 'ProxyLookup' );