Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
828440e
Implement password policy with hook
JolienTrog Aug 26, 2025
3e7a2cf
fix code sniffer violations
JolienTrog Aug 26, 2025
ed78365
fix code sniffer violations
JolienTrog Aug 26, 2025
bb96ba7
fix code sniffer violations
JolienTrog Aug 26, 2025
174c59c
Update application/forms/Account/ChangePasswordForm.php
JolienTrog Aug 26, 2025
93c6479
Update application/forms/Account/ChangePasswordForm.php
JolienTrog Aug 26, 2025
4ab7f2f
add constructor for password policy objekt
JolienTrog Aug 26, 2025
9175c4d
add constructor to PasswordValidator and codereview changes
JolienTrog Aug 27, 2025
1215b94
fix codesniffer
JolienTrog Aug 27, 2025
0a44791
Implement 'None Password Policy'-class for consistency
JolienTrog Aug 28, 2025
8f49073
fix codesniffer
JolienTrog Aug 28, 2025
43d6483
fix if no password policy is set in config.ini
JolienTrog Aug 28, 2025
02c067e
fix codesniffer
JolienTrog Aug 28, 2025
740837f
changes codereview
JolienTrog Aug 28, 2025
64d7036
codereview
JolienTrog Aug 28, 2025
b3a1a31
codereview
JolienTrog Aug 28, 2025
d2d91d2
codereview
JolienTrog Aug 28, 2025
2a10671
Change Class Default in CommonPasswordPolicy
JolienTrog Sep 1, 2025
d7acd7c
Unittest for Classes Password Policy
JolienTrog Sep 2, 2025
33bb7ba
codereview: Improve type hints and return types
JolienTrog Sep 2, 2025
9d8cbcd
codereview
JolienTrog Sep 10, 2025
2682e0f
add documantation for general and custom password policy
JolienTrog Sep 10, 2025
91f20c8
codereview
JolienTrog Sep 11, 2025
ba6972d
codereview change description methods typ to return string or null
JolienTrog Sep 11, 2025
6b2ffd0
implement Password Policy Helper Class to reduce code duplication
JolienTrog Sep 29, 2025
71090ae
fix failed unittest
JolienTrog Oct 6, 2025
d7e36e3
Handle invalid password policy config
JolienTrog Oct 14, 2025
76bacb6
Fix code sniffer violation
JolienTrog Oct 14, 2025
29b74f1
Apply code review suggestions
JolienTrog Nov 6, 2025
47acabf
Rearrange helper, split hook and interface
JolienTrog Nov 21, 2025
409137e
Adjust validation to accept oldPassword
JolienTrog Jan 26, 2026
81e6859
Adjust Test with second value
JolienTrog Jan 26, 2026
7193bab
code-review
JolienTrog Jan 30, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions application/forms/Account/ChangePasswordForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

namespace Icinga\Forms\Account;

use Icinga\Authentication\PasswordPolicyHelper;
use Icinga\Authentication\User\DbUserBackend;
use Icinga\Data\Filter\Filter;
use Icinga\User;
Expand Down Expand Up @@ -46,10 +47,12 @@ public function createElements(array $formData)
'password',
'new_password',
array(
'label' => $this->translate('New Password'),
'required' => true
'label' => $this->translate('New Password'),
'required' => true
)
);
PasswordPolicyHelper::applyPasswordPolicy($this, 'new_password', 'old_password');

