Laravel Two Factor Authentication using Email Tutorial

By Hardik Savani October 16, 2021 Category : Laravel

Hello,

In this quick example, let's see laravel two factor authentication with email. i would like to share with you laravel 2fa with email authentication. i explained simply about two factor authentication twilio laravel. you will learn 2 factor auth laravel email. you will do the following things for laravel two factor authentication email.

you can use this example with laravel 6, laravel 7 and laravel 8 version.

In this example, i will give you step by step all info how to add two factor authentication with sending mail in laravel. we will use google gmail smtp for sending mail with code. you can follow bellow step and make it done.

Let's see full example code here:

Verify Code Page:

Email Content:

Step 1 : Install Laravel

first of all we need to get fresh Laravel version application using bellow command, So open your terminal OR command prompt and run bellow command:

composer create-project laravel/laravel example-app

Step 2: Create Migration for table

here, we need to create "user_codes" table. so let's create migration as bellow:

php artisan make:migration create_user_codes

After this command you will find one file in following path "database/migrations" and you have to put bellow code in your migration file for create user_codes table.

<?php

use Illuminate\Database\Migrations\Migration;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Support\Facades\Schema;

class CreateUserCodes extends Migration

{

/**

* Run the migrations.

*

* @return void

*/

public function up()

{

Schema::create('user_codes', function (Blueprint $table) {

$table->id();

$table->integer('user_id');

$table->string('code');

$table->timestamps();

});

}

/**

* Reverse the migrations.

*

* @return void

*/

public function down()

{

Schema::dropIfExists('user_codes');

}

}

Now you have to run this migration by following command:

php artisan migrate

Step 3: Create and Update Models

Here, we need to update user model and create new model call UserCode. so let's update code:

app/Models/User.php

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;

use Illuminate\Database\Eloquent\Factories\HasFactory;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Illuminate\Notifications\Notifiable;

use Laravel\Sanctum\HasApiTokens;

use Exception;

use Mail;

use App\Mail\SendCodeMail;

class User extends Authenticatable

{

use HasApiTokens, HasFactory, Notifiable;

/**

* The attributes that are mass assignable.

*

* @var string[]

*/

protected $fillable = [

'name',

'email',

'password'

];

/**

* The attributes that should be hidden for serialization.

*

* @var array

*/

protected $hidden = [

'password',

'remember_token',

];

/**

* The attributes that should be cast.

*

* @var array

*/

protected $casts = [

'email_verified_at' => 'datetime',

];

/**

* Write code on Method

*

* @return response()

*/

public function generateCode()

{

$code = rand(1000, 9999);

UserCode::updateOrCreate(

[ 'user_id' => auth()->user()->id ],

[ 'code' => $code ]

);

try {

$details = [

'title' => 'Mail from ItSolutionStuff.com',

'code' => $code

];

Mail::to(auth()->user()->email)->send(new SendCodeMail($details));

} catch (Exception $e) {

info("Error: ". $e->getMessage());

}

}

}

app/Models/UserCode.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;

use Illuminate\Database\Eloquent\Model;

class UserCode extends Model

{

use HasFactory;

public $table = "user_codes";

protected $fillable = [

'user_id',

'code',

];

}

Step 4: Create Auth Scaffold

Here, we will use laravel ui package and create auth scaffold with bootstrap framework. let's follow bellow command:

composer require laravel/ui

now let's run command for creating auth scaffold:

php artisan ui bootstrap --auth

Step 5: Create Middleware

In this step, we will create new middleware for check user has 2fa or not. so let's create new middleware with following command and code:

php artisan make:middleware Check2FA

app/Http/Middleware/Check2FA.php

<?php

namespace App\Http\Middleware;

use Closure;

use Illuminate\Http\Request;

use Session;

class Check2FA

{

/**

* Handle an incoming request.

*

* @param \Illuminate\Http\Request $request

* @param \Closure $next

* @return mixed

*/

public function handle(Request $request, Closure $next)

{

if (!Session::has('user_2fa')) {

return redirect()->route('2fa.index');

}

return $next($request);

}

}

app/Http/Kernel.php

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;

class Kernel extends HttpKernel

{

...

...

...

protected $routeMiddleware = [

'auth' => \App\Http\Middleware\Authenticate::class,

'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,

'can' => \Illuminate\Auth\Middleware\Authorize::class,

'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,

'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,

'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,

'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,

'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,

'2fa' => \App\Http\Middleware\Check2FA::class,

];

}

Step 6: Create Route

We need to create register routes as bellow:

routes/web.php

<?php

use Illuminate\Support\Facades\Route;

/*

|--------------------------------------------------------------------------

| Web Routes

|--------------------------------------------------------------------------

|

| Here is where you can register web routes for your application. These

| routes are loaded by the RouteServiceProvider within a group which

| contains the "web" middleware group. Now create something great!

|

*/

Route::get('/', function () {

return view('welcome');

});

Auth::routes();

Route::get('/home', [App\Http\Controllers\HomeController::class, 'index'])->name('home')->middleware('2fa');

Route::get('2fa', [App\Http\Controllers\TwoFAController::class, 'index'])->name('2fa.index');

Route::post('2fa', [App\Http\Controllers\TwoFAController::class, 'store'])->name('2fa.post');

Route::get('2fa/reset', [App\Http\Controllers\TwoFAController::class, 'resend'])->name('2fa.resend');

Step 7: Create and Update Controllers

Here, we need to update LoginController controller file.

Also we will create TwoFAController new controller file and write code there. so let's create these files:

app/Http/Controllers/Auth/LoginController.php

<?php

namespace App\Http\Controllers\Auth;

use App\Http\Controllers\Controller;

