Add 2FA support to your Laravel Application!
You can install the package via composer:
composer require modernmcguire/drawbridge
You can publish and run the migrations with:
php artisan vendor:publish --tag="drawbridge-migrations"
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="drawbridge-config"
Optionally, you can publish the login and email using
php artisan vendor:publish --tag="drawbridge-views"
The package has multiple drivers to choose from. You can set the driver in the config file or your env.
'default_driver' => env('OTP_DRIVER', 'email'),
Note: Currently the only one that is setup is the email driver.
- Run Migrations
- Apply the
HandlesOTP
trait to your User model - Set
two_factor_enabled
to true on the user - Login!
You will be redirected to a page to enter your OTP code.
New database fields will be added to your users
table.
Field | Description |
---|---|
two_factor_enabled | Whether two-factor authentication is enabled |
otp_secret | The OTP code to match against |
otp_secret_expires_at | The time the OTP code expires (default: 5 minutes) |
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.