session_helper::isTfaRequired() - Code Metrics - Inspection of "Fix a few language related issues." - paul999/phpbb_2fa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Paul

created 2019-09-05 22:04 UTC

session_helper::isTfaRequired() B

↳ Parent: session_helper

Complexity

Conditions	8
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	28
rs	8.4444
c	0
b	0
f	0
cc	8
nc	8
nop	3

<?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\helper;

use paul999\tfa\exceptions\module_exception;
use paul999\tfa\modules\module_interface;
use phpbb\auth\auth;
use phpbb\config\config;
use phpbb\controller\helper;
use phpbb\db\driver\driver_interface;
use phpbb\di\service_collection;
use phpbb\template\template;
use phpbb\user;

/**
 * helper method which is used to detect if a user needs to use 2FA
 */
class session_helper implements session_helper_interface
{
	/**
	 * @var driver_interface
	 */
	private $db;

	/**
	 * @var config
	 */
	private $config;

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

	/**
	 * @var array
	 */
	private $modules = array();

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

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

	/**
	 * @var array
	 */
	private $user_array = array();

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

	/**
	 * @var \phpbb\controller\helper
	 */
	private $controller_helper;

	/**
	 * Constructor
	 *
	 * @access public
	 *
	 * @param driver_interface         $db
	 * @param config                   $config
	 * @param user                     $user
	 * @param service_collection       $modules
	 * @param \phpbb\template\template $template
	 * @param \phpbb\controller\helper $controller_helper
	 * @param string                   $registration_table
	 * @param string                   $user_table
	 */
	public function __construct(driver_interface $db, config $config, user $user, service_collection $modules, template $template, helper $controller_helper, $registration_table, $user_table)

	{
		$this->db					= $db;
		$this->user					= $user;
		$this->config				= $config;
		$this->template 			= $template;
		$this->controller_helper 	= $controller_helper;
		$this->registration_table	= $registration_table;
		$this->user_table			= $user_table;

		$this->validateModules($modules);

	}

	/**
	 * Register the tagged modules if they are enabled.
	 * @param service_collection $modules
	 */
	private function validateModules(service_collection $modules)
	{
		/**
		 * @var module_interface $module
		 */
		foreach ($modules as $module)
		{
			if ($module instanceof module_interface)
			{
				// Only add them if they are actually a module_interface.
				$priority = $module->get_priority();
				if (isset($this->modules[$module->get_priority()]))
				{
					throw new module_exception(400, 'TFA_DOUBLE_PRIORITY', array($priority, get_class($module), get_class($this->modules[$priority])));
				}
				if ($module->is_enabled())
				{
					$this->modules[$priority] = $module;
				}
			}
		}
	}

	/**
	 * @param $requested_module
	 * @return null|module_interface
	 */
	public function findModule($requested_module)
	{
		/**
		 * @var module_interface $module
		 */
		foreach ($this->getModules() as $module)
		{
			if ($module->get_name() == $requested_module)
			{
				return $module;
			}
		}
		return null;
	}

	/**
	 * @return array
	 */
	public function getModules()
	{
		return $this->modules;
	}

	/**
	 * @param int $user_id
	 * @param bool $admin
	 * @param array $userdata
	 * @return bool
	 */
	public function isTfaRequired($user_id, $admin = false, $userdata = array())
	{
		if (sizeof($this->modules) == 0)
		{
			return false;
		}
		switch ($this->config['tfa_mode'])
		{
			case session_helper_interface::MODE_DISABLED:
				return false;

			case session_helper_interface::MODE_NOT_REQUIRED:
				return $this->isTfaRegistered($user_id);

			case session_helper_interface::MODE_REQUIRED_FOR_ACP_LOGIN:
			case session_helper_interface::MODE_REQUIRED_FOR_ADMIN:
				return $this->do_permission_check($user_id, $userdata, 'a_');

			case session_helper_interface::MODE_REQUIRED_FOR_MODERATOR:
				return $this->do_permission_check($user_id, $userdata, array('m_', 'a_'));

			case session_helper_interface::MODE_REQUIRED:
				return true;

			default:
				return false;
		}
	}

	/**
	 * Check if the user has two factor authentication added to his account.
	 *
	 * @param int $user_id
	 * @return bool
	 */
	public function isTfaRegistered($user_id)
	{
		if (isset($this->user_array[$user_id]))
		{
			return $this->user_array[$user_id];
		}

		$this->user_array[$user_id] = false; // Preset to false.

		/**
		 * @var int $priority
		 * @var module_interface $module
		 */
		foreach ($this->modules as $priority => $module)
		{
			$this->user_array[$user_id] = $this->user_array[$user_id] || $module->is_usable($user_id);
		}
		return $this->user_array[$user_id];
	}

