Hashing

• Introduction
• Configuration
• Basic Usage
  • Hashing Passwords
  • Verifying That a Password Matches a Hash
  • Determining if a Password Needs to be Rehashed
• Hash Algorithm Verification

Introduction

The Laravel Hash facade provides secure Bcrypt and Argon2 hashing for storing user passwords. If you are using one of the Laravel application starter kits, Bcrypt will be used for registration and authentication by default.

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. When hashing passwords, slow is good. The longer an algorithm takes to hash a password, the longer it takes malicious users to generate "rainbow tables" of all possible string hash values that may be used in brute force attacks against applications.

Configuration

By default, Laravel uses the bcrypt hashing driver when hashing data. However, several other hashing drivers are supported, including argon and argon2id.

You may specify your application's hashing driver using the HASH_DRIVER environment variable. But, if you want to customize all of Laravel's hashing driver options, you should publish the complete hashing configuration file using the config:publish Artisan command:

1php artisan config:publish hashing
1php artisan config:publish hashing

Basic Usage

Hashing Passwords

You may hash a password by calling the make method on the Hash facade:

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Http\RedirectResponse;
 6use Illuminate\Http\Request;
 7use Illuminate\Support\Facades\Hash;
 8 
 9class PasswordController extends Controller
10{
11    /**
12     * Update the password for the user.
13     */
14    public function update(Request $request): RedirectResponse
15    {
16        // Validate the new password length...
17 
18        $request->user()->fill([
19            'password' => Hash::make($request->newPassword)
20        ])->save();
21 
22        return redirect('/profile');
23    }
24}
 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Http\RedirectResponse;
 6use Illuminate\Http\Request;
 7use Illuminate\Support\Facades\Hash;
 8 
 9class PasswordController extends Controller
10{
11    /**
12     * Update the password for the user.
13     */
14    public function update(Request $request): RedirectResponse
15    {
16        // Validate the new password length...
17 
18        $request->user()->fill([
19            'password' => Hash::make($request->newPassword)
20        ])->save();
21 
22        return redirect('/profile');
23    }
24}

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 rounds option; however, the default work factor managed by Laravel is acceptable for most applications:

1$hashed = Hash::make('password', [
2    'rounds' => 12,
3]);
1$hashed = Hash::make('password', [
2    'rounds' => 12,
3]);

Adjusting The Argon2 Work Factor

If you are using the Argon2 algorithm, the make method allows you to manage the work factor of the algorithm using the memory, time, and threads options; however, the default values managed by Laravel are acceptable for most applications:

1$hashed = Hash::make('password', [
2    'memory' => 1024,
3    'time' => 2,
4    'threads' => 2,
5]);
1$hashed = Hash::make('password', [
2    'memory' => 1024,
3    'time' => 2,
4    'threads' => 2,
5]);

Verifying That a Password Matches a Hash

The check method provided by the Hash facade allows you to verify that a given plain-text string corresponds to a given hash:

1if (Hash::check('plain-text', $hashedPassword)) {
2    // The passwords match...
3}
1if (Hash::check('plain-text', $hashedPassword)) {
2    // The passwords match...
3}

Determining if a Password Needs to be Rehashed

The needsRehash method provided by the Hash facade allows you to determine if the work factor used by the hasher has changed since the password was hashed. Some applications choose to perform this check during the application's authentication process:

1if (Hash::needsRehash($hashed)) {
2    $hashed = Hash::make('plain-text');
3}
1if (Hash::needsRehash($hashed)) {
2    $hashed = Hash::make('plain-text');
3}

Hash Algorithm Verification

To prevent hash algorithm manipulation, Laravel's Hash::check method will first verify the given hash was generated using the application's selected hashing algorithm. If the algorithms are different, a RuntimeException exception will be thrown.

This is the expected behavior for most applications, where the hashing algorithm is not expected to change and different algorithms can be an indication of a malicious attack. However, if you need to support multiple hashing algorithms within your application, such as when migrating from one algorithm to another, you can disable hash algorithm verification by setting the HASH_VERIFY environment variable to false:

1HASH_VERIFY=false
1HASH_VERIFY=false