BlockManager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Block;

use DateTime;
use DateTimeZone;
use Hooks;
use IP;
use LogicException;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\User\UserIdentity;
use MWCryptHash;
use Psr\Log\LoggerInterface;
use User;
use WebRequest;
use WebResponse;
use Wikimedia\IPSet;

class BlockManager {
    private $permissionManager;

    private $options;

    public const CONSTRUCTOR_OPTIONS = [
        'ApplyIpBlocksToXff',
        'CookieSetOnAutoblock',
        'CookieSetOnIpBlock',
        'DnsBlacklistUrls',
        'EnableDnsBlacklist',
        'ProxyList',
        'ProxyWhitelist',
        'SecretKey',
        'SoftBlockRanges',
    ];

    private $logger;

    public function __construct(
        ServiceOptions $options,
        PermissionManager $permissionManager,
        LoggerInterface $logger
    ) {
        $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
        $this->options = $options;
        $this->permissionManager = $permissionManager;
        $this->logger = $logger;
    }

    public function getUserBlock( User $user, $request, $fromReplica ) {
        $fromMaster = !$fromReplica;
        $ip = null;

        // If this is the global user, they may be affected by IP blocks (case #1),
        // or they may be exempt (case #2). If affected, look for additional blocks
        // against the IP address.
        $checkIpBlocks = $request &&
            !$this->permissionManager->userHasRight( $user, 'ipblock-exempt' );

        if ( $request && $checkIpBlocks ) {

            // Case #1: checking the global user, including IP blocks
            $ip = $request->getIP();
            // TODO: remove dependency on DatabaseBlock (T221075)
            $blocks = DatabaseBlock::newListFromTarget( $user, $ip, $fromMaster );
            $this->getAdditionalIpBlocks( $blocks, $request, !$user->isRegistered(), $fromMaster );
            $this->getCookieBlock( $blocks, $user, $request );

        } elseif ( $request ) {

            // Case #2: checking the global user, but they are exempt from IP blocks
            // TODO: remove dependency on DatabaseBlock (T221075)
            $blocks = DatabaseBlock::newListFromTarget( $user, null, $fromMaster );
            $this->getCookieBlock( $blocks, $user, $request );

        } else {

            // Case #3: checking whether a user's account is blocked
            // TODO: remove dependency on DatabaseBlock (T221075)
            $blocks = DatabaseBlock::newListFromTarget( $user, null, $fromMaster );

        }

        // Filter out any duplicated blocks, e.g. from the cookie
        $blocks = $this->getUniqueBlocks( $blocks );

        $block = null;
        if ( count( $blocks ) > 0 ) {
            if ( count( $blocks ) === 1 ) {
                $block = $blocks[ 0 ];
            } else {
                $block = new CompositeBlock( [
                    'address' => $ip,
                    'byText' => 'MediaWiki default',
                    'reason' => wfMessage( 'blockedtext-composite-reason' )->plain(),
                    'originalBlocks' => $blocks,
                ] );
            }
        }

        Hooks::run( 'GetUserBlock', [ clone $user, $ip, &$block ] );

        return $block;
    }

    private function getCookieBlock( &$blocks, UserIdentity $user, WebRequest $request ) {
        $cookieBlock = $this->getBlockFromCookieValue( $user, $request );
        if ( $cookieBlock instanceof DatabaseBlock ) {
            $blocks[] = $cookieBlock;
        }
    }

    private function getAdditionalIpBlocks( &$blocks, WebRequest $request, $isAnon, $fromMaster ) {
        $ip = $request->getIP();

        // Proxy blocking
        if ( !in_array( $ip, $this->options->get( 'ProxyWhitelist' ) ) ) {
            // Local list
            if ( $this->isLocallyBlockedProxy( $ip ) ) {
                $blocks[] = new SystemBlock( [
                    'byText' => wfMessage( 'proxyblocker' )->text(),
                    'reason' => wfMessage( 'proxyblockreason' )->plain(),
                    'address' => $ip,
                    'systemBlock' => 'proxy',
                ] );
            } elseif ( $isAnon && $this->isDnsBlacklisted( $ip ) ) {
                $blocks[] = new SystemBlock( [
                    'byText' => wfMessage( 'sorbs' )->text(),
                    'reason' => wfMessage( 'sorbsreason' )->plain(),
                    'address' => $ip,
                    'systemBlock' => 'dnsbl',
                ] );
            }
        }

        // Soft blocking
        if ( $isAnon && IP::isInRanges( $ip, $this->options->get( 'SoftBlockRanges' ) ) ) {
            $blocks[] = new SystemBlock( [
                'address' => $ip,
                'byText' => 'MediaWiki default',
                'reason' => wfMessage( 'softblockrangesreason', $ip )->plain(),
                'anonOnly' => true,
                'systemBlock' => 'wgSoftBlockRanges',
            ] );
        }

        // (T25343) Apply IP blocks to the contents of XFF headers, if enabled
        if ( $this->options->get( 'ApplyIpBlocksToXff' )
            && !in_array( $ip, $this->options->get( 'ProxyWhitelist' ) )
        ) {
            $xff = $request->getHeader( 'X-Forwarded-For' );
            $xff = array_map( 'trim', explode( ',', $xff ) );
            $xff = array_diff( $xff, [ $ip ] );
            // TODO: remove dependency on DatabaseBlock (T221075)
            $xffblocks = DatabaseBlock::getBlocksForIPList( $xff, $isAnon, $fromMaster );
            $blocks = array_merge( $blocks, $xffblocks );
        }
    }