	/**
	 * Check if the user has any key registred, even if the module is not available.
	 *
	 * @param int $user_id
	 * @return bool
	 */
	public function isTfaKeyRegistred($user_id)
	{
		/**
		 * @var int $priority
		 * @var module_interface $module
		 */
		foreach ($this->modules as $priority => $module)
		{
			if ($module->key_registered($user_id)) {
				return true;
			}
		}
		return false;
	}


	/**
	 * @param int $user_id
	 * @param bool $admin
	 * @param bool $auto_login
	 * @param bool $viewonline
	 * @param string $redirect
	 * @param bool $secure
	 * @throws \Exception
	 */
	public function generate_page($user_id, $admin, $auto_login, $viewonline, $redirect, $secure = false)
	{
		$this->user->add_lang_ext('paul999/tfa', 'common');

		$modules = $this->getModules();

		/**
		 * @var module_interface $row
		 */
		foreach ($modules as $row)
		{
			if ($row->is_usable($user_id))
			{
				$this->template->assign_block_vars('tfa_options', array_merge(array(
					'ID'	=> $row->get_name(),
					'NAME'	=> $this->user->lang($row->get_translatable_name()),

					'U_SUBMIT_AUTH'	=> $this->controller_helper->route('paul999_tfa_read_controller_submit', array(
						'user_id'		=> (int) $user_id,
						'admin'			=> (int) $admin,
						'auto_login'	=> (int) $auto_login,
						'viewonline'	=> (int) $viewonline,
						'class'			=> $row->get_name(),
					)),
					'S_HIDDEN_FIELDS' => build_hidden_fields(['sid' => $this->user->session_id]),
				), $row->login_start($user_id)));
			}
		}

		add_form_key('tfa_login_page');

		$random = sha1(random_bytes(32));

		$sql_ary = array(
			'tfa_random' 	=> $random,
			'tfa_uid'		=> $user_id,
		);
		$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . "
			WHERE
				session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "' AND
				session_user_id = " . (int) $this->user->data['user_id'];
		$this->db->sql_query($sql);

		$this->template->assign_vars(array(
			'REDIRECT'		=> $redirect,
			'RANDOM'		=> $random,
			'RELOGIN_NOTE'	=> $secure,
		));

		page_header('TFA_KEY_REQUIRED');

		$this->template->set_filenames(array(
			'body' => '@paul999_tfa/authenticate_main.html'
		));
		page_footer(false); // Do not include cron on this page!
	}

	/**
	 * Return the userdata for a specific user.
	 *
	 * @param int $user_id
	 * @param array $userdata
	 * @return array
	 */
	private function user_data($user_id, $userdata = array())
	{
		if (empty($userdata))
		{
			$sql = 'SELECT * FROM ' . $this->user_table . ' WHERE user_id = ' . (int) $user_id;
			$result = $this->db->sql_query($sql);
			$userdata = $this->db->sql_fetchrow($result);
			$this->db->sql_freeresult($result);
		}
		return $userdata;
	}

