1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
|
<?php
use MediaWiki\Block\BlockManager;
use MediaWiki\Block\CompositeBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\MainConfigNames;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Request\FauxResponse;
use MediaWiki\User\User;
use Psr\Log\NullLogger;
use Wikimedia\TestingAccessWrapper;
/**
* @group Blocking
* @group Database
* @covers \MediaWiki\Block\BlockManager
*/
class BlockManagerTest extends MediaWikiIntegrationTestCase {
use TestAllServiceOptionsUsed;
protected User $user;
protected User $sysopUser;
private array $blockManagerConfig;
protected function setUp(): void {
parent::setUp();
$this->user = $this->getTestUser()->getUser();
$this->sysopUser = $this->getTestSysop()->getUser();
$this->blockManagerConfig = [
MainConfigNames::ApplyIpBlocksToXff => true,
MainConfigNames::CookieSetOnAutoblock => true,
MainConfigNames::CookieSetOnIpBlock => true,
MainConfigNames::DnsBlacklistUrls => [],
MainConfigNames::EnableDnsBlacklist => true,
MainConfigNames::ProxyList => [],
MainConfigNames::ProxyWhitelist => [],
MainConfigNames::SecretKey => false,
MainConfigNames::SoftBlockRanges => [],
];
}
private function getBlockManager( $overrideConfig ) {
return new BlockManager(
...$this->getBlockManagerConstructorArgs( $overrideConfig )
);
}
private function getBlockManagerConstructorArgs( $overrideConfig ) {
$blockManagerConfig = array_merge( $this->blockManagerConfig, $overrideConfig );
$this->overrideConfigValues( $blockManagerConfig );
$services = $this->getServiceContainer();
return [
new LoggedServiceOptions(
self::$serviceOptionsAccessLog,
BlockManager::CONSTRUCTOR_OPTIONS,
$services->getMainConfig()
),
$services->getUserFactory(),
$services->getUserIdentityUtils(),
new NullLogger(),
$services->getHookContainer(),
$services->getDatabaseBlockStore(),
$services->getProxyLookup()
];
}
public function testGetBlock() {
// Reset so that hooks are called
$permissionManager = $this->getServiceContainer()->getPermissionManager();
$permissionManager->invalidateUsersRightsCache();
$onGetUserBlockCalled = false;
$onGetUserBlockIP = false;
$this->setTemporaryHook(
'GetUserBlock',
static function ( $user, $ip, &$block ) use ( &$onGetUserBlockCalled, &$onGetUserBlockIP ) {
$onGetUserBlockCalled = true;
$onGetUserBlockIP = $ip;
return true;
}
);
$blockManager = $this->getBlockManager( [] );
$block = $blockManager->getBlock(
$this->user,
null,
false
);
// We don't actually care about the block, just whether or not the right hooks were called
$this->assertTrue(
$onGetUserBlockCalled,
'Check that HookRunner::onGetUserBlock was called'
);
$this->assertNull(
$onGetUserBlockIP,
'The `GetUserBlock` hook should have been called with null since we ' .
'didn\'t pass a request'
);
}
/**
* @dataProvider provideBlocksForShouldApplyCookieBlock
*/
public function testGetBlockFromCookieValue( $options, $expected ) {
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( [
MainConfigNames::CookieSetOnAutoblock => true,
MainConfigNames::CookieSetOnIpBlock => true,
] )
);
$blockStore = $this->getServiceContainer()->getDatabaseBlockStore();
$block = new DatabaseBlock( array_merge( [
'address' => $options['target'] ?: $this->user,
'by' => $this->sysopUser,
], $options['blockOptions'] ) );
$blockStore->insertBlock( $block );
$user = $options['registered'] ? $this->user : new User();
$user->getRequest()->setCookie( 'BlockID', $blockManager->getCookieValue( $block ) );
$this->assertSame( $expected, (bool)$blockManager->getBlockFromCookieValue(
$user,
$user->getRequest()
) );
}
/**
* @dataProvider provideBlocksForShouldApplyCookieBlock
*/
public function testTrackBlockWithCookieRemovesBlocks( $options, $expectKeepCookie ) {
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( [
MainConfigNames::CookieSetOnAutoblock => true,
MainConfigNames::CookieSetOnIpBlock => true,
] )
);
$blockStore = $this->getServiceContainer()->getDatabaseBlockStore();
$block = new DatabaseBlock( array_merge( [
'address' => $options['target'] ?: $this->user,
'by' => $this->sysopUser,
], $options['blockOptions'] ) );
$blockStore->insertBlock( $block );
$user = $options['registered'] ? $this->user : new User();
$user->getRequest()->setCookie( 'BlockID', $blockManager->getCookieValue( $block ) );
$response = new FauxResponse;
$blockManager->trackBlockWithCookie(
$user,
$response
);
$this->assertCount(
$expectKeepCookie ? 0 : 1,
$response->getCookies()
);
}
public static function provideBlocksForShouldApplyCookieBlock() {
return [
'Autoblocking user block' => [
[
'target' => '',
'registered' => true,
'blockOptions' => [
'enableAutoblock' => true
],
],
true,
],
'Autoblocking user block for anonymous user' => [
[
'target' => '',
'registered' => false,
'blockOptions' => [
'enableAutoblock' => true
],
],
true,
],
'Non-autoblocking user block' => [
[
'target' => '',
'registered' => true,
'blockOptions' => [],
],
false,
],
'IP block for anonymous user' => [
[
'target' => '127.0.0.1',
'registered' => false,
'blockOptions' => [],
],
true,
],
'IP block for logged in user' => [
[
'target' => '127.0.0.1',
'registered' => true,
'blockOptions' => [],
],
false,
],
'IP range block for anonymous user' => [
[
'target' => '127.0.0.0/8',
'registered' => false,
'blockOptions' => [],
],
true,
],
];
}
/**
* @dataProvider provideIsLocallyBlockedProxy
*/
public function testIsLocallyBlockedProxy( $proxyList, $expected ) {
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( [
MainConfigNames::ProxyList => $proxyList
] )
);
$ip = '1.2.3.4';
$this->assertSame( $expected, $blockManager->isLocallyBlockedProxy( $ip ) );
}
public static function provideIsLocallyBlockedProxy() {
return [
'Proxy list is empty' => [ [], false ],
'Proxy list contains IP' => [ [ '1.2.3.4' ], true ],
'Proxy list contains IP as value' => [ [ 'test' => '1.2.3.4' ], true ],
'Proxy list contains range that covers IP' => [ [ '1.2.3.0/16' ], true ],
];
}
/**
* @dataProvider provideIsDnsBlacklisted
*/
public function testIsDnsBlacklisted( $options, $expected ) {
$blockManagerConfig = [
MainConfigNames::EnableDnsBlacklist => true,
MainConfigNames::DnsBlacklistUrls => $options['blacklist'],
MainConfigNames::ProxyWhitelist => $options['whitelist'],
];
$blockManager = $this->getMockBuilder( BlockManager::class )
->setConstructorArgs( $this->getBlockManagerConstructorArgs( $blockManagerConfig ) )
->onlyMethods( [ 'checkHost' ] )
->getMock();
$blockManager->method( 'checkHost' )
->willReturnMap( [ [
$options['dnsblQuery'],
$options['dnsblResponse'],
] ] );
$this->assertSame(
$expected,
$blockManager->isDnsBlacklisted( $options['ip'], $options['checkWhitelist'] )
);
}
public static function provideIsDnsBlacklisted() {
$dnsblFound = [ '127.0.0.2' ];
$dnsblNotFound = false;
return [
'IP is blacklisted' => [
[
'blacklist' => [ 'dnsbl.test' ],
'ip' => '127.0.0.1',
'dnsblQuery' => '1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [],
'checkWhitelist' => false,
],
true,
],
'IP is blacklisted; blacklist has key' => [
[
'blacklist' => [ [ 'dnsbl.test', 'key' ] ],
'ip' => '127.0.0.1',
'dnsblQuery' => 'key.1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [],
'checkWhitelist' => false,
],
true,
],
'IP is blacklisted; blacklist is array' => [
[
'blacklist' => [ [ 'dnsbl.test' ] ],
'ip' => '127.0.0.1',
'dnsblQuery' => '1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [],
'checkWhitelist' => false,
],
true,
],
'IP is not blacklisted' => [
[
'blacklist' => [ 'dnsbl.test' ],
'ip' => '1.2.3.4',
'dnsblQuery' => '4.3.2.1.dnsbl.test',
'dnsblResponse' => $dnsblNotFound,
'whitelist' => [],
'checkWhitelist' => false,
],
false,
],
'Blacklist is empty' => [
[
'blacklist' => [],
'ip' => '127.0.0.1',
'dnsblQuery' => '1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [],
'checkWhitelist' => false,
],
false,
],
'IP is blacklisted and whitelisted; whitelist is not checked' => [
[
'blacklist' => [ 'dnsbl.test' ],
'ip' => '127.0.0.1',
'dnsblQuery' => '1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [ '127.0.0.1' ],
'checkWhitelist' => false,
],
true,
],
'IP is blacklisted and whitelisted; whitelist is checked' => [
[
'blacklist' => [ 'dnsbl.test' ],
'ip' => '127.0.0.1',
'dnsblQuery' => '1.0.0.127.dnsbl.test',
'dnsblResponse' => $dnsblFound,
'whitelist' => [ '127.0.0.1' ],
'checkWhitelist' => true,
],
false,
],
];
}
public function testGetUniqueBlocks() {
$blockId = 100;
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject( $this->getBlockManager( [] ) );
$block = $this->getMockBuilder( DatabaseBlock::class )
->onlyMethods( [ 'getId' ] )
->getMock();
$block->method( 'getId' )
->willReturn( $blockId );
$autoblock = $this->getMockBuilder( DatabaseBlock::class )
->onlyMethods( [ 'getParentBlockId', 'getType' ] )
->getMock();
$autoblock->method( 'getParentBlockId' )
->willReturn( $blockId );
$autoblock->method( 'getType' )
->willReturn( DatabaseBlock::TYPE_AUTO );
$blocks = [ $block, $block, $autoblock, new SystemBlock() ];
$this->assertCount( 2, $blockManager->getUniqueBlocks( $blocks ) );
}
/**
* @dataProvider provideTrackBlockWithCookie
*/
public function testTrackBlockWithCookie( $options, $expected ) {
$this->overrideConfigValue( MainConfigNames::CookiePrefix, '' );
$request = new FauxRequest();
if ( $options['cookieSet'] ) {
$request->setCookie( 'BlockID', 'the value does not matter' );
}
/** @var FauxResponse $response */
$response = $request->response();
$user = $this->getMockBuilder( User::class )
->onlyMethods( [ 'getBlock', 'getRequest' ] )
->getMock();
$user->method( 'getBlock' )
->willReturn( $options['block'] );
$user->method( 'getRequest' )
->willReturn( $request );
// Although the block cookie is set via DeferredUpdates, in command line mode updates are
// processed immediately
$blockManager = $this->getBlockManager( [
MainConfigNames::SecretKey => '',
MainConfigNames::CookieSetOnIpBlock => true,
] );
$blockManager->trackBlockWithCookie( $user, $response );
$this->assertCount( $expected['count'], $response->getCookies() );
$this->assertEquals( $expected['value'], $response->getCookie( 'BlockID' ) );
}
public function provideTrackBlockWithCookie() {
$blockId = 123;
return [
'Block cookie is already set; there is a trackable block' => [
[
'cookieSet' => true,
'block' => $this->getTrackableBlock( $blockId ),
],
[
'count' => 1,
'value' => $blockId,
]
],
'Block cookie is already set; there is no block' => [
[
'cookieSet' => true,
'block' => null,
],
[
// Cookie is cleared by setting it to empty value
'count' => 1,
'value' => '',
]
],
'Block cookie is not yet set; there is no block' => [
[
'cookieSet' => false,
'block' => null,
],
[
'count' => 0,
'value' => null,
]
],
'Block cookie is not yet set; there is a trackable block' => [
[
'cookieSet' => false,
'block' => $this->getTrackableBlock( $blockId ),
],
[
'count' => 1,
'value' => $blockId,
]
],
'Block cookie is not yet set; there is a composite block with a trackable block' => [
[
'cookieSet' => false,
'block' => new CompositeBlock( [
'originalBlocks' => [
new SystemBlock(),
$this->getTrackableBlock( $blockId ),
]
] ),
],
[
'count' => 1,
'value' => $blockId,
]
],
'Block cookie is not yet set; there is a composite block but no trackable block' => [
[
'cookieSet' => false,
'block' => new CompositeBlock( [
'originalBlocks' => [
new SystemBlock(),
new SystemBlock(),
]
] ),
],
[
'count' => 0,
'value' => null,
]
],
];
}
private function getTrackableBlock( $blockId ) {
$block = $this->getMockBuilder( DatabaseBlock::class )
->onlyMethods( [ 'getType', 'getId' ] )
->getMock();
$block->method( 'getType' )
->willReturn( DatabaseBlock::TYPE_IP );
$block->method( 'getId' )
->willReturn( $blockId );
return $block;
}
/**
* @dataProvider provideSetBlockCookie
*/
public function testSetBlockCookie( $expiryDelta, $expectedExpiryDelta ) {
$this->overrideConfigValue( MainConfigNames::CookiePrefix, '' );
$request = new FauxRequest();
$response = $request->response();
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( [
MainConfigNames::SecretKey => '',
MainConfigNames::CookieSetOnIpBlock => true,
] )
);
$now = wfTimestamp();
$block = new DatabaseBlock( [
'expiry' => $expiryDelta === '' ? '' : $now + $expiryDelta
] );
$blockManager->setBlockCookie( $block, $response );
$cookies = $response->getCookies();
$this->assertEqualsWithDelta(
$now + $expectedExpiryDelta,
$cookies['BlockID']['expire'],
60 // Allow actual to be up to 60 seconds later than expected
);
}
public static function provideSetBlockCookie() {
// Maximum length of a block cookie, defined in BlockManager::setBlockCookie
$maxExpiryDelta = ( 24 * 60 * 60 );
$longExpiryDelta = ( 48 * 60 * 60 );
$shortExpiryDelta = ( 12 * 60 * 60 );
return [
'Block has indefinite expiry' => [
'',
$maxExpiryDelta,
],
'Block expiry is later than maximum cookie block expiry' => [
$longExpiryDelta,
$maxExpiryDelta,
],
'Block expiry is sooner than maximum cookie block expiry' => [
$shortExpiryDelta,
$shortExpiryDelta,
],
];
}
/**
* @dataProvider provideShouldTrackBlockWithCookie
*/
public function testShouldTrackBlockWithCookie( $options, $expected ) {
$block = $this->getMockBuilder( DatabaseBlock::class )
->onlyMethods( [ 'getType', 'isAutoblocking' ] )
->getMock();
$block->method( 'getType' )
->willReturn( $options['type'] );
if ( isset( $options['autoblocking'] ) ) {
$block->method( 'isAutoblocking' )
->willReturn( $options['autoblocking'] );
}
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( $options['blockManagerConfig'] )
);
$this->assertSame(
$expected,
$blockManager->shouldTrackBlockWithCookie( $block, $options['isAnon'] )
);
}
public static function provideShouldTrackBlockWithCookie() {
return [
'IP block, anonymous user, IP block cookies enabled' => [
[
'type' => DatabaseBlock::TYPE_IP,
'isAnon' => true,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnIpBlock => true ],
],
true
],
'IP range block, anonymous user, IP block cookies enabled' => [
[
'type' => DatabaseBlock::TYPE_RANGE,
'isAnon' => true,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnIpBlock => true ],
],
true
],
'IP block, anonymous user, IP block cookies disabled' => [
[
'type' => DatabaseBlock::TYPE_IP,
'isAnon' => true,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnIpBlock => false ],
],
false
],
'IP block, logged in user, IP block cookies enabled' => [
[
'type' => DatabaseBlock::TYPE_IP,
'isAnon' => false,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnIpBlock => true ],
],
false
],
'User block, anonymous, autoblock cookies enabled, block is autoblocking' => [
[
'type' => DatabaseBlock::TYPE_USER,
'isAnon' => true,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnAutoblock => true ],
'autoblocking' => true,
],
false
],
'User block, logged in, autoblock cookies enabled, block is autoblocking' => [
[
'type' => DatabaseBlock::TYPE_USER,
'isAnon' => false,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnAutoblock => true ],
'autoblocking' => true,
],
true
],
'User block, logged in, autoblock cookies disabled, block is autoblocking' => [
[
'type' => DatabaseBlock::TYPE_USER,
'isAnon' => false,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnAutoblock => false ],
'autoblocking' => true,
],
false
],
'User block, logged in, autoblock cookies enabled, block is not autoblocking' => [
[
'type' => DatabaseBlock::TYPE_USER,
'isAnon' => false,
'blockManagerConfig' => [ MainConfigNames::CookieSetOnAutoblock => true ],
'autoblocking' => false,
],
false
],
'Block type is autoblock' => [
[
'type' => DatabaseBlock::TYPE_AUTO,
'isAnon' => true,
'blockManagerConfig' => [],
],
false
]
];
}
public function testClearBlockCookie() {
$this->overrideConfigValue( MainConfigNames::CookiePrefix, '' );
$request = new FauxRequest();
$response = $request->response();
$response->setCookie( 'BlockID', '100' );
$this->assertSame( '100', $response->getCookie( 'BlockID' ) );
BlockManager::clearBlockCookie( $response );
$this->assertSame( '', $response->getCookie( 'BlockID' ) );
}
/**
* @dataProvider provideGetIdFromCookieValue
*/
public function testGetIdFromCookieValue( $options, $expected ) {
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject(
$this->getBlockManager( [ MainConfigNames::SecretKey => $options['secretKey'] ] ) );
$this->assertEquals(
$expected,
$blockManager->getIdFromCookieValue( $options['cookieValue'] )
);
}
public static function provideGetIdFromCookieValue() {
$blockId = 100;
$secretKey = '123';
$hmac = MWCryptHash::hmac( $blockId, $secretKey, false );
return [
'No secret key is set' => [
[
'secretKey' => '',
'cookieValue' => $blockId,
'calculatedHmac' => MWCryptHash::hmac( $blockId, '', false ),
],
$blockId,
],
'Secret key is set and stored hmac is correct' => [
[
'secretKey' => $secretKey,
'cookieValue' => $blockId . '!' . $hmac,
'calculatedHmac' => $hmac,
],
$blockId,
],
'Secret key is set and stored hmac is incorrect' => [
[
'secretKey' => $secretKey,
'cookieValue' => $blockId . '!xyz',
'calculatedHmac' => $hmac,
],
null,
],
];
}
/**
* @dataProvider provideGetCookieValue
*/
public function testGetCookieValue( $options, $expected ) {
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject( $this->getBlockManager( [
MainConfigNames::SecretKey => $options['secretKey']
] ) );
$block = $this->getMockBuilder( DatabaseBlock::class )
->onlyMethods( [ 'getId' ] )
->getMock();
$block->method( 'getId' )
->willReturn( $options['blockId'] );
$this->assertEquals(
$expected,
$blockManager->getCookieValue( $block )
);
}
public static function provideGetCookieValue() {
$blockId = 100;
return [
'Secret key not set' => [
[
'secretKey' => '',
'blockId' => $blockId,
'hmac' => MWCryptHash::hmac( $blockId, '', false ),
],
$blockId,
],
'Secret key set' => [
[
'secretKey' => '123',
'blockId' => $blockId,
'hmac' => MWCryptHash::hmac( $blockId, '123', false ),
],
$blockId . '!' . MWCryptHash::hmac( $blockId, '123', false ) ],
];
}
/**
* @dataProvider provideGetXffBlocks
*/
public function testGetXffBlocks(
$applyIpBlocksToXff,
$proxyWhiteList,
$isAnon,
$expected
) {
$xff = '1.2.3.4, 5.6.7.8, 9.10.11.12';
$ip = '1.2.3.4';
$blockManagerConfig = [
MainConfigNames::ApplyIpBlocksToXff => $applyIpBlocksToXff,
MainConfigNames::ProxyWhitelist => $proxyWhiteList,
];
$blockManagerMock = $this->getMockBuilder( BlockManager::class )
->setConstructorArgs( $this->getBlockManagerConstructorArgs( $blockManagerConfig ) )
->onlyMethods( [ 'getBlocksForIPList' ] )
->getMock();
$blockManagerMock->method( 'getBlocksForIPList' )
->willReturnCallback( function () use ( $isAnon ) {
if ( $isAnon ) {
return [ $this->createMock( DatabaseBlock::class ) ];
} else {
return [];
}
} );
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject( $blockManagerMock );
$this->assertSame(
$expected,
(bool)$blockManager->getXffBlocks( $ip, $xff, $isAnon, false )
);
}
public static function provideGetXffBlocks() {
return [
'ApplyIpBlocksToXff config is false' => [
'applyIpBlocksToXff' => false,
'proxyWhiteList' => [],
'isAnon' => true,
false,
],
'IP is in ProxyWhiteList' => [
'applyIpBlocksToXff' => true,
'proxyWhiteList' => [ '1.2.3.4' ],
'isAnon' => true,
false,
],
'User is logged in' => [
'applyIpBlocksToXff' => true,
'proxyWhiteList' => [],
'isAnon' => false,
false,
],
'IP is in XFF list but not in ProxyWhiteList' => [
'applyIpBlocksToXff' => true,
'proxyWhiteList' => [],
'isAnon' => true,
true,
],
];
}
/**
* @dataProvider provideGetSystemIpBlocks
*/
public function testGetSystemIpBlocks(
$proxyWhitelist,
$softBlockRanges,
$isLocallyBlockedProxy,
$isDnsBlacklisted,
$isAnon,
$expected
) {
$ip = '1.2.3.4';
$blockManagerConfig = [
MainConfigNames::ProxyWhitelist => $proxyWhitelist,
MainConfigNames::SoftBlockRanges => $softBlockRanges,
MainConfigNames::ProxyList => ( $isLocallyBlockedProxy ? [ $ip ] : [] ),
];
$blockManagerMock = $this->getMockBuilder( BlockManager::class )
->setConstructorArgs( $this->getBlockManagerConstructorArgs( $blockManagerConfig ) )
->onlyMethods( [ 'isDnsBlacklisted' ] )
->getMock();
$blockManagerMock->method( 'isDnsBlacklisted' )
->willReturn( $isDnsBlacklisted );
/** @var BlockManager $blockManager */
$blockManager = TestingAccessWrapper::newFromObject( $blockManagerMock );
$this->assertSame(
$expected,
(bool)$blockManager->getSystemIpBlocks( $ip, $isAnon )
);
}
public static function provideGetSystemIpBlocks() {
return [
'IP is in ProxyWhiteList' => [
'proxyWhitelist' => [ '1.2.3.4' ],
'softBlockRanges' => [],
'isLocallyBlockedProxy' => true,
'isDnsBlacklisted' => true,
'isAnon' => true,
false,
],
'IP is locally blocked proxy only' => [
'proxyWhitelist' => [],
'softBlockRanges' => [],
'isLocallyBlockedProxy' => true,
'isDnsBlacklisted' => false,
'isAnon' => false,
true,
],
'IP is DNS blacklisted only, anon' => [
'proxyWhitelist' => [],
'softBlockRanges' => [],
'isLocallyBlockedProxy' => false,
'isDnsBlacklisted' => true,
'isAnon' => true,
true,
],
'IP is DNS blacklisted only, logged in' => [
'proxyWhitelist' => [],
'softBlockRanges' => [],
'isLocallyBlockedProxy' => false,
'isDnsBlacklisted' => true,
'isAnon' => false,
false,
],
'IP is in SoftBlockRanges and ProxyWhiteList, anon' => [
'proxyWhitelist' => [ '1.2.3.4' ],
'softBlockRanges' => [ '1.2.3.4' ],
'isLocallyBlockedProxy' => false,
'isDnsBlacklisted' => false,
'isAnon' => true,
true,
],
'IP is in SoftBlockRanges and ProxyWhiteList, logged in' => [
'proxyWhitelist' => [ '1.2.3.4' ],
'softBlockRanges' => [ '1.2.3.4' ],
'isLocallyBlockedProxy' => false,
'isDnsBlacklisted' => false,
'isAnon' => false,
false,
],
];
}
public function testGetBlocksForIPList() {
$blockManager = $this->getBlockManager( [] );
$block = new DatabaseBlock( [
'address' => '1.2.3.4',
'by' => $this->getTestSysop()->getUser(),
] );
$inserted = $this->getServiceContainer()
->getDatabaseBlockStore()
->insertBlock( $block );
$this->assertTrue(
(bool)$inserted['id'],
'Check that the block was inserted correctly'
);
// Early return of empty array if no ips in the list
$list = $blockManager->getBlocksForIPList( [], true, false );
$this->assertCount(
0,
$list,
'No blocks retrieved if no ips listed'
);
// Early return of empty array if all ips are either invalid or trusted proxies,
// '192.168.1.1' is set to trusted in setUp();
$list = $blockManager->getBlocksForIPList(
[ '300.300.300.300', '192.168.1.1' ],
true,
false
);
$this->assertCount(
0,
$list,
'No blocks retrieved if all ips are invalid or trusted proxies'
);
// Actually fetching, block was inserted above
$list = $blockManager->getBlocksForIPList( [ '1.2.3.4' ], true, false );
$this->assertCount(
1,
$list,
'Block retrieved for the blocked ip'
);
$this->assertInstanceOf(
DatabaseBlock::class,
$list[0],
'DatabaseBlock returned'
);
$this->assertSame(
$inserted['id'],
$list[0]->getId(),
'Block returned is the correct one'
);
}
/**
* @coversNothing
*/
public function testAllServiceOptionsUsed() {
$this->assertAllServiceOptionsUsed();
}
}
|