otp::is_enabled() - Code Metrics - Inspection of "Moved some common stuff to a abstract module." - paul999/phpbb_2fa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d043ad...19080b )

by Paul

created 2016-08-05 14:34 UTC

otp::is_enabled() A

↳ Parent: otp

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 *
 * 2FA extension for the phpBB Forum Software package.
 *
 * @copyright (c) 2015 Paul Sohier
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace paul999\tfa\modules;

use OTPAuthenticate\OTPAuthenticate;
use OTPAuthenticate\OTPHelper;
use phpbb\db\driver\driver_interface;
use phpbb\request\request_interface;
use phpbb\template\template;
use phpbb\user;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

class otp extends abstract_module
{
	/**
	 * @var \OTPAuthenticate\OTPHelper
	 */
	private $otp_helper;

	/**
	 * @var \OTPAuthenticate\OTPAuthenticate
	 */
	private $otp;

	/**
	 * @var \phpbb\db\driver\driver_interface
	 */
	private $db;

	/**
	 * @var \phpbb\user
	 */
	private $user;

	/**
	 * @var \phpbb\request\request_interface
	 */
	private $request;

	/**
	 * @var \phpbb\template\template
	 */
	private $template;

	/**
	 * @var string
	 */
	private $otp_registration_table;

	/**
	 * OTP constructor.
	 *
	 * @param \phpbb\db\driver\driver_interface $db
	 * @param \phpbb\user                       $user
	 * @param \phpbb\request\request_interface  $request
	 * @param \phpbb\template\template          $template
	 * @param string                            $otp_registration_table
	 */
	public function __construct(driver_interface $db, user $user, request_interface $request, template $template, $otp_registration_table)
	{
		$this->otp_helper = new OTPHelper();
		$this->otp = new OTPAuthenticate();
		$this->db = $db;
		$this->user = $user;
		$this->request = $request;
		$this->template = $template;
		$this->otp_registration_table = $otp_registration_table;
	}

	/**
	 * Get a language key for this specific module.
	 * @return string
	 */
	public function get_translatable_name()
	{
		return 'OTP';
	}

	/**
	 * Return the name of the current module
	 * This is for internal use only
	 * @return string
	 */
	public function get_name()
	{
		return 'otp';
	}

	/**
	 * Return if this module is enabled by the admin
	 * (And all server requirements are met).
	 *
	 * Do not return false in case a specific user disabled this module,
	 * OR if the user is unable to use this specific module,
	 * OR if a browser specific item is missing/incorrect.
	 * @return boolean
	 */
	public function is_enabled()
	{
		return true;
	}

	/**
	 * Check if the current user is able to use this module.
	 *
	 * This means that the user enabled it in the UCP,
	 * And has it setup up correctly.
	 * This method will be called during login, not during registration/
	 *
	 * @param int $user_id
	 *
	 * @return bool
	 */
	public function is_usable($user_id)

	{
		$sql = 'SELECT COUNT(registration_id) as reg_id 
					FROM ' . $this->otp_registration_table . ' 
					WHERE 
						user_id = ' . (int) $user_id;
		$result = $this->db->sql_query($sql);
		$row = $this->db->sql_fetchrow($result);
		$this->db->sql_freeresult($result);

		return $row && $row['reg_id'] > 0;
	}

	/**
	 * Check if the user can potentially use this.
	 * This method is called at registration page.
	 *
	 * You can, for example, check if the current browser is suitable.
	 *
	 * @param int|boolean $user_id Use false to ignore user
	 *
	 * @return bool
	 */
	public function is_potentially_usable($user_id = false)
	{
		return true;
	}

	/**
	 * Get the priority for this module.
	 * A lower priority means more chance it gets selected as default option
	 *
	 * There can be only one module with a specific priority!
	 * If there is already a module registered with this priority,
	 * a Exception might be thrown
	 *
	 * @return int
	 */
	public function get_priority()
	{
		return 15;
	}

	/**
	 * Start of the login procedure.
	 *
	 * @param int $user_id
	 *
	 * @return int
	 */
	public function login_start($user_id)
	{
		// TODO: Implement login_start() method.
	}

	/**
	 * Actual login procedure
	 *
	 * @param int $user_id
	 */
	public function login($user_id)
	{
		// TODO: Implement login() method.
	}

	/**
	 * If this module can add new keys (Or other things)
	 *
	 * @return boolean
	 */
	public function can_register()
	{
		return true;
	}

