Download the PHP package mflor/pwned without Composer
On this page you can find all versions of the php package mflor/pwned. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package pwned
Short Description A clean and simple PHP library for interacting with all HaveIBeenPwned.com's API endpoints
License MIT
Informations about the package pwned
Pwned
A clean and simple PHP library for interacting with all HaveIBeenPwned.com's API endpoints
This package wraps the entire HaveIBeenPwned API in a simple, easy to use, PHP library, that can be used in any project.
Many other packages wrapping the API, are either supposed to be used in a framework, or only wraps the password checker.
Installation
Install the library with composer:
Authorisation
Authorisation is required for all APIs that enable searching HIBP by email address, namely retrieving all breaches for an account and retrieving all pastes for an account. An HIBP subscription key is required to make an authorised call and can be obtained on the API key page.
Setup
Usage
Breaches
Pastes
Passwords
Both search and occurrences takes a second boolean parameter, to disable padding for request. Be aware, that this is less secure, than having the padding enabled, which is default. Read more about the padding in Troy Hunt's blog post
Exceptions
This package will throw custom exceptions if a Client Error occures.
\Mflor\Pwned\Exceptions\BadRequestException
is thrown on status code 400
\Mflor\Pwned\Exceptions\UnauthorizedException
is thrown on status code 401
\Mflor\Pwned\Exceptions\ForbiddenException
is thrown on status code 403
\Mflor\Pwned\Exceptions\NotFoundException
is thrown on status code 404
\Mflor\Pwned\Exceptions\TooManyRequestsException
is thrown on status code 429
\Mflor\Pwned\Exceptions\ServiceUnavailableException
is thrown on status code 503
Code | Description |
---|---|
400 | Bad request — the account does not comply with an acceptable format (i.e. it's an empty string) |
401 | Unauthorised — either no API key was provided or it wasn't valid |
403 | Forbidden — no user agent has been specified in the request |
404 | Not found — the account could not be found and has therefore not been pwned |
429 | Too many requests — the rate limit has been exceeded |
503 | Service unavailable — usually returned by Cloudflare if the underlying service is not available |
Testing
You can run all tests by executing either of the following commands:
License
MIT