Files
postfixadmin/tests/LoginTest.php
T
Rodrigo Cortés Cano e638095d58 Harden password recovery requests (#1130)
Require a validated canonical site_url for recovery links, keep responses uniform, and persist a five-minute per-account request limit.

The token update is atomic across supported database engines and performs the same password hashing work for unknown accounts.

Refs #1128

thanks @TrapoSAMA
2026-08-29 14:55:49 +01:00

286 lines
9.6 KiB
PHP

<?php
class LoginTest extends \PHPUnit\Framework\TestCase
{
private string $passwordExpirationConfig;
public function setUp(): void
{
global $CONF;
$this->passwordExpirationConfig = (string)Config::read('password_expiration');
$this->cleanUp();
$CONF['pacrypt'] = 'md5'; // crap
db_execute("INSERT INTO domain(domain, description, transport) values ('example.com', 'test', 'foo')", [], true);
db_execute(
"INSERT INTO mailbox(username, password, name, maildir, local_part, domain) VALUES(:username, :password, :name, :maildir, :local_part, :domain)",
[
'username' => 'test@example.com',
'password' => pacrypt('foobar'),
'name' => 'test user',
'maildir' => '/foo/bar',
'local_part' => 'test',
'domain' => 'example.com',
]);
parent::setUp();
}
public function tearDown(): void
{
Config::write('password_expiration', $this->passwordExpirationConfig);
$this->cleanUp();
parent::tearDown(); // TODO: Change the autogenerated stub
}
private function cleanUp()
{
db_query('DELETE FROM alias');
db_query('DELETE FROM alias_domain');
db_query('DELETE FROM mailbox');
db_query('DELETE FROM domain_admins');
db_query('DELETE FROM domain');
}
public function testChangePassword()
{
$login = new Login('mailbox');
$this->assertTrue($login->login('test@example.com', 'foobar'));
// Can't change - current password wrong.
try {
$login->changePassword('test@example.com', 'foobar2', 'foobar2');
$this->fail("Exception should have been thrown");
} catch (\Exception $e) {
$this->assertEquals("You didn't supply your current password!", $e->getMessage());
}
// Should change, current password correct.
$this->assertTrue($login->changePassword('test@example.com', 'foobar2', 'foobar'));
// Can't now login with the old password
$this->assertFalse($login->login('test@example.com', 'foobar'));
// Can login with the new one...
$this->assertTrue($login->login('test@example.com', 'foobar2'));
$mailbox = db_query_one(
'SELECT password_expiry FROM mailbox WHERE username = :username',
['username' => 'test@example.com']
);
$this->assertSame(strtotime(PASSWORD_EXPIRATION_NEVER), strtotime($mailbox['password_expiry']));
Config::write('password_expiration', 'YES');
db_execute(
'UPDATE domain SET password_expiry = :days WHERE domain = :domain',
['days' => 30, 'domain' => 'example.com']
);
$this->assertTrue($login->changePassword('test@example.com', 'foobar3', 'foobar2'));
$mailbox = db_query_one(
'SELECT password_expiry FROM mailbox WHERE username = :username',
['username' => 'test@example.com']
);
$expiry = strtotime($mailbox['password_expiry']);
$this->assertGreaterThanOrEqual(strtotime('+29 days'), $expiry);
$this->assertLessThanOrEqual(strtotime('+31 days'), $expiry);
}
public function testInvalidUsers()
{
$login = new Login('mailbox');
$this->assertFalse($login->login('test', 'password'));
$this->assertFalse($login->login('test', ''));
$this->assertFalse($login->login('', ''));
}
public function testEmptyStringWithDovecot()
{
global $CONF;
if (!file_exists('/usr/bin/doveadm')) {
$this->markTestSkipped("/usr/bin/doveadm doesn't exist.");
}
$CONF['encrypt'] = 'dovecot:sha512';
db_execute(
"UPDATE mailbox SET password = :password WHERE username = :username",
[
'username' => 'test@example.com',
'password' => '{SHA512}ClAmHr0aOQ/tK/Mm8mc8FFWCpjQtUjIElz0CGTN/gWFqgGmwElh89WNfaSXxtWw2AjDBmyc1AO4BPgMGAb8kJQ==', // pacrypt('foobar'),
]
);
$l = new Login('mailbox');
$this->assertFalse($l->login('test@example.com', ''));
$this->assertTrue($l->login('test@example.com', 'foobar'));
$this->assertFalse($l->login('test@fails.com', 'foobar'));
}
public function testInvalidLogin()
{
$login = new Login('mailbox');
$this->assertFalse($login->login('test', 'password'));
$this->assertFalse($login->login('test', 'foobar'));
$this->assertFalse($login->login('', ''));
}
public function testPasswordRecovery()
{
$login = new Login('mailbox');
$this->assertFalse($login->generatePasswordRecoveryCode(''));
$this->assertFalse($login->generatePasswordRecoveryCode('doesnotexist'));
$this->assertNotEmpty($login->generatePasswordRecoveryCode('test@example.com'));
}
public function testAddAppPasswordIncorrectPassword()
{
$login = new Login('mailbox');
$this->assertTrue($login->login('test@example.com', 'foobar'));
$this->expectExceptionMessage("You didn't supply your current password!");
$this->assertTrue($login->addAppPassword('test@example.com', 'fish', '1st-app-password', 'something'));
}
public function testAddAppPassword()
{
$login = new Login('mailbox');
$this->assertTrue($login->login('test@example.com', 'foobar'));
$this->assertTrue($login->addAppPassword('test@example.com', 'foobar', '1st-app-password', 'something'));
$this->assertTrue($login->addAppPassword('test@example.com', 'foobar', '1st-app-password', 'something'));
$rows = db_query_all('SELECT * FROM mailbox_app_password');
$this->assertEquals(2, count($rows));
foreach ($rows as $r) {
$this->assertEquals('1st-app-password', $r['description']);
$this->assertNotEmpty($r['password_hash']);
$this->assertEquals('test@example.com', $r['username']);
}
}
/**
* Test admin login works via the admin table.
*/
public function testAdminLogin()
{
db_execute(
"INSERT INTO admin(username, password, superadmin, active) VALUES(:username, :password, :superadmin, :active)",
[
'username' => 'admin@example.com',
'password' => pacrypt('adminpass'),
'superadmin' => db_get_boolean(true),
'active' => db_get_boolean(true),
]
);
$login = new Login('admin');
$this->assertTrue($login->login('admin@example.com', 'adminpass'));
$this->assertFalse($login->login('admin@example.com', 'wrongpass'));
$this->assertFalse($login->login('nonexistent@example.com', 'adminpass'));
db_query("DELETE FROM admin WHERE username = 'admin@example.com'");
}
/**
* Test inactive mailbox cannot login.
*/
public function testInactiveMailboxCannotLogin()
{
db_execute(
"UPDATE mailbox SET active = :active WHERE username = :username",
['active' => db_get_boolean(false), 'username' => 'test@example.com']
);
$login = new Login('mailbox');
$this->assertFalse($login->login('test@example.com', 'foobar'));
// Reactivate
db_execute(
"UPDATE mailbox SET active = :active WHERE username = :username",
['active' => db_get_boolean(true), 'username' => 'test@example.com']
);
}
/**
* Test inactive admin cannot login.
*/
public function testInactiveAdminCannotLogin()
{
db_execute(
"INSERT INTO admin(username, password, superadmin, active) VALUES(:username, :password, :superadmin, :active)",
[
'username' => 'inactive@example.com',
'password' => pacrypt('adminpass'),
'superadmin' => db_get_boolean(false),
'active' => db_get_boolean(false),
]
);
$login = new Login('admin');
$this->assertFalse($login->login('inactive@example.com', 'adminpass'));
db_query("DELETE FROM admin WHERE username = 'inactive@example.com'");
}
/**
* Test Login constructor rejects invalid table names.
*/
public function testInvalidTableThrows()
{
$this->expectException(\InvalidArgumentException::class);
new Login('invalid_table');
}
/**
* Test password recovery code can be verified.
*/
public function testPasswordRecoveryCodeVerification()
{
$login = new Login('mailbox');
$token = $login->generatePasswordRecoveryCode('test@example.com');
$this->assertNotEmpty($token);
$this->assertIsString($token);
// Verify token is stored (hashed) in the database
$row = db_query_one(
"SELECT token, token_validity FROM " . table_by_key('mailbox') . " WHERE username = :username",
['username' => 'test@example.com']
);
$this->assertNotNull($row);
$this->assertNotEmpty($row['token']);
$this->assertNotEmpty($row['token_validity']);
$this->assertFalse($login->generatePasswordRecoveryCode('test@example.com'));
db_execute(
"UPDATE " . table_by_key('mailbox') . " SET token_validity = :validity WHERE username = :username",
[
'validity' => date('Y-m-d H:i:s', strtotime('+54 minutes')),
'username' => 'test@example.com',
]
);
$replacement = $login->generatePasswordRecoveryCode('test@example.com');
$this->assertIsString($replacement);
$this->assertNotSame($token, $replacement);
}
}