Settings improvements (#238)

- Add button to test current vaas configuration
- Rename app settings to be more intuitive

Author: lennartdohmann

LICENSES/AGPL-3.0-only.txt

@@ -23,7 +23,7 @@ An older license, called the Affero General Public License and published by Affe
 
 The precise terms and conditions for copying, distribution and modification follow.
 
-                       TERMS AND CONDITIONS
+                      TERMS AND CONDITIONS
 
 0. Definitions.
 
@@ -219,14 +219,14 @@ If you develop a new program, and you want it to be of the greatest possible use
 
 To do so, attach the following notices to the program.  It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
 
-     <one line to give the program's name and a brief idea of what it does.>
-     Copyright (C) <year>  <name of author>
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
 
-     This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
-     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.
+    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 along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    You should have received a copy of the GNU Affero General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 

LICENSES/CC0-1.0.txt

@@ -43,22 +43,22 @@ Related Rights"). Copyright and Related Rights include, but are not
 limited to, the following:
 
   i. the right to reproduce, adapt, distribute, perform, display,
-     communicate, and translate a Work;
+    communicate, and translate a Work;
  ii. moral rights retained by the original author(s) and/or performer(s);
 iii. publicity and privacy rights pertaining to a person's image or
-     likeness depicted in a Work;
+    likeness depicted in a Work;
  iv. rights protecting against unfair competition in regards to a Work,
-     subject to the limitations in paragraph 4(a), below;
+    subject to the limitations in paragraph 4(a), below;
   v. rights protecting the extraction, dissemination, use and reuse of data
-     in a Work;
+    in a Work;
  vi. database rights (such as those arising under Directive 96/9/EC of the
-     European Parliament and of the Council of 11 March 1996 on the legal
-     protection of databases, and under any national implementation
-     thereof, including any amended or successor version of such
-     directive); and
+    European Parliament and of the Council of 11 March 1996 on the legal
+    protection of databases, and under any national implementation
+    thereof, including any amended or successor version of such
+    directive); and
 vii. other similar, equivalent or corresponding rights throughout the
-     world based on applicable law or treaty, and any national
-     implementations thereof.
+    world based on applicable law or treaty, and any national
+    implementations thereof.
 
 2. Waiver. To the greatest extent permitted by, but not in contravention
 of, applicable law, Affirmer hereby overtly, fully, permanently,

Makefile

@@ -129,6 +129,7 @@ appstore: build
 	--exclude="$(source_build_directory)/psalm.xml" \
 	--exclude="$(source_build_directory)/webpack.config.json" \
 	--exclude="$(source_build_directory)/stylelint.config.json" \
+	--exclude="$(source_build_directory)/empty-skeleton.config.php" \
 	--exclude="$(source_build_directory)/scoper.inc.php" \
 	--exclude="$(source_build_directory)/renovate.json" \
 	--exclude="$(source_build_directory)/renovate.json.license" \

appinfo/routes.php

@@ -26,6 +26,7 @@
 		['name' => 'settings#getSendMailSummaryOfMaliciousFiles', 'url'
 			=> '/getSendMailSummaryOfMaliciousFiles', 'verb' => 'GET'],
 		['name' => 'settings#setSendMailSummaryOfMaliciousFiles', 'url'
-			=> '/setSendMailSummaryOfMaliciousFiles', 'verb' => 'POST']
+			=> '/setSendMailSummaryOfMaliciousFiles', 'verb' => 'POST'],
+		['name' => 'settings#testsettings', 'url' => '/testsettings', 'verb' => 'POST']
 	]
 ];

composer.json

