ipunkt/laravel-two-factor-authentication

Two factor authentication (2FA) with TOTP tokens. (RFC 6238)

Two Factor Authentication

, _(*1)

Introduction

This package adds 2FA (Two Factor Authentication) to your laravel application., _(*2)

Installation

Just install the package by adding to composer requirements, _(*3)

composer require ipunkt/laravel-two-factor-authentication

and add the Service Provider in your config/app.php, _(*4)

\Ipunkt\Laravel\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider::class,

After adding the provider the database migration should run, _(*5)

php artisan migrate

Setup

User Model Trait

The package adds a google2fa_secret column to your users table. This can be null, but should hold the secret key, being generated with the help of a trait: Ipunkt\Laravel\TwoFactorAuthentication\TwoFactorSupport, _(*6)

This trait has to be added to the authorization based user model class., _(*7)

Authentication Controller

The Ipunkt\Laravel\TwoFactorAuthentication\AuthenticatesWith2FA trait overrides the authenticated method within the LoginController. So please update your LoginController, _(*8)

use App\Http\Controllers\Controller;
use Ipunkt\Laravel\TwoFactorAuthentication\AuthenticatesWith2FA;
use Illuminate\Foundation\Auth\AuthenticatesUsers;

class LoginController extends Controller
{
    use AuthenticatesUsers,
            AuthenticatesWith2FA {
            AuthenticatesWith2FA::authenticated insteadof AuthenticatesUsers;
        }
    //...
}

So we can interact with the user after authenticating with user credentials and display a TOTP field to get the Authenticator App displayed One-Time-Token., _(*9)

Customizing Package Content

Config

You can change config settings by publishing config file, _(*10)

$> php artisan vendor:publish --provider="Ipunkt\Laravel\TwoFactorAuthentication\ServiceProvider" --tag=config

and edit /config/2fa.php to suit your needs., _(*11)

Views

You can change delivered views by publishing view files, _(*12)

$> php artisan vendor:publish --provider="Ipunkt\Laravel\TwoFactorAuthentication\ServiceProvider" --tag=view

and edit views in /resources/views/vendor/2fa., _(*13)

Migrations

You can change the packaged migrations by publishing migrations, _(*14)

$> php artisan vendor:publish --provider="Ipunkt\Laravel\TwoFactorAuthentication\ServiceProvider" --tag=migrations

and edit migrations in /database/migrations., _(*15)

License

Two Factor Authentication is open-sourced software licensed under the MIT license, _(*16)