Files
postfixadmin/tests/SecurityListOutputTest.php
T
Rodrigo Cortés Cano 3feeb081af Escape security lists and make template escaping opt-outs explicit (#1172)
fixes potential XSS issue with TOTP exception lists (which need escaping, see also #1185). 

refactors Template escaping to use TemplateEscape enum (rather than the previous boolean).

thanks @TrapoSAMA
2026-11-01 10:41:54 +00:00

258 lines
12 KiB
PHP

<?php
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
class SecurityListOutputTest extends TestCase
{
private const USERNAME = 'test@security-list-http.example.com';
private const DOMAIN = 'security-list-http.example.com';
private string $directory;
private string $url;
private string $cookie = '';
private $server;
protected function setUp(): void
{
self::assertSame(1, db_insert('domain', [
'domain' => self::DOMAIN, 'description' => 'Security output HTTP test', 'transport' => 'virtual',
]));
$descriptions = self::descriptions();
foreach ($descriptions as $index => $description) {
self::assertSame(1, db_insert('mailbox_app_password', [
'username' => self::USERNAME, 'description' => $description, 'password_hash' => 'fixture-unused',
], []));
self::assertSame(1, db_insert('totp_exception_address', [
'username' => self::USERNAME, 'description' => $description, 'ip' => '192.0.2.' . ($index + 1),
], []));
}
self::assertSame(1, db_insert('totp_exception_address', [
'username' => self::DOMAIN, 'description' => 'Domain exception', 'ip' => '192.0.2.10',
], []));
$this->directory = sys_get_temp_dir() . '/pfa-security-list-' . bin2hex(random_bytes(6));
self::assertTrue(mkdir($this->directory));
$config = Config::getInstance()->getAll();
$config['totp'] = 'YES';
$config['app_passwords'] = 'YES';
$config['default_language'] = 'en';
$config['language_hook'] = '';
$config['domain_dns_status_check'] = 0;
// Other tests may leave callable rules that cannot be transferred through JSON.
$config['password_validation'] = ['/.{5}/' => 'password_too_short 5'];
file_put_contents($this->directory . '/config.json', json_encode($config, JSON_THROW_ON_ERROR));
$socket = stream_socket_server('tcp://127.0.0.1:0');
self::assertIsResource($socket);
$address = stream_socket_get_name($socket, false);
fclose($socket);
$this->url = 'http://' . $address;
$command = [PHP_BINARY];
if (php_ini_loaded_file()) {
array_push($command, '-c', php_ini_loaded_file());
}
array_push($command, '-d', 'session.save_path=' . $this->directory, '-d', 'log_errors=1', '-d', 'error_log=' . $this->directory . '/error.log', '-S', $address, __DIR__ . '/fixtures/security-list-http-router.php');
$env = getenv();
$env['PFA_SECURITY_LIST_TEST_CONFIG'] = $this->directory . '/config.json';
$this->server = proc_open($command, [0 => ['pipe', 'r'], 1 => ['file', $this->directory . '/server.log', 'a'], 2 => ['file', $this->directory . '/server.log', 'a']], $pipes, dirname(__DIR__), $env);
self::assertIsResource($this->server);
fclose($pipes[0]);
for ($attempt = 0; $attempt < 100; $attempt++) {
$ready = @stream_socket_client('tcp://' . $address, $errno, $error, 0.1);
if ($ready !== false) {
fclose($ready);
return;
}
usleep(50000);
}
self::fail('PHP HTTP server did not start: ' . file_get_contents($this->directory . '/server.log'));
}
protected function tearDown(): void
{
if (is_resource($this->server)) {
proc_terminate($this->server);
proc_close($this->server);
}
foreach (['mailbox_app_password', 'totp_exception_address'] as $table) {
db_execute('DELETE FROM ' . table_by_key($table) . ' WHERE username = :username OR username = :domain', [
'username' => self::USERNAME, 'domain' => self::DOMAIN,
]);
}
db_delete('mailbox', 'username', self::USERNAME);
db_delete('domain_admins', 'username', 'admin@' . self::DOMAIN);
db_delete('domain', 'domain', self::DOMAIN);
if (isset($this->directory) && is_dir($this->directory)) {
foreach (new DirectoryIterator($this->directory) as $file) {
if (!$file->isDot()) {
unlink($file->getPathname());
}
}
rmdir($this->directory);
}
}
public static function pages(): array
{
return [
'mailbox application passwords' => ['/users/app-passwords.php', 'user', 2, 0],
'global-admin application passwords' => ['/app-passwords.php', 'global-admin', 2, 0],
'mailbox TOTP exceptions' => ['/users/totp-exceptions.php', 'user', 3, 1],
'global-admin TOTP exceptions' => ['/totp-exceptions.php', 'global-admin', 3, 0],
];
}
#[DataProvider('pages')]
public function testStoredListValuesRenderAsText(string $path, string $role, int $descriptionColumn, int $disabled): void
{
[$status] = $this->request('/__session?role=' . $role);
self::assertSame(200, $status);
[$status, $html] = $this->request($path);
self::assertSame(200, $status, $html);
$document = new DOMDocument();
$previousErrors = libxml_use_internal_errors(true);
try {
$document->loadHTML('<?xml encoding="UTF-8">' . $html);
} finally {
libxml_clear_errors();
libxml_use_internal_errors($previousErrors);
}
$xpath = new DOMXPath($document);
self::assertSame(0, $xpath->query('//*[@data-security-fixture]')->length);
$rows = $xpath->query('//table[@id="mailbox_table"]/tr[td]');
$descriptions = [];
foreach ($rows as $row) {
$descriptions[] = $xpath->query('./td[' . $descriptionColumn . ']', $row)->item(0)->textContent;
}
foreach (self::descriptions() as $description) {
self::assertContains(html_entity_decode($description, ENT_QUOTES, 'UTF-8'), $descriptions);
}
self::assertSame($disabled, $xpath->query('//table[@id="mailbox_table"]//button[@disabled]')->length);
self::assertSame($rows->length, $xpath->query('//table[@id="mailbox_table"]//input[@name="CSRF_Token"]')->length);
self::assertStringNotContainsString('&amp;lt;tag&amp;gt;', $html);
}
public static function forms(): array
{
return [
'password' => ['/users/password.php', 2],
'TOTP' => ['/users/totp.php', 1],
];
}
#[DataProvider('forms')]
public function testFormErrorsRenderTranslatedText(string $path, int $errorCount): void
{
[$status] = $this->request('/__session?role=user');
self::assertSame(200, $status);
[$status, $html] = $this->request($path);
self::assertSame(200, $status, $html);
self::assertSame(1, preg_match('/name=["\']CSRF_Token["\'][^>]*value=["\']([^"\']+)/', $html, $match));
[$status, $html] = $this->request($path, [
'CSRF_Token' => $match[1], 'fPassword_current' => 'incorrect-fixture-password',
'fPassword' => '', 'fPassword2' => '', 'fTOTP_code' => '', 'fTOTP_secret' => '',
]);
self::assertSame(200, $status, $html);
self::assertStringContainsString('Invalid &lt;password&gt; &amp; current', $html);
self::assertStringNotContainsString('<password>', $html);
self::assertSame($errorCount, substr_count($html, 'mb-3 is-invalid'));
if ($errorCount === 2) {
self::assertStringContainsString('Invalid &lt;password&gt; &amp; new', $html);
}
}
public function testTotpQrAndSecretRemainUsable(): void
{
$this->request('/__session?role=user');
[$status, $html] = $this->request('/users/totp.php');
self::assertSame(200, $status, $html);
self::assertSame(1, preg_match('/data:image\/png;base64, ([A-Za-z0-9+\/=]+)"/', $html, $qr));
$png = base64_decode($qr[1], true);
self::assertNotFalse($png);
self::assertStringStartsWith("\x89PNG\r\n\x1a\n", $png);
self::assertSame(1, preg_match('/name="fTOTP_secret" value="([A-Z2-7]+)"/', $html, $secret));
self::assertStringContainsString('/>' . $secret[1], $html);
self::assertStringNotContainsString('is-invalid', $html);
}
public function testDomainSelectionPreservesAuthorisation(): void
{
self::assertSame(1, db_insert('domain_admins', [
'username' => 'admin@' . self::DOMAIN, 'domain' => self::DOMAIN, 'active' => true,
], ['created']));
$this->request('/__session?role=global-admin');
[$status, $html] = $this->request('/list-virtual.php', ['fDomain' => self::DOMAIN]);
self::assertSame(200, $status, $html);
self::assertStringContainsString(self::DOMAIN . ' :</h4>', $html);
[$status] = $this->request('/list-virtual.php', ['fDomain' => '<img src=x onerror="alert(1)">']);
self::assertSame(302, $status);
}
public static function editorRoles(): array
{
return ['domain admin' => ['admin'], 'global admin' => ['global-admin']];
}
#[DataProvider('editorRoles')]
public function testGenericEditorEscapesTextAndPreservesHtml(string $role): void
{
$name = 'R&D <b>name</b> "quoted"';
self::assertSame(1, db_insert('domain_admins', [
'username' => 'admin@' . self::DOMAIN, 'domain' => self::DOMAIN, 'active' => true,
], ['created']));
self::assertSame(1, db_insert('mailbox', [
'username' => self::USERNAME, 'password' => 'fixture-unused', 'name' => $name,
'maildir' => self::DOMAIN . '/test/', 'local_part' => 'test', 'domain' => self::DOMAIN,
'active' => true, 'totp_secret' => 'JBSWY3DPEHPK3PXP',
]));
$this->request('/__session?role=' . $role);
$path = '/edit.php?table=mailbox&edit=' . urlencode(self::USERNAME);
[$status, $html] = $this->request($path);
self::assertSame(200, $status, $html);
self::assertStringContainsString('R&amp;D &lt;b&gt;name&lt;/b&gt; &quot;quoted&quot;', $html);
self::assertStringContainsString('<button type="submit" name="reset_totp"', $html);
self::assertStringNotContainsString('&lt;button', $html);
self::assertSame(1, preg_match('/name=["\']CSRF_Token["\'][^>]*value=["\']([^"\']+)/', $html, $token));
$editedName = 'Changed <b>text</b> & "quoted"';
// Invalid quota prevents writes; the read-only HTML field takes its default assignment path.
[$status, $html] = $this->request($path, [
'table' => 'mailbox', 'edit' => self::USERNAME, 'CSRF_Token' => $token[1],
'value' => ['name' => $editedName, 'quota' => '-999'],
]);
self::assertSame(200, $status, $html);
self::assertStringContainsString('Changed &lt;b&gt;text&lt;/b&gt; &amp; &quot;quoted&quot;', $html);
self::assertStringNotContainsString('name="reset_totp"', $html);
self::assertSame($name, db_query_one('SELECT name FROM ' . table_by_key('mailbox') . ' WHERE username = ?', [self::USERNAME])['name']);
[$status, $html] = $this->request('/edit.php?table=mailbox&domain=' . self::DOMAIN);
self::assertSame(200, $status, $html);
self::assertStringContainsString('name="value[name]"', $html);
self::assertStringNotContainsString('name="reset_totp"', $html);
}
private static function descriptions(): array
{
return [
'<img data-security-fixture="injected" src=x onerror="alert(1)">',
"R&D \"quoted\" 'text' <tag> UTF-8: \u{00F1}",
'Legacy &lt;tag&gt; &amp; text',
];
}
private function request(string $path, ?array $data = null): array
{
$options = ['ignore_errors' => true, 'follow_location' => 0, 'timeout' => 10,
'header' => "Cookie: {$this->cookie}\r\n"];
if ($data !== null) {
$options['method'] = 'POST';
$options['header'] .= "Content-Type: application/x-www-form-urlencoded\r\n";
$options['content'] = http_build_query($data);
}
$body = file_get_contents($this->url . $path, false, stream_context_create(['http' => $options]));
self::assertNotFalse($body);
foreach ($http_response_header as $header) {
if (preg_match('/^Set-Cookie: (postfixadmin_session=[^;]+)/i', $header, $match)) {
$this->cookie = $match[1];
}
}
return [(int)explode(' ', $http_response_header[0])[1], $body];
}
}