	/**
	 * Start with the registration of a new security key.
	 * This page should return a name of a template, and
	 * it should assign the required variables for this template.
	 *
	 * @return string
	 */
	public function register_start()
	{
		$secret = $this->otp->generateSecret();
		$QR = $this->otp_helper->generateKeyURI('totp', $secret, generate_board_url());
		$this->template->assign_vars(array(
			'TFA_QR_CODE'				=> 'https://chart.googleapis.com/chart?chs=200x200&chld=M|0&cht=qr&chl=' . $QR,
			'TFA_SECRET'				=> $secret,
			'L_TFA_ADD_OTP_KEY_EXPLAIN'	=> $this->user->lang('TFA_ADD_OTP_KEY_EXPLAIN', $secret),
			'S_HIDDEN_FIELDS'			=> build_hidden_fields(array(
				'secret'	=> $secret,
			)),
		));

		return 'tfa_otp_ucp_new';
	}

	/**
	 * Do the actual registration of a new security key.
	 *
	 * @return boolean Result of the registration.
	 * @throws BadRequestHttpException
	 */
	public function register()
	{
		$secret = $this->request->variable('secret', '');
		$otp	= $this->request->variable('otp', '');

		if (!$this->otp->checkTOTP($secret, $otp))
		{
			throw new BadRequestHttpException($this->user->lang('TFA_OTP_INVALID_KEY'));
		}

		$sql_ary = array(
			'user_id' 		=> $this->user->data['user_id'],
			'secret'		=> $secret,
			'registered' 	=> time(),
			'last_used' 	=> time(),
		);

		$sql = 'INSERT INTO ' . $this->otp_registration_table . ' ' . $this->db->sql_build_array('INSERT', $sql_ary);
		$this->db->sql_query($sql);
	}

	/**
	 * This method is called to show the UCP page.
	 * You can assign template variables to the template, or do anything else here.
	 */
	public function show_ucp()
	{
		$this->show_ucp_complete($this->otp_registration_table);
	}

	/**
	 * Delete a specific row from the UCP.
	 * The data is based on the data provided in show_ucp.
	 *
	 * @param int $key
	 *
	 * @return void
	 */
	public function delete($key)

	{
		$sql = 'DELETE FROM ' . $this->otp_registration_table . '
					WHERE user_id = ' . (int) $this->user->data['user_id'] . '
					AND registration_id =' . (int) $key;

		$this->db->sql_query($sql);
	}
}


