Internal Docs added #6

Author: imrealashu

src/AuthenticatesUsersWith2FA.php

@@ -2,7 +2,6 @@
 
 namespace Thecodework\TwoFactorAuthentication;
 
-use App\User;
 use Auth;
 use Illuminate\Http\Request;
 use OTPHP\TOTP;
@@ -30,7 +29,7 @@ protected function authenticated(Request $request, $user)
     {
         if ($user->is_two_factor_enabled) {
             $request->session()->put('2fa:user:id', encrypt($user->id));
-            $secret = getenv('HMAC_SECRET');
+            $secret    = getenv('HMAC_SECRET');
             $signature = hash_hmac('sha256', $user->id, $secret);
             Auth::logout();
 
@@ -51,7 +50,7 @@ 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');
+        $userId     = $request->session()->get('2fa:user:id');
         $this->user = $userModel->find(decrypt($userId));
 
         // If token is not valid then custom validation error message will be shown.
@@ -74,7 +73,7 @@ public function verifyToken(Request $request)
             'totp_token' => 'required|digits:6|valid_token',
         ], $messages);
 
-        $secret = getenv('HMAC_SECRET');
+        $secret    = getenv('HMAC_SECRET');
         $signature = hash_hmac('sha256', $this->user->id, $secret);
         if ($validator->fails()) {
             return redirect('verify-2fa?signature=' . $signature)

src/Http/Controllers/TwoFactorAuthenticationController.php

@@ -3,7 +3,6 @@
 namespace Thecodework\TwoFactorAuthentication\Http\Controllers;
 
 use App\Http\Controllers\Controller;
-use App\User;
 use Base32\Base32;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Schema;

src/TwoFactorAuthenticationServiceProvider.php

@@ -35,11 +35,21 @@ public function boot()
         ], 'views');
     }
 
+    /**
+     * Get User moded defined in config file
+     *
+     * @return string
+     */
     public static function determineUserModel(): string
     {
         return $userModel = config('2fa-config.model');
     }
 
+    /**
+     * Get User Model Instance.
+     *
+     * @return \Illuminate\Database\Eloquent\Model
+     */
     public static function getUserModelInstance(): Model {
         $userModelClassName = self::determineUserModel();
         return new $userModelClassName();