	/**
	 * @param int $user_id
	 * @param array $userdata
	 * @param string|array $permission
	 * @return bool
	 */
	private function do_permission_check($user_id, $userdata, $permission)
	{
		if ($this->isTfaRegistered($user_id))
		{
			return true;
		}
		$userdata = $this->user_data($user_id, $userdata);
		$auth = new auth();
		$auth->acl($userdata);

		if (!is_array($permission))
		{
			$permission = array($permission);
		}
		foreach ($permission as $perm)
		{
			if ($auth->acl_get($perm))
			{
				return true;
			}
		}
		return false;
	}
}


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\helper;
12
13		use paul999\tfa\exceptions\module_exception;
14		use paul999\tfa\modules\module_interface;
15		use phpbb\auth\auth;
16		use phpbb\config\config;
17		use phpbb\controller\helper;
18		use phpbb\db\driver\driver_interface;
19		use phpbb\di\service_collection;
20		use phpbb\template\template;
21		use phpbb\user;
22
23		/**
24		* helper method which is used to detect if a user needs to use 2FA
25		*/
26		class session_helper implements session_helper_interface
27		{
28		/**
29		* @var driver_interface
30		*/
31		private $db;
32
33		/**
34		* @var config
35		*/
36		private $config;
37
38		/**
39		* @var user
40		*/
41		private $user;
42
43		/**
44		* @var array
45		*/
46		private $modules = array();
47
48		/**
49		* @var string
50		*/
51		private $registration_table;
52
53		/**
54		* @var string
55		*/
56		private $user_table;
57
58		/**
59		* @var array
60		*/
61		private $user_array = array();
62
63		/**
64		* @var \phpbb\template\template
65		*/
66		private $template;
67
68		/**
69		* @var \phpbb\controller\helper
70		*/
71		private $controller_helper;
72
73		/**
74		* Constructor
75		*
76		* @access public
77		*
78		* @param driver_interface $db
79		* @param config $config
80		* @param user $user
81		* @param service_collection $modules
82		* @param \phpbb\template\template $template
83		* @param \phpbb\controller\helper $controller_helper
84		* @param string $registration_table
85		* @param string $user_table
86		*/
87	View Code Duplication	public function __construct(driver_interface $db, config $config, user $user, service_collection $modules, template $template, helper $controller_helper, $registration_table, $user_table)
		0 ignored issues – show Duplication introduced 2016-08-06 15:26 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...
88		{
89		$this->db = $db;
90		$this->user = $user;
91		$this->config = $config;
92		$this->template = $template;
93		$this->controller_helper = $controller_helper;
94		$this->registration_table = $registration_table;
95		$this->user_table = $user_table;
96
97		$this->validateModules($modules);
98
99		}
100
101		/**
102		* Register the tagged modules if they are enabled.
103		* @param service_collection $modules
104		*/
105		private function validateModules(service_collection $modules)
106		{
107		/**
108		* @var module_interface $module
109		*/
110		foreach ($modules as $module)
111		{
112		if ($module instanceof module_interface)
113		{
114		// Only add them if they are actually a module_interface.
115		$priority = $module->get_priority();
116		if (isset($this->modules[$module->get_priority()]))
117		{
118		throw new module_exception(400, 'TFA_DOUBLE_PRIORITY', array($priority, get_class($module), get_class($this->modules[$priority])));
119		}
120		if ($module->is_enabled())
121		{
122		$this->modules[$priority] = $module;
123		}
124		}
125		}
126		}
127
128		/**
129		* @param $requested_module
130		* @return null\|module_interface
131		*/
132		public function findModule($requested_module)
133		{
134		/**
135		* @var module_interface $module
136		*/
137		foreach ($this->getModules() as $module)
138		{
139		if ($module->get_name() == $requested_module)
140		{
141		return $module;
142		}
143		}
144		return null;
145		}
146
147		/**
148		* @return array
149		*/
150		public function getModules()
151		{
152		return $this->modules;
153		}
154
155		/**
156		* @param int $user_id
157		* @param bool $admin
158		* @param array $userdata
159		* @return bool
160		*/
161		public function isTfaRequired($user_id, $admin = false, $userdata = array())
162		{
163		if (sizeof($this->modules) == 0)
164		{
165		return false;
166		}
167		switch ($this->config['tfa_mode'])
168		{
169		case session_helper_interface::MODE_DISABLED:
170		return false;
171
172		case session_helper_interface::MODE_NOT_REQUIRED:
173		return $this->isTfaRegistered($user_id);
174
175		case session_helper_interface::MODE_REQUIRED_FOR_ACP_LOGIN:
176		case session_helper_interface::MODE_REQUIRED_FOR_ADMIN:
177		return $this->do_permission_check($user_id, $userdata, 'a_');
178
179		case session_helper_interface::MODE_REQUIRED_FOR_MODERATOR:
180		return $this->do_permission_check($user_id, $userdata, array('m_', 'a_'));
181
182		case session_helper_interface::MODE_REQUIRED:
183		return true;
184
185		default:
186		return false;
187		}
188		}
189
190		/**
191		* Check if the user has two factor authentication added to his account.
192		*
193		* @param int $user_id
194		* @return bool
195		*/
196		public function isTfaRegistered($user_id)
197		{
198		if (isset($this->user_array[$user_id]))
199		{
200		return $this->user_array[$user_id];
201		}
202
203		$this->user_array[$user_id] = false; // Preset to false.
204
205		/**
206		* @var int $priority
207		* @var module_interface $module
208		*/
209		foreach ($this->modules as $priority => $module)
210		{
211		$this->user_array[$user_id] = $this->user_array[$user_id] \|\| $module->is_usable($user_id);
212		}
213		return $this->user_array[$user_id];
214		}
215
216		/**
217		* Check if the user has any key registred, even if the module is not available.
218		*
219		* @param int $user_id
220		* @return bool
221		*/
222		public function isTfaKeyRegistred($user_id)
223		{
224		/**
225		* @var int $priority
226		* @var module_interface $module
227		*/
228		foreach ($this->modules as $priority => $module)
229		{
230		if ($module->key_registered($user_id)) {
231		return true;
232		}
233		}
234		return false;
235		}
236
237
238		/**
239		* @param int $user_id
240		* @param bool $admin
241		* @param bool $auto_login
242		* @param bool $viewonline
243		* @param string $redirect
244		* @param bool $secure
245		* @throws \Exception
246		*/
247		public function generate_page($user_id, $admin, $auto_login, $viewonline, $redirect, $secure = false)
248		{
249		$this->user->add_lang_ext('paul999/tfa', 'common');
		0 ignored issues – show Deprecated Code introduced 2018-03-24 13:08 UTC by Report Bug Copy Issue Report The method `phpbb\user::add_lang_ext()` has been deprecated with message: : 3.2.0-dev (To be removed: 3.3.0) This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
250		$modules = $this->getModules();
251
252		/**
253		* @var module_interface $row
254		*/
255		foreach ($modules as $row)
256		{
257		if ($row->is_usable($user_id))
258		{
259		$this->template->assign_block_vars('tfa_options', array_merge(array(
260		'ID' => $row->get_name(),
261		'NAME' => $this->user->lang($row->get_translatable_name()),
		0 ignored issues – show Deprecated Code introduced 2018-03-24 13:08 UTC by Report Bug Copy Issue Report The method `phpbb\user::lang()` has been deprecated with message: 3.2.0-dev (To be removed 4.0.0) This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
262		'U_SUBMIT_AUTH' => $this->controller_helper->route('paul999_tfa_read_controller_submit', array(
263		'user_id' => (int) $user_id,
264		'admin' => (int) $admin,
265		'auto_login' => (int) $auto_login,
266		'viewonline' => (int) $viewonline,
267		'class' => $row->get_name(),
268		)),
269		'S_HIDDEN_FIELDS' => build_hidden_fields(['sid' => $this->user->session_id]),
270		), $row->login_start($user_id)));
271		}
272		}
273
274		add_form_key('tfa_login_page');
275
276		$random = sha1(random_bytes(32));
277
278		$sql_ary = array(
279		'tfa_random' => $random,
280		'tfa_uid' => $user_id,
281		);
282		$sql = 'UPDATE ' . SESSIONS_TABLE . ' SET ' . $this->db->sql_build_array('UPDATE', $sql_ary) . "
283		WHERE
284		session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "' AND
285		session_user_id = " . (int) $this->user->data['user_id'];
286		$this->db->sql_query($sql);
287
288		$this->template->assign_vars(array(
289		'REDIRECT' => $redirect,
290		'RANDOM' => $random,
291		'RELOGIN_NOTE' => $secure,
292		));
293
294		page_header('TFA_KEY_REQUIRED');
295
296		$this->template->set_filenames(array(
297		'body' => '@paul999_tfa/authenticate_main.html'
298		));
299		page_footer(false); // Do not include cron on this page!
300		}
301
302		/**
303		* Return the userdata for a specific user.
304		*
305		* @param int $user_id
306		* @param array $userdata
307		* @return array
308		*/
309		private function user_data($user_id, $userdata = array())
310		{
311		if (empty($userdata))
312		{
313		$sql = 'SELECT * FROM ' . $this->user_table . ' WHERE user_id = ' . (int) $user_id;
314		$result = $this->db->sql_query($sql);
315		$userdata = $this->db->sql_fetchrow($result);
316		$this->db->sql_freeresult($result);
317		}
318		return $userdata;
319		}
320
321		/**
322		* @param int $user_id
323		* @param array $userdata
324		* @param string\|array $permission
325		* @return bool
326		*/
327		private function do_permission_check($user_id, $userdata, $permission)
328		{
329		if ($this->isTfaRegistered($user_id))
330		{
331		return true;
332		}
333		$userdata = $this->user_data($user_id, $userdata);
334		$auth = new auth();
335		$auth->acl($userdata);
336
337		if (!is_array($permission))
338		{
339		$permission = array($permission);
340		}
341		foreach ($permission as $perm)
342		{
343		if ($auth->acl_get($perm))
344		{
345		return true;
346		}
347		}
348		return false;
349		}
350		}
351

paul999 / phpbb_2fa

Pull Request — master (#17)

session_helper::isTfaRequired() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like