createnl/zxcvbn-bundle

zxcvbn-php symfony bundle

3.1.0 2023-12-21 15:37 UTC

Requires

• php: ^8.0
• bjeavons/zxcvbn-php: ^1.3
• symfony/translation: ^5.4|^6.0|^7.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/console: ^5.4|^6.0|^7.0
• symfony/framework-bundle: ^5.4|^6.0|^7.0

MIT

• Alex Lisenkov

README

Zxcvbn Symfony Bundle

A bundle to integrate zxcvbn-php with your symfony app. Supports localization and custom matchers.

Installation

composer require createnl/zxcvbn-bundle

Basic Usage

use Createnl\ZxcvbnBundle\ZxcvbnFactoryInterface;

class PasswordController
{
    public function updatePassword(string $password, ZxcvbnFactoryInterface $zxcvbnFactory)
    {
        $userData = [
          'Marco',
          '[e-mail]'
        ];

        $zxcvbn = $zxcvbnFactory->createZxcvbn();

        $weak = $zxcvbn->passwordStrength($password, $userData);
        echo $weak['score']; // will print 0
        
        $strong = $zxcvbn->passwordStrength('correct horse battery staple');
        echo $strong['score']; // will print 4

        echo $weak['feedback']['warning']; // will print user-facing feedback on the password, set only when score <= 2
        echo $weak['feedback']['suggestions']; // may contain user-facing suggestions to improve the score
    }
}

Localization

This package supports the localization of warning and suggestion messages. Checks on common passwords, words and (family) names are only in English (US). But you can tag your own matcher to extend to your needs.

Supported languages:

• Dutch 🇳🇱
• English 🇺🇸
• French 🇫🇷

More about localization in Symfony.

Adding translations

If you are missing translations in your language you may consider creating (and contribute) them.

Override in your project:

1. Open messages.en.yaml
2. Copy the contents to your project's translation file
3. Change to your needs

Contributing a language:

1. Fork this repository
2. Copy messages.en.yaml
3. Change the filename to messages.LOCALE.yaml (for example messages.es.yaml)
4. Open it up and translate the right-hand values to your language
5. Create a Pull Request
6. Thank you!

Extending matchers

If you created your own matcher you can tag them with zxcvbn.matcher in your service container.

services:
  App\ZxcvbnMatchers\:
    resource: '../src/ZxcvbnMatchers'
    tags: ['zxcvbn.matcher']