fernleafsystems/zxcvbn-php

Realistic password strength estimation PHP library based on Zxcvbn JS

1.1.1 2023-07-06 10:12 UTC

Requires

• php: ^7.2 || ^8.0
• symfony/polyfill-mbstring: >=1.3.1

Requires (Dev)

• php-coveralls/php-coveralls: *
• phpunit/phpunit: < 6.0
• squizlabs/php_codesniffer: 3.*

MIT

• See contributors

• password
• zxcvbn

README

This is a simple fork of mkopinsky/zxcvbn-php to enable PHP 8 support by avoiding usage of the reserved match keyword.

Zxcvbn-PHP is a password strength estimator using pattern matching and minimum entropy calculation. Zxcvbn-PHP is based on the the Javascript zxcvbn project from Dropbox and @lowe. "zxcvbn" is bad password, just like "qwerty" and "123456".

zxcvbn attempts to give sound password advice through pattern matching and conservative entropy calculations. It finds 10k common passwords, common American names and surnames, common English words, and common patterns like dates, repeats (aaa), sequences (abcd), and QWERTY patterns.

Installation

The library can be installed with Composer by adding it as a dependency to your composer.json file.

{
    "require": {
        "fernleafsystems/zxcvbn-php": "^1.0"
    }
}

After running php composer.phar update on the command line, include the autoloader in your PHP scripts so that the ZxcvbnPhp class is available.

require_once 'vendor/autoload.php';

Usage

use ZxcvbnPhp\Zxcvbn;

$userData = [
  'Marco',
  '[e-mail]'
];

$zxcvbn = new Zxcvbn();
$strength = $zxcvbn->passwordStrength('password', $userData);
echo $strength['score'];
// will print 0

$strength = $zxcvbn->passwordStrength('correct horse battery staple');
echo $strength['score'];
// will print 4

Acknowledgements

Thanks to:

• @lowe for the original Javascript Zxcvbn
• @Dreyer's port for reference for initial implementation
• bjeavon's implementation for building out zxcvbn-php as a solid initial port of the Dropbox library with composer support and unit tests