TwoFactorChallengeController - Code Metrics - Inspection of "Merge pull request #9632 from nextcloud/enhancemen..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e3be9e...9444a3 )

by Morris

created 2018-06-25 13:50 UTC

TwoFactorChallengeController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes

Metric	Value
dl	0
loc	170
rs	10
c	0
b	0
f	0
wmc	17
lcom	1
cbo	13

6 Methods

Rating	Name	Size	Complexity
A	__construct()	8	1
A	getLogoutUrl()	3	1
A	splitProvidersAndBackupCodes()	13	3
A	selectChallenge()	15	1
B	showChallenge()	39	6
A	solveChallenge()	29	5

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Christoph Wurst <[email protected]>
 * @author Cornelius Kölbel <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Core\Controller;

use OC\Authentication\TwoFactorAuth\Manager;
use OC_User;
use OC_Util;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\Authentication\TwoFactorAuth\IProvider;
use OCP\Authentication\TwoFactorAuth\IProvidesCustomCSP;
use OCP\Authentication\TwoFactorAuth\TwoFactorException;
use OCP\IRequest;
use OCP\ISession;
use OCP\IURLGenerator;
use OCP\IUserSession;

class TwoFactorChallengeController extends Controller {

	/** @var Manager */
	private $twoFactorManager;

	/** @var IUserSession */
	private $userSession;

	/** @var ISession */
	private $session;

	/** @var IURLGenerator */
	private $urlGenerator;

	/**
	 * @param string $appName
	 * @param IRequest $request
	 * @param Manager $twoFactorManager
	 * @param IUserSession $userSession
	 * @param ISession $session
	 * @param IURLGenerator $urlGenerator
	 */
	public function __construct($appName, IRequest $request, Manager $twoFactorManager, IUserSession $userSession,
		ISession $session, IURLGenerator $urlGenerator) {
		parent::__construct($appName, $request);
		$this->twoFactorManager = $twoFactorManager;
		$this->userSession = $userSession;
		$this->session = $session;
		$this->urlGenerator = $urlGenerator;
	}

	/**
	 * @return string
	 */
	protected function getLogoutUrl() {
		return OC_User::getLogoutUrl($this->urlGenerator);
	}
	
	/**
	 * @param IProvider[] $providers
	 */
	private function splitProvidersAndBackupCodes(array $providers): array {
		$regular = [];
		$backup = null;
		foreach ($providers as $provider) {
			if ($provider->getId() === 'backup_codes') {
				$backup = $provider;
			} else {
				$regular[] = $provider;
			}
		}

		return [$regular, $backup];
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @param string $redirect_url
	 * @return TemplateResponse
	 */
	public function selectChallenge($redirect_url) {
		$user = $this->userSession->getUser();
		$providerSet = $this->twoFactorManager->getProviderSet($user);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		$allProviders = $providerSet->getProviders();
		list($providers, $backupProvider) = $this->splitProvidersAndBackupCodes($allProviders);

		$data = [
			'providers' => $providers,
			'backupProvider' => $backupProvider,
			'providerMissing' => $providerSet->isProviderMissing(),
			'redirect_url' => $redirect_url,
			'logout_url' => $this->getLogoutUrl(),
		];
		return new TemplateResponse($this->appName, 'twofactorselectchallenge', $data, 'guest');
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 * @UseSession
	 *
	 * @param string $challengeProviderId
	 * @param string $redirect_url
	 * @return TemplateResponse|RedirectResponse
	 */
	public function showChallenge($challengeProviderId, $redirect_url) {
		$user = $this->userSession->getUser();
		$providerSet = $this->twoFactorManager->getProviderSet($user);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		$provider = $providerSet->getProvider($challengeProviderId);
		if (is_null($provider)) {
			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
		}

		$backupProvider = $providerSet->getProvider('backup_codes');
		if (!is_null($backupProvider) && $backupProvider->getId() === $provider->getId()) {
			// Don't show the backup provider link if we're already showing that provider's challenge
			$backupProvider = null;
		}

		$errorMessage = '';
		$error = false;
		if ($this->session->exists('two_factor_auth_error')) {
			$this->session->remove('two_factor_auth_error');
			$error = true;
			$errorMessage = $this->session->get("two_factor_auth_error_message");
			$this->session->remove('two_factor_auth_error_message');
		}
		$tmpl = $provider->getTemplate($user);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		$tmpl->assign('redirect_url', $redirect_url);
		$data = [
			'error' => $error,
			'error_message' => $errorMessage,
			'provider' => $provider,
			'backupProvider' => $backupProvider,
			'logout_url' => $this->getLogoutUrl(),
			'redirect_url' => $redirect_url,
			'template' => $tmpl->fetchPage(),
		];
		$response = new TemplateResponse($this->appName, 'twofactorshowchallenge', $data, 'guest');
		if ($provider instanceof IProvidesCustomCSP) {
			$response->setContentSecurityPolicy($provider->getCSP());
		}
		return $response;
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 * @UseSession
	 *
	 * @UserRateThrottle(limit=5, period=100)
	 *
	 * @param string $challengeProviderId
	 * @param string $challenge
	 * @param string $redirect_url
	 * @return RedirectResponse
	 */
	public function solveChallenge($challengeProviderId, $challenge, $redirect_url = null) {
		$user = $this->userSession->getUser();
		$provider = $this->twoFactorManager->getProvider($user, $challengeProviderId);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		if (is_null($provider)) {
			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
		}

		try {
			if ($this->twoFactorManager->verifyChallenge($challengeProviderId, $user, $challenge)) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
				if (!is_null($redirect_url)) {
					return new RedirectResponse($this->urlGenerator->getAbsoluteURL(urldecode($redirect_url)));
				}
				return new RedirectResponse(OC_Util::getDefaultPageUrl());
			}
		} catch (TwoFactorException $e) {
			/*
			 * The 2FA App threw an TwoFactorException. Now we display more
			 * information to the user. The exception text is stored in the
			 * session to be used in showChallenge()
			 */
			$this->session->set('two_factor_auth_error_message', $e->getMessage());
		}

		$this->session->set('two_factor_auth_error', true);
		return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.showChallenge', [
			'challengeProviderId' => $provider->getId(),
			'redirect_url' => $redirect_url,
		]));
	}

}


