2 files changed, 143 insertions, 116 deletions

diff --git a/apps/federation/lib/Controller/OCSAuthAPIController.php b/apps/federation/lib/Controller/OCSAuthAPIController.php
index 5a976720b04..16b401be251 100644
--- a/apps/federation/lib/Controller/OCSAuthAPIController.php
+++ b/apps/federation/lib/Controller/OCSAuthAPIController.php
@@ -1,41 +1,26 @@
 <?php
+
 /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bjoern Schiessle <bjoern@schiessle.org>
- * @author Björn Schießle <bjoern@schiessle.org>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
  */
 namespace OCA\Federation\Controller;
 
 use OCA\Federation\DbHandler;
 use OCA\Federation\TrustedServers;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\BruteForceProtection;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\Attribute\PublicPage;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCS\OCSForbiddenException;
 use OCP\AppFramework\OCSController;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\IRequest;
+use OCP\Security\Bruteforce\IThrottler;
 use OCP\Security\ISecureRandom;
 use Psr\Log\LoggerInterface;
 
@@ -46,41 +31,35 @@ use Psr\Log\LoggerInterface;
  *
  * @package OCA\Federation\Controller
  */
+#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)]
 class OCSAuthAPIController extends OCSController {
-	private ISecureRandom $secureRandom;
-	private IJobList $jobList;
-	private TrustedServers $trustedServers;
-	private DbHandler $dbHandler;
-	private LoggerInterface $logger;
-	private ITimeFactory $timeFactory;
-
 	public function __construct(
 		string $appName,
 		IRequest $request,
-		ISecureRandom $secureRandom,
-		IJobList $jobList,
-		TrustedServers $trustedServers,
-		DbHandler $dbHandler,
-		LoggerInterface $logger,
-		ITimeFactory $timeFactory
+		private ISecureRandom $secureRandom,
+		private IJobList $jobList,
+		private TrustedServers $trustedServers,
+		private DbHandler $dbHandler,
+		private LoggerInterface $logger,
+		private ITimeFactory $timeFactory,
+		private IThrottler $throttler,
 	) {
 		parent::__construct($appName, $request);
-
-		$this->secureRandom = $secureRandom;
-		$this->jobList = $jobList;
-		$this->trustedServers = $trustedServers;
-		$this->dbHandler = $dbHandler;
-		$this->logger = $logger;
-		$this->timeFactory = $timeFactory;
 	}
 
 	/**
 	 * Request received to ask remote server for a shared secret, for legacy end-points
 	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @throws OCSForbiddenException
+	 * @param string $url URL of the server
+	 * @param string $token Token of the server
+	 * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
+	 * @throws OCSForbiddenException Requesting shared secret is not allowed
+	 *
+	 * 200: Shared secret requested successfully
 	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[BruteForceProtection(action: 'federationSharedSecret')]
 	public function requestSharedSecretLegacy(string $url, string $token): DataResponse {
 		return $this->requestSharedSecret($url, $token);
 	}
@@ -89,10 +68,16 @@ class OCSAuthAPIController extends OCSController {
 	/**
 	 * Create shared secret and return it, for legacy end-points
 	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @throws OCSForbiddenException
+	 * @param string $url URL of the server
+	 * @param string $token Token of the server
+	 * @return DataResponse<Http::STATUS_OK, array{sharedSecret: string}, array{}>
+	 * @throws OCSForbiddenException Getting shared secret is not allowed
+	 *
+	 * 200: Shared secret returned
 	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[BruteForceProtection(action: 'federationSharedSecret')]
 	public function getSharedSecretLegacy(string $url, string $token): DataResponse {
 		return $this->getSharedSecret($url, $token);
 	}
@@ -100,13 +85,20 @@ class OCSAuthAPIController extends OCSController {
 	/**
 	 * Request received to ask remote server for a shared secret
 	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @throws OCSForbiddenException
+	 * @param string $url URL of the server
+	 * @param string $token Token of the server
+	 * @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
+	 * @throws OCSForbiddenException Requesting shared secret is not allowed
+	 *
+	 * 200: Shared secret requested successfully
 	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[BruteForceProtection(action: 'federationSharedSecret')]
 	public function requestSharedSecret(string $url, string $token): DataResponse {
 		if ($this->trustedServers->isTrustedServer($url) === false) {
-			$this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret', ['app' => 'federation']);
+			$this->throttler->registerAttempt('federationSharedSecret', $this->request->getRemoteAddress());
+			$this->logger->error('remote server not trusted (' . $url . ') while requesting shared secret');
 			throw new OCSForbiddenException();
 		}
 
@@ -115,8 +107,7 @@ class OCSAuthAPIController extends OCSController {
 		$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']
+				'remote server (' . $url . ') presented lower token. We will initiate the exchange of the shared secret.'
 			);
 			throw new OCSForbiddenException();
 		}
@@ -136,21 +127,28 @@ class OCSAuthAPIController extends OCSController {
 	/**
 	 * Create shared secret and return it
 	 *
-	 * @NoCSRFRequired
-	 * @PublicPage
-	 * @throws OCSForbiddenException
+	 * @param string $url URL of the server
+	 * @param string $token Token of the server
+	 * @return DataResponse<Http::STATUS_OK, array{sharedSecret: string}, array{}>
+	 * @throws OCSForbiddenException Getting shared secret is not allowed
+	 *
+	 * 200: Shared secret returned
 	 */
+	#[NoCSRFRequired]
+	#[PublicPage]
+	#[BruteForceProtection(action: 'federationSharedSecret')]
 	public function getSharedSecret(string $url, string $token): DataResponse {
 		if ($this->trustedServers->isTrustedServer($url) === false) {
-			$this->logger->error('remote server not trusted (' . $url . ') while getting shared secret', ['app' => 'federation']);
+			$this->throttler->registerAttempt('federationSharedSecret', $this->request->getRemoteAddress());
+			$this->logger->error('remote server not trusted (' . $url . ') while getting shared secret');
 			throw new OCSForbiddenException();
 		}
 
 		if ($this->isValidToken($url, $token) === false) {
+			$this->throttler->registerAttempt('federationSharedSecret', $this->request->getRemoteAddress());
 			$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']
+				'remote server (' . $url . ') didn\'t send a valid token (got "' . $token . '" but expected "' . $expectedToken . '") while getting shared secret'
 			);
 			throw new OCSForbiddenException();
 		}
diff --git a/apps/federation/lib/Controller/SettingsController.php b/apps/federation/lib/Controller/SettingsController.php
index 8bcdc769de9..27341eba815 100644
--- a/apps/federation/lib/Controller/SettingsController.php
+++ b/apps/federation/lib/Controller/SettingsController.php
@@ -1,60 +1,54 @@
 <?php
+
 /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bjoern Schiessle <bjoern@schiessle.org>
- * @author Björn Schießle <bjoern@schiessle.org>
- * @author Morris Jobke <hey@morrisjobke.de>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
  */
 namespace OCA\Federation\Controller;
 
+use OCA\Federation\Settings\Admin;
 use OCA\Federation\TrustedServers;
-use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\AuthorizedAdminSetting;
 use OCP\AppFramework\Http\DataResponse;
-use OCP\HintException;
+use OCP\AppFramework\OCS\OCSException;
+use OCP\AppFramework\OCS\OCSNotFoundException;
+use OCP\AppFramework\OCSController;
 use OCP\IL10N;
 use OCP\IRequest;
+use Psr\Log\LoggerInterface;
 
-class SettingsController extends Controller {
-	private IL10N $l;
-	private TrustedServers $trustedServers;
-
-	public function __construct(string $AppName,
-								IRequest $request,
-								IL10N $l10n,
-								TrustedServers $trustedServers
+class SettingsController extends OCSController {
+	public function __construct(
+		string $AppName,
+		IRequest $request,
+		private IL10N $l,
+		private TrustedServers $trustedServers,
+		private LoggerInterface $logger,
 	) {
 		parent::__construct($AppName, $request);
-		$this->l = $l10n;
-		$this->trustedServers = $trustedServers;
 	}
 
 
 	/**
-	 * Add server to the list of trusted Nextclouds.
+	 * Add server to the list of trusted Nextcloud servers
+	 *
+	 * @param string $url The URL of the server to add
+	 * @return DataResponse<Http::STATUS_OK, array{id: int, message: string, url: string}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_CONFLICT, array{message: string}, array{}>
 	 *
-	 * @AuthorizedAdminSetting(settings=OCA\Federation\Settings\Admin)
-	 * @throws HintException
+	 * 200: Server added successfully
+	 * 404: Server not found at the given URL
+	 * 409: Server is already in the list of trusted servers
 	 */
+	#[AuthorizedAdminSetting(settings: Admin::class)]
+	#[ApiRoute(verb: 'POST', url: '/trusted-servers')]
 	public function addServer(string $url): DataResponse {
-		$this->checkServer($url);
-		$id = $this->trustedServers->addServer($url);
+		$this->checkServer(trim($url));
 
+		// Add the server to the list of trusted servers, all is well
+		$id = $this->trustedServers->addServer(trim($url));
 		return new DataResponse([
 			'url' => $url,
 			'id' => $id,
@@ -63,34 +57,69 @@ class SettingsController extends Controller {
 	}
 
 	/**
-	 * Add server to the list of trusted Nextclouds.
+	 * Add server to the list of trusted Nextcloud servers
 	 *
-	 * @AuthorizedAdminSetting(settings=OCA\Federation\Settings\Admin)
+	 * @param int $id The ID of the trusted server to remove
+	 * @return DataResponse<Http::STATUS_OK, array{id: int}, array{}>|DataResponse<Http::STATUS_NOT_FOUND, array{message: string}, array{}>
+	 *
+	 * 200: Server removed successfully
+	 * 404: Server not found at the given ID
 	 */
+	#[AuthorizedAdminSetting(settings: Admin::class)]
+	#[ApiRoute(verb: 'DELETE', url: '/trusted-servers/{id}', requirements: ['id' => '\d+'])]
 	public function removeServer(int $id): DataResponse {
-		$this->trustedServers->removeServer($id);
-		return new DataResponse();
+		try {
+			$this->trustedServers->getServer($id);
+		} catch (\Exception $e) {
+			throw new OCSNotFoundException($this->l->t('No server found with ID: %s', [$id]));
+		}
+
+		try {
+			$this->trustedServers->removeServer($id);
+			return new DataResponse(['id' => $id]);
+		} catch (\Exception $e) {
+			$this->logger->error($e->getMessage(), ['e' => $e]);
+			throw new OCSException($this->l->t('Could not remove server'), Http::STATUS_INTERNAL_SERVER_ERROR);
+		}
 	}
 
 	/**
-	 * Check if the server should be added to the list of trusted servers or not.
+	 * List all trusted servers
+	 *
+	 * @return DataResponse<Http::STATUS_OK, list<array{id: int, status: int, url: string}>, array{}>
 	 *
-	 * @AuthorizedAdminSetting(settings=OCA\Federation\Settings\Admin)
-	 * @throws HintException
+	 * 200: List of trusted servers
 	 */
-	protected function checkServer(string $url): bool {
+	#[AuthorizedAdminSetting(settings: Admin::class)]
+	#[ApiRoute(verb: 'GET', url: '/trusted-servers')]
+	public function getServers(): DataResponse {
+		$servers = $this->trustedServers->getServers();
+
+		// obfuscate the shared secret
+		$servers = array_map(function ($server) {
+			return [
+				'url' => $server['url'],
+				'id' => $server['id'],
+				'status' => $server['status'],
+			];
+		}, $servers);
+
+		// return the list of trusted servers
+		return new DataResponse($servers);
+	}
+
+
+	/**
+	 * Check if the server should be added to the list of trusted servers or not.
+	 */
+	#[AuthorizedAdminSetting(settings: Admin::class)]
+	protected function checkServer(string $url): void {
 		if ($this->trustedServers->isTrustedServer($url) === true) {
-			$message = 'Server is already in the list of trusted servers.';
-			$hint = $this->l->t('Server is already in the list of trusted servers.');
-			throw new HintException($message, $hint);
+			throw new OCSException($this->l->t('Server is already in the list of trusted servers.'), Http::STATUS_CONFLICT);
 		}
 
 		if ($this->trustedServers->isNextcloudServer($url) === false) {
-			$message = 'No server to federate with found';
-			$hint = $this->l->t('No server to federate with found');
-			throw new HintException($message, $hint);
+			throw new OCSNotFoundException($this->l->t('No server to federate with found'));
 		}
-
-		return true;
 	}
 }