TfaController::generateRecoveryCode() - Code Metrics - Inspection of "Added the 2FA system + Logs system" - XetaIO/Xeta - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#194)

by Fèvre
created 2016-11-05 12:17 UTC
TfaController::generateRecoveryCode() B

↳ Parent: TfaController
Complexity

Conditions	4
Paths	3
Size

Total Lines	65
Code Lines	44
Duplication

Lines	5
Ratio	7.69 %
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	5
loc	65
rs	8.8507
cc	4
eloc	44
nc	3
nop	0
How to fix Long Method

<?php
namespace App\Controller;

use App\Event\Logs;
use Cake\Core\Configure;
use Cake\Event\Event;
use Endroid\QrCode\QrCode;
use RobThree\Auth\TwoFactorAuth;

class TfaController extends AppController
{
    /**
     * Display the index action.
     *
     * @return void
     */
    public function index()
    {
    }

    /**
     * Display an intro to the Two-factor Authentication.
     *
     * @return \Cake\Network\Response|void
     */
    public function intro()
    {
        $this->loadModel('Users');

        $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'Users.id' => $this->Auth->user('id')
            ])
            ->select([
                'id',
                'two_factor_auth_enabled'
            ])
            ->first();

        if ($user->two_factor_auth_enabled == true) {

            $this->Flash->error(__('You have already set-up the Two-factor authentication.'));

            return $this->redirect(['controller' => 'users', 'action' => 'security']);
        }
    }

    /**
     * Configure the Two-factor Authentication.
     *
     * @return \Cake\Network\Response|void
     */
    public function configure()
    {
        $this->loadModel('Users');

        $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->contain([
                'UsersTwoFactorAuth'
            ])
            ->where([
                'Users.id' => $this->Auth->user('id')
            ])
            ->select([
                'Users.id',
                'Users.username',
                'Users.two_factor_auth_enabled',
                'UsersTwoFactorAuth.id',
                'UsersTwoFactorAuth.user_id',
                'UsersTwoFactorAuth.secret',
                'UsersTwoFactorAuth.username'
            ])
            ->first();

        if ($user->two_factor_auth_enabled == true) {

            $this->Flash->error(__('You have already set-up the Two-factor authentication.'));

            return $this->redirect(['controller' => 'users', 'action' => 'security']);
        }

        $tfa = new TwoFactorAuth('Xeta');

        if (!is_null($user->users_two_factor_auth)) {
            $secret = $user->users_two_factor_auth->secret;
        } else {
            $this->loadModel('UsersTwoFactorAuth');
            $secret = $tfa->createSecret();

            $data = [
                'user_id' => $this->Auth->user('id'),
                'secret' => $secret,
                'username' => $user->username
            ];

            $entity = $this->UsersTwoFactorAuth->newEntity($data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->UsersTwoFactorAuth->save($entity);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $imgSrc = $tfa->getQRCodeImageAsDataUri($user->username, $secret);
        $secretCode = chunk_split($secret, 4, ' ');

        $this->set(compact('imgSrc', 'secretCode'));
    }

    /**
     * Enable the Two-factor Authentication.
     *
     * @return \Cake\Network\Response|void
     */
    public function enable()
    {
        if (!$this->request->is('post')) {
            return $this->redirect(['action' => 'configure']);
        }

        $this->loadModel('UsersTwoFactorAuth');

        $userTfa = $this->UsersTwoFactorAuth
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'UsersTwoFactorAuth.user_id' => $this->Auth->user('id')
            ])
            ->first();

        if (is_null($userTfa) || empty($userTfa->secret) || !isset($this->request->data['code'])) {
            $this->Flash->error(__('Two-factor secret verification failed. Please verify your secret and try again.'));

            return $this->redirect(['action' => 'configure']);
        }

        $tfa = new TwoFactorAuth('Xeta');

        if ($tfa->verifyCode($userTfa->secret, $this->request->data['code']) === true && $this->request->data['code'] != $userTfa->current_code) {
            $this->loadModel('Users');

            $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                ->find()
                ->where([
                    'Users.id' => $this->Auth->user('id')
                ])
                ->select([
                    'id',
                    'username',
                    'two_factor_auth_enabled'
                ])
                ->first();

            $user->two_factor_auth_enabled = true;
            $this->Users->save($user);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            $data = [
                'session' => $this->request->clientIp() . $this->request->header('User-Agent') . gethostbyaddr($this->request->clientIp()),
                'current_code' => $this->request->data['code'],
                'recovery_code' => $this->_generateNewRecoveryCode($userTfa->username)
            ];

            $this->UsersTwoFactorAuth->patchEntity($userTfa, $data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->UsersTwoFactorAuth->save($userTfa);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            //Logs Event.
            $this->eventManager()->attach(new Logs());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $event = new Event('Log.User', $this, [
                'user_id' => $user->id,
                'username' => $user->username,
                'user_ip' => $this->request->clientIp(),
                'user_agent' => $this->request->header('User-Agent'),
                'action' => '2FA.enabled'
            ]);
            $this->eventManager()->dispatch($event);

            $this->Flash->success(__('Two-factor authentication successfully enabled !'));

            $this->set(compact('user', 'userTfa'));
        } else {
            $this->Flash->error(__('Two-factor secret verification failed. Please verify your secret and try again.'));

            return $this->redirect(['action' => 'configure']);
        }
    }

    /**
     * Disable the Two-factor Authentication.
     *
     * @return \Cake\Network\Response
     */
    public function disable()
    {
        $this->loadModel('Users');

        $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'Users.id' => $this->Auth->user('id')
            ])
            ->select([
                'id',
                'username',
                'two_factor_auth_enabled'
            ])
            ->first();

        if (is_null($user) || $user->two_factor_auth_enabled == false) {

            $this->Flash->error(__('The Two-factor authentication is not enabled !'));

            return $this->redirect(['controller' => 'users', 'action' => 'security']);
        }

        $user->two_factor_auth_enabled = false;
        $this->Users->save($user);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $this->loadModel('UsersTwoFactorAuth');

        $userTfa = $this->UsersTwoFactorAuth
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'UsersTwoFactorAuth.user_id' => $this->Auth->user('id')
            ])
            ->first();

        $this->UsersTwoFactorAuth->delete($userTfa);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        //Logs Event.
        $this->eventManager()->attach(new Logs());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $event = new Event('Log.User', $this, [
            'user_id' => $user->id,
            'username' => $user->username,
            'user_ip' => $this->request->clientIp(),
            'user_agent' => $this->request->header('User-Agent'),
            'action' => '2FA.disabled'
        ]);
        $this->eventManager()->dispatch($event);

        $this->Flash->success(__('The Two-factor authentication has been disabled !'));

        return $this->redirect(['controller' => 'users', 'action' => 'security']);
    }

    /**
     * Display the recovery code and the status of the code.
     *
     * @return \Cake\Network\Response|void
     */
    public function recoveryCode()
    {
        $this->loadModel('Users');

        $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->contain([
                'UsersTwoFactorAuth'
            ])
            ->where([
                'Users.id' => $this->Auth->user('id')
            ])
            ->select([
                'Users.id',
                'Users.two_factor_auth_enabled',
                'UsersTwoFactorAuth.user_id',
                'UsersTwoFactorAuth.recovery_code',
                'UsersTwoFactorAuth.recovery_code_used'
            ])
            ->first();

        if (is_null($user) || $user->two_factor_auth_enabled == false) {

            $this->Flash->error(__('The Two-factor authentication is not enabled !'));

            return $this->redirect(['controller' => 'users', 'action' => 'security']);
        }

        $this->set(compact('user'));
    }

    /**
     * Generate a new recovery code.
     *
     * @return \Cake\Network\Response
     */
    public function generateRecoveryCode()
    {
        $this->loadModel('Users');
        $this->loadModel('UsersTwoFactorAuth');

        $user = $this->Users
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'Users.id' => $this->Auth->user('id')
            ])
            ->select([
                'Users.id',
                'Users.username',
                'Users.two_factor_auth_enabled'
            ])
            ->first();

        if (is_null($user) || $user->two_factor_auth_enabled == false) {

            $this->Flash->error(__('The Two-factor authentication is not enabled !'));

            return $this->redirect(['controller' => 'users', 'action' => 'security']);
        }

        $tfa = $this->UsersTwoFactorAuth
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->find()
            ->where([
                'UsersTwoFactorAuth.user_id' => $this->Auth->user('id')
            ])
            ->select([
                'UsersTwoFactorAuth.id',
                'UsersTwoFactorAuth.user_id',
                'UsersTwoFactorAuth.username',
                'UsersTwoFactorAuth.recovery_code',
                'UsersTwoFactorAuth.recovery_code_used'
            ])
            ->first();

        $data = [
            'recovery_code' => $this->_generateNewRecoveryCode($tfa->username),
            'recovery_code_used' => false
        ];

        $this->UsersTwoFactorAuth->patchEntity($tfa, $data);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if ($this->UsersTwoFactorAuth->save($tfa)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            //Logs Event.
            $this->eventManager()->attach(new Logs());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $event = new Event('Log.User', $this, [
                'user_id' => $user->id,
                'username' => $user->username,
                'user_ip' => $this->request->clientIp(),
                'user_agent' => $this->request->header('User-Agent'),
                'action' => '2FA.recovery_code.regenerate'
            ]);
            $this->eventManager()->dispatch($event);

            $this->Flash->success(__('New two-factor recovery code successfully generated.'));

            return $this->redirect(['action' => 'recoveryCode']);
        } else {
            $this->Flash->error(__('Error to generate two-factor recovery code.'));

            return $this->redirect(['action' => 'recoveryCode']);
        }
    }

    /**
     * Function to generate a recovery code.
     *
     * Generate a code into this format :
     * XXXX-XXXX-XXXX-XXXX
     *
     * @param string $user The username of the user.
     *
     * @return string
     */
    protected function _generateNewRecoveryCode($user)
    {
        $code = md5(rand() . uniqid() . time() . $user);

        //Split the code into smaller chunks
        $code = chunk_split(substr($code, 0, 16), 4, '-');

        //Remove the last string added by chunk_split().
        $code = substr($code, 0, -1);

        return $code;
    }
}

1			<?php
2			namespace App\Controller;
3
4			use App\Event\Logs;
5			use Cake\Core\Configure;
6			use Cake\Event\Event;
7			use Endroid\QrCode\QrCode;
8			use RobThree\Auth\TwoFactorAuth;
9
10			class TfaController extends AppController
11			{
12			/**
13			* Display the index action.
14			*
15			* @return void
16			*/
17			public function index()
18			{
19			}
20
21			/**
22			* Display an intro to the Two-factor Authentication.
23			*
24			* @return \Cake\Network\Response\|void
25			*/
26			public function intro()
27			{
28			$this->loadModel('Users');
29
30			$user = $this->Users
			0 ignored issues – show Documentation introduced 2016-11-05 09:03 UTC by Report Bug Copy Issue Report The property `Users` does not exist on `object<App\Controller\TfaController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
31			->find()
32			->where([
33			'Users.id' => $this->Auth->user('id')
34			])
35			->select([
36			'id',
37			'two_factor_auth_enabled'
38			])
39			->first();
XetaIO / Xeta

Pull Request — master (#194)

TfaController::generateRecoveryCode() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
