New feature added which helps users to define User model. #6

Author: imrealashu

config/2fa-config.php

@@ -28,4 +28,15 @@
      * To Support Google Authenticator
      */
     'number_of_digits' => 8,
+
+    /*
+     * Explitcitly Define Table name for the model.
+     */
+    'table' => 'users',
+
+    /*
+     * User Model
+     * By Default `\App\User` Model is defined.
+     */
+    'model' => '\App\User',
 ];

database/migrations/2017_01_20_160000_add_two_factor_authentication_required_fields.php

@@ -13,7 +13,7 @@ class AddTwoFactorAuthenticationRequiredFields extends Migration
      */
     public function up()
     {
-        Schema::table('users', function (Blueprint $table) {
+        Schema::table(config('2fa-config.table'), function (Blueprint $table) {
             $table->smallInteger('is_two_factor_enabled')->default(0)->before('created_at');
             $table->string('two_factor_secret_key')->nullable()->default(NULL)->after('is_two_factor_enabled');
         });
@@ -26,7 +26,7 @@ public function up()
      */
     public function down()
     {
-        Schema::table('users', function (Blueprint $table) {
+        Schema::table(config('2fa-config.table'), function (Blueprint $table) {
             $table->dropColumn('is_two_factor_enabled');
             $table->dropColumn('two_factor_secret_key');
         });

src/AuthenticatesUsersWith2FA.php

@@ -6,6 +6,7 @@
 use Auth;
 use Illuminate\Http\Request;
 use OTPHP\TOTP;
+use Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider;
 use Validator;
 
 trait AuthenticatesUsersWith2FA
@@ -48,9 +49,10 @@ protected function authenticated(Request $request, $user)
      */
     public function verifyToken(Request $request)
     {
+        $userModel = TwoFactorAuthenticationServiceProvider::getUserModelInstance();
         // Pulling encrypted user id from session and getting user details
         $userId = $request->session()->get('2fa:user:id');
-        $this->user = User::find(decrypt($userId));
+        $this->user = $userModel->find(decrypt($userId));
 
         // If token is not valid then custom validation error message will be shown.
         $messages = [

src/Exceptions/TwoFactorAuthenticationExceptions.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Thecodework\TwoFactorAuthentication\Exceptions;
+
+class TwoFactorAuthenticationExceptions extends \Exception {
+
+    /**
+     * Column Not Found
+     *
+     */
+    public static function columnNotFound()
+    {
+        $table = config('2fa-config.table');
+        return new static("Could not locate required column `two_factor_secret_key` or `is_two_factor_enabled` in `$table` table. Make sure the migrations ran properly.");
+    }
+}

src/Http/Controllers/TwoFactorAuthenticationController.php

@@ -6,23 +6,43 @@
 use App\User;
 use Base32\Base32;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Schema;
 use OTPHP\TOTP;
 use Thecodework\TwoFactorAuthentication\AuthenticatesUsersWith2FA;
 use Thecodework\TwoFactorAuthentication\Contracts\TwoFactorAuthenticationInterface;
+use Thecodework\TwoFactorAuthentication\Exceptions\TwoFactorAuthenticationExceptions;
+use Thecodework\TwoFactorAuthentication\TwoFactorAuthenticationServiceProvider;
 
 class TwoFactorAuthenticationController extends Controller implements TwoFactorAuthenticationInterface
 {
     use AuthenticatesUsersWith2FA;
 
+    /**
+     * User Model
+     */
+    protected $userModel;
+
+    /**
+     * Assigns $usersModel Property a Model instance.
+     */
+    public function __construct()
+    {
+        $this->userModel = TwoFactorAuthenticationServiceProvider::getUserModelInstance();
+    }
     /**
      * Setup two factor authentication.
      *
      * @param \Illuminate\Http\Request
      * @param \Illuminate\Http\Response
+     * @throws \Thecodework\TwoFactorAuthentications\Exceptions\TwoFactorAuthenticationExceptions
      */
     public function setupTwoFactorAuthentication(Request $request)
     {
-        $user = User::find($request->user()->id);
+        $user = $this->userModel->find($request->user()->id);
+        if (!Schema::hasColumn(config('2fa-config.table'), 'two_factor_secret_key') ||
+            !Schema::hasColumn(config('2fa-config.table'), 'is_two_factor_enabled')) {
+            throw TwoFactorAuthenticationExceptions::columnNotFound();
+        }
         $user->two_factor_secret_key = $user->two_factor_secret_key ?? $this->base32EncodedString(config('2fa-config.number_of_digits'));
         $user->update();
 
@@ -53,7 +73,7 @@ public function setupTwoFactorAuthentication(Request $request)
      */
     public function enableTwoFactorAuthentication(Request $request)
     {
-        $user = User::find($request->user()->id);
+        $user                        = $this->userModel->find($request->user()->id);
         $user->is_two_factor_enabled = 1;
         $user->update();
 
@@ -78,7 +98,7 @@ public function enableTwoFactorAuthentication(Request $request)
      */
     public function disableTwoFactorAuthentication(Request $request)
     {
-        $user = User::find($request->user()->id);
+        $user                        = $this->userModel->find($request->user()->id);
         $user->is_two_factor_enabled = 0;
         $user->two_factor_secret_key = null;
         $user->update();
@@ -103,7 +123,7 @@ public function disableTwoFactorAuthentication(Request $request)
     public function verifyTwoFactorAuthentication(Request $request)
     {
         if ($request->session()->has('2fa:user:id')) {
-            $secret = getenv('HMAC_SECRET');
+            $secret    = getenv('HMAC_SECRET');
             $signature = hash_hmac('sha256', decrypt($request->session()->get('2fa:user:id')), $secret);
 
             if (md5($signature) !== md5($request->signature)) {
@@ -124,8 +144,7 @@ public function verifyTwoFactorAuthentication(Request $request)
      * @return string
      */
     private function base32EncodedString($length = 30):
-    string
-    {
+    string {
         return Base32::encode($this->strRandom($length));
     }
 
@@ -137,8 +156,7 @@ private function base32EncodedString($length = 30):
      * @return string
      */
     private function strRandom($length = 30):
-    string
-    {
+    string{
         $string = '';
 
         while (($len = strlen($string)) < $length) {

src/TwoFactorAuthenticationServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Thecodework\TwoFactorAuthentication;
 
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Database\Eloquent\Model;
 
 class TwoFactorAuthenticationServiceProvider extends ServiceProvider
 {
@@ -33,4 +34,14 @@ public function boot()
             __DIR__ . '/../resources/views/' => resource_path('views/vendor/2fa'),
         ], 'views');
     }
+
+    public static function determineUserModel(): string
+    {
+        return $userModel = config('2fa-config.model');
+    }
+
+    public static function getUserModelInstance(): Model {
+        $userModelClassName = self::determineUserModel();
+        return new $userModelClassName();
+    }
 }