$this->addElement(
'password',
'new_password_confirmation',
Expand Down
37 changes: 37 additions & 0 deletions application/forms/Config/General/PasswordPolicyConfigForm.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php
/* Icinga Web 2 | (c) 2025 Icinga GmbH | GPLv2+ */

namespace Icinga\Forms\Config\General;

use Icinga\Application\Hook\PasswordPolicyHook;
use Icinga\Authentication\PasswordPolicyHelper;
use Icinga\Web\Form;

/**
* Configuration form for password policy selection
*
* This form is not used directly but as subform for the {@link GeneralConfigForm}.
*/
class PasswordPolicyConfigForm extends Form
{
public function init(): void
{
$this->setName('form_config_general_password_policy');
}

public function createElements(array $formData): static
{
$this->addElement(
'select',
sprintf('%s_%s', PasswordPolicyHelper::CONFIG_SECTION, PasswordPolicyHelper::CONFIG_KEY),
[
'description' => $this->translate('Enforce password requirements for new passwords'),
'label' => $this->translate('Password Policy'),
'value' => PasswordPolicyHelper::DEFAULT_PASSWORD_POLICY,
'multiOptions' => PasswordPolicyHook::all()
]
);

return $this;
}
}
3 changes: 3 additions & 0 deletions application/forms/Config/GeneralConfigForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Icinga\Forms\Config\General\DefaultAuthenticationDomainConfigForm;
use Icinga\Forms\Config\General\LoggingConfigForm;
use Icinga\Forms\Config\General\ThemingConfigForm;
use Icinga\Forms\Config\General\PasswordPolicyConfigForm;
use Icinga\Forms\ConfigForm;

/**
Expand All @@ -32,9 +33,11 @@ public function createElements(array $formData)
$loggingConfigForm = new LoggingConfigForm();
$themingConfigForm = new ThemingConfigForm();
$domainConfigForm = new DefaultAuthenticationDomainConfigForm();
$passwordPolicyConfigForm = new PasswordPolicyConfigForm();
$this->addSubForm($appConfigForm->create($formData));
$this->addSubForm($loggingConfigForm->create($formData));
$this->addSubForm($themingConfigForm->create($formData));
$this->addSubForm($domainConfigForm->create($formData));
$this->addSubForm($passwordPolicyConfigForm->create($formData));
}
}
9 changes: 7 additions & 2 deletions application/forms/Config/User/UserForm.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@
namespace Icinga\Forms\Config\User;

use Icinga\Application\Hook\ConfigFormEventsHook;
use Icinga\Application\Logger;
use Icinga\Authentication\PasswordPolicyHelper;
use Icinga\Data\Filter\Filter;
use Icinga\Forms\RepositoryForm;
use Icinga\Web\Form\Element\Note;
use Icinga\Web\Notification;
use Throwable;

class UserForm extends RepositoryForm
{
Expand Down Expand Up @@ -38,10 +42,11 @@ protected function createInsertElements(array $formData)
'password',
'password',
array(
'required' => true,
'label' => $this->translate('Password')
'required' => true,
'label' => $this->translate('Password')
)
);
PasswordPolicyHelper::applyPasswordPolicy($this, 'password');

$this->setTitle($this->translate('Add a new user'));
$this->setSubmitLabel($this->translate('Add'));
Expand Down
101 changes: 101 additions & 0 deletions doc/05-Authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,107 @@ resource = icingaweb-mysql
Please read [this chapter](20-Advanced-Topics.md#advanced-topics-authentication-tips-manual-user-database-auth)
in order to manually create users directly inside the database.

### Password Policy <a id="authentication-password-policy"></a>

Icinga Web supports password policies when using database authentication.
You can configure this under **Configuration > Application > General**.

By default, no password policy is enforced (`Any`).
Icinga Web provides a built-in policy called `Common` with the following requirements:

* Minimum length of 12 characters
* At least one number
* At least one special character
* At least one uppercase letter
* At least one lowercase letter

#### Custom Password Policy <a id="authentication-custom-password-policy"></a>

You can create custom password policies by developing a module with a provided hook.

**Create Module Structure**
```bash
mkdir -p /usr/share/icingaweb2/modules/mypasswordpolicy/library/Mypasswordpolicy/ProvidedHook
cd /usr/share/icingaweb2/modules/mypasswordpolicy
```

Create `module.info`:
```ini
Module: mypasswordpolicy
Name: My Password Policy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add Module: mypasswordpolicy before Name please.

Version: 1.0.0
Description: Custom password policy implementation
```

**Implement the Hook**

Icinga Web provides the `PasswordPolicyHook` with predefined methods
that simplify the extension of custom password policies.

Create `library/Mypasswordpolicy/ProvidedHook/PasswordPolicy.php`:

```php
<?php

namespace Icinga\Module\Mypasswordpolicy\ProvidedHook;

use Icinga\Application\Hook\PasswordPolicyHook;use ipl\I18n\Translation;

class PasswordPolicy extends PasswordPolicyHook
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example does not use Translation, but it would be nice if this were included as well.

{
use Translation;

public function getName(): string
{
return 'My Custom Policy';
}

public function getDescription(): string
{
return 'Custom password requirements: 8+ chars, 1 number';
}

public function validate(string $newPassword, ?string $oldPassword = null): array;
{
$violations = [];

if (strlen($newPassword) < 8) {
$violations[] = 'Password must be at least 8 characters';
}

if (! preg_match('/[0-9]/', $newPassword)) {
$violations[] = 'Password must contain at least one number';
}

if ($oldPassword !== null && hash_equals($oldPassword, $newPassword)) {
$violations[] = 'New password must be different from the old password';
}

return $violations;
}
}
?>
```

**Register the Hook**

Create `run.php`:
```php
<?php

use Icinga\Module\Mypasswordpolicy\ProvidedHook\MyPasswordPolicy;
Mypasswordpolicy::register();
?>
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Enable the module:
```bash
icingacli module enable mypasswordpolicy
```

You can choose in the settings the preferred password policy.

The custom policy will now appear in **Configuration > Application > General** under Password Policy.

## Groups <a id="authentication-configuration-groups"></a>

Expand Down
14 changes: 9 additions & 5 deletions library/Icinga/Application/ApplicationBootstrap.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@
use DirectoryIterator;
use ErrorException;
use Exception;
use Icinga\Application\ProvidedHook\DbMigration;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't reorder the whole imports. Two new lines for CommonPasswordPolicy and AnyPasswordPolicy should be sufficient.

use ipl\I18n\GettextTranslator;
use ipl\I18n\StaticTranslator;
use LogicException;
use Icinga\Application\Modules\Manager as ModuleManager;
use Icinga\Application\ProvidedHook\DbMigration;
use Icinga\Authentication\User\UserBackend;
use Icinga\Data\ConfigObject;
use Icinga\Exception\ConfigurationError;
use Icinga\Exception\NotReadableError;
use Icinga\Exception\IcingaException;
use Icinga\Exception\NotReadableError;
use ipl\I18n\GettextTranslator;
use ipl\I18n\StaticTranslator;
use LogicException;
use Icinga\Application\ProvidedHook\AnyPasswordPolicy;
use Icinga\Application\ProvidedHook\CommonPasswordPolicy;

/**
* This class bootstraps a thin Icinga application layer
Expand Down Expand Up @@ -740,6 +742,8 @@ public function hasLocales()
protected function registerApplicationHooks(): self
{
Hook::register('DbMigration', DbMigration::class, DbMigration::class);
CommonPasswordPolicy::register();
AnyPasswordPolicy::register();

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

return $this;
}
Expand Down
44 changes: 44 additions & 0 deletions library/Icinga/Application/Hook/PasswordPolicyHook.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php
/* Icinga Web 2 | (c) 2025 Icinga GmbH | GPLv2+ */

namespace Icinga\Application\Hook;

use Icinga\Application\Hook;
use Icinga\Authentication\PasswordPolicy;

/**
* Base class for hookable password policies
*/
abstract class PasswordPolicyHook implements PasswordPolicy
{
/**
* Hook name
*/
protected const HOOK_NAME = 'PasswordPolicy';

/**
* Register password policy
*
* @return void
*/
public static function register(): void
{
Hook::register(self::HOOK_NAME, static::class, static::class);
}

/**
* Return all registered password policies sorted by name
*
* @return array
*/
public static function all(): array
{
$passwordPolicies = [];
foreach (Hook::all('PasswordPolicy') as $class => $policy) {
$passwordPolicies[$class] = $policy->getName();
}
asort($passwordPolicies);

return $passwordPolicies;
Comment on lines +36 to +42
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$passwordPolicies = [];
foreach (Hook::all('PasswordPolicy') as $class => $policy) {
$passwordPolicies[$class] = $policy->getName();
}
asort($passwordPolicies);
return $passwordPolicies;
$passwordPolicies = [];
foreach (Hook::all('PasswordPolicy') as $class => $policy) {
$passwordPolicies[$class] = $policy->getName();
}
asort($passwordPolicies);
return $passwordPolicies;

}
}
31 changes: 31 additions & 0 deletions library/Icinga/Application/ProvidedHook/AnyPasswordPolicy.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?php
/* Icinga Web 2 | (c) 2025 Icinga GmbH | GPLv2+ */

namespace Icinga\Application\ProvidedHook;

use Icinga\Application\Hook\PasswordPolicyHook;
use ipl\I18n\Translation;

/**
* Policy to allow any password
*/
class AnyPasswordPolicy extends PasswordPolicyHook
{
use Translation;

public function getName(): string
{
// Policy is named 'None' to indicate that no password policy is enforced and any password is accepted
return $this->translate('None');
}

public function getDescription(): ?string
{
return null;
}

public function validate(string $newPassword, ?string $oldPassword = null): array
{
return [];
}
}
62 changes: 62 additions & 0 deletions library/Icinga/Application/ProvidedHook/CommonPasswordPolicy.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<?php
/* Icinga Web 2 | (c) 2025 Icinga GmbH | GPLv2+ */

namespace Icinga\Application\ProvidedHook;

use Icinga\Application\Hook\PasswordPolicyHook;
use ipl\I18n\Translation;

/**
* Common implementation of a password policy
*
* Enforces:
* - Minimum length of 12 characters
* - At least one number
* - At least one special character
* - At least one uppercase letter
* - At least one lowercase letter
*/
class CommonPasswordPolicy extends PasswordPolicyHook
{
use Translation;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

public function getName(): string
{
return $this->translate('Common');
}

public function getDescription(): ?string
{
return $this->translate(
'Password requirements: minimum 12 characters, ' .
'at least 1 number, 1 special character, uppercase and lowercase letters.'
);
}

public function validate(string $newPassword, ?string $oldPassword = null): array
{
$violations = [];

if (mb_strlen($newPassword) < 12) {
$violations[] = $this->translate('Password must be at least 12 characters long');
}

if (! preg_match('/[0-9]/', $newPassword)) {
$violations[] = $this->translate('Password must contain at least one number');
}

if (! preg_match('/[^a-zA-Z0-9]/', $newPassword)) {
$violations[] = $this->translate('Password must contain at least one special character');
}

if (! preg_match('/[A-Z]/', $newPassword)) {
$violations[] = $this->translate('Password must contain at least one uppercase letter');
}

if (! preg_match('/[a-z]/', $newPassword)) {
$violations[] = $this->translate('Password must contain at least one lowercase letter');
}

return $violations;
}
}
Loading
Loading