Stars: 212
Forks: 28
Pull Requests: 30
Issues: 7
Watchers: 10
Last Updated: 2022-07-25 06:30:18
🔒 Password Exposed Helper Function - Check if a password has been exposed in a data breach.
License: GNU Lesser General Public License v3.0
Languages: PHP
This PHP package provides a password_exposed
helper function, that uses the haveibeenpwned.com API to check if a password has been exposed in a data breach.
The password_exposed
package can be easily installed using Composer. Just run the following command from the root of your project.
composer require "divineomega/password_exposed"
If you have never used the Composer dependency manager before, head to the Composer website for more information on how to get started.
To check if a password has been exposed in a data breach, just pass it to the password_exposed
method.
Here is a basic usage example:
switch(password_exposed('hunter2')) {
case PasswordStatus::EXPOSED:
// Password has been exposed in a data breach.
break;
case PasswordStatus::NOT_EXPOSED:
// Password has not been exposed in a known data breach.
break;
case PasswordStatus::UNKNOWN:
// Unable to check password due to an API error.
break;
}
If you prefer to avoid using helper functions, the following syntax is also available.
$passwordStatus = (new PasswordExposedChecker())->passwordExposed($password);
You can also supply the SHA1 hash instead of the plain text password, by using the following method.
$passwordStatus = (new PasswordExposedChecker())->passwordExposedByHash($hash);
or...
$passwordStatus = password_exposed_by_hash($hash);