Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 11
ProxyLookup
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 3
30
0.00% covered (danger)
0.00%
0 / 11
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 isConfiguredProxy
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 5
 isTrustedProxy
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */
use Wikimedia\IPSet;
/**
 * @since 1.28
 */
class ProxyLookup {
    /**
     * @var string[]
     */
    private $proxyServers;
    /**
     * @var string[]
     */
    private $proxyServersComplex;
    /**
     * @var IPSet|null
     */
    private $proxyIPSet;
    /**
     * @param string[] $proxyServers Simple list of IPs
     * @param string[] $proxyServersComplex Complex list of IPs/ranges
     */
    public function __construct( $proxyServers, $proxyServersComplex ) {
        $this->proxyServers = $proxyServers;
        $this->proxyServersComplex = $proxyServersComplex;
    }
    /**
     * Checks if an IP matches a proxy we've configured
     *
     * @param string $ip
     * @return bool
     */
    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
        if ( !$this->proxyIPSet ) {
            $this->proxyIPSet = new IPSet( $this->proxyServersComplex );
        }
        return $this->proxyIPSet->match( $ip );
    }
    /**
     * Checks if an IP is a trusted proxy provider.
     * Useful to tell if X-Forwarded-For data is possibly bogus.
     * CDN cache servers for the site are whitelisted.
     *
     * @param string $ip
     * @return bool
     */
    public function isTrustedProxy( $ip ) {
        $trusted = $this->isConfiguredProxy( $ip );
        Hooks::runner()->onIsTrustedProxy( $ip, $trusted );
        return $trusted;
    }
}