Thecodework\TwoFactorAuthentication\Http\Controllers\TwoFactorAuthenticationController

Complexity

Total Complexity

16

Size/Duplication

Total Lines	171
Duplicated Lines	20.47 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	6
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	enableTwoFactorAuthentication()	17	17	2
A	disableTwoFactorAuthentication()	18	18	2
A	verifyTwoFactorAuthentication()	0	15	3
A	__construct()	0	9	1
A	setupTwoFactorAuthentication()	0	21	2
A	base32EncodedString()	0	5	1
A	strRandom()	0	15	2
A	updateUserWith2FAGeneratedKey()	0	10	3

<?php

namespace Thecodework\TwoFactorAuthentication\Http\Controllers;

use App\Http\Controllers\Controller;
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 $TwoFAModel;

    /**
     * Assigns $usersModel Property a Model instance.
     */
    public function __construct()
    {
        $this->TwoFAModel = TwoFactorAuthenticationServiceProvider::getTwoFAModelInstance();

        $this->middleware(function ($request, $next) {
            $this->setUser(auth()->user());

The method user does only exist in Illuminate\Contracts\Auth\Guard, but not in Illuminate\Contracts\Auth\Factory.

            return $next($request);
        });
    }

    /**
     * Setup two factor authentication.
     *
     * @param \Illuminate\Http\Request
     * @param \Illuminate\Http\Response
     *
     * @throws \Thecodework\TwoFactorAuthentications\Exceptions\TwoFactorAuthenticationExceptions
     */
    public function setupTwoFactorAuthentication(Request $request)
    {
        $this->updateUserWith2FAGeneratedKey();
        $user = $this->getUser();
        $totp = new TOTP(
            config('2fa-config.account_name'),
            $user->two_factor_secret_key,
            config('2fa-config.period'),
            config('2fa-config.digest_algorithm'),
            config('2fa-config.number_of_digits')
        );

        $barcode = $totp->getQrCodeUri();

        // Return Barcode image if ajax Request
        if ($request->ajax()) {
            return $barcode;
        }

        return view('2fa::setup', compact('barcode', 'user'));
    }

    /**
     * Disable 2FA.
     *
     * @param \Illuminate\Http\Request
     *
     * @return mixed
     */
    public function enableTwoFactorAuthentication(Request $request)
    {
        $user = $this->TwoFAModel->find($request->user()->id);
        $user->is_two_factor_enabled = 1;
        $user->update();

        if ($request->ajax()) {
            return [
                'data' => [
                    'message'     => 'success',
                    'description' => '2FA Enabled',
                ],
            ];
        }

        return redirect('home');
    }

    /**
     * Enable 2FA.
     *
     * @param \Illuminate\Http\Request
     *
     * @return mixed
     */
    public function disableTwoFactorAuthentication(Request $request)
    {
        $user = $this->TwoFAModel->find($request->user()->id);
        $user->is_two_factor_enabled = 0;
        $user->two_factor_secret_key = null;
        $user->update();

        if ($request->ajax()) {
            return [
                'data' => [
                    'message'     => 'success',
                    'description' => '2FA Disabled',
                ],
            ];
        }

        return redirect('home');
    }

    /**
     * Verify Two Factor Authentication.
     *
     * @param \Illuminate\Http\Request $request
     */
    public function verifyTwoFactorAuthentication(Request $request)
    {
        if ($request->session()->has('2fa:user:id')) {
            $secret = getenv('HMAC_SECRET');
            $signature = hash_hmac('sha256', decrypt($request->session()->get('2fa:user:id')), $secret);

            if (md5($signature) !== md5($request->signature)) {
                return redirect()->intended('login');
            }

            return view('2fa::verify');
        }

        return redirect()->back(); //shoud be configurable
    }

    /**
     * Encode Random String to 32 Base Transfer Encoding.
     *
     * @param int $length Length of the encoded string.
     *
     * @return string
     */
    private function base32EncodedString($length = 30):
    string
    {
        return Base32::encode($this->strRandom($length));
    }

    /**
     * Generate a more truly "random" alpha-numeric string.
     *
     * @param int $length
     *
     * @return string
     */
    private function strRandom($length = 30):
    string
    {
        $string = '';

        while (($len = strlen($string)) < $length) {
            $size = $length - $len;

            $bytes = random_bytes($size);

            $string .= substr(str_replace(['/', '+', '='], '', base64_encode($bytes)), 0, $size);
        }

        return $string;
    }

    private function updateUserWith2FAGeneratedKey()
    {
        $user = $this->TwoFAModel->find($this->getUser()->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();
    }
}