nextcloud/apps/federation/lib/Controller/OCSAuthAPIController.php

213 lines
5.6 KiB
PHP
Raw Normal View History

2015-11-10 12:50:59 +03:00
<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
* @author Lukas Reschke <lukas@statuscode.ch>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-07-21 17:49:16 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
2016-01-12 17:02:16 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-11-10 12:50:59 +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/>
*
*/
namespace OCA\Federation\Controller;
2015-11-10 12:50:59 +03:00
use OCA\Federation\DbHandler;
use OCA\Federation\TrustedServers;
use OCP\AppFramework\Http;
use OCP\AppFramework\OCS\OCSForbiddenException;
use OCP\AppFramework\OCSController;
use OCP\AppFramework\Utility\ITimeFactory;
2015-11-19 19:10:42 +03:00
use OCP\BackgroundJob\IJobList;
use OCP\ILogger;
2015-11-10 12:50:59 +03:00
use OCP\IRequest;
use OCP\Security\ISecureRandom;
/**
* Class OCSAuthAPI
*
* OCS API end-points to exchange shared secret between two connected Nextclouds
2015-11-10 12:50:59 +03:00
*
* @package OCA\Federation\Controller
2015-11-10 12:50:59 +03:00
*/
class OCSAuthAPIController extends OCSController{
2015-11-10 12:50:59 +03:00
/** @var ISecureRandom */
private $secureRandom;
2015-11-19 19:10:42 +03:00
/** @var IJobList */
2015-11-10 12:50:59 +03:00
private $jobList;
/** @var TrustedServers */
private $trustedServers;
/** @var DbHandler */
private $dbHandler;
/** @var ILogger */
private $logger;
/** @var ITimeFactory */
private $timeFactory;
2015-11-10 12:50:59 +03:00
/**
2015-11-19 19:10:42 +03:00
* OCSAuthAPI constructor.
2015-11-10 12:50:59 +03:00
*
* @param string $appName
2015-11-10 12:50:59 +03:00
* @param IRequest $request
* @param ISecureRandom $secureRandom
2015-11-19 19:10:42 +03:00
* @param IJobList $jobList
2015-11-10 12:50:59 +03:00
* @param TrustedServers $trustedServers
* @param DbHandler $dbHandler
* @param ILogger $logger
* @param ITimeFactory $timeFactory
2015-11-10 12:50:59 +03:00
*/
public function __construct(
$appName,
2015-11-10 12:50:59 +03:00
IRequest $request,
ISecureRandom $secureRandom,
2015-11-19 19:10:42 +03:00
IJobList $jobList,
2015-11-10 12:50:59 +03:00
TrustedServers $trustedServers,
DbHandler $dbHandler,
ILogger $logger,
ITimeFactory $timeFactory
2015-11-10 12:50:59 +03:00
) {
parent::__construct($appName, $request);
2015-11-10 12:50:59 +03:00
$this->secureRandom = $secureRandom;
$this->jobList = $jobList;
$this->trustedServers = $trustedServers;
$this->dbHandler = $dbHandler;
$this->logger = $logger;
$this->timeFactory = $timeFactory;
2015-11-10 12:50:59 +03:00
}
/**
* @NoCSRFRequired
* @PublicPage
*
* request received to ask remote server for a shared secret, for legacy end-points
*
* @param string $url
* @param string $token
* @return Http\DataResponse
* @throws OCSForbiddenException
*/
public function requestSharedSecretLegacy($url, $token) {
return $this->requestSharedSecret($url, $token);
}
/**
* @NoCSRFRequired
* @PublicPage
*
* create shared secret and return it, for legacy end-points
*
* @param string $url
* @param string $token
* @return Http\DataResponse
* @throws OCSForbiddenException
*/
public function getSharedSecretLegacy($url, $token) {
return $this->getSharedSecret($url, $token);
}
2015-11-10 12:50:59 +03:00
/**
* @NoCSRFRequired
* @PublicPage
*
2015-11-10 12:50:59 +03:00
* request received to ask remote server for a shared secret
*
2016-08-19 22:41:55 +03:00
* @param string $url
* @param string $token
* @return Http\DataResponse
* @throws OCSForbiddenException
2015-11-10 12:50:59 +03:00
*/
2016-08-19 22:41:55 +03:00
public function requestSharedSecret($url, $token) {
2015-11-10 12:50:59 +03:00
if ($this->trustedServers->isTrustedServer($url) === false) {
$this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret', ['app' => 'federation']);
throw new OCSForbiddenException();
2015-11-10 12:50:59 +03:00
}
// if both server initiated the exchange of the shared secret the greater
// token wins
$localToken = $this->dbHandler->getToken($url);
if (strcmp($localToken, $token) > 0) {
$this->logger->info(
'remote server (' . $url . ') presented lower token. We will initiate the exchange of the shared secret.',
['app' => 'federation']
);
throw new OCSForbiddenException();
}
2015-11-10 12:50:59 +03:00
$this->jobList->add(
'OCA\Federation\BackgroundJob\GetSharedSecret',
[
'url' => $url,
'token' => $token,
'created' => $this->timeFactory->getTime()
2015-11-10 12:50:59 +03:00
]
);
return new Http\DataResponse();
2015-11-10 12:50:59 +03:00
}
/**
* @NoCSRFRequired
* @PublicPage
*
2015-11-10 12:50:59 +03:00
* create shared secret and return it
*
2016-08-19 22:41:55 +03:00
* @param string $url
* @param string $token
* @return Http\DataResponse
* @throws OCSForbiddenException
2015-11-10 12:50:59 +03:00
*/
2016-08-19 22:41:55 +03:00
public function getSharedSecret($url, $token) {
if ($this->trustedServers->isTrustedServer($url) === false) {
$this->logger->error('remote server not trusted (' . $url . ') while getting shared secret', ['app' => 'federation']);
throw new OCSForbiddenException();
}
if ($this->isValidToken($url, $token) === false) {
$expectedToken = $this->dbHandler->getToken($url);
$this->logger->error(
'remote server (' . $url . ') didn\'t send a valid token (got "' . $token . '" but expected "'. $expectedToken . '") while getting shared secret',
['app' => 'federation']
);
throw new OCSForbiddenException();
2015-11-10 12:50:59 +03:00
}
$sharedSecret = $this->secureRandom->generate(32);
2015-11-10 12:50:59 +03:00
$this->trustedServers->addSharedSecret($url, $sharedSecret);
// reset token after the exchange of the shared secret was successful
$this->dbHandler->addToken($url, '');
2015-11-10 12:50:59 +03:00
return new Http\DataResponse([
'sharedSecret' => $sharedSecret
]);
2015-11-10 12:50:59 +03:00
}
protected function isValidToken($url, $token) {
$storedToken = $this->dbHandler->getToken($url);
2015-12-11 08:17:47 +03:00
return hash_equals($storedToken, $token);
2015-11-10 12:50:59 +03:00
}
}