├── .gitignore
├── src
    ├── Facades
    │   └── Authy.php
    ├── Contracts
    │   └── Auth
    │   │   └── TwoFactor
    │   │       ├── SMSToken.php
    │   │       ├── PhoneToken.php
    │   │       ├── Authenticatable.php
    │   │       └── Provider.php
    ├── AuthyFacadeAccessor.php
    ├── Providers
    │   └── AuthyServiceProvider.php
    ├── Auth
    │   └── TwoFactor
    │   │   └── Authenticatable.php
    └── Services
    │   └── Authy.php
├── config
    └── config.php
├── composer.json
├── migrations
    └── migration.php
├── views
    └── form.blade.php
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /bootstrap/compiled.php
2 | .env.*.php
3 | .env.php
4 | .env
5 | /vendor
6 | composer.lock
7 | /.idea
8 | 


--------------------------------------------------------------------------------
/src/Facades/Authy.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Facades;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | class Authy extends Facade
 8 | {
 9 |     /**
10 |      * Get the registered name of the component.
11 |      *
12 |      * @return string
13 |      */
14 |     protected static function getFacadeAccessor()
15 |     {
16 |         return 'Srmklive\Authy\AuthyFacadeAccessor';
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * Authy configuration & API credentials.
 5 |  *
 6 |  * @author Raza Mehdi<srmk@outlook.com>
 7 |  */
 8 | 
 9 | return [
10 |     'mode'    => env('AUTHY_MODE', 'live'), // Can be either 'live' or 'sandbox'. If empty or invalid 'live' will be used
11 |     'sandbox' => [
12 |         'key' => env('AUTHY_TEST_KEY', ''),
13 |     ],
14 |     'live' => [
15 |         'key' => env('AUTHY_LIVE_KEY', ''),
16 |     ],
17 |     'sms' => env('AUTHY_SEND_SMS', false),
18 | ];
19 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/TwoFactor/SMSToken.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Contracts\Auth\TwoFactor;
 4 | 
 5 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
 6 | 
 7 | interface SMSToken
 8 | {
 9 |     /**
10 |      * Send the user two-factor authentication token via SMS.
11 |      *
12 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
13 |      *
14 |      * @return void
15 |      */
16 |     public function sendSmsToken(TwoFactorAuthenticatable $user);
17 | }
18 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/TwoFactor/PhoneToken.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Contracts\Auth\TwoFactor;
 4 | 
 5 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
 6 | 
 7 | interface PhoneToken
 8 | {
 9 |     /**
10 |      * Start the user two-factor authentication via phone call.
11 |      *
12 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
13 |      *
14 |      * @return void
15 |      */
16 |     public function sendPhoneCallToken(TwoFactorAuthenticatable $user);
17 | }
18 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "srmklive/authy",
 3 |   "description": "Plugin for enabling two-factor authentication in Laravel applications",
 4 |   "keywords": ["api", "authentication", "two factor", "authy", "laravel two factor authentication", "two factor authentication"],
 5 |   "homepage": "https://github.com/srmklive/laravel-twofactor-authentication",
 6 |   "license": "MIT",
 7 |   "require": {
 8 |     "guzzlehttp/guzzle": "~6.0|~7.0",
 9 |     "nesbot/carbon": "~1.2|~2.0",
10 |     "illuminate/support": "~5.1|~5.2|~5.3|~5.4|~5.5|~5.6|~5.7|~5.8|~6.0|~7.0|~8.0|~9.0"
11 |   },
12 |   "extra": {
13 |     "laravel": {
14 |       "providers": [
15 |         "Srmklive\\Authy\\Providers\\AuthyServiceProvider"
16 |       ],
17 |       "aliases": {
18 |         "Authy": "Srmklive\\Authy\\Facades\\Authy"
19 |       }
20 |     }
21 |   },
22 |   "autoload":{
23 |     "psr-4": {
24 |       "Srmklive\\Authy\\": "src/"
25 |     }
26 |   },
27 |   "authors": [
28 |     {
29 |       "name": "Raza Mehdi",
30 |       "email": "srmk@outlook.com"
31 |     }
32 |   ]
33 | }
34 | 


--------------------------------------------------------------------------------
/migrations/migration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | use Illuminate\Database\Schema\Blueprint;
 5 | 
 6 | class UpdateUsersTable extends Migration
 7 | {
 8 |     /**
 9 |      * Run the migrations.
10 |      *
11 |      * @return void
12 |      */
13 |     public function up()
14 |     {
15 |         Schema::table('users', function (Blueprint $table) {
16 |             // Two-Factor Authentication Columns...
17 |             $table->string('phone_country_code')->nullable();
18 |             $table->string('phone_number')->nullable();
19 |             $table->text('two_factor_options')->nullable();
20 |         });
21 |     }
22 | 
23 |     /**
24 |      * Reverse the migrations.
25 |      *
26 |      * @return void
27 |      */
28 |     public function down()
29 |     {
30 |         Schema::table('users', function (Blueprint $table) {
31 |             $table->dropColumn([
32 |                 'phone_country_code',
33 |                 'phone_number',
34 |                 'two_factor_options',
35 |             ]);
36 |         });
37 |     }
38 | }
39 | 


--------------------------------------------------------------------------------
/src/AuthyFacadeAccessor.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy;
 4 | 
 5 | use Srmklive\Authy\Services\Authy;
 6 | 
 7 | class AuthyFacadeAccessor
 8 | {
 9 |     /**
10 |      * TwoFactor auth provider object.
11 |      *
12 |      * @var
13 |      */
14 |     public static $provider;
15 | 
16 |     /**
17 |      * Get specific TwoFactor auth provider object to use.
18 |      *
19 |      * @return Authy
20 |      */
21 |     public static function getProvider()
22 |     {
23 |         if (empty(self::$provider)) {
24 |             return new Authy();
25 |         } else {
26 |             return self::$provider;
27 |         }
28 |     }
29 | 
30 |     /**
31 |      * Set specific TwoFactor auth provider to use.
32 |      *
33 |      * @param string $option
34 |      *
35 |      * @return Authy
36 |      */
37 |     public static function setProvider($option = '')
38 |     {
39 |         if (!in_array($option, ['authy'])) {
40 |             $option = 'authy';
41 |         }
42 | 
43 |         if ($option == 'authy') {
44 |             self::$provider = new Authy();
45 |         }
46 | 
47 |         return self::getProvider();
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/TwoFactor/Authenticatable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Contracts\Auth\TwoFactor;
 4 | 
 5 | use Illuminate\Contracts\Auth\Authenticatable as BaseAuthenticatable;
 6 | 
 7 | interface Authenticatable extends BaseAuthenticatable
 8 | {
 9 |     /**
10 |      * Get the e-mail address used for two-factor authentication.
11 |      *
12 |      * @return string
13 |      */
14 |     public function getEmailForTwoFactorAuth();
15 | 
16 |     /**
17 |      * Get the country code used for two-factor authentication.
18 |      *
19 |      * @return string
20 |      */
21 |     public function getAuthCountryCode();
22 | 
23 |     /**
24 |      * Get the phone number used for two-factor authentication.
25 |      *
26 |      * @return string
27 |      */
28 |     public function getAuthPhoneNumber();
29 | 
30 |     /**
31 |      * Set the country code and phone number used for two-factor authentication.
32 |      *
33 |      * @param string $countryCode
34 |      * @param string $phoneNumber
35 |      *
36 |      * @return void
37 |      */
38 |     public function setAuthPhoneInformation($countryCode, $phoneNumber);
39 | 
40 |     /**
41 |      * Get the two-factor provider options in array format.
42 |      *
43 |      * @return array
44 |      */
45 |     public function getTwoFactorAuthProviderOptions();
46 | 
47 |     /**
48 |      * Set the two-factor provider options in array format.
49 |      *
50 |      * @param array $options
51 |      *
52 |      * @return void
53 |      */
54 |     public function setTwoFactorAuthProviderOptions(array $options);
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Contracts/Auth/TwoFactor/Provider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Contracts\Auth\TwoFactor;
 4 | 
 5 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
 6 | 
 7 | interface Provider
 8 | {
 9 |     /**
10 |      * Determine if the given user has two-factor authentication enabled.
11 |      *
12 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
13 |      *
14 |      * @return bool
15 |      */
16 |     public function isEnabled(TwoFactorAuthenticatable $user);
17 | 
18 |     /**
19 |      * Register the given user with the provider.
20 |      *
21 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
22 |      * @param bool                                                     $sms
23 |      *
24 |      * @return void
25 |      */
26 |     public function register(TwoFactorAuthenticatable $user, $sms = false);
27 | 
28 |     /**
29 |      * Determine if the given token is valid for the given user.
30 |      *
31 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
32 |      * @param string                                                   $token
33 |      *
34 |      * @return bool
35 |      */
36 |     public function tokenIsValid(TwoFactorAuthenticatable $user, $token);
37 | 
38 |     /**
39 |      * Delete the given user from the provider.
40 |      *
41 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
42 |      *
43 |      * @return bool
44 |      */
45 |     public function delete(TwoFactorAuthenticatable $user);
46 | }
47 | 


--------------------------------------------------------------------------------
/views/form.blade.php:
--------------------------------------------------------------------------------
 1 | @section('styles')
 2 | <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/authy-form-helpers/2.3/flags.authy.css" />
 3 | <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/authy-form-helpers/2.3/form.authy.css" />
 4 | @endsection
 5 | 
 6 | <div class="col-sm-4 col-sm-offset-4">
 7 |     <form method="POST">
 8 |         {{csrf_field()}}
 9 |         <h3>Enable Two-Factor Authentication</h3>
10 |         <div class="row">
11 |             <div class="col-xs-3">Country:</div>
12 |             <div class="col-xs-9">
13 |                 <select id="authy-countries" name="country-code"></select>
14 |             </div>
15 |         </div>
16 |         <div class="row">
17 |             <div class="col-xs-3">Cellphone:</div>
18 |             <div class="col-xs-9">
19 |                 <input id="authy-cellphone" type="text" value="" name="authy-cellphone" />
20 |             </div>
21 |         </div>
22 |         <div class="row">
23 |             <div class="col-xs-9 col-xs-offset-3">
24 |                 <div class="checkbox">
25 |                     <label>
26 |                         <input type="checkbox" name="send_sms" />
27 |                         Send two-factor token via SMS
28 |                     </label>
29 |                 </div>
30 |             </div>
31 |         </div>
32 |         <div class="row">
33 |             <div class="col-xs-9 col-xs-offset-3">
34 |                 <button type="submit">Submit</button>
35 |             </div>
36 |         </div>        
37 |     </form>
38 | </div>
39 | 
40 | @section('scripts')
41 | <script src="https://cdnjs.cloudflare.com/ajax/libs/authy-form-helpers/2.3/form.authy.js"></script>
42 | @endsection
43 | 


--------------------------------------------------------------------------------
/src/Providers/AuthyServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Providers;
 4 | 
 5 | use Carbon\Carbon;
 6 | use Illuminate\Support\ServiceProvider;
 7 | use Srmklive\Authy\Services\Authy;
 8 | 
 9 | class AuthyServiceProvider extends ServiceProvider
10 | {
11 |     /**
12 |      * Indicates if loading of the provider is deferred.
13 |      *
14 |      * @var bool
15 |      */
16 |     protected $defer = false;
17 | 
18 |     /**
19 |      * Bootstrap the application events.
20 |      *
21 |      * @return void
22 |      */
23 |     public function boot()
24 |     {
25 |         // Publish config files
26 |         $this->publishes([
27 |             __DIR__.'/../../config/config.php' => config_path('authy.php'),
28 |         ]);
29 | 
30 |         if (!class_exists('UpdateUsersTable')) {
31 |             $this->publishes([
32 |                 __DIR__.'/../../migrations/migration.php' => database_path('/migrations/'.
33 |                     str_replace(':', '', str_replace('-', '_', Carbon::now()->format('Y-m-d_H:i:s'))).'_update_users_table.php'),
34 |             ]);
35 |         }
36 | 
37 |         // Load Authy View Files
38 |         $this->loadViewsFrom(__DIR__.'/../../views', 'authy');
39 |         $this->publishes([
40 |             __DIR__.'/../../views' => base_path('resources/views/vendor/authy'),
41 |         ]);
42 |     }
43 | 
44 |     /**
45 |      * Register the service provider.
46 |      *
47 |      * @return void
48 |      */
49 |     public function register()
50 |     {
51 |         $this->registerAuthy();
52 | 
53 |         $this->mergeConfig();
54 |     }
55 | 
56 |     /**
57 |      * Register the Authy class with application.
58 |      *
59 |      * @return void
60 |      */
61 |     private function registerAuthy()
62 |     {
63 |         $this->app->singleton('authy', function () {
64 |             return new Authy();
65 |         });
66 |     }
67 | 
68 |     /**
69 |      * Merges user's and paypal's config files.
70 |      *
71 |      * @return void
72 |      */
73 |     private function mergeConfig()
74 |     {
75 |         $this->mergeConfigFrom(
76 |             __DIR__.'/../../config/config.php',
77 |             'authy'
78 |         );
79 |     }
80 | }
81 | 


--------------------------------------------------------------------------------
/src/Auth/TwoFactor/Authenticatable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Srmklive\Authy\Auth\TwoFactor;
 4 | 
 5 | trait Authenticatable
 6 | {
 7 |     /**
 8 |      * Get the e-mail address used for two-factor authentication.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function getEmailForTwoFactorAuth()
13 |     {
14 |         return $this->email;
15 |     }
16 | 
17 |     /**
18 |      * Get the country code used for two-factor authentication.
19 |      *
20 |      * @return string
21 |      */
22 |     public function getAuthCountryCode()
23 |     {
24 |         return $this->phone_country_code;
25 |     }
26 | 
27 |     /**
28 |      * Get the phone number used for two-factor authentication.
29 |      *
30 |      * @return string
31 |      */
32 |     public function getAuthPhoneNumber()
33 |     {
34 |         return $this->phone_number;
35 |     }
36 | 
37 |     /**
38 |      * Set the country code and phone number used for two-factor authentication.
39 |      *
40 |      * @param string $countryCode
41 |      * @param string $phoneNumber
42 |      *
43 |      * @return void
44 |      */
45 |     public function setAuthPhoneInformation($countryCode, $phoneNumber)
46 |     {
47 |         $this->phone_country_code = $countryCode;
48 | 
49 |         $this->phone_number = $phoneNumber;
50 |     }
51 | 
52 |     /**
53 |      * Get the two-factor provider options in array format.
54 |      *
55 |      * @return array
56 |      */
57 |     public function getTwoFactorAuthProviderOptions()
58 |     {
59 |         return json_decode($this->two_factor_options, true) ?: [];
60 |     }
61 | 
62 |     /**
63 |      * Set the two-factor provider options in array format.
64 |      *
65 |      * @param array $options
66 |      *
67 |      * @return void
68 |      */
69 |     public function setTwoFactorAuthProviderOptions(array $options)
70 |     {
71 |         $this->two_factor_options = json_encode($options);
72 |     }
73 | 
74 |     /**
75 |      * Determine if the user is using two-factor authentication.
76 |      *
77 |      * @return bool
78 |      */
79 |     public function getUsingTwoFactorAuthAttribute()
80 |     {
81 |         $options = $this->getTwoFactorAuthProviderOptions();
82 | 
83 |         return isset($options['id']);
84 |     }
85 | }
86 | 


--------------------------------------------------------------------------------
/src/Services/Authy.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Srmklive\Authy\Services;
  4 | 
  5 | use Exception;
  6 | use GuzzleHttp\Client as HttpClient;
  7 | use GuzzleHttp\Exception\ClientException;
  8 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
  9 | use Srmklive\Authy\Contracts\Auth\TwoFactor\PhoneToken as SendPhoneTokenContract;
 10 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Provider as BaseProvider;
 11 | use Srmklive\Authy\Contracts\Auth\TwoFactor\SMSToken as SendSMSTokenContract;
 12 | 
 13 | class Authy implements BaseProvider, SendSMSTokenContract, SendPhoneTokenContract
 14 | {
 15 |     /**
 16 |      * Array containing configuration data.
 17 |      *
 18 |      * @var array
 19 |      */
 20 |     private $config;
 21 | 
 22 |     /**
 23 |      * Authy constructor.
 24 |      */
 25 |     public function __construct()
 26 |     {
 27 |         if (!empty(config('authy.mode')) && (config('authy.mode') == 'sandbox')) {
 28 |             $this->config['api_key'] = config('authy.sandbox.key');
 29 |             $this->config['api_url'] = 'http://sandbox-api.authy.com';
 30 |         } else {
 31 |             $this->config['api_key'] = config('authy.live.key');
 32 |             $this->config['api_url'] = 'https://api.authy.com';
 33 |         }
 34 |     }
 35 | 
 36 |     /**
 37 |      * Determine if the given user has two-factor authentication enabled.
 38 |      *
 39 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
 40 |      *
 41 |      * @return bool
 42 |      */
 43 |     public function isEnabled(TwoFactorAuthenticatable $user)
 44 |     {
 45 |         return isset($user->getTwoFactorAuthProviderOptions()['id']);
 46 |     }
 47 | 
 48 |     /**
 49 |      * Register the given user with the provider.
 50 |      *
 51 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
 52 |      * @param bool                                                     $sms
 53 |      *
 54 |      * @throws \Exception
 55 |      *
 56 |      * @return void
 57 |      */
 58 |     public function register(TwoFactorAuthenticatable $user, $sms = false)
 59 |     {
 60 |         try {
 61 |             $request = (new HttpClient())->post($this->config['api_url'].'/protected/json/users/new?api_key='.$this->config['api_key'], [
 62 |                 'form_params' => [
 63 |                     'user' => [
 64 |                         'email'        => $user->getEmailForTwoFactorAuth(),
 65 |                         'cellphone'    => preg_replace('/[^0-9]/', '', $user->getAuthPhoneNumber()),
 66 |                         'country_code' => $user->getAuthCountryCode(),
 67 |                     ],
 68 |                 ],
 69 |             ]);
 70 | 
 71 |             $response = $request->getBody()->getContents();
 72 |             $response = \GuzzleHttp\json_decode($response, true);
 73 | 
 74 |             $user->setTwoFactorAuthProviderOptions([
 75 |                 'id'  => $response['user']['id'],
 76 |                 'sms' => $sms,
 77 |             ]);
 78 |         } catch (ClientException $e) {
 79 |             $errors = $e->getResponse()->getBody()->getContents();
 80 |             $errors = \GuzzleHttp\json_decode($errors, true);
 81 | 
 82 |             throw new \Exception($errors['message']);
 83 |         }
 84 |     }
 85 | 
 86 |     /**
 87 |      * Send the user two-factor authentication token via SMS.
 88 |      *
 89 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
 90 |      *
 91 |      * @return void
 92 |      */
 93 |     public function sendSmsToken(TwoFactorAuthenticatable $user)
 94 |     {
 95 |         try {
 96 |             $options = $user->getTwoFactorAuthProviderOptions();
 97 | 
 98 |             $response = json_decode((new HttpClient())->get(
 99 |                 $this->config['api_url'].'/protected/json/sms/'.$options['id'].
100 |                 '?force=true&api_key='.$this->config['api_key']
101 |             )->getBody(), true);
102 | 
103 |             return $response['success'] === true;
104 |         } catch (Exception $e) {
105 |             return false;
106 |         }
107 |     }
108 | 
109 |     /**
110 |      * Start the user two-factor authentication via phone call.
111 |      *
112 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
113 |      *
114 |      * @return void
115 |      */
116 |     public function sendPhoneCallToken(TwoFactorAuthenticatable $user)
117 |     {
118 |         try {
119 |             $options = $user->getTwoFactorAuthProviderOptions();
120 | 
121 |             $response = json_decode((new HttpClient())->get(
122 |                 $this->config['api_url'].'/protected/json/call/'.$options['id'].
123 |                 '?force=true&api_key='.$this->config['api_key']
124 |             )->getBody(), true);
125 | 
126 |             return $response['success'] === true;
127 |         } catch (Exception $e) {
128 |             return false;
129 |         }
130 |     }
131 | 
132 |     /**
133 |      * Determine if the given token is valid for the given user.
134 |      *
135 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
136 |      * @param string                                                   $token
137 |      *
138 |      * @return bool
139 |      */
140 |     public function tokenIsValid(TwoFactorAuthenticatable $user, $token)
141 |     {
142 |         try {
143 |             $options = $user->getTwoFactorAuthProviderOptions();
144 | 
145 |             $response = json_decode((new HttpClient())->get(
146 |                 $this->config['api_url'].'/protected/json/verify/'.
147 |                 $token.'/'.$options['id'].'?force=true&api_key='.
148 |                 $this->config['api_key']
149 |             )->getBody(), true);
150 | 
151 |             return $response['token'] === 'is valid';
152 |         } catch (Exception $e) {
153 |             return false;
154 |         }
155 |     }
156 | 
157 |     /**
158 |      * Delete the given user from the provider.
159 |      *
160 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
161 |      *
162 |      * @return bool
163 |      */
164 |     public function delete(TwoFactorAuthenticatable $user)
165 |     {
166 |         $options = $user->getTwoFactorAuthProviderOptions();
167 | 
168 |         (new HttpClient())->post(
169 |             $this->config['api_url'].'/protected/json/users/delete/'.
170 |             $options['id'].'?api_key='.$this->config['api_key']
171 |         );
172 | 
173 |         $user->setTwoFactorAuthProviderOptions([]);
174 |     }
175 | 
176 |     /**
177 |      * Determine if the given user should be sent two-factor authentication token via SMS/phone call.
178 |      *
179 |      * @param \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
180 |      *
181 |      * @return bool
182 |      */
183 |     public function canSendToken(TwoFactorAuthenticatable $user)
184 |     {
185 |         $sendToken = collect(
186 |             $user->getTwoFactorAuthProviderOptions()
187 |         )->pluck(['sms', 'phone', 'email'])->filter(function ($value) {
188 |             return !empty($value) ? $value : null;
189 |         })->isEmpty();
190 | 
191 |         return ($this->isEnabled($user) && !$sendToken) ? true : false;
192 |     }
193 | }
194 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Laravel Two-Factor Authentication
  2 | 
  3 | [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
  4 | [![Latest Version on Packagist](https://img.shields.io/packagist/v/srmklive/authy.svg?style=flat-square)](https://packagist.org/packages/srmklive/authy)
  5 | [![Total Downloads](https://img.shields.io/packagist/dt/srmklive/authy.svg?style=flat-square)](https://packagist.org/packages/srmklive/authy)
  6 | [![StyleCI](https://styleci.io/repos/473authy()98032/shield?style=flat)](https://styleci.io/repos/47398032)
  7 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/srmklive/laravel-twofactor-authentication/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/srmklive/laravel-twofactor-authentication/?branch=master)
  8 | [![SensioLabsInsight](https://insight.sensiolabs.com/projects/1f1e2abe-aefe-4490-a011-0ec8fac6860f/small.png)](https://insight.sensiolabs.com/projects/1f1e2abe-aefe-4490-a011-0ec8fac6860f)
  9 | 
 10 | - [Introduction](#introduction)
 11 | - [Installation](#installation)
 12 | - [Modify Login Workflow](#modify-login-workflow)
 13 | - [Usage](#usage)
 14 | - [Add a new TwoFactor Authentication Provider](#implement-new-provider)
 15 | - [Demo Application](#demo-application)
 16 | 
 17 | <a name="introduction"></a>
 18 | ## Introduction
 19 | 
 20 | This plugins allows you to enable two-factor authentication in your Laravel applications. 
 21 | 
 22 | **Only Laravel 5.1 or greater supported**
 23 | 
 24 | 
 25 | <a name="installation"></a>
 26 | ## Installation
 27 | 
 28 | * Use following command to install:
 29 | 
 30 | ```bash
 31 | composer require srmklive/authy
 32 | ```
 33 | 
 34 | * Add the service provider to your $providers array in config/app.php file like: 
 35 | 
 36 | ```php
 37 | Srmklive\Authy\Providers\AuthyServiceProvider::class
 38 | ```
 39 | 
 40 | * Add the alias to your $aliases array in config/app.php file like: 
 41 | 
 42 | ```php
 43 | 'Authy' => Srmklive\Authy\Facades\Authy::class
 44 | ```
 45 | 
 46 | * Run the following command to publish configuration:
 47 | 
 48 | ```bash
 49 | php artisan vendor:publish --provider "Srmklive\Authy\Providers\AuthyServiceProvider"
 50 | ```
 51 | 
 52 | * Run the following command to migrate user table changes to database:
 53 | 
 54 | ```bash
 55 | php artisan migrate
 56 | ```
 57 | 
 58 | * Add the following lines in your User model (e.g App\User.php)
 59 | 
 60 |   * Before the class declaration, add these lines:
 61 | 
 62 | ```php
 63 | use Srmklive\Authy\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
 64 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatableContract;
 65 | ```
 66 | 
 67 |   * Now the change the class declaration. For example, if your class declaration is 
 68 | 
 69 | ```php
 70 | class User extends Model implements AuthenticatableContract,
 71 |                                     AuthorizableContract,
 72 |                                     CanResetPasswordContract
 73 | ```
 74 | 
 75 | then change it to this:
 76 | 
 77 | ```php
 78 | class User extends Model implements AuthenticatableContract,
 79 |                                     AuthorizableContract,
 80 |                                     CanResetPasswordContract,
 81 |                                     TwoFactorAuthenticatableContract
 82 | ```
 83 | 
 84 |   * Now change the import traits line accordingly in user model file. For example if the line is:
 85 | 
 86 | ```php
 87 | use Authenticatable, Authorizable, CanResetPassword;
 88 | ```
 89 | 
 90 | to
 91 | 
 92 | ```php
 93 | use Authenticatable, Authorizable, CanResetPassword, TwoFactorAuthenticatable;
 94 | ```
 95 | 
 96 |   * Lastly, add/update $hidden variable to hide 'two_factor_options' field from any DB call for user detail:
 97 | 
 98 | ```php
 99 | protected $hidden = [
100 | 	'two_factor_options'
101 | ];
102 | ```
103 | 
104 | 
105 | <a name="modify-login-workflow"></a>
106 | ## Modifying Login Workflow
107 | 
108 | * You need to add the following code to your `app\Http\Controllers\Auth\AuthController.php`.
109 | 
110 | ```php
111 | 
112 |     /**
113 |      * Send the post-authentication response.
114 |      *
115 |      * @param  \Illuminate\Http\Request  $request
116 |      * @param  \Illuminate\Contracts\Auth\Authenticatable  $user
117 |      * @return \Illuminate\Http\Response
118 |      */
119 |     protected function authenticated(Request $request, Authenticatable $user)
120 |     {
121 |         if (Authy::getProvider()->isEnabled($user)) {
122 |             return $this->logoutAndRedirectToTokenScreen($request, $user);
123 |         }
124 | 
125 |         return redirect()->intended($this->redirectPath());
126 |     }
127 |     
128 |     /**
129 |      * Generate a redirect response to the two-factor token screen.
130 |      *
131 |      * @param  \Illuminate\Http\Request  $request
132 |      * @param  \Illuminate\Contracts\Auth\Authenticatable  $user
133 |      * @return \Illuminate\Http\Response
134 |      */
135 |     protected function logoutAndRedirectToTokenScreen(Request $request, Authenticatable $user)
136 |     {
137 |         // Uncomment this line for Laravel 5.2+
138 |         //auth($this->getGuard())->logout();
139 | 
140 |         // Uncomment this line for Laravel 5.1
141 |         // auth()->logout();
142 | 
143 |         $request->session()->put('authy:auth:id', $user->id);
144 | 
145 |         return redirect(url('auth/token'));
146 |     }
147 | 
148 |     /**
149 |      * Show two-factor authentication page
150 |      *
151 |      * @return \Illuminate\Http\Response|\Illuminate\View\View
152 |      */
153 |     public function getToken()
154 |     {
155 |         return session('authy:auth:id') ? view('auth.token') : redirect(url('login'));
156 |     }
157 | 
158 |     /**
159 |      * Verify the two-factor authentication token.
160 |      *
161 |      * @param  \Illuminate\Http\Request  $request
162 |      * @return \Illuminate\Http\Response
163 |      */
164 |     public function postToken(Request $request)
165 |     {
166 |         $this->validate($request, ['token' => 'required']);
167 |         if (! session('authy:auth:id')) {
168 |             return redirect(url('login'));
169 |         }
170 | 
171 |         // Uncomment these lines for use in Laravel 5.2+ 
172 |         //$guard = config('auth.defaults.guard');
173 |         //$provider = config('auth.guards.' . $guard . '.provider');
174 |         //$model = config('auth.providers.' . $provider . '.model');
175 | 
176 |         // Uncomment the line below for use in Laravel 5.1
177 |         // $model = config('auth.model');
178 | 
179 |         $user = (new $model)->findOrFail(
180 |             $request->session()->pull('authy:auth:id')
181 |         );
182 | 
183 |         if (Authy::getProvider()->tokenIsValid($user, $request->token)) {
184 |             // Uncomment this line for Laravel 5.2+
185 |             //auth($this->getGuard())->login($user);
186 | 
187 |             // Uncomment this line for Laravel 5.1
188 | 	        //auth()->login($user);
189 | 
190 |             return redirect()->intended($this->redirectPath());
191 |         } else {
192 |             return redirect(url('login'))->withErrors('Invalid two-factor authentication token provided!');
193 |         }
194 |     }        
195 | ```
196 | 
197 | * Add route to verify two-factor authentication token
198 | 
199 | ```php
200 | Route::get('auth/token','Auth\AuthController@getToken');
201 | Route::post('auth/token','Auth\AuthController@postToken');
202 | ```
203 | 
204 | * Create view file in `resources/views/auth/token.blade.php`. Change this accordingly for your application. I have used code from [AdminLTE](https://github.com/almasaeed2010/AdminLTE) theme here.
205 | 
206 | ```blade
207 | @extends('layouts.app')
208 | 
209 | @section('content')
210 |     <div class="register-logo">
211 |         Two-factor Authentication
212 |     </div>
213 | 
214 |     <div class="register-box-body">
215 |         <p class="login-box-msg">Validate your two-factor authentication token</p>
216 |         <form method="POST" action="{{url('auth/token')}}">
217 |             {!! csrf_field() !!}
218 | 
219 |             @if (count($errors) > 0)
220 |                 <div class="alert alert-danger">
221 |                     <ul>
222 |                         @foreach ($errors->all() as $error)
223 |                             <li>{{ $error }}</li>
224 |                         @endforeach
225 |                     </ul>
226 |                 </div>
227 |             @endif
228 | 
229 |             <div class="form-group has-feedback">
230 |                 <input type="type" name="token" class="form-control" placeholder="Token">
231 |                 <span class="glyphicon glyphicon-envelope form-control-feedback"></span>
232 |             </div>
233 |             <div class="row">
234 |                 <div class="col-xs-7"></div><!-- /.col -->
235 |                 <div class="col-xs-5">
236 |                     <button type="submit" class="btn btn-primary btn-block btn-flat">Verify Token</button>
237 |                 </div><!-- /.col -->
238 |             </div>
239 |         </form>
240 |     </div><!-- /.form-box -->
241 | @endsection
242 | 
243 | ```
244 | 
245 | 
246 | <a name="usage"></a>
247 | ## Usage
248 | 
249 | * Registering User
250 | 
251 | ```php
252 | $phone = '405-342-5699';
253 | $code = 1;
254 | 
255 | $user = User::find(1);
256 | 
257 | $user->setAuthPhoneInformation(
258 |     $code, $phone
259 | );
260 | 
261 | try {
262 |    Authy::getProvider()->register($user);
263 | 
264 |    $user->save();
265 | } catch (Exception $e) {
266 |    app(ExceptionHandler::class)->report($e);
267 | 
268 |    return response()->json(['error' => ['Unable To Register User']], 422);
269 | }
270 | ```
271 | 
272 | * Send token via SMS
273 | 
274 | ```php
275 | $user = User::find(1);
276 | 
277 | try {
278 |    Authy::getProvider()->sendSmsToken($user);
279 | } catch (Exception $e) {
280 |    app(ExceptionHandler::class)->report($e);
281 | 
282 |    return response()->json(['error' => ['Unable To Send 2FA Login Token']], 422);
283 | }
284 | ```
285 | 
286 | * Send token via phone call
287 | 
288 | ```php
289 | $user = User::find(1);
290 | 
291 | try {
292 |    Authy::getProvider()->sendPhoneCallToken($user);
293 | } catch (Exception $e) {
294 |    app(ExceptionHandler::class)->report($e);
295 | 
296 |    return response()->json(['error' => ['Unable To Send 2FA Login Token']], 422);
297 | }
298 | ```
299 | 
300 | * Validating two-factor token
301 | 
302 | ```php
303 | $user = User::find(1);
304 | 
305 | try {
306 |    Authy::getProvider()->tokenIsValid($user, $token);
307 | } catch (Exception $e) {
308 |    app(ExceptionHandler::class)->report($e);
309 | 
310 |    return response()->json(['error' => ['Invalid 2FA Login Token Provided']], 422);
311 | }
312 | ```
313 | 
314 | * Deleting User
315 | 
316 | ```php
317 | $user = User::find(1);
318 | 
319 | try {
320 |    Authy::getProvider()->delete($user);
321 | 
322 |    $user->save();
323 | } catch (Exception $e) {
324 |    app(ExceptionHandler::class)->report($e);
325 | 
326 |    return response()->json(['error' => ['Unable to Delete User']], 422);
327 | }
328 | ```
329 | 
330 | <a name="implement-new-provider"></a>
331 | ## Add a new TwoFactor Authentication Provider
332 | 
333 | Currently this package uses two-factor authentication services from [**Authy**](https://www.authy.com). You can also implement another two-factor authentication provider by doing the following:
334 | 
335 | ```php
336 | <?php
337 | 
338 | namespace App\Services;
339 | 
340 | use Exception;
341 | use GuzzleHttp\Client as HttpClient;
342 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Provider as BaseProvider;
343 | use Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable as TwoFactorAuthenticatable;
344 | 
345 | class MyAuthProvider implements BaseProvider
346 | {
347 |     /**
348 |      * Array containing configuration data.
349 |      *
350 |      * @var array $config
351 |      */
352 |     private $config;
353 | 
354 |     /**
355 |      * Authy constructor.
356 |      */
357 |     public function __construct()
358 |     {
359 |     	// Add your configuration code here
360 |     }
361 | 
362 |     /**
363 |      * Determine if the given user has two-factor authentication enabled.
364 |      *
365 |      * @param  \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
366 |      * @return bool
367 |      */
368 |     public function isEnabled(TwoFactorAuthenticatable $user)
369 |     {
370 |     	// Add your code here
371 |     }
372 | 
373 |     /**
374 |      * Register the given user with the provider.
375 |      *
376 |      * @param  \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
377 |      * @param boolean $sms
378 |      * @return void
379 |      */
380 |     public function register(TwoFactorAuthenticatable $user, $sms = false)
381 |     {
382 |     	// Add your code here
383 |     }
384 | 
385 |     /**
386 |      * Determine if the given token is valid for the given user.
387 |      *
388 |      * @param  \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
389 |      * @param  string  $token
390 |      * @return bool
391 |      */
392 |     public function tokenIsValid(TwoFactorAuthenticatable $user, $token)
393 |     {
394 |     	// Add your code here
395 |     }
396 | 
397 |     /**
398 |      * Delete the given user from the provider.
399 |      *
400 |      * @param  \Srmklive\Authy\Contracts\Auth\TwoFactor\Authenticatable $user
401 |      * @return bool
402 |      */
403 |     public function delete(TwoFactorAuthenticatable $user)
404 |     {
405 |     	// Add your code here
406 |     }
407 | }
408 | ```
409 | 
410 | <a name="demo-application"></a>
411 | ## Demo Application
412 | 
413 | I have also implemented this package in a simple laravel application. You can view installation instructions [here](https://github.com/srmklive/laravel-2fa-demo). Through this application, you can do:
414 | 
415 | * User login & registration.
416 | * Enable/Disable two-factor authentication for a user.
417 | 


--------------------------------------------------------------------------------