550 lines
17 KiB
PHP
550 lines
17 KiB
PHP
<?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
|
|
*/
|
|
|
|
namespace MediaWiki\Block;
|
|
|
|
use DateTime;
|
|
use DateTimeZone;
|
|
use DeferredUpdates;
|
|
use IP;
|
|
use MediaWiki\Config\ServiceOptions;
|
|
use MediaWiki\Permissions\PermissionManager;
|
|
use MediaWiki\User\UserIdentity;
|
|
use MWCryptHash;
|
|
use User;
|
|
use WebRequest;
|
|
use WebResponse;
|
|
use Wikimedia\IPSet;
|
|
|
|
/**
|
|
* A service class for checking blocks.
|
|
* To obtain an instance, use MediaWikiServices::getInstance()->getBlockManager().
|
|
*
|
|
* @since 1.34 Refactored from User and Block.
|
|
*/
|
|
class BlockManager {
|
|
// TODO: This should be UserIdentity instead of User
|
|
/** @var User */
|
|
private $currentUser;
|
|
|
|
/** @var WebRequest */
|
|
private $currentRequest;
|
|
|
|
/** @var PermissionManager */
|
|
private $permissionManager;
|
|
|
|
/**
|
|
* TODO Make this a const when HHVM support is dropped (T192166)
|
|
*
|
|
* @var array
|
|
* @since 1.34
|
|
*/
|
|
public static $constructorOptions = [
|
|
'ApplyIpBlocksToXff',
|
|
'CookieSetOnAutoblock',
|
|
'CookieSetOnIpBlock',
|
|
'DnsBlacklistUrls',
|
|
'EnableDnsBlacklist',
|
|
'ProxyList',
|
|
'ProxyWhitelist',
|
|
'SecretKey',
|
|
'SoftBlockRanges',
|
|
];
|
|
|
|
/**
|
|
* @param ServiceOptions $options
|
|
* @param User $currentUser
|
|
* @param WebRequest $currentRequest
|
|
* @param PermissionManager $permissionManager
|
|
*/
|
|
public function __construct(
|
|
ServiceOptions $options,
|
|
User $currentUser,
|
|
WebRequest $currentRequest,
|
|
PermissionManager $permissionManager
|
|
) {
|
|
$options->assertRequiredOptions( self::$constructorOptions );
|
|
$this->options = $options;
|
|
$this->currentUser = $currentUser;
|
|
$this->currentRequest = $currentRequest;
|
|
$this->permissionManager = $permissionManager;
|
|
}
|
|
|
|
/**
|
|
* Get the blocks that apply to a user. If there is only one, return that, otherwise
|
|
* return a composite block that combines the strictest features of the applicable
|
|
* blocks.
|
|
*
|
|
* TODO: $user should be UserIdentity instead of User
|
|
*
|
|
* @internal This should only be called by User::getBlockedStatus
|
|
* @param User $user
|
|
* @param bool $fromReplica Whether to check the replica DB first.
|
|
* To improve performance, non-critical checks are done against replica DBs.
|
|
* Check when actually saving should be done against master.
|
|
* @return AbstractBlock|null The most relevant block, or null if there is no block.
|
|
*/
|
|
public function getUserBlock( User $user, $fromReplica ) {
|
|
$isAnon = $user->getId() === 0;
|
|
|
|
// TODO: If $user is the current user, we should use the current request. Otherwise,
|
|
// we should not look for XFF or cookie blocks.
|
|
$request = $user->getRequest();
|
|
|
|
# We only need to worry about passing the IP address to the block generator if the
|
|
# user is not immune to autoblocks/hardblocks, and they are the current user so we
|
|
# know which IP address they're actually coming from
|
|
$ip = null;
|
|
$sessionUser = $this->currentUser;
|
|
// the session user is set up towards the end of Setup.php. Until then,
|
|
// assume it's a logged-out user.
|
|
$globalUserName = $sessionUser->isSafeToLoad()
|
|
? $sessionUser->getName()
|
|
: IP::sanitizeIP( $this->currentRequest->getIP() );
|
|
if ( $user->getName() === $globalUserName &&
|
|
!$this->permissionManager->userHasRight( $user, 'ipblock-exempt' ) ) {
|
|
$ip = $this->currentRequest->getIP();
|
|
}
|
|
|
|
// User/IP blocking
|
|
// After this, $blocks is an array of blocks or an empty array
|
|
// TODO: remove dependency on DatabaseBlock
|
|
$blocks = DatabaseBlock::newListFromTarget( $user, $ip, !$fromReplica );
|
|
|
|
// Cookie blocking
|
|
$cookieBlock = $this->getBlockFromCookieValue( $user, $request );
|
|
if ( $cookieBlock instanceof AbstractBlock ) {
|
|
$blocks[] = $cookieBlock;
|
|
}
|
|
|
|
// Proxy blocking
|
|
if ( $ip !== null && !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',
|
|
] );
|
|
}
|
|
}
|
|
|
|
// (T25343) Apply IP blocks to the contents of XFF headers, if enabled
|
|
if ( $this->options->get( 'ApplyIpBlocksToXff' )
|
|
&& $ip !== null
|
|
&& !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
|
|
$xffblocks = DatabaseBlock::getBlocksForIPList( $xff, $isAnon, !$fromReplica );
|
|
$blocks = array_merge( $blocks, $xffblocks );
|
|
}
|
|
|
|
// Soft blocking
|
|
if ( $ip !== null
|
|
&& $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',
|
|
] );
|
|
}
|
|
|
|
// Filter out any duplicated blocks, e.g. from the cookie
|
|
$blocks = $this->getUniqueBlocks( $blocks );
|
|
|
|
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,
|
|
] );
|
|
}
|
|
return $block;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Given a list of blocks, return a list of unique blocks.
|
|
*
|
|
* This usually means that each block has a unique ID. For a block with ID null,
|
|
* if it's an autoblock, it will be filtered out if the parent block is present;
|
|
* if not, it is assumed to be a unique system block, and kept.
|
|
*
|
|
* @param AbstractBlock[] $blocks
|
|
* @return AbstractBlock[]
|
|
*/
|
|
private function getUniqueBlocks( array $blocks ) {
|
|
$systemBlocks = [];
|
|
$databaseBlocks = [];
|
|
|
|
foreach ( $blocks as $block ) {
|
|
if ( $block instanceof SystemBlock ) {
|
|
$systemBlocks[] = $block;
|
|
} elseif ( $block->getType() === DatabaseBlock::TYPE_AUTO ) {
|
|
if ( !isset( $databaseBlocks[$block->getParentBlockId()] ) ) {
|
|
$databaseBlocks[$block->getParentBlockId()] = $block;
|
|
}
|
|
} else {
|
|
$databaseBlocks[$block->getId()] = $block;
|
|
}
|
|
}
|
|
|
|
return array_merge( $systemBlocks, $databaseBlocks );
|
|
}
|
|
|
|
/**
|
|
* Try to load a block from an ID given in a cookie value. If the block is invalid
|
|
* doesn't exist, or the cookie value is malformed, remove the cookie.
|
|
*
|
|
* @param UserIdentity $user
|
|
* @param WebRequest $request
|
|
* @return DatabaseBlock|bool The block object, or false if none could be loaded.
|
|
*/
|
|
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
|
|
$block = DatabaseBlock::newFromID( $blockCookieId );
|
|
if (
|
|
$block instanceof DatabaseBlock &&
|
|
$this->shouldApplyCookieBlock( $block, $user->isAnon() )
|
|
) {
|
|
return $block;
|
|
}
|
|
}
|
|
|
|
$this->clearBlockCookie( $request->response() );
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check if the block loaded from the cookie should be applied.
|
|
*
|
|
* @param DatabaseBlock $block
|
|
* @param bool $isAnon The user is logged out
|
|
* @return bool The block sould be applied
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Check if an IP address is in the local proxy list
|
|
*
|
|
* @param string $ip
|
|
* @return bool
|
|
*/
|
|
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 );
|
|
}
|
|
|
|
/**
|
|
* Whether the given IP is in a DNS blacklist.
|
|
*
|
|
* @param string $ip IP to check
|
|
* @param bool $checkWhitelist Whether to check the whitelist first
|
|
* @return bool True if blacklisted.
|
|
*/
|
|
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' ) );
|
|
}
|
|
|
|
/**
|
|
* Whether the given IP is in a given DNS blacklist.
|
|
*
|
|
* @param string $ip IP to check
|
|
* @param array $bases Array of Strings: URL of the DNS blacklist
|
|
* @return bool True if blacklisted.
|
|
*/
|
|
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 ) {
|
|
wfDebugLog(
|
|
'dnsblacklist',
|
|
"Hostname $hostname is {$ipList[0]}, it's a proxy says $basename!"
|
|
);
|
|
$found = true;
|
|
break;
|
|
}
|
|
|
|
wfDebugLog( 'dnsblacklist', "Requested $hostname, not found in $basename." );
|
|
}
|
|
}
|
|
|
|
return $found;
|
|
}
|
|
|
|
/**
|
|
* Wrapper for mocking in tests.
|
|
*
|
|
* @param string $hostname DNSBL query
|
|
* @return string[]|bool IPv4 array, or false if the IP is not blacklisted
|
|
*/
|
|
protected function checkHost( $hostname ) {
|
|
return gethostbynamel( $hostname );
|
|
}
|
|
|
|
/**
|
|
* Set the 'BlockID' cookie depending on block type and user authentication status.
|
|
*
|
|
* @since 1.34
|
|
* @param User $user
|
|
*/
|
|
public function trackBlockWithCookie( User $user ) {
|
|
$request = $user->getRequest();
|
|
if ( $request->getCookie( 'BlockID' ) !== null ) {
|
|
// User already has a block cookie
|
|
return;
|
|
}
|
|
|
|
// Defer checks until the user has been fully loaded to avoid circular dependency
|
|
// of User on itself (T180050 and T226777)
|
|
DeferredUpdates::addCallableUpdate(
|
|
function () use ( $user, $request ) {
|
|
$block = $user->getBlock();
|
|
$response = $request->response();
|
|
$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 ) ) {
|
|
$this->setBlockCookie( $originalBlock, $response );
|
|
return;
|
|
}
|
|
}
|
|
} else {
|
|
if ( $this->shouldTrackBlockWithCookie( $block, $isAnon ) ) {
|
|
$this->setBlockCookie( $block, $response );
|
|
}
|
|
}
|
|
}
|
|
},
|
|
DeferredUpdates::PRESEND
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Set the 'BlockID' cookie to this block's ID and expiry time. The cookie's expiry will be
|
|
* the same as the block's, to a maximum of 24 hours.
|
|
*
|
|
* @since 1.34
|
|
* @internal Should be private.
|
|
* Left public for backwards compatibility, until DatabaseBlock::setCookie is removed.
|
|
* @param DatabaseBlock $block
|
|
* @param WebResponse $response The response on which to set the cookie.
|
|
*/
|
|
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 );
|
|
}
|
|
|
|
/**
|
|
* Check if the block should be tracked with a cookie.
|
|
*
|
|
* @param AbstractBlock $block
|
|
* @param bool $isAnon The user is logged out
|
|
* @return bool The block sould be tracked with a cookie
|
|
*/
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Unset the 'BlockID' cookie.
|
|
*
|
|
* @since 1.34
|
|
* @param WebResponse $response
|
|
*/
|
|
public static function clearBlockCookie( WebResponse $response ) {
|
|
$response->clearCookie( 'BlockID', [ 'httpOnly' => false ] );
|
|
}
|
|
|
|
/**
|
|
* Get the stored ID from the 'BlockID' cookie. The cookie's value is usually a combination of
|
|
* the ID and a HMAC (see DatabaseBlock::setCookie), but will sometimes only be the ID.
|
|
*
|
|
* @since 1.34
|
|
* @internal Should be private.
|
|
* Left public for backwards compatibility, until DatabaseBlock::getIdFromCookieValue is removed.
|
|
* @param string $cookieValue The string in which to find the ID.
|
|
* @return int|null The block ID, or null if the HMAC is present and invalid.
|
|
*/
|
|
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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the BlockID cookie's value for this block. This is usually the block ID concatenated
|
|
* with an HMAC in order to avoid spoofing (T152951), but if wgSecretKey is not set will just
|
|
* be the block ID.
|
|
*
|
|
* @since 1.34
|
|
* @internal Should be private.
|
|
* Left public for backwards compatibility, until DatabaseBlock::getCookieValue is removed.
|
|
* @param DatabaseBlock $block
|
|
* @return string The block ID, probably concatenated with "!" and the HMAC.
|
|
*/
|
|
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;
|
|
}
|
|
|
|
}
|