    private function getUniqueBlocks( array $blocks ) {
        $systemBlocks = [];
        $databaseBlocks = [];

        foreach ( $blocks as $block ) {
            if ( $block instanceof SystemBlock ) {
                $systemBlocks[] = $block;
            } elseif ( $block->getType() === DatabaseBlock::TYPE_AUTO ) {
                '@phan-var DatabaseBlock $block';
                if ( !isset( $databaseBlocks[$block->getParentBlockId()] ) ) {
                    $databaseBlocks[$block->getParentBlockId()] = $block;
                }
            } else {
                $databaseBlocks[$block->getId()] = $block;
            }
        }

        return array_values( array_merge( $systemBlocks, $databaseBlocks ) );
    }

    private function getBlockFromCookieValue(
        UserIdentity $user,
        WebRequest $request
    ) {
        $cookieValue = $request->getCookie( 'BlockID' );
        if ( is_null( $cookieValue ) ) {
            return false;
        }

        $blockCookieId = $this->getIdFromCookieValue( $cookieValue );
        if ( !is_null( $blockCookieId ) ) {
            // TODO: remove dependency on DatabaseBlock (T221075)
            $block = DatabaseBlock::newFromID( $blockCookieId );
            if (
                $block instanceof DatabaseBlock &&
                $this->shouldApplyCookieBlock( $block, !$user->isRegistered() )
            ) {
                return $block;
            }
        }

        return false;
    }

    private function shouldApplyCookieBlock( DatabaseBlock $block, $isAnon ) {
        if ( !$block->isExpired() ) {
            switch ( $block->getType() ) {
                case DatabaseBlock::TYPE_IP:
                case DatabaseBlock::TYPE_RANGE:
                    // If block is type IP or IP range, load only
                    // if user is not logged in (T152462)
                    return $isAnon &&
                        $this->options->get( 'CookieSetOnIpBlock' );
                case DatabaseBlock::TYPE_USER:
                    return $block->isAutoblocking() &&
                        $this->options->get( 'CookieSetOnAutoblock' );
                default:
                    return false;
            }
        }
        return false;
    }

    private function isLocallyBlockedProxy( $ip ) {
        $proxyList = $this->options->get( 'ProxyList' );
        if ( !$proxyList ) {
            return false;
        }

        if ( !is_array( $proxyList ) ) {
            // Load values from the specified file
            $proxyList = array_map( 'trim', file( $proxyList ) );
        }

        $proxyListIPSet = new IPSet( $proxyList );
        return $proxyListIPSet->match( $ip );
    }

    public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
        if ( !$this->options->get( 'EnableDnsBlacklist' ) ||
            ( $checkWhitelist && in_array( $ip, $this->options->get( 'ProxyWhitelist' ) ) )
        ) {
            return false;
        }

