Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terminal42/contao-password-validation
https://github.com/terminal42/contao-password-validation
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/terminal42/contao-password-validation
- Owner: terminal42
- License: mit
- Created: 2019-07-02T12:14:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T08:36:58.000Z (10 months ago)
- Last Synced: 2024-11-13T01:13:21.936Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 110 KB
- Stars: 7
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
terminal42/contao-password-validation
=====================================
A Contao bundle that validates user passwords against your password policy.
## Features
- Validate a password against your organization policies
- Force members to do a password-change
## Installation
Choose the installation method that matches your workflow!
### Installation via Contao Manager
Search for `terminal42/contao-password-validation` in the Contao Manager and add it to your installation. Finally,
update the packages.
### Manual installation
Add a composer dependency for this bundle. Therefore, change in the project root and run the following:
```bash
composer require terminal42/contao-password-validation
```
Depending on your environment, the command can differ, i.e. starting with `php composer.phar …` if you do not have
composer installed globally.
Then, update the database via the Contao install tool.
## Configuration
### Password validation
Add the following configuration parameters to your `app/config/config.yml`:
(Skip options that you do not need)
```yml
terminal42_password_validation:
Contao\FrontendUser:
min_length: 10
max_length: 20
require:
uppercase: 1
lowercase: 1
numbers: 1
other: 1
other_chars: "+*ç%&/()=?"
password_history: 10
change_days: 90
haveibeenpwned: 1
Contao\BackendUser:
min_length: 10
haveibeenpwned: 1
```
Parameter | Purpose
--------- | -------
`password_history`: | Keep track of the latest `n` passwords, and force the users not to choose one of their recent passwords.
`change_days`: | Ask the user to change their password after certain days.
`haveibeenpwned`: | Check the user password against known data breaches reported to [';--have i been pwned?](https://haveibeenpwned.com/). The configuration allows you to specify an integer to define the [minimum number of data breaches](https://haveibeenpwned.com/API/v3#SearchingPwnedPasswordsByRange) the password needs to occur in to fail password validation.
### Password-change
1. Create a "password-change" page and place a password-change module on it. Select this page as password-change page in
the page root.
2. You can now force members to change their passwords by ticking the corresponding checkbox in the member edit-mask.
## Add your own password validator
You can add your own validation rule, e.g. a dictionary check.
Create a class that implements `PasswordValidatorInterface`. Then, create and tag a corresponding service.
```
app.password_validation.validator.dictionary:
class: App\PasswordValidation\Validator\Dictionary
tags:
- { name: terminal42_password_validation.validator, alias: dictionary }
```
## License
This bundle is released under the [MIT license](LICENSE)