mike-jg / pwned-api
There is no license information available for the latest version (1.0.1) of this package.
PwnedApi is a PHP library to work with the API at https://haveibeenpwned.com/API/v2/
1.0.1
2018-02-27 18:51 UTC
Requires
- php: ^7.1
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- phpunit/phpunit: ^7.0
This package is not auto-updated.
Last update: 2024-06-09 04:06:28 UTC
README
This is meant as a simple way to interface with the service at https://haveibeenpwned.com/API/v2/
Installation
$ composer require mike-jg/pwned-api
Basic Usage
The preferred way to interact with the API is to use the Client::searchByRange
method, as this protects the value of the source password being searched for.
See https://haveibeenpwned.com/API/v2/#SearchingPwnedPasswordsByRange
<?php use PwnedApi\Client; $client = new Client(); $password = sha1("P@ssw0rd"); $rangeResult = $client->searchByRange($password); // Boolean: was this password found? echo $rangeResult->wasFound(); // How many times this password was found in the database echo $rangeResult->getCount();
Alternatively you can also search by a specific password to see if it was found. See https://haveibeenpwned.com/API/v2/#SearchingPwnedPasswordsByPassword
<?php use PwnedApi\Client; $client = new Client(); $password = sha1("P@ssw0rd"); $rangeResult = $client->searchByPasswordHash($password); // Boolean: was this password found? echo $rangeResult->wasFound(); // How many times this password was found in the database echo $rangeResult->getCount();
Overriding the HTTP client
To specify a different HTTP client to use, e.g. if you need to inject proxy details.
<?php use PwnedApi\Client; $client = new Client(); $client->setHttpClient(new GuzzleHttp\Client());