mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-04 15:57:45 +02:00
Code Issues Releases Wiki Activity

[ticket/9687] Add tests for ban manager and fix some inconsistencies

Browse Source 
PHPBB3-9687
This commit is contained in:
Marc Alexander
2023-07-29 16:22:40 +02:00
parent 658e8effd5
commit cf0e747d51
11 changed files with 914 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

699
tests/ban/ban_manager_test.php Normal file
View File

@@ -0,0 +1,699 @@
<?php
namespace phpbb\tests\unit\ban;
use phpbb\ban\exception\invalid_length_exception;
use phpbb\ban\exception\no_valid_emails_exception;
use phpbb\ban\exception\no_valid_ips_exception;
use phpbb\ban\exception\no_valid_users_exception;
use phpbb\ban\exception\type_not_found_exception;
require_once __DIR__ . '/../test_framework/phpbb_session_test_case.php';
class ban_manager_test extends \phpbb_session_test_case
{
protected $ban_manager;
protected $phpbb_container;
protected function getDataSet()
{
return $this->createXMLDataSet(__DIR__ . '/fixtures/sessions_banlist.xml');
}
public function setUp(): void
{
parent::setUp();
global $config, $phpbb_dispatcher, $phpbb_root_path, $phpEx;
$language = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$user = new \phpbb\user($language, '\phpbb\datetime');
$user->data['user_id'] = 2;
$user->data['user_email'] = 'foo@bar.com';
$config = new \phpbb\config\config([]);
$phpbb_dispatcher = new \phpbb_mock_event_dispatcher();
// Change the global cache object for this test because
// the mock cache object does not hit the database as is needed
// for this test.
$cache = new \phpbb\cache\service(
new \phpbb\cache\driver\dummy(),
$config,
$this->db,
$phpbb_dispatcher,
$phpbb_root_path,
$phpEx
);
$phpbb_container = new \phpbb_mock_container_builder();
$ban_type_email = new \phpbb\ban\type\email($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_user = new \phpbb\ban\type\user($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_ip = new \phpbb\ban\type\ip($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$phpbb_container->set('ban.type.email', $ban_type_email);
$phpbb_container->set('ban.type.user', $ban_type_user);
$phpbb_container->set('ban.type.ip', $ban_type_ip);
$collection = new \phpbb\di\service_collection($phpbb_container);
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$collection->add('ban.type.ip');
$this->ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, $user, 'phpbb_bans', 'phpbb_users');
$phpbb_container->set('ban.manager', $this->ban_manager);
$this->phpbb_container = $phpbb_container;
}
public function data_check_ban(): array
{
return [
[
[],
false
],
[
['user_ip' => '127.0.0.1'],
[
'item' => '127.0.0.1',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '10.0.0.1'], // first IP for 10.0.0.1/28 range
[
'item' => '10.0.0.1/28',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '10.0.0.14'], // last IP for 10.0.0.1/28 range
[
'item' => '10.0.0.1/28',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '10.0.0.15'], // first IP outside 10.0.0.1/28 range
[
'item' => '10.0.0.1/28',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '2001:4860:4860::8888'], // first IP in 2001:4860:4860::8888/12 range
[
'item' => '2001:4860:4860::8888/12',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '200F:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF'], // last IP in 2001:4860:4860::8888/12 range
[
'item' => '2001:4860:4860::8888/12',
'end' => '0',
'reason' => '1',
'mode' => 'ip',
],
],
[
['user_ip' => '2010:4860:4860::1'], // IP outside the 2001:4860:4860::8888/12 range
false,
],
[
['user_id' => 2],
false,
],
[
['user_id' => 5], // there is only an expired ban
false,
],
[
['user_id' => 4],
[
'item' => '4',
'end' => '0',
'reason' => '1',
'mode' => 'user',
],
],
[
['user_email' => 'test@phpbb.com'],
false,
],
[
['user_email' => 'bar@example.org'],
[
'item' => 'bar@example.org',
'end' => '0',
'reason' => '1',
'mode' => 'email',
],
],
[
['user_email' => 'test@foo.bar'],
[
'item' => '*@foo.bar',
'end' => '0',
'reason' => '1',
'mode' => 'email',
],
],
];
}
/**
* @dataProvider data_check_ban
*/
public function test_check_ban($user_data, $expected)
{
$this->assertEquals($expected, $this->ban_manager->check($user_data));
}
public function data_get_bans(): array
{
return [
[
'foo',
'',
type_not_found_exception::class
],
[
'ip',
[
[
'ban_id' => '2',
'ban_item' => '127.0.0.1',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
[
'ban_id' => '3',
'ban_item' => '127.1.1.1',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
[
'ban_id' => '6',
'ban_item' => '10.0.0.1/28',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
[
'ban_id' => '7',
'ban_item' => '2001:4860:4860::8888/12',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
],
],
[
'email',
[
[
'ban_id' => '5',
'ban_item' => 'bar@example.org',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
[
'ban_id' => '9',
'ban_item' => '*@foo.bar',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
],
],
[
'user',
[
[
'ban_id' => '4',
'ban_item' => '4',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
],
],
];
}
/**
* @dataProvider data_get_bans
*/
public function test_get_bans($ban_type, $expected, $expected_exception = false)
{
if ($expected_exception !== false)
{
$this->expectException($expected_exception);
}
$this->assertEquals($expected, $this->ban_manager->get_bans($ban_type));
}
public function data_get_ban_end(): array
{
return [
[
0,
20,
0,
],
[
80, // 1 minute plus 20 seconds
20,
1,
],
[
20,
20,
-1,
],
[
2 * 86400, // Ban end should be before this time
20,
-1,
'1970-01-02',
],
[
0,
20,
-1,
'1970-01-02-15:30', // wrong format
invalid_length_exception::class,
],
];
}
/**
* @dataProvider data_get_ban_end
*/
public function test_get_ban_end($expected, $ban_start, $length, $end_date = '', $expected_exception = false)
{
if ($expected_exception)
{
$this->expectException($expected_exception);
}
$start_time = new \DateTime();
$start_time->setTimestamp($ban_start);
$expected_end = new \DateTime();
$expected_end->setTimestamp($expected);
$ban_end = $this->ban_manager->get_ban_end($start_time, $length, $end_date);
if ($length >= 0 || !$end_date)
{
$this->assertEquals($expected_end, $ban_end);
}
else
{
$this->assertLessThan($expected_end, $ban_end);
$this->assertGreaterThan($start_time, $ban_end);
}
}
public function test_get_banned_users()
{
$banned_users = $this->ban_manager->get_banned_users();
$this->assertEquals(
[
4 => 0,
5 => 0
],
$banned_users
);
}
public function test_get_banned_users_own_method()
{
global $phpbb_root_path, $phpEx;
$phpbb_container = new \phpbb_mock_container_builder();
$ban_type_email = new \phpbb\ban\type\email($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_user = new \phpbb\ban\type\user($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_ip = $this->getMockBuilder(\phpbb\ban\type\ip::class)
->setConstructorArgs([$this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys'])
->getMock();
$ban_type_ip->method('get_banned_users')
->willReturn([19 => 1234, 20 => 0]);
$phpbb_container->set('ban.type.email', $ban_type_email);
$phpbb_container->set('ban.type.user', $ban_type_user);
$phpbb_container->set('ban.type.ip', $ban_type_ip);
$collection = new \phpbb\di\service_collection($phpbb_container);
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$collection->add('ban.type.ip');
$language = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$user = new \phpbb\user($language, '\phpbb\datetime');
$config = new \phpbb\config\config([]);
$phpbb_dispatcher = new \phpbb_mock_event_dispatcher();
// Change the global cache object for this test because
// the mock cache object does not hit the database as is needed
// for this test.
$cache = new \phpbb\cache\service(
new \phpbb\cache\driver\dummy(),
$config,
$this->db,
$phpbb_dispatcher,
$phpbb_root_path,
$phpEx
);
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, $user, 'phpbb_bans', 'phpbb_users');
$this->assertEquals(
[
4 => 0,
5 => 0,
20 => 0,
],
$ban_manager->get_banned_users()
);
$ban_type_ip_reflection = new \ReflectionClass($ban_type_ip);
$get_excluded_reflection = $ban_type_ip_reflection->getMethod('get_excluded');
$get_excluded_reflection->setAccessible(true);
$this->assertFalse($get_excluded_reflection->invoke($ban_type_ip));
}
public function test_ban_empty_ban_items()
{
global $phpbb_root_path, $phpEx;
$phpbb_container = new \phpbb_mock_container_builder();
$ban_type_email = new \phpbb\ban\type\email($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_user = new \phpbb\ban\type\user($this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys');
$ban_type_ip = $this->getMockBuilder(\phpbb\ban\type\ip::class)
->setConstructorArgs([$this->db, 'phpbb_users', 'phpbb_sessions', 'phpbb_sessions_keys'])
->getMock();
$ban_type_ip->method('prepare_for_storage')
->willReturn([]);
$ban_type_ip->method('get_type')
->willReturn('ip');
$phpbb_container->set('ban.type.email', $ban_type_email);
$phpbb_container->set('ban.type.user', $ban_type_user);
$phpbb_container->set('ban.type.ip', $ban_type_ip);
$collection = new \phpbb\di\service_collection($phpbb_container);
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$collection->add('ban.type.ip');
$language = new \phpbb\language\language(new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$user = new \phpbb\user($language, '\phpbb\datetime');
$config = new \phpbb\config\config([]);
$phpbb_dispatcher = new \phpbb_mock_event_dispatcher();
// Change the global cache object for this test because
// the mock cache object does not hit the database as is needed
// for this test.
$cache = new \phpbb\cache\service(
new \phpbb\cache\driver\dummy(),
$config,
$this->db,
$phpbb_dispatcher,
$phpbb_root_path,
$phpEx
);
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, $user, 'phpbb_bans', 'phpbb_users');
$start_time = new \DateTime();
$start_time->setTimestamp(1000);
$end_time = new \DateTime();
$end_time->setTimestamp(0);
$this->assertFalse($ban_manager->ban(
'ip',
['192.168.1.1'],
$start_time,
$end_time,
''
));
}
public function data_test_ban(): array
{
return [
[
'user',
['normal_user'],
1000,
500, // end before start
'',
'',
false,
invalid_length_exception::class,
],
[
'foo', // invalid ban type
['normal_user'],
1000,
0, // end before start
'',
'',
false,
type_not_found_exception::class,
],
[
'user',
[], // empty user list
1000,
0,
'',
'',
false,
no_valid_users_exception::class,
],
[
'user',
['founder'], // user same as current user
1000,
0,
'',
'',
false,
no_valid_users_exception::class,
],
[
'user',
['normal_user'],
1000,
0,
'',
'',
true,
],
[
'user',
['normal_u*'],
1000,
0,
'',
'',
true,
],
[
'ip',
[],
1000,
0,
'',
'',
false,
no_valid_ips_exception::class,
],
[
'ip',
['192.168.I.1'], // invalid IP
1000,
0,
'',
'',
false,
no_valid_ips_exception::class,
],
[
'ip',
['192.168.1.1'],
1000,
0,
'',
'',
true,
],
[
'email',
['this_is_not_an_email'],
1000,
0,
'',
'',
false,
no_valid_emails_exception::class
],
[
'email',
['test@example.com'],
1000,
0,
'',
'',
true,
],
[
'email',
['*@foo.bar'],
1000,
0,
'',
'',
true,
],
[
'email',
['test@example.com', str_repeat('a', 100) . '@example.com'], // one email too long, shouldn't cause any issues though
1000,
0,
'',
'',
true,
],
];
}
/**
* @dataProvider data_test_ban
*/
public function test_ban($mode, $items, $start, $end, $reason, $display_reason, $expected, $expected_exception = '')
{
if ($expected_exception)
{
$this->expectException($expected_exception);
}
$start_time = new \DateTime();
$start_time->setTimestamp($start);
$end_time = new \DateTime();
$end_time->setTimestamp($end);
$ban_return = $this->ban_manager->ban($mode, $items, $start_time, $end_time, $reason, $display_reason);
$this->assertEquals($expected, $ban_return);
}
public function test_ban_actual()
{
$start_time = new \DateTime();
$start_time->setTimestamp(1000);
$end_time = new \DateTime();
$end_time->setTimestamp(0);
$ban_return = $this->ban_manager->ban('ip', ['121.122.123.124'], $start_time, $end_time, '', 'because');
$this->assertTrue($ban_return);
$this->assertEquals(
[
'item' => '121.122.123.124',
'end' => 0,
'reason' => 'because',
'mode' => 'ip'
],
$this->ban_manager->check(['user_ip' => '121.122.123.124'])
);
}
public function data_test_unban(): array
{
return [
[
'does_not_exist',
[10],
[],
type_not_found_exception::class
],
[
'user',
[4],
[
[
'ban_id' => '4',
'ban_item' => '4',
'ban_start' => '1111',
'ban_end' => '0',
'ban_reason' => 'HAHAHA',
'ban_reason_display' => '1',
],
],
],
];
}
/**
* @dataProvider data_test_unban
*/
public function test_unban($mode, $items, $expected, $expected_exception = '')
{
if ($expected_exception)
{
$this->expectException($expected_exception);
}
$before_bans = $this->ban_manager->get_bans($mode);
$this->ban_manager->unban($mode, $items);
$after_bans = $this->ban_manager->get_bans($mode);
$ban_diff = array_diff_assoc($before_bans, count($after_bans) ? $after_bans : []);
$this->assertEquals($expected, $ban_diff);
}
public function test_unban_invalid_type()
{
$this->expectException(type_not_found_exception::class);
$this->ban_manager->unban('does_not_exist', []);
}
public function test_base_type_methods()
{
$ban_type_ip = $this->phpbb_container->get('ban.type.ip');
$base_type_reflection = new \ReflectionClass(\phpbb\ban\type\base::class);
$after_unban = $base_type_reflection->getMethod('after_unban');
$this->assertEquals(['foo'], $after_unban->invoke($ban_type_ip, ['items' => ['foo']]));
$check = $base_type_reflection->getMethod('check');
$this->assertFalse($check->invoke($ban_type_ip, [], []));
}
}

161
tests/ban/fixtures/sessions_banlist.xml Normal file
View File

@@ -0,0 +1,161 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dataset>
<table name="phpbb_users">
<column>user_id</column>
<column>username_clean</column>
<column>user_permissions</column>
<column>user_sig</column>
<column>user_email</column>
<column>user_ip</column>
<column>user_type</column>
<row>
<value>1</value>
<value>anonymous</value>
<value></value>
<value></value>
<value></value>
<value>127.0.0.1</value>
<value>2</value>
</row>
<row>
<value>2</value>
<value>founder</value>
<value></value>
<value></value>
<value>admin@foo.bar</value>
<value>21.22.23.24</value>
<value>3</value>
</row>
<row>
<value>3</value>
<value>normal_user</value>
<value></value>
<value></value>
<value>normal_user@foo.bar</value>
<value>21.22.23.25</value>
<value>0</value>
</row>
<row>
<value>4</value>
<value>ipv6_user</value>
<value></value>
<value></value>
<value>normal_user@foo.bar</value>
<value>2345:0425:2CA1:0000:0000:0567:5673:23b5</value>
<value>0</value>
</row>
<row>
<value>5</value>
<value>another_user</value>
<value></value>
<value></value>
<value>bar@example.org</value>
<value>123.124.125.126</value>
<value>0</value>
</row>
</table>
<table name="phpbb_sessions">
<column>session_id</column>
<column>session_user_id</column>
<column>session_ip</column>
<column>session_browser</column>
<column>session_admin</column>
<row>
<value>bar_session000000000000000000000</value>
<value>4</value>
<value>127.0.0.1</value>
<value>user agent</value>
<value>1</value>
</row>
</table>
<table name="phpbb_bans">
<column>ban_id</column>
<column>ban_mode</column>
<column>ban_item</column>
<column>ban_start</column>
<column>ban_end</column>
<column>ban_reason</column>
<column>ban_reason_display</column>
<row>
<value>2</value>
<value>ip</value>
<value>127.0.0.1</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>3</value>
<value>ip</value>
<value>127.1.1.1</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>4</value>
<value>user</value>
<value>4</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>5</value>
<value>email</value>
<value>bar@example.org</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>6</value>
<value>ip</value>
<value>10.0.0.1/28</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>7</value>
<value>ip</value>
<value>2001:4860:4860::8888/12</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>8</value>
<value>invalid_mode</value>
<value>foo</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>9</value>
<value>email</value>
<value>*@foo.bar</value>
<value>1111</value>
<value>0</value>
<value>HAHAHA</value>
<value>1</value>
</row>
<row>
<value>10</value>
<value>user</value>
<value>3</value>
<value>1111</value>
<value>1234</value>
<value>expired</value>
<value>1</value>
</row>
</table>
</dataset>

2
tests/bootstrap.php
View File

@@ -34,6 +34,8 @@ $phpbb_class_loader_ext = new \phpbb\class_loader('\\', $phpbb_root_path . 'ext/
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new \phpbb\class_loader('phpbb\\', $phpbb_root_path . 'phpbb/', "php");
$phpbb_class_loader->register();
$phpbb_class_loader_tests = new \phpbb\class_loader('phpbb\\tests\\', $phpbb_root_path . '../tests/', 'php');
$phpbb_class_loader_tests->register();
require_once 'test_framework/phpbb_test_case_helpers.php';
require_once 'test_framework/phpbb_test_case.php';

2
tests/functions/validate_user_email_test.php
View File

@@ -59,7 +59,7 @@ class phpbb_functions_validate_user_email_test extends phpbb_database_test_case
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, 'phpbb_bans', 'phpbb_users');
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, $this->user, 'phpbb_bans', 'phpbb_users');
$phpbb_container->set('ban.manager', $ban_manager);
}

7
tests/session/check_ban_test.php
View File

@@ -51,7 +51,10 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case
'BAN_TRIGGERED_BY_USER' => 'BAN_TRIGGERED_BY_USER',
];
global $cache, $config, $phpbb_root_path, $phpEx, $phpbb_filesystem, $phpbb_container;
global $cache, $config, $phpbb_root_path, $phpEx, $phpbb_filesystem, $phpbb_container, $user;
$language = new phpbb\language\language(new phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$user = new \phpbb\user($language, '\phpbb\datetime');
$phpbb_filesystem = new \phpbb\filesystem\filesystem();
@@ -81,7 +84,7 @@ class phpbb_session_check_ban_test extends phpbb_session_test_case
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, 'phpbb_bans', 'phpbb_users');
$ban_manager = new \phpbb\ban\manager($collection, $cache, $this->db, $user, 'phpbb_bans', 'phpbb_users');
$phpbb_container->set('ban.manager', $ban_manager);
}

6
tests/session/testable_factory.php
View File

@@ -75,7 +75,7 @@ class phpbb_session_testable_factory
{
// set up all the global variables used by session
global $SID, $_SID, $db, $config, $cache, $request, $phpbb_container, $phpbb_dispatcher;
global $phpbb_root_path, $phpEx;
global $user, $phpbb_root_path, $phpEx;
$request = $this->request = new phpbb_mock_request(
array(),
@@ -90,6 +90,8 @@ class phpbb_session_testable_factory
$cache = $this->cache = new phpbb_mock_cache($this->get_cache_data());
$SID = $_SID = null;
$language = new phpbb\language\language(new phpbb\language\language_file_loader($phpbb_root_path, $phpEx));
$user = new \phpbb\user($language, '\phpbb\datetime');
$phpbb_container = $this->container = new phpbb_mock_container_builder();
$phpbb_container->set(
@@ -124,7 +126,7 @@ class phpbb_session_testable_factory
$collection->add('ban.type.email');
$collection->add('ban.type.user');
$ban_manager = new \phpbb\ban\manager($collection, $cache_service, $db, 'phpbb_bans', 'phpbb_users');
$ban_manager = new \phpbb\ban\manager($collection, $cache_service, $db, $user,'phpbb_bans', 'phpbb_users');
$phpbb_container->set('ban.manager', $ban_manager);
$session = new phpbb_mock_session_testable;