ryanj93/php-password-toolbox

A simple toolkit for generate, analyse and hash passwords with PHP.

Password toolkit (PHP edition)

Password toolkit is a simple library that will help you handling passwords with PHP without any dependencies. This library is a PHP porting from the "Password toolkit" library available for Node.js. You can use this library to generate suggested passwords, analyse user provided passwords in order to get a strength score and create a hash that can be stored within the database. Note that this library require PHP version 7.0 or greater., _(*1)

Password analysis

First, you need to create an instance of the "Analyzer" class as following:, _(*2)

$analyzer = new PHPPasswordToolBox\Analyzer();, _(*3)

Simple analysis:, _(*4)

$analyzer->analyze($password);, _(*5)

Complete analysis:, _(*6)

$analyzer->setDictionaryPath('rockyou.txt')->completeAnalysis($password);, _(*7)

Note that the complete analysis require a dictionary containing a list of weak passwords, passwords in this list must be separated by a break line (\n). You can download dictionaries here. Both methods will return an associative array containing informations about chars count, keywords and the score., _(*8)

Password generation

First, you need to create an instance of the "Generator" class as following:, _(*9)

$generator = new PHPPasswordToolBox\Generator();, _(*10)

Random password:, _(*11)

$generator->generate(12);, _(*12)

Human readable password generation:, _(*13)

$generator->setDictionaryPath('dictionary.txt')->generateHumanReadable(12, 2);, _(*14)

Note that in order to generate human readable passwords you need a dictionary, words in the dictionary must be separated by a break line (\n). If you are looking for an English word list, give a look here., _(*15)

Password hashing

Simple hash generation:, _(*16)

PHPPasswordToolBox\Hash::createSimpleHash($password);, _(*17)

More complex hash generation:, _(*18)

PHPPasswordToolBox\Hash::createHash($password);, _(*19)

The first method will return the hash as a string, the second one will return an associative array with the hash and its parameters (salts, algorithm, loop number). If you need to compare a given password and a hash generated with the first method you can use this method:, _(*20)

PHPPasswordToolBox\Hash::compareSimpleHash($password, $hash);, _(*21)

While if you used the second method you can do this:, _(*22)

PHPPasswordToolBox\Hash::compareHash($password, $hash);, _(*23)

Are you looking for the Node.js version? Give a look here., _(*24)