yuloh/battery-staple

This package is abandoned and no longer maintained. No replacement package was suggested.

Generate XKCD inspired passwords

1.0 2016-11-13 20:06 UTC

This package is auto-updated.

Last update: 2021-11-23 07:02:28 UTC


README

A password generator, inspired by XKCD.

XKCD comic

Install

Via Composer

composer require yuloh/battery-staple

Usage

$password = Yuloh\BatteryStaple\PasswordGenerator::generate();
// returns something like "beefjapanesesealedunwrap"

Security

The library is 8 lines of code, so there isn't much that can go wrong. Here is what happens:

  • A word list of 10,000 words is loaded.
  • A random number is generated with random_int and the word on that line is used.
  • Repeat the above until you have 4 words.

That being said, I am not a security expert. I cannot guarantee that this library is cryptographically secure and you shouldn't use it for anything important.

Contributing

Contributions Welcome. Some ideas:

  • Allow choosing a delimiter
  • Set min/max word length, so you don't get words like 'the'
  • Case transformation options (using neko?)