1		<?php
2		/**
3		*
4		* 2FA extension for the phpBB Forum Software package.
5		*
6		* @copyright (c) 2015 Paul Sohier
7		* @license GNU General Public License, version 2 (GPL-2.0)
8		*
9		*/
10
11		namespace paul999\tfa\modules;
12
13		use OTPAuthenticate\OTPAuthenticate;
14		use OTPAuthenticate\OTPHelper;
15		use phpbb\db\driver\driver_interface;
16		use phpbb\request\request_interface;
17		use phpbb\template\template;
18		use phpbb\user;
19		use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
20
21		class otp extends abstract_module
22		{
23		/**
24		* @var \OTPAuthenticate\OTPHelper
25		*/
26		private $otp_helper;
27
28		/**
29		* @var \OTPAuthenticate\OTPAuthenticate
30		*/
31		private $otp;
32
33		/**
34		* @var \phpbb\db\driver\driver_interface
35		*/
36		private $db;
37
38		/**
39		* @var \phpbb\user
40		*/
41		private $user;
42
43		/**
44		* @var \phpbb\request\request_interface
45		*/
46		private $request;
47
48		/**
49		* @var \phpbb\template\template
50		*/
51		private $template;
52
53		/**
54		* @var string
55		*/
56		private $otp_registration_table;
57
58		/**
59		* OTP constructor.
60		*
61		* @param \phpbb\db\driver\driver_interface $db
62		* @param \phpbb\user $user
63		* @param \phpbb\request\request_interface $request
64		* @param \phpbb\template\template $template
65		* @param string $otp_registration_table
66		*/
67		public function __construct(driver_interface $db, user $user, request_interface $request, template $template, $otp_registration_table)
68		{
69		$this->otp_helper = new OTPHelper();
70		$this->otp = new OTPAuthenticate();
71		$this->db = $db;
72		$this->user = $user;
73		$this->request = $request;
74		$this->template = $template;
75		$this->otp_registration_table = $otp_registration_table;
76		}
77
78		/**
79		* Get a language key for this specific module.
80		* @return string
81		*/
82		public function get_translatable_name()
83		{
84		return 'OTP';
85		}
86
87		/**
88		* Return the name of the current module
89		* This is for internal use only
90		* @return string
91		*/
92		public function get_name()
93		{
94		return 'otp';
95		}
96
97		/**
98		* Return if this module is enabled by the admin
99		* (And all server requirements are met).
100		*
101		* Do not return false in case a specific user disabled this module,
102		* OR if the user is unable to use this specific module,
103		* OR if a browser specific item is missing/incorrect.
104		* @return boolean
105		*/
106		public function is_enabled()
107		{
108		return true;
109		}
110
111		/**
112		* Check if the current user is able to use this module.
113		*
114		* This means that the user enabled it in the UCP,
115		* And has it setup up correctly.
116		* This method will be called during login, not during registration/
117		*
118		* @param int $user_id
119		*
120		* @return bool
121		*/
122	View Code Duplication	public function is_usable($user_id)
		0 ignored issues – show Duplication introduced 2016-08-05 14:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		{
124		$sql = 'SELECT COUNT(registration_id) as reg_id
125		FROM ' . $this->otp_registration_table . '
126		WHERE
127		user_id = ' . (int) $user_id;
128		$result = $this->db->sql_query($sql);
129		$row = $this->db->sql_fetchrow($result);
130		$this->db->sql_freeresult($result);
131
132		return $row && $row['reg_id'] > 0;
133		}
134
135		/**
136		* Check if the user can potentially use this.
137		* This method is called at registration page.
138		*
139		* You can, for example, check if the current browser is suitable.
140		*
141		* @param int\|boolean $user_id Use false to ignore user
142		*
143		* @return bool
144		*/
145		public function is_potentially_usable($user_id = false)
146		{
147		return true;
148		}
149
150		/**
151		* Get the priority for this module.
152		* A lower priority means more chance it gets selected as default option
153		*
154		* There can be only one module with a specific priority!
155		* If there is already a module registered with this priority,
156		* a Exception might be thrown
157		*
158		* @return int
159		*/
160		public function get_priority()
161		{
162		return 15;
163		}
164
165		/**
166		* Start of the login procedure.
167		*
168		* @param int $user_id
169		*
170		* @return int
171		*/
172		public function login_start($user_id)
173		{
174		// TODO: Implement login_start() method.
175		}
176
177		/**
178		* Actual login procedure
179		*
180		* @param int $user_id
181		*/
182		public function login($user_id)
183		{
184		// TODO: Implement login() method.
185		}
186
187		/**
188		* If this module can add new keys (Or other things)
189		*
190		* @return boolean
191		*/
192		public function can_register()
193		{
194		return true;
195		}
196
197		/**
198		* Start with the registration of a new security key.
199		* This page should return a name of a template, and
200		* it should assign the required variables for this template.
201		*
202		* @return string
203		*/
204		public function register_start()
205		{
206		$secret = $this->otp->generateSecret();
207		$QR = $this->otp_helper->generateKeyURI('totp', $secret, generate_board_url());
208		$this->template->assign_vars(array(
209		'TFA_QR_CODE' => 'https://chart.googleapis.com/chart?chs=200x200&chld=M\|0&cht=qr&chl=' . $QR,
210		'TFA_SECRET' => $secret,
211		'L_TFA_ADD_OTP_KEY_EXPLAIN' => $this->user->lang('TFA_ADD_OTP_KEY_EXPLAIN', $secret),
212		'S_HIDDEN_FIELDS' => build_hidden_fields(array(
213		'secret' => $secret,
214		)),
215		));
216
217		return 'tfa_otp_ucp_new';
218		}
219
220		/**
221		* Do the actual registration of a new security key.
222		*
223		* @return boolean Result of the registration.
224		* @throws BadRequestHttpException
225		*/
226		public function register()
227		{
228		$secret = $this->request->variable('secret', '');
229		$otp = $this->request->variable('otp', '');
230
231		if (!$this->otp->checkTOTP($secret, $otp))
232		{
233		throw new BadRequestHttpException($this->user->lang('TFA_OTP_INVALID_KEY'));
234		}
235
236		$sql_ary = array(
237		'user_id' => $this->user->data['user_id'],
238		'secret' => $secret,
239		'registered' => time(),
240		'last_used' => time(),
241		);
242
243		$sql = 'INSERT INTO ' . $this->otp_registration_table . ' ' . $this->db->sql_build_array('INSERT', $sql_ary);
244		$this->db->sql_query($sql);
245		}
246
247		/**
248		* This method is called to show the UCP page.
249		* You can assign template variables to the template, or do anything else here.
250		*/
251		public function show_ucp()
252		{
253		$this->show_ucp_complete($this->otp_registration_table);
254		}
255
256		/**
257		* Delete a specific row from the UCP.
258		* The data is based on the data provided in show_ucp.
259		*
260		* @param int $key
261		*
262		* @return void
263		*/
264	View Code Duplication	public function delete($key)
		0 ignored issues – show Duplication introduced 2016-08-05 14:37 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
265		{
266		$sql = 'DELETE FROM ' . $this->otp_registration_table . '
267		WHERE user_id = ' . (int) $this->user->data['user_id'] . '
268		AND registration_id =' . (int) $key;
269
270		$this->db->sql_query($sql);
271		}
272		}
273

paul999 / phpbb_2fa

Push — master ( d043ad...19080b )

otp::is_enabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like