Download the PHP package lithemod/hash without Composer
On this page you can find all versions of the php package lithemod/hash. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lithemod/hash
More information about lithemod/hash
Files in lithemod/hash
Package hash
Short Description An effective module for hashing passwords using Bcrypt.
License MIT
Informations about the package hash
Lithe Hash
A robust module for securely hashing passwords using Bcrypt. This module simplifies the process of creating, verifying, and managing password hashes, ensuring security best practices are followed.
Table of Contents
- Installation
- Usage
- Importing the Class
- Creating a Hash
- Verifying a Hash
- Checking if a Hash Needs Rehashing
- Understanding Bcrypt
- Handling Exceptions
- Testing
- License
Installation
To install the lithemod/hash
package, you can use Composer. Run the following command in your terminal:
This will add the package to your project's dependencies, allowing you to use the Hash
class in your application.
Usage
Importing the Class
Before using the Hash
class, you must import it in your PHP file:
Creating a Hash
To create a hash from a password, use the make
method. The method accepts a password and an optional array of options:
- Parameters:
string $value
: The password to be hashed.array $options
: Optional parameters (e.g., cost) to adjust the hashing algorithm.
- Returns: A hashed string that can be stored in a database.
Example:
Verifying a Hash
To check if a given password matches the hash, use the check
method:
- Parameters:
string $value
: The password to verify.string $hash
: The hashed password to compare against.
- Returns:
true
if the password matches the hash;false
otherwise.
Example:
Checking if a Hash Needs Rehashing
You can determine if a hash needs to be rehashed (for example, if you change the cost factor) using the needsRehash
method:
- Parameters:
string $hash
: The hashed password to evaluate.array $options
: Optional parameters to specify the cost.
- Returns:
true
if the hash needs to be rehashed;false
otherwise.
Example:
Understanding Bcrypt
Bcrypt is a widely-used password hashing function designed to be slow and computationally intensive, making it resistant to brute-force attacks. By using a configurable cost factor, Bcrypt allows you to increase the difficulty of hashing as hardware becomes faster.
- Cost Factor: The cost factor determines the computational complexity of hashing a password. It represents the number of iterations of the hashing algorithm. A higher cost means more security but also increases processing time. The recommended range is between 10 and 12 for most applications.
Handling Exceptions
The make
method throws an InvalidArgumentException
if the cost is set outside the valid range (4 to 31). You should handle this in your code to ensure robustness:
Testing
To ensure that your installation of the lithemod/hash
module works correctly, you can run the included unit tests. If you have PHPUnit installed, execute the following command in your project directory:
This will run the tests defined in the Tests
namespace and validate the functionality of the Hash
class.
License
This package is licensed under the MIT License. See the LICENSE file for more information.