Download the PHP package oldas/pwned-passwords without Composer
On this page you can find all versions of the php package oldas/pwned-passwords. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oldas/pwned-passwords
More information about oldas/pwned-passwords
Files in oldas/pwned-passwords
Package pwned-passwords
Short Description A library to query Troy Hunt's Pwned Passwords service to see whether or not a password has been included in a public breach.
License MIT
Informations about the package pwned-passwords
PwnedPasswords
PwnedPasswords is a library that allows you to query Troy Hunt's Pwned Passwords API to determine if a password has been compromised in a public data breach.
Requirements
- PHP >= 8.2
Installation
Install PwnedPasswords easily with Composer by running the following command in your project directory:
Usage
First, include the Composer autoload.php
to load the library:
Then, use the core service class HaveIBeenPwnedService
to interact with the Pwned Passwords API:
Methods Explained
isPwned(string $plainTextPassword): ?bool
This method checks whether the given password has been exposed in a public data breach by querying the Pwned Passwords API.
- Returns:
true
: The password was found in a breach.false
: The password was not found in a breach.null
: The API call timed out or failed.
validatePassword(string $plainTextPassword): void
This method ensures the password meets the library's input criteria. If the password is invalid, it throws an exception before performing any further operations.
- Throws:
InvalidPasswordInputException
Notes
- The library uses the k-anonymity technique to query the API securely without revealing the full password to external services.
- Ensure proper validation and exception handling in your implementation to cover cases such as API timeout or invalid input.
License
This project is released under the MIT License.