@@ -30,12 +30,12 @@
     },
     "scripts": {
         "lint": "find . -name \\*.php -not -path './vendor/*' -not -path './nextcloud-server/*' -not -path './node_modules/*'  -print0 | xargs -0 -n1 php -l",
-        "cs:check": "rm -rf node_modules/ nextcloud-server/ || true && ./vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php-cs-fixer.dist.php .",
-        "cs:fix": "rm -rf node_modules/ nextcloud-server/ || true && ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php .",
-        "psalm": "rm -rf node_modules/ || true && vendor/psalm/phar/psalm.phar",
-        "psalm:check": "rm -rf node_modules/ || true && composer run psalm -- --threads=1 --monochrome --no-progress --output-format=github --show-info=true",
-        "psalm:fix": "rm -rf node_modules/ || true && composer run psalm -- --alter --issues=MissingOverrideAttribute,ClassMustBeFinal,PossiblyUnusedMethod,MissingParamType",
-        "psalm:clear": "vendor/psalm/phar/psalm.phar --clear-cache && vendor/psalm/phar/psalm.phar --clear-global-cache"
+        "cs:check": "./vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php-cs-fixer.dist.php .",
+        "cs:fix": "./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php .",
+        "psalm": "./vendor/psalm/phar/psalm.phar",
+        "psalm:check": "composer run psalm -- --threads=1 --monochrome --no-progress --output-format=github --show-info=true",
+        "psalm:fix": "composer run psalm -- --alter --issues=MissingOverrideAttribute,ClassMustBeFinal,PossiblyUnusedMethod,MissingParamType",
+        "psalm:clear": "./vendor/psalm/phar/psalm.phar --clear-cache && vendor/psalm/phar/psalm.phar --clear-global-cache"
     },
     "config": {
         "allow-plugins": {

lib/Controller/SettingsController.php

@@ -7,29 +7,37 @@
 namespace OCA\GDataVaas\Controller;
 
 use OCA\GDataVaas\Service\TagService;
+use OCA\GDataVaas\Service\VerdictService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\DB\Exception;
 use OCP\IAppConfig;
 use OCP\IRequest;
 use OCP\Mail\IMailer;
+use VaasSdk\Exceptions\VaasAuthenticationException;
+use VaasSdk\Options\VaasOptions;
+use VaasSdk\Vaas;
+use VaasSdk\Verdict;
 
 class SettingsController extends Controller {
 	private IAppConfig $config;
 	private TagService $tagService;
 	private IMailer $mailer;
+	private VerdictService $verdictService;
 
 	public function __construct(
 		$appName,
 		IRequest $request,
 		IAppConfig $config,
 		TagService $tagService,
 		IMailer $mailer,
+		VerdictService $verdictService,
 	) {
 		parent::__construct($appName, $request);
 		$this->config = $config;
 		$this->tagService = $tagService;
 		$this->mailer = $mailer;
+		$this->verdictService = $verdictService;
 	}
 
 	public function setconfig(
@@ -154,4 +162,28 @@ public function setSendMailSummaryOfMaliciousFiles(bool $sendMailSummaryOfMalici
 		$this->config->setValueBool($this->appName, 'notifyAdminEnabled', $sendMailSummaryOfMaliciousFiles);
 		return new JSONResponse(['status' => 'success']);
 	}
+
+	public function testSettings(string $tokenEndpoint, string $vaasUrl): JSONResponse {
+		try {
+			$authenticator = $this->verdictService->getAuthenticator($this->verdictService->authMethod, $tokenEndpoint);
+			$options = new VaasOptions(true, true, $vaasUrl);
+			$vaas = Vaas::builder()
+				->withAuthenticator($authenticator)
+				->withOptions($options)
+				->build();
+			$verdict = $vaas->forUrlAsync('https://www.gdata.de')->await();
+			if ($verdict->verdict === Verdict::CLEAN) {
+				return new JSONResponse(['status' => 'success']);
+			}
+			return new JSONResponse(['status' => 'error', 'message' => 'Test URL verdict: ' . $verdict->verdict->value]);
+		} catch (VaasAuthenticationException $e) {
+			return new JSONResponse([
+				'status' => 'error',
+				'message' => 'Authentication failed. Please also check your login details above and save them before
+				taking the test. ' . $e->getMessage()
+			]);
+		} catch (\Exception $e) {
+			return new JSONResponse(['status' => 'error', 'message' => $e->getMessage()]);
+		}
+	}
 }

lib/Service/VerdictService.php

@@ -28,7 +28,7 @@ class VerdictService {
 	private string $password;
 	private string $clientId;
 	private string $clientSecret;
-	private string $authMethod;
+	public string $authMethod;
 	private string $tokenEndpoint;
 	private string $vaasUrl;
 	private IAppConfig $appConfig;
@@ -212,31 +212,33 @@ public function createAndConnectVaas(): Vaas {
 		}
 		$options = new VaasOptions(true, true, $this->vaasUrl);
 		return Vaas::builder()
-			->withAuthenticator($this->getAuthenticator($this->authMethod))
+			->withAuthenticator($this->getAuthenticator($this->authMethod, $this->tokenEndpoint))
 			->withOptions($options)
 			->build();
 	}
 
 	/**
 	 * @param string $authMethod
+	 * @param string $tokenEndpoint
 	 * @return ClientCredentialsGrantAuthenticator|ResourceOwnerPasswordGrantAuthenticator
 	 * @throws VaasAuthenticationException
 	 */
 	public function getAuthenticator(
 		string $authMethod,
+		string $tokenEndpoint,
 	): ClientCredentialsGrantAuthenticator|ResourceOwnerPasswordGrantAuthenticator {
 		if ($authMethod === 'ResourceOwnerPassword') {
 			return new ResourceOwnerPasswordGrantAuthenticator(
 				'nextcloud-customer',
 				$this->username,
 				$this->password,
-				$this->tokenEndpoint
+				$tokenEndpoint
 			);
 		} elseif ($authMethod === 'ClientCredentials') {
 			return new ClientCredentialsGrantAuthenticator(
 				$this->clientId,
 				$this->clientSecret,
-				$this->tokenEndpoint
+				$tokenEndpoint
 			);
 		} else {
 			throw new VaasAuthenticationException('Invalid auth method: ' . $authMethod);

lib/Settings/VaasAdminSection.php

@@ -17,7 +17,7 @@ public function __construct(
 
 	#[\Override]
 	public function getName(): string {
-		return 'Verdict-as-a-Service';
+		return 'G DATA Antivirus';
 	}
 
 	#[\Override]

psalm.xml

@@ -19,6 +19,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
         <directory name="lib" />
         <ignoreFiles>
             <directory name="vendor" />
+            <directory name="nextcloud-server" />
         </ignoreFiles>
     </projectFiles>
     <extraFiles>

src/admin-settings.js

@@ -38,6 +38,7 @@ document.addEventListener('DOMContentLoaded', async () => {
 
 	const authSubmit = document.querySelector('#auth_submit');
 	const authSubmitAdvanced = document.querySelector('#auth_submit_advanced');
+	const testSettings = document.querySelector('#test-settings');
 	const resetAllTags = document.querySelector('#reset');
 	const autoScanFiles = document.querySelector('#auto_scan_files');
 	const prefixMalicious = document.querySelector('#prefixMalicious');
@@ -91,6 +92,24 @@ document.addEventListener('DOMContentLoaded', async () => {
 		}
 	});
 
+	testSettings.addEventListener('click', async (e) => {
+		e.preventDefault();
+		const tokenEndpoint = document.querySelector('#token_endpoint').value;
+		const vaasUrl = document.querySelector('#vaas_url').value;
+
+		const response = await postData(OC.generateUrl('apps/gdatavaas/testsettings'), {
+			tokenEndpoint,
+			vaasUrl
+		});
+		const msgElement = document.querySelector('#auth_save_msg_advanced');
+
+		if (response.status === "success") {
+			msgElement.textContent = 'Authentication successful and VaaS backend reachable.';
+		} else {
+			msgElement.textContent = response.message || 'An error occurred during the test.';
+		}
+	});
+
 	authSubmitAdvanced.addEventListener('click', async (e) => {
 		e.preventDefault();
 		const tokenEndpoint = document.querySelector('#token_endpoint').value;