pragaonj/laminas-password-validator

Laminas validator for character-set based password validation.

v1.0.0 2022-01-07 11:28 UTC

Requires

• php: ^7.4 || ^8.0
• laminas/laminas-validator: ^2.15

Requires (Dev)

• phpunit/phpunit: ^9.5

BSD-3-Clause

• pragaonj

• validator
• password
• laminas

README

laminas-password-validator provides a validator for character-set based input validation.

Installation

composer require pragaonj/laminas-password-validator

Usage

The password validator implements laminas Laminas\Validator\ValidatorInterface and can be used like every other laminas validator. The validator requires two options:

• characterSets contains an array of considered character-sets (possible values are: DIGIT, LETTER, CAPITAL_LETTER, SPECIAL_CHARACTER)
• numberOfRequiredCharacterSets the number of considered character-sets that need to be present in the password.

General usage

use Pragaonj\Validator\PasswordValidator;

$validator = new PasswordValidator([
    "characterSets" => 
    [
        PasswordValidator::SPECIAL_CHARACTER,
        PasswordValidator::LETTER,
        PasswordValidator::CAPITAL_LETTER,
        PasswordValidator::DIGIT,
    ],
    "numberOfRequiredCharacterSets" => 4, // requires all 4 character-sets to be present in the password
]);

$valid = $validator->isValid("myInsecurePassword");

$messages = $validator->getMessages();

To overwrite the default error message you can set the messageTemplate for msgNotEnoughCharacterSets.

use Pragaonj\Validator\PasswordValidator;

$validator = new PasswordValidator([
    "characterSets" => 
    [
        PasswordValidator::SPECIAL_CHARACTER,
        PasswordValidator::LETTER,
        PasswordValidator::CAPITAL_LETTER,
        PasswordValidator::DIGIT,
    ],
    "numberOfRequiredCharacterSets" => 3,
    "messageTemplates" => [
        PasswordValidator::MSG_NOTENOUGHCHARACTARSETS => "my custom error message"
    ]
]);

$valid = $validator->isValid("myInsecurePassword");

$messages = $validator->getMessages();
// will return ["msgNotEnoughCharacterSets" => "my custom error message"]

Usage in laminas-mvc application

To use the validator in a laminas-mvc application register it as invokable in your module.config.php.

use Pragaonj\Validator\PasswordValidator;

return [
  'validators' => [
    'invokables' => [
        PasswordValidator::class,
    ],
    "aliases" => [
        "PasswordValidator" => PasswordValidator::class,
    ]
  ],
];