        return $this->inDnsBlacklist( $ip, $this->options->get( 'DnsBlacklistUrls' ) );
    }

    private function inDnsBlacklist( $ip, array $bases ) {
        $found = false;
        // @todo FIXME: IPv6 ???  (https://bugs.php.net/bug.php?id=33170)
        if ( IP::isIPv4( $ip ) ) {
            // Reverse IP, T23255
            $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );

            foreach ( $bases as $base ) {
                // Make hostname
                // If we have an access key, use that too (ProjectHoneypot, etc.)
                $basename = $base;
                if ( is_array( $base ) ) {
                    if ( count( $base ) >= 2 ) {
                        // Access key is 1, base URL is 0
                        $hostname = "{$base[1]}.$ipReversed.{$base[0]}";
                    } else {
                        $hostname = "$ipReversed.{$base[0]}";
                    }
                    $basename = $base[0];
                } else {
                    $hostname = "$ipReversed.$base";
                }

                // Send query
                $ipList = $this->checkHost( $hostname );

                if ( $ipList ) {
                    $this->logger->info(
                        "Hostname $hostname is {$ipList[0]}, it's a proxy says $basename!"
                    );
                    $found = true;
                    break;
                }

                $this->logger->debug( "Requested $hostname, not found in $basename." );
            }
        }

        return $found;
    }

    protected function checkHost( $hostname ) {
        return gethostbynamel( $hostname );
    }

    public function trackBlockWithCookie( User $user, WebResponse $response ) {
        $request = $user->getRequest();

        if ( $request->getCookie( 'BlockID' ) !== null ) {
            $cookieBlock = $this->getBlockFromCookieValue( $user, $request );
            if ( $cookieBlock && $this->shouldTrackBlockWithCookie( $cookieBlock, $user->isAnon() ) ) {
                return;
            }
            // The block pointed to by the cookie is invalid or should not be tracked.
            $this->clearBlockCookie( $response );
        }

        if ( !$user->isSafeToLoad() ) {
            // Prevent a circular dependency by not allowing this method to be called
            // before or while the user is being loaded.
            // E.g. User > BlockManager > Block > Message > getLanguage > User.
            // See also T180050 and T226777.
            throw new LogicException( __METHOD__ . ' requires a loaded User object' );
        }
        if ( $response->headersSent() ) {
            throw new LogicException( __METHOD__ . ' must be called pre-send' );
        }

        $block = $user->getBlock();
        $isAnon = $user->isAnon();

        if ( $block ) {
            if ( $block instanceof CompositeBlock ) {
                // TODO: Improve on simply tracking the first trackable block (T225654)
                foreach ( $block->getOriginalBlocks() as $originalBlock ) {
                    if ( $this->shouldTrackBlockWithCookie( $originalBlock, $isAnon ) ) {
                        '@phan-var DatabaseBlock $originalBlock';
                        $this->setBlockCookie( $originalBlock, $response );
                        return;
                    }
                }
            } else {
                if ( $this->shouldTrackBlockWithCookie( $block, $isAnon ) ) {
                    '@phan-var DatabaseBlock $block';
                    $this->setBlockCookie( $block, $response );
                }
            }
        }
    }

    public function setBlockCookie( DatabaseBlock $block, WebResponse $response ) {
        // Calculate the default expiry time.
        $maxExpiryTime = wfTimestamp( TS_MW, wfTimestamp() + ( 24 * 60 * 60 ) );

        // Use the block's expiry time only if it's less than the default.
        $expiryTime = $block->getExpiry();
        if ( $expiryTime === 'infinity' || $expiryTime > $maxExpiryTime ) {
            $expiryTime = $maxExpiryTime;
        }

        // Set the cookie. Reformat the MediaWiki datetime as a Unix timestamp for the cookie.
        $expiryValue = DateTime::createFromFormat(
            'YmdHis',
            $expiryTime,
            new DateTimeZone( 'UTC' )
        )->format( 'U' );
        $cookieOptions = [ 'httpOnly' => false ];
        $cookieValue = $this->getCookieValue( $block );
        $response->setCookie( 'BlockID', $cookieValue, $expiryValue, $cookieOptions );
    }

    private function shouldTrackBlockWithCookie( AbstractBlock $block, $isAnon ) {
        if ( $block instanceof DatabaseBlock ) {
            switch ( $block->getType() ) {
                case DatabaseBlock::TYPE_IP:
                case DatabaseBlock::TYPE_RANGE:
                    return $isAnon && $this->options->get( 'CookieSetOnIpBlock' );
                case DatabaseBlock::TYPE_USER:
                    return !$isAnon &&
                        $this->options->get( 'CookieSetOnAutoblock' ) &&
                        $block->isAutoblocking();
                default:
                    return false;
            }
        }
        return false;
    }

    public static function clearBlockCookie( WebResponse $response ) {
        $response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
    }

    public function getIdFromCookieValue( $cookieValue ) {
        // The cookie value must start with a number
        if ( !is_numeric( substr( $cookieValue, 0, 1 ) ) ) {
            return null;
        }

        // Extract the ID prefix from the cookie value (may be the whole value, if no bang found).
        $bangPos = strpos( $cookieValue, '!' );
        $id = ( $bangPos === false ) ? $cookieValue : substr( $cookieValue, 0, $bangPos );
        if ( !$this->options->get( 'SecretKey' ) ) {
            // If there's no secret key, just use the ID as given.
            return $id;
        }
        $storedHmac = substr( $cookieValue, $bangPos + 1 );
        $calculatedHmac = MWCryptHash::hmac( $id, $this->options->get( 'SecretKey' ), false );
        if ( $calculatedHmac === $storedHmac ) {
            return $id;
        } else {
            return null;
        }
    }

    public function getCookieValue( DatabaseBlock $block ) {
        $id = $block->getId();
        if ( !$this->options->get( 'SecretKey' ) ) {
            // If there's no secret key, don't append a HMAC.
            return $id;
        }
        $hmac = MWCryptHash::hmac( $id, $this->options->get( 'SecretKey' ), false );
        $cookieValue = $id . '!' . $hmac;
        return $cookieValue;
    }

}