-
Notifications
You must be signed in to change notification settings - Fork 282
Implement password policy with hook #5419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
828440e
3e7a2cf
ed78365
bb96ba7
174c59c
93c6479
4ab7f2f
9175c4d
1215b94
0a44791
8f49073
43d6483
02c067e
740837f
64d7036
b3a1a31
d2d91d2
2a10671
d7acd7c
33bb7ba
9d8cbcd
2682e0f
91f20c8
ba6972d
6b2ffd0
71090ae
d7e36e3
76bacb6
29b74f1
47acabf
409137e
81e6859
7193bab
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?php | ||
| /* Icinga Web 2 | (c) 2025 Icinga GmbH | GPLv2+ */ | ||
|
|
||
lippserd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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), | ||
| [ | ||
Al2Klimov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 'description' => $this->translate('Enforce password requirements for new passwords'), | ||
| 'label' => $this->translate('Password Policy'), | ||
| 'value' => PasswordPolicyHelper::DEFAULT_PASSWORD_POLICY, | ||
| 'multiOptions' => PasswordPolicyHook::all() | ||
| ] | ||
| ); | ||
|
|
||
lippserd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return $this; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -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> | ||||
lippserd marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
|
|
||||
| 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 | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add |
||||
| 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 | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The example does not |
||||
| { | ||||
| 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(); | ||||
| ?> | ||||
| ``` | ||||
|
|
||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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> | ||||
|
|
||||
|
|
||||
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -6,16 +6,18 @@ | |||
| use DirectoryIterator; | ||||
| use ErrorException; | ||||
| use Exception; | ||||
| use Icinga\Application\ProvidedHook\DbMigration; | ||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please don't reorder the whole imports. Two new lines for |
||||
| 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 | ||||
|
|
@@ -740,6 +742,8 @@ public function hasLocales() | |||
| protected function registerApplicationHooks(): self | ||||
| { | ||||
| Hook::register('DbMigration', DbMigration::class, DbMigration::class); | ||||
| CommonPasswordPolicy::register(); | ||||
| AnyPasswordPolicy::register(); | ||||
|
|
||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||
| return $this; | ||||
| } | ||||
|
|
||||
| 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); | ||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||
Al2Klimov marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||
| * 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
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||
| 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 []; | ||
| } | ||
| } |
| 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; | ||||
|
|
||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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; | ||||
| } | ||||
| } | ||||
Uh oh!
There was an error while loading. Please reload this page.