nextcloud/core/Controller/TwoFactorChallengeControlle...

282 lines
8.5 KiB
PHP
Raw Permalink Normal View History

2016-05-11 12:23:25 +03:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Cornelius Kölbel <cornelius.koelbel@netknights.it>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2016-05-11 12:23:25 +03:00
*
* @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/>
2016-05-11 12:23:25 +03:00
*
*/
namespace OC\Core\Controller;
use OC\Authentication\TwoFactorAuth\Manager;
use OC_User;
use OC_Util;
2016-05-11 12:23:25 +03:00
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\AppFramework\Http\StandaloneTemplateResponse;
use OCP\Authentication\TwoFactorAuth\IActivatableAtLogin;
use OCP\Authentication\TwoFactorAuth\IProvider;
use OCP\Authentication\TwoFactorAuth\IProvidesCustomCSP;
use OCP\Authentication\TwoFactorAuth\TwoFactorException;
2016-05-11 12:23:25 +03:00
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;
}
2016-06-07 18:53:00 +03:00
/**
* @return string
*/
protected function getLogoutUrl() {
return OC_User::getLogoutUrl($this->urlGenerator);
2016-06-07 18:53:00 +03:00
}
/**
* @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];
}
2016-06-07 18:53:00 +03:00
2016-05-11 12:23:25 +03:00
/**
* @NoAdminRequired
2016-05-11 12:23:25 +03:00
* @NoCSRFRequired
* @TwoFactorSetUpDoneRequired
2016-05-11 12:23:25 +03:00
*
* @param string $redirect_url
* @return StandaloneTemplateResponse
2016-05-11 12:23:25 +03:00
*/
public function selectChallenge($redirect_url) {
2016-05-11 12:23:25 +03:00
$user = $this->userSession->getUser();
$providerSet = $this->twoFactorManager->getProviderSet($user);
$allProviders = $providerSet->getProviders();
[$providers, $backupProvider] = $this->splitProvidersAndBackupCodes($allProviders);
$setupProviders = $this->twoFactorManager->getLoginSetupProviders($user);
2016-05-11 12:23:25 +03:00
$data = [
'providers' => $providers,
'backupProvider' => $backupProvider,
'providerMissing' => $providerSet->isProviderMissing(),
'redirect_url' => $redirect_url,
'logout_url' => $this->getLogoutUrl(),
'hasSetupProviders' => !empty($setupProviders),
2016-05-11 12:23:25 +03:00
];
return new StandaloneTemplateResponse($this->appName, 'twofactorselectchallenge', $data, 'guest');
2016-05-11 12:23:25 +03:00
}
/**
* @NoAdminRequired
2016-05-11 12:23:25 +03:00
* @NoCSRFRequired
* @UseSession
* @TwoFactorSetUpDoneRequired
2016-05-11 12:23:25 +03:00
*
* @param string $challengeProviderId
* @param string $redirect_url
* @return StandaloneTemplateResponse|RedirectResponse
2016-05-11 12:23:25 +03:00
*/
public function showChallenge($challengeProviderId, $redirect_url) {
2016-05-11 12:23:25 +03:00
$user = $this->userSession->getUser();
$providerSet = $this->twoFactorManager->getProviderSet($user);
$provider = $providerSet->getProvider($challengeProviderId);
2016-05-11 12:23:25 +03:00
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;
2016-05-11 12:23:25 +03:00
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');
2016-05-11 12:23:25 +03:00
}
$tmpl = $provider->getTemplate($user);
$tmpl->assign('redirect_url', $redirect_url);
2016-05-11 12:23:25 +03:00
$data = [
'error' => $error,
'error_message' => $errorMessage,
2016-05-11 12:23:25 +03:00
'provider' => $provider,
'backupProvider' => $backupProvider,
'logout_url' => $this->getLogoutUrl(),
'redirect_url' => $redirect_url,
'template' => $tmpl->fetchPage(),
2016-05-11 12:23:25 +03:00
];
$response = new StandaloneTemplateResponse($this->appName, 'twofactorshowchallenge', $data, 'guest');
if ($provider instanceof IProvidesCustomCSP) {
$response->setContentSecurityPolicy($provider->getCSP());
}
return $response;
2016-05-11 12:23:25 +03:00
}
/**
* @NoAdminRequired
2016-05-11 12:23:25 +03:00
* @NoCSRFRequired
* @UseSession
* @TwoFactorSetUpDoneRequired
2016-05-11 12:23:25 +03:00
*
* @UserRateThrottle(limit=5, period=100)
*
2016-05-11 12:23:25 +03:00
* @param string $challengeProviderId
* @param string $challenge
* @param string $redirect_url
2016-05-11 12:23:25 +03:00
* @return RedirectResponse
*/
public function solveChallenge($challengeProviderId, $challenge, $redirect_url = null) {
2016-05-11 12:23:25 +03:00
$user = $this->userSession->getUser();
$provider = $this->twoFactorManager->getProvider($user, $challengeProviderId);
if (is_null($provider)) {
return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
}
try {
if ($this->twoFactorManager->verifyChallenge($challengeProviderId, $user, $challenge)) {
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());
2016-05-11 12:23:25 +03:00
}
$this->session->set('two_factor_auth_error', true);
return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.showChallenge', [
'challengeProviderId' => $provider->getId(),
'redirect_url' => $redirect_url,
]));
2016-05-11 12:23:25 +03:00
}
/**
* @NoAdminRequired
* @NoCSRFRequired
*/
public function setupProviders() {
$user = $this->userSession->getUser();
$setupProviders = $this->twoFactorManager->getLoginSetupProviders($user);
$data = [
'providers' => $setupProviders,
'logout_url' => $this->getLogoutUrl(),
];
$response = new StandaloneTemplateResponse($this->appName, 'twofactorsetupselection', $data, 'guest');
return $response;
}
/**
* @NoAdminRequired
* @NoCSRFRequired
*/
public function setupProvider(string $providerId) {
$user = $this->userSession->getUser();
$providers = $this->twoFactorManager->getLoginSetupProviders($user);
$provider = null;
foreach ($providers as $p) {
if ($p->getId() === $providerId) {
$provider = $p;
break;
}
}
if ($provider === null) {
return new RedirectResponse($this->urlGenerator->linkToRoute('core.TwoFactorChallenge.selectChallenge'));
}
/** @var IActivatableAtLogin $provider */
$tmpl = $provider->getLoginSetup($user)->getBody();
$data = [
'provider' => $provider,
'logout_url' => $this->getLogoutUrl(),
'template' => $tmpl->fetchPage(),
];
$response = new StandaloneTemplateResponse($this->appName, 'twofactorsetupchallenge', $data, 'guest');
return $response;
}
/**
* @NoAdminRequired
* @NoCSRFRequired
*
* @todo handle the extreme edge case of an invalid provider ID and redirect to the provider selection page
*/
public function confirmProviderSetup(string $providerId) {
return new RedirectResponse($this->urlGenerator->linkToRoute(
'core.TwoFactorChallenge.showChallenge',
[
'challengeProviderId' => $providerId,
]
));
}
2016-05-11 12:23:25 +03:00
}