https://github.com/lablnet/php-hashing
This Package provides secure Bcrypt and Argon2 hashing for storing user passwords.
https://github.com/lablnet/php-hashing
argon2 bcrypt classes free hashing oop package passwords-hash php secured
Last synced: 9 months ago
JSON representation
This Package provides secure Bcrypt and Argon2 hashing for storing user passwords.
- Host: GitHub
- URL: https://github.com/lablnet/php-hashing
- Owner: lablnet
- License: mit
- Created: 2019-02-06T08:06:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-06T08:18:20.000Z (about 7 years ago)
- Last Synced: 2025-04-25T02:03:39.935Z (11 months ago)
- Topics: argon2, bcrypt, classes, free, hashing, oop, package, passwords-hash, php, secured
- Language: PHP
- Homepage:
- Size: 7.81 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Hashing
This Package provides secure Bcrypt and Argon2 hashing for storing user passwords.
## Requirement
1. PHP 7 (7.3 Recommanded).
2. Composer.
> The Argon2i driver requires PHP 7.2.0 or greater and the Argon2id
> driver requires PHP 7.3.0 or greater.
> Bcrypt is a great choice for hashing passwords because its "work factor" is adjustable, which means that the time it takes to generate a hash can be increased as hardware power increases.
## Insallation
Installing this package is very simple, first ensure you have the right PHP version and composer installed then in your terminal/(command prompt) run:
``` composer require lablnet/hashing ```
## Basic Usage
You may hash a password by calling the `make` method on the Hashing Class:
```php
make($password);
echo $password_hash;
```
### Adjusting The Bcrypt Work Factor
If you are using the Bcrypt algorithm, the `make` method allows you to manage the work factor of the algorithm using the cost option:
```php
$hashing = new Hashing('bcrypt');
$password_hash = $hashing->make($password, [
'cost' => 12
]);
```
### Adjusting The Argon2 Work Factor
If you are using the Argon2I or Argon2Id algorithm, the `make` method allows you to manage the work factor of the algorithm using the memory, time, and threads options:
```php
$hashing = new Hashing('argon2i');
$password_hash = $hashing->make($password, [
'memory' => 1024,
'time' => 2,
'threads' => 2,
]);
```
> For more information on these options, check out the [official PHP documentation](https://secure.php.net/manual/en/function.password-hash.php).
>
### Verifying A Password Against A Hash
The `verify` method allows you to verify that a given plain-text string corresponds to a given hash
```php
if ($hashing->verify($password,$password_hash)) {
//The password matched.
}
```
### Checking If A Password Needs To Be Rehashed
The `needsRehash` function allows you to determine if the work factor used by the hashing has changed since the password was hashed:
```php
if ($hashing->needsRehash($hashed)) {
$password_hash = $hashing->make($password);
}
```
## Supported algorithm
in this library three algorithm are supported
- Bcrypt
- Argon2I
- Argon2ID
### Switch between algorithm
```php
$hashing = new Hashing('supported-algorithm');
$bvcryptHashing = new Hashing('bcrypt');
```
#### Default work factors
You can provide default work factors like
```php
//Argon2
$argon2Hashing = new Hashing('argon2i',[
'memory' => 1024,
'time' => 2,
'threads' => 2,
'verify' => false,
]);
//Bcrypt
$vcryptHashing = new Hashing('bcrypt'[
'cost' => 12,
'verify' => false,
]);
```
here verify option is additional indicate that if this set to true the algorithm is also sticky check on verify, if both algorithm are not matched then means password is not correct.