use App\Providers\RouteServiceProvider;

use Illuminate\Foundation\Auth\AuthenticatesUsers;

use Illuminate\Http\Request;

use Auth;

use App\Models\UserCode;

class LoginController extends Controller

{

/*

|--------------------------------------------------------------------------

| Login Controller

|--------------------------------------------------------------------------

|

| This controller handles authenticating users for the application and

| redirecting them to your home screen. The controller uses a trait

| to conveniently provide its functionality to your applications.

|

*/

use AuthenticatesUsers;

/**

* Where to redirect users after login.

*

* @var string

*/

protected $redirectTo = RouteServiceProvider::HOME;

/**

* Create a new controller instance.

*

* @return void

*/

public function __construct()

{

$this->middleware('guest')->except('logout');

}

/**

* Write code on Method

*

* @return response()

*/

public function login(Request $request)

{

$request->validate([

'email' => 'required',

'password' => 'required',

]);

$credentials = $request->only('email', 'password');

if (Auth::attempt($credentials)) {

auth()->user()->generateCode();

return redirect()->route('2fa.index');

}

return redirect("login")->withSuccess('Oppes! You have entered invalid credentials');

}

}

app/Http/Controllers/TwoFAController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Session;

use App\Models\UserCode;

class TwoFAController extends Controller

{

/**

* Write code on Method

*

* @return response()

*/

public function index()

{

return view('2fa');

}

/**

* Write code on Method

*

* @return response()

*/

public function store(Request $request)

{

$request->validate([

'code'=>'required',

]);

$find = UserCode::where('user_id', auth()->user()->id)

->where('code', $request->code)

->where('updated_at', '>=', now()->subMinutes(2))

->first();

if (!is_null($find)) {

Session::put('user_2fa', auth()->user()->id);

return redirect()->route('home');

}

return back()->with('error', 'You entered wrong code.');

}

/**

* Write code on Method

*

* @return response()

*/

public function resend()

{

auth()->user()->generateCode();

return back()->with('success', 'We sent you code on your email.');

}

}

Step 8: Create Mail Class

Here, we need to create mail class and need to add configuration on email file. so let's run following command and update file.

php artisan make:mail SendCodeMail

app/Mail/SendCodeMail.php

<?php

namespace App\Mail;

use Illuminate\Bus\Queueable;

use Illuminate\Contracts\Queue\ShouldQueue;

use Illuminate\Mail\Mailable;

use Illuminate\Queue\SerializesModels;

class SendCodeMail extends Mailable

{

use Queueable, SerializesModels;

public $details;

/**

* Create a new message instance.

*

* @return void

*/

public function __construct($details)

{

$this->details = $details;

}

/**

* Build the message.

*

* @return $this

*/

public function build()

{

return $this->subject('Mail from ItSolutionStuff.com')

->view('emails.code');

}

}

.env

MAIL_DRIVER=smtp

MAIL_HOST=smtp.gmail.com

MAIL_PORT=587

MAIL_USERNAME=mygoogle@gmail.com

MAIL_PASSWORD=rrnnucvnqlbsl

MAIL_ENCRYPTION=tls

MAIL_FROM_ADDRESS=mygoogle@gmail.com

MAIL_FROM_NAME="${APP_NAME}"

Step 9: Create Blade File

Here, we will create code blade file and create new 2fa blade file. so let's update following code here.

resources/views/2fa.blade.php

@extends('layouts.app')

@section('content')

<div class="container">

<div class="row justify-content-center">

<div class="col-md-8">

<div class="card">

<div class="card-header">2FA Verification</div>

<div class="card-body">

<form method="POST" action="{{ route('2fa.post') }}">

@csrf

<p class="text-center">We sent code to email : {{ substr(auth()->user()->email, 0, 5) . '******' . substr(auth()->user()->email, -2) }}</p>

@if ($message = Session::get('success'))

<div class="row">

<div class="col-md-12">

<div class="alert alert-success alert-block">

<button type="button" class="close" data-dismiss="alert">×</button>

<strong>{{ $message }}</strong>

</div>

</div>

</div>

@endif

@if ($message = Session::get('error'))

<div class="row">

<div class="col-md-12">

<div class="alert alert-danger alert-block">

<button type="button" class="close" data-dismiss="alert">×</button>

<strong>{{ $message }}</strong>

</div>

</div>

</div>

@endif

<div class="form-group row">

<label for="code" class="col-md-4 col-form-label text-md-right">Code</label>

<div class="col-md-6">

<input id="code" type="number" class="form-control @error('code') is-invalid @enderror" name="code" value="{{ old('code') }}" required autocomplete="code" autofocus>

@error('code')

<span class="invalid-feedback" role="alert">

<strong>{{ $message }}</strong>

</span>

@enderror

</div>

</div>

<div class="form-group row mb-0">

<div class="col-md-8 offset-md-4">

<a class="btn btn-link" href="{{ route('2fa.resend') }}">Resend Code?</a>

</div>

</div>

<div class="form-group row mb-0">

<div class="col-md-8 offset-md-4">

<button type="submit" class="btn btn-primary">

Submit

</button>

</div>

</div>

</form>

</div>

</div>

</div>

</div>

</div>

@endsection

resources/views/emails/code.blade.php

<!DOCTYPE html>

<html>

<head>

<title>ItsolutionStuff.com</title>

</head>

<body>

<h1>{{ $details['title'] }}</h1>

<p>Your code is : {{ $details['code'] }}</p>

<p>Thank you</p>

</body>

</html>

Ok, now we are ready to run.

So let's run project using this command:

php artisan serve

open bellow UR:

localhost:8000/

Now you can simply run and check...

I hope it can help you....

Tags :