PHP library for Have I Been Pwned and Pwned Passwords.
HIBP-PHP is a composer library for accessing the Have I Been Pwned and Pwned Passwords APIs (currently v3).
The HIBP API now requires an API Key that needs to be purchased at the HIBP site for any lookups that use an email address. This currently means that if you're only using this package for lookups from the PwnedPassword section of the API, then an API key isn't required.
Version 5.x has dropped support for older PHP versions (< 7.4). If you still need a version of this package to run on an older PHP version, then please use the icawebdesign/hibp-php:^4 tag, though the 4.x branch will no longer receive updates.
Requirements
- PHP 7.4+
Installation
composer require icawebdesign/hibp-phpUsage examples for Breach Sites data
Get all breach sites
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$breachSites = $breach->getAllBreachSites();Or we can filter for a domain the breach was listed in:
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$breachSites = $breach->getAllBreachSites('adobe.com');Get single breach site
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$breachSite = $breach->getBreach('adobe');Get list of data classes for breach sites
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$dataClasses = $breach->getAllDataClasses();Get data for a breached email account
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$data = $breach->getBreachedAccount('[email protected]');We can retrieve unverified accounts too by specifying true for the second param (not retrieved by default):
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$data = $breach->getBreachedAccount('[email protected]', true);We can also filter results back to a specific breached domain by adding a domain as the 3rd param
The PwnedPasswd methods can now take a second param of an array to specify GuzzleHttp request options.
use Icawebdesign\Hibp\Breach\Breach;
use Icawebdesign\Hibp\HibpHttp;
$breach = new Breach(new HibpHttp($apiKey));
$data = $breach->getBreachedAccount('[email protected]', true, 'adobe.com');Usage examples for Pwned Passwords
Get number of times the start of a hash appears in the system matching against a full hash
use Icawebdesign\Hibp\Password\PwnedPassword;
use Icawebdesign\Hibp\HibpHttp;
$pwnedPassword = new PwnedPassword(new HibpHttp($apiKey));
$count = $pwnedPassword->rangeFromHash('5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');Get number of times the start of a hash appears in the system as above, but with padded values to help prevent fingerprinting
use Icawebdesign\Hibp\Password\PwnedPassword;
use Icawebdesign\Hibp\HibpHttp;
$pwnedPassword = new PwnedPassword(new HibpHttp($apiKey));
$hashData = $pwnedPassword->paddedRangeDataFromHash('5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');Get a collection of hash data from a start of a hash and matching against a full hash
use Icawebdesign\Hibp\Password\PwnedPassword;
use Icawebdesign\Hibp\HibpHttp;
$pwnedPassword = new PwnedPassword(new HibpHttp($apiKey));
$hashData = $pwnedPassword->rangeDataFromHash('5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');Get a collection of hash data from a start of a hash and matching against a full hash as above, but with padded values to help prevent fingerprinting
use Icawebdesign\Hibp\Password\PwnedPassword;
use Icawebdesign\Hibp\HibpHttp;
$pwnedPassword = new PwnedPassword(new HibpHttp($apiKey));
$hashData = $pwnedPassword->paddedRangeDataFromHash('5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');
// Strip padded values from results
$hashData = PwnedPassword::stripZeroMatchesData($hashData, '5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');Usage examples for Paste lists
Get a collection of pastes that a specified email account has appeared in
use Icawebdesign\Hibp\Paste\Paste;
use Icawebdesign\Hibp\HibpHttp;
$paste = new Paste(new HibpHttp($apiKey));
$data = $paste->lookup('[email protected]');Laravel specifics
If using the package within a Laravel application, you can use the provided facades.
First, you need to add your HIBP API key to your .env file, or your preferred method for adding values to your server environment variables.
HIBP_API_KEY=abcdefgh123456789
You can then use the facades to call the relevant methods:
// Breach
use Icawebdesign\Hibp\Facades\Breach;
$breachSites = Breach::getAllBreachSites();
// Paste
use Icawebdesign\Hibp\Facades\Paste;
$paste = Paste::lookup('[email protected]');
// PwnedPassword
use Icawebdesign\Hibp\Facades\PwnedPassword;
$count = PwnedPassword::rangeFromHash('5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8');Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
Thank you to Artem Fomenko for being the first external contributor to the package providing request options for Guzzle for the PwnedPassword methods.
License
The MIT License (MIT). Please see License File for more information.