eureka/component-password

PHP password library.

5.0.0 2024-03-12 11:18 UTC

Requires

• php: 8.1.*||8.2.*||8.3.*
• ext-mbstring: *

Requires (Dev)

• eureka/component-console: ^6.1.0
• friendsofphp/php-cs-fixer: ^3.51.0
• maglnet/composer-require-checker: ^4.7.1
• phpstan/phpstan: ^1.10.60
• phpstan/phpstan-phpunit: ^1.3.16
• phpstan/phpstan-strict-rules: ^1.5.2
• phpunit/phpcov: ^9.0.2
• phpunit/phpunit: ^10.5.12

Suggests

• eureka/component-console: Provide an lightway console to execute password script helper to generate password

MIT

• Romain Cottard

README

Generate, hash & verify secure password.

Usage

Composer

composer require "eureka/component-password"

Password Generator

<?php

use Eureka\Component\Password\PasswordGenerator;
use Eureka\Component\Password\StringGenerator;

//~ Use service generator
$length  = 16;  // default
$alpha   = 0.6; // default
$numeric = 0.2; // default
$special = 0.2; // default

$generator = new PasswordGenerator(
    new StringGenerator()
);

$password = $generator->generate($length, $alpha, $numeric, $special);

echo $password->getPlain() . PHP_EOL;
echo $password->getHash() . PHP_EOL;

Password

<?php

use Eureka\Component\Password\Password;

//~ Just define password
$password = new Password('mySecretPassword');

echo $password->getHash() . PHP_EOL;
echo $password->getPlain() . PHP_EOL;

PasswordChecker

<?php

use Eureka\Component\Password\PasswordChecker;

//~ Just define password
$passwordChecker = new PasswordChecker();

$passwordPlain = 'mypassword'; // From login form 
$passwordHash  = '...';        // Retrieved from db for example
echo 'Is valid password: ' . $passwordChecker->verify($passwordPlain, $passwordHash) . PHP_EOL;

Script - Password Generator

vendor/bin/console password/script/generator --help

will output this:

Use    : bin/console Eureka\Component\Password\Script\Generator [OPTION]...
OPTIONS:
  -g,     --generate                    Generate password
  -l ARG, --length=ARG                  Password length
  -a ARG, --ratio-alpha=ARG             Alphabetic latin characters ratio
  -n ARG, --ratio-numeric=ARG           Numeric characters ratio
  -o ARG, --ratio-other=ARG             Other characters ratio

Contributing

See the CONTRIBUTING file.

Install / update project

You can install project with the following command:

make install

And update with the following command:

make update

NB: For the components, the composer.lock file is not committed.

Testing & CI (Continuous Integration)

Tests

You can run unit tests (with coverage) on your side with following command:

make tests

You can run integration tests (without coverage) on your side with following command:

make integration

For prettier output (but without coverage), you can use the following command:

make testdox # run tests without coverage reports but with prettified output

Code Style

You also can run code style check with following commands:

make phpcs

You also can run code style fixes with following commands:

make phpcsf

Check for missing explicit dependencies

You can check if any explicit dependency is missing with the following command:

make deps

Static Analysis

To perform a static analyze of your code (with phpstan, lvl 9 at default), you can use the following command:

make analyse

To ensure you code still compatible with current supported version at Deezer and futures versions of php, you need to run the following commands (both are required for full support):

Minimal supported version:

make php81compatibility

Maximal supported version:

make php83compatibility

CI Simulation

And the last "helper" commands, you can run before commit and push, is:

make ci  

License

This project is currently under The MIT License (MIT). See LICENCE file for more information.