barzo/password-generator

PHP library for generating easy to remember but hard to guess passwords

v1.0.0 2020-11-02 11:43 UTC

Requires (Dev)

• phpunit/phpunit: ~4.3.0

Suggests

• ext-openssl: Allows to use cryptographically strong random generator

MIT

• Denys Potapov

• password

README

PHP library for generating easy to remember, but hard to quess passwords. Inspired by xkcd comic, library generates phrases from frequently used words:

• English phrases (example "throat fast only idea")
• German phrases (examle "laut welt ganze liter")
• Russian phrases (example "тоже металл пора подача")
• Russian transliterated phrases (example "kater nekiy zabrat dazhe")

Try online

Install

Via Composer

{
    "require": {
        "barzo/password-generator": "~0.4"
    }
}

Basic usage

Generate password with default length (4 words) and default separator (space).

use Barzo\Password\Generator;

// would output something like "throat fast only idea"
echo Generator::generateEn();

// would output something like "laut welt ganze liter"
echo Generator::generateDe();

// would output something like "тоже металл пора подача"
echo Generator::generateRu();

// would output something like "kater nekiy zabrat dazhe"
echo Generator::generateRuTranslit();

Each of above functions accepts length and separator paramenetrs.

// would output something like "ritual-error-raise-arab-tail"
echo Barzo\Password\Generator::generateEn(5, '-');

Advanced usage

Call static function Generator::generate to generate passwords from wordlists. Params

• wordlists - array of WordListInterface. If array is shorter then length, function would iterate from the beginning of array.
• lenght - password length in words. Default - 4
• separator - words separator. Default - ' '(space)

Example:

echo Generator::generate(
    [
        new Barzo\Password\WordList\En(), 
        new Barzo\Password\WordList\RuTranslit()
    ],
    5, 
    '-'
);

// would output something like "idea-dovod-critic-sever-happy"

Word lists

English

List of 2048 most frequently used English words.

German

List of 2048 most frequently used german words(source). Words with diacritic letters (ä, ö, ü) and eszett (ß) excluded.

Russian Transliterated

List of 2048 transliterated most frequently used Russain words (source). "Hard" to transliterate letters (ь, ъ) excluded.

Russian

Lists consist of 2048 most frequently used Russain words (source).

Security

If OpenSSL extension avaivable library would use openssl_random_pseudo_bytes for random number generation.

Testing

$ php vendor/bin/phpunit

Changelog

1.0.0

• Update namespaces for psr-4 and composer 2 (thanks to @parkourben99)

0.4.0

• Updated WordList\Ru. Now only words with length from 4 to 6
• Updated WordList\RuTranslit. Now only words with length from 4 to 6
• Added German words list

Contributing

To add new language open an issue with link to frequency dictionary.

Pull requests are welcome.

Credits

All Contributors

License

The MIT License (MIT). Please see License File for more information.