https://github.com/thecodework/two-factor-authentication
Two Factor Authentication for Laravel
https://github.com/thecodework/two-factor-authentication
laravel laravel-5-package two-factor-authentication two-step-authentication
Last synced: 6 months ago
JSON representation
Two Factor Authentication for Laravel
- Host: GitHub
- URL: https://github.com/thecodework/two-factor-authentication
- Owner: thecodework
- License: mit
- Created: 2017-03-17T18:10:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T19:27:47.000Z (about 3 years ago)
- Last Synced: 2025-11-13T08:16:18.573Z (8 months ago)
- Topics: laravel, laravel-5-package, two-factor-authentication, two-step-authentication
- Language: PHP
- Homepage: http://imrealashu.in/code/laravel/two-factor-authentication-in-laravel/
- Size: 406 KB
- Stars: 21
- Watchers: 6
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/thecodework/two-factor-authentication)
[](https://scrutinizer-ci.com/g/thecodework/two-factor-authentication/?branch=master)
[](https://styleci.io/repos/85341644)
[](https://packagist.org/packages/thecodework/two-factor-authentication)
# Laravel Two Factor Authentication (2FA)
Two Factor Authentication or 2-Step Verification provides stronger security for your Account by requiring a second step of verification when you sign in. In addition to your password, you’ll also need a code generated by the Google Authenticator app on your phone. This package implements TOTP defined in [RFC 6238](https://tools.ietf.org/html/rfc6238)
## Requirements
- PHP >= 7.1
- Laravel >= 5.3
- Google Authenticator [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2&hl=en) - [iOS](https://itunes.apple.com/in/app/google-authenticator/id388497605?mt=8) (Recommended) or [Authy](https://www.authy.com/) mobile app
## Installation
**1. Composer Install**
```bash
$ composer require thecodework/two-factor-authentication
```
_Note_ - If your're using Laravel 5.5 or newer version then auto-discovery-pacakge would automatically update the providers and you could skip to **Step 3**
**2. Add Service Provider**
After requiring the package add `TwoFactorAuthenticationServiceProvider::class` into providors array in `app.php` confi file
```php
[
'providers' => [
//...
Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider::class
]
]
```
**3. Publish the ConfigFile**
Publish config file
```
$ php artisan vendor:publish --provider="Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider" --tag=config
```
Once the config file is published you can navigate to config directory of your application and look for `2fa-config.php` file and change configuration as you want.
**4. Run Migrations**
Now run the migration
```bash
$ php artisan migrate
```
It will use the default User model and adds two columns `is_2fa_enabled` and `secret_key`.
**5. Add `AuthenticatesUserWith2FA` trait in the LoginController**
Now the config file is placed. The last thing to do is addding `AuthenticatesUsersWith2FA` trait in the `Http/Controllers/Auth/LoginController.php` file which helps to stop user at verify-2fa page to enter TOTP token after each login.
The final snippet will look like this.
```php
use AuthenticatesUsers, AuthenticatesUsersWith2FA {
AuthenticatesUsersWith2FA::authenticated insteadof AuthenticatesUsers;
}
```
Note: Don't forget to include use statement `use Thecodework\TwoFactorAuthentication\AuthenticatesUsersWith2FA` in the header.
**6. Setup 2FA for user**
**• Enable 2FA**
Now login to the application and visit `/setup-2fa/` route, which will show a barcode which can be scanned either using Google Authenticator or Authy mobile application as described above.
Scan that code and click **Enable Two Factor Authentication**.
**• Disable 2FA**
To disable Two Factor, visit `/setup-2fa` route, which will now show a **Disable Two Factor Authentication** button. Click to disable 2FA for your account.
**7. Testing 2FA**
Now to test 2FA, perform logout and log back in again, it will ask you to enter Token which can be obtain from the authenticator mobile application. Enter the token and you're logged in.
### Additionally
If you want to publish views, and migration as well along with config file then run
```
$ php artisan vendor:publish --provider="Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider"
```
## Contribution
Feel free to create issues, submit PRs and talk about features and enhancement through proposing issue. If you find any security consideration, instead of creating an issue send an email to [imrealashu@gmail.com](mailto:imrealashu@gmail.com).