1			<?php
2			/**
3			* @copyright Copyright (c) 2016, ownCloud, Inc.
4			*
5			* @author Christoph Wurst <[email protected]>
6			* @author Cornelius Kölbel <[email protected]>
7			* @author Joas Schilling <[email protected]>
8			* @author Lukas Reschke <[email protected]>
9			* @author Roeland Jago Douma <[email protected]>
10			*
11			* @license AGPL-3.0
12			*
13			* This code is free software: you can redistribute it and/or modify
14			* it under the terms of the GNU Affero General Public License, version 3,
15			* as published by the Free Software Foundation.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU Affero General Public License for more details.
21			*
22			* You should have received a copy of the GNU Affero General Public License, version 3,
23			* along with this program. If not, see <http://www.gnu.org/licenses/>
24			*
25			*/
26
27			namespace OC\Core\Controller;
28
29			use OC\Authentication\TwoFactorAuth\Manager;
30			use OC_User;
31			use OC_Util;
32			use OCP\AppFramework\Controller;
33			use OCP\AppFramework\Http\RedirectResponse;
34			use OCP\AppFramework\Http\TemplateResponse;
35			use OCP\Authentication\TwoFactorAuth\IProvider;
36			use OCP\Authentication\TwoFactorAuth\IProvidesCustomCSP;
37			use OCP\Authentication\TwoFactorAuth\TwoFactorException;
38			use OCP\IRequest;
39			use OCP\ISession;
40			use OCP\IURLGenerator;
41			use OCP\IUserSession;
42
43			class TwoFactorChallengeController extends Controller {
44
45			/** @var Manager */
46			private $twoFactorManager;
47
48			/** @var IUserSession */
49			private $userSession;
50
51			/** @var ISession */
52			private $session;
53
54			/** @var IURLGenerator */
55			private $urlGenerator;
56
57			/**
58			* @param string $appName
59			* @param IRequest $request
60			* @param Manager $twoFactorManager
61			* @param IUserSession $userSession
62			* @param ISession $session
63			* @param IURLGenerator $urlGenerator
64			*/
65			public function __construct($appName, IRequest $request, Manager $twoFactorManager, IUserSession $userSession,
66			ISession $session, IURLGenerator $urlGenerator) {
67			parent::__construct($appName, $request);
68			$this->twoFactorManager = $twoFactorManager;
69			$this->userSession = $userSession;
70			$this->session = $session;
71			$this->urlGenerator = $urlGenerator;
72			}
73
74			/**
75			* @return string
76			*/
77			protected function getLogoutUrl() {
78			return OC_User::getLogoutUrl($this->urlGenerator);
79			}
80
81			/**
82			* @param IProvider[] $providers
83			*/
84			private function splitProvidersAndBackupCodes(array $providers): array {
85			$regular = [];
86			$backup = null;
87			foreach ($providers as $provider) {
88			if ($provider->getId() === 'backup_codes') {
89			$backup = $provider;
90			} else {
91			$regular[] = $provider;
92			}
93			}
94
95			return [$regular, $backup];
96			}
97
98			/**
99			* @NoAdminRequired
100			* @NoCSRFRequired
101			*
102			* @param string $redirect_url
103			* @return TemplateResponse
104			*/
105			public function selectChallenge($redirect_url) {
106			$user = $this->userSession->getUser();
107			$providerSet = $this->twoFactorManager->getProviderSet($user);
			0 ignored issues – show Bug introduced 2018-05-28 12:34 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->userSession->getUser()` on line `106` can be `null`; however, `OC\Authentication\TwoFac...nager::getProviderSet()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
108			$allProviders = $providerSet->getProviders();
109			list($providers, $backupProvider) = $this->splitProvidersAndBackupCodes($allProviders);
110
111			$data = [
112			'providers' => $providers,
113			'backupProvider' => $backupProvider,
114			'providerMissing' => $providerSet->isProviderMissing(),
115			'redirect_url' => $redirect_url,
116			'logout_url' => $this->getLogoutUrl(),
117			];
118			return new TemplateResponse($this->appName, 'twofactorselectchallenge', $data, 'guest');
119			}
120
121			/**
122			* @NoAdminRequired
123			* @NoCSRFRequired
124			* @UseSession
125			*
126			* @param string $challengeProviderId
127			* @param string $redirect_url
128			* @return TemplateResponse\|RedirectResponse
129			*/
130			public function showChallenge($challengeProviderId, $redirect_url) {
131			$user = $this->userSession->getUser();
132			$providerSet = $this->twoFactorManager->getProviderSet($user);
			0 ignored issues – show Bug introduced 2018-05-28 12:34 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->userSession->getUser()` on line `131` can be `null`; however, `OC\Authentication\TwoFac...nager::getProviderSet()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
133			$provider = $providerSet->getProvider($challengeProviderId);
134			if (is_null($provider)) {
135			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
136			}
137
138			$backupProvider = $providerSet->getProvider('backup_codes');
139			if (!is_null($backupProvider) && $backupProvider->getId() === $provider->getId()) {
140			// Don't show the backup provider link if we're already showing that provider's challenge
141			$backupProvider = null;
142			}
143
144			$errorMessage = '';
145			$error = false;
146			if ($this->session->exists('two_factor_auth_error')) {
147			$this->session->remove('two_factor_auth_error');
148			$error = true;
149			$errorMessage = $this->session->get("two_factor_auth_error_message");
150			$this->session->remove('two_factor_auth_error_message');
151			}
152			$tmpl = $provider->getTemplate($user);
			0 ignored issues – show Bug introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->userSession->getUser()` on line `131` can be `null`; however, `OCP\Authentication\TwoFa...Provider::getTemplate()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
153			$tmpl->assign('redirect_url', $redirect_url);
154			$data = [
155			'error' => $error,
156			'error_message' => $errorMessage,
157			'provider' => $provider,
158			'backupProvider' => $backupProvider,
159			'logout_url' => $this->getLogoutUrl(),
160			'redirect_url' => $redirect_url,
161			'template' => $tmpl->fetchPage(),
162			];
163			$response = new TemplateResponse($this->appName, 'twofactorshowchallenge', $data, 'guest');
164			if ($provider instanceof IProvidesCustomCSP) {
165			$response->setContentSecurityPolicy($provider->getCSP());
166			}
167			return $response;
168			}
169
170			/**
171			* @NoAdminRequired
172			* @NoCSRFRequired
173			* @UseSession
174			*
175			* @UserRateThrottle(limit=5, period=100)
176			*
177			* @param string $challengeProviderId
178			* @param string $challenge
179			* @param string $redirect_url
180			* @return RedirectResponse
181			*/
182			public function solveChallenge($challengeProviderId, $challenge, $redirect_url = null) {
183			$user = $this->userSession->getUser();
184			$provider = $this->twoFactorManager->getProvider($user, $challengeProviderId);
			0 ignored issues – show Bug introduced 2016-06-09 12:21 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->userSession->getUser()` on line `183` can be `null`; however, `OC\Authentication\TwoFac...\Manager::getProvider()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
185			if (is_null($provider)) {
186			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
187			}
188
189			try {
190			if ($this->twoFactorManager->verifyChallenge($challengeProviderId, $user, $challenge)) {
			0 ignored issues – show Bug introduced 2017-04-18 10:59 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$this->userSession->getUser()` on line `183` can be `null`; however, `OC\Authentication\TwoFac...ager::verifyChallenge()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
191			if (!is_null($redirect_url)) {
192			return new RedirectResponse($this->urlGenerator->getAbsoluteURL(urldecode($redirect_url)));
193			}
194			return new RedirectResponse(OC_Util::getDefaultPageUrl());
195			}
196			} catch (TwoFactorException $e) {
197			/*
198			* The 2FA App threw an TwoFactorException. Now we display more
199			* information to the user. The exception text is stored in the
200			* session to be used in showChallenge()
201			*/
202			$this->session->set('two_factor_auth_error_message', $e->getMessage());
203			}
204
205			$this->session->set('two_factor_auth_error', true);
206			return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.showChallenge', [
207			'challengeProviderId' => $provider->getId(),
208			'redirect_url' => $redirect_url,
209			]));
210			}
211
212			}
213

nextcloud / server

Push — master ( e3be9e...9444a3 )

TwoFactorChallengeController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like