Add maximum scan size setting for file uploads (#236)

Author: lennartdohmann

lib/Controller/ScanController.php

@@ -6,24 +6,27 @@
 
 namespace OCA\GDataVaas\Controller;
 
-use Coduo\PHPHumanizer\NumberHumanizer;
 use Exception;
+use OCA\GDataVaas\AppInfo\Application;
 use OCA\GDataVaas\Service\VerdictService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\Files\EntityTooLargeException;
 use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
+use OCP\IAppConfig;
 use OCP\IRequest;
 use VaasSdk\Exceptions\VaasAuthenticationException;
 
 class ScanController extends Controller {
+	private IAppConfig $config;
 	private VerdictService $verdictService;
 
-	public function __construct($appName, IRequest $request, VerdictService $verdictService) {
+	public function __construct($appName, IRequest $request, VerdictService $verdictService, IAppConfig $config) {
 		parent::__construct($appName, $request);
 
+		$this->config = $config;
 		$this->verdictService = $verdictService;
 	}
 
@@ -39,8 +42,8 @@ public function scan(int $fileId): JSONResponse {
 			return new JSONResponse(['verdict' => $verdict->verdict->value], 200);
 		} catch (EntityTooLargeException) {
 			return new JSONResponse(
-				['error' => "File $fileId is larger than " . NumberHumanizer::binarySuffix(
-					VerdictService::MAX_FILE_SIZE, 'de')], 413);
+				['error' => 'File is larger than '
+					. $this->config->getValueInt(Application::APP_ID, 'maxScanSizeInMB', 256) . 'MB.'], 413);
 		} catch (NotFoundException) {
 			return new JSONResponse(['error' => "File $fileId not found"], 404);
 		} catch (NotPermittedException) {

lib/Controller/SettingsController.php

@@ -42,6 +42,7 @@ public function setconfig(
 		$scanOnlyThis,
 		$doNotScanThis,
 		$notifyMails,
+		$maxScanSize,
 	): JSONResponse {
 		if (!empty($notifyMails)) {
 			$mails = explode(',', preg_replace('/\s+/', '', $notifyMails));
@@ -51,6 +52,9 @@ public function setconfig(
 				}
 			}
 		}
+		if ((int)$maxScanSize < 1) {
+			return new JSONResponse(['status' => 'error', 'message' => 'Invalid max scan size: ' . $maxScanSize]);
+		}
 		$this->config->setValueString($this->appName, 'username', $username);
 		$this->config->setValueString($this->appName, 'password', $password);
 		$this->config->setValueString($this->appName, 'clientId', $clientId);
@@ -60,6 +64,7 @@ public function setconfig(
 		$this->config->setValueString($this->appName, 'scanOnlyThis', $scanOnlyThis);
 		$this->config->setValueString($this->appName, 'doNotScanThis', $doNotScanThis);
 		$this->config->setValueString($this->appName, 'notifyMails', $notifyMails);
+		$this->config->setValueInt($this->appName, 'maxScanSizeInMB', (int)$maxScanSize);
 		return new JSONResponse(['status' => 'success']);
 	}
 

lib/Service/ScanService.php

@@ -6,7 +6,6 @@
 
 namespace OCA\GDataVaas\Service;
 
-use Coduo\PHPHumanizer\NumberHumanizer;
 use OCA\GDataVaas\AppInfo\Application;
 use OCP\DB\Exception;
 use OCP\Files\EntityTooLargeException;
@@ -66,7 +65,8 @@ public function run(): int {
 			} catch (EntityTooLargeException) {
 				$this->logger->error(
 					"File $fileId is larger than
-					" . NumberHumanizer::binarySuffix(VerdictService::MAX_FILE_SIZE, 'de'));
+					" . $this->appConfig->getValueInt(Application::APP_ID, 'maxScanSizeInMB', 256) . 'MB.'
+				);
 			} catch (NotFoundException) {
 				$this->logger->error("File $fileId not found");
 			} catch (NotPermittedException) {

lib/Service/VerdictService.php

@@ -24,8 +24,6 @@
 use VaasSdk\VaasVerdict;
 
 class VerdictService {
-	public const MAX_FILE_SIZE = 1073741824;
-
 	private string $username;
 	private string $password;
 	private string $clientId;
@@ -115,9 +113,10 @@ public function scanFileById(int $fileId): VaasVerdict {
 	 * @param string $path
 	 * @return bool
 	 */
-	public static function isFileTooLargeToScan(string $path): bool {
+	public function isFileTooLargeToScan(string $path): bool {
 		$size = filesize($path);
-		return ($size === false) || $size > self::MAX_FILE_SIZE;
+		return ($size === false)
+			|| $size > ($this->appConfig->getValueInt(Application::APP_ID, 'maxScanSizeInMB', 256) * 1024 * 1024);
 	}
 
 	/**

lib/Settings/VaasAdmin.php

@@ -55,7 +55,9 @@ public function getForm(): TemplateResponse {
 			'notifyMail' => $this->config->getValueString(Application::APP_ID, 'notifyMails'),
 			'sendMailOnVirusUpload'
 				=> $this->config->getValueBool(Application::APP_ID, 'sendMailOnVirusUpload'),
-			'notifyAdminEnabled' => $this->config->getValueBool(Application::APP_ID, 'notifyAdminEnabled')
+			'notifyAdminEnabled' => $this->config->getValueBool(Application::APP_ID, 'notifyAdminEnabled'),
+			'maxScanSizeInMB'
+				=> $this->config->getValueInt(Application::APP_ID, 'maxScanSizeInMB', 256)
 		];
 
 		return new TemplateResponse(Application::APP_ID, 'admin', $params);

src/admin-settings.js

@@ -64,6 +64,7 @@ document.addEventListener('DOMContentLoaded', async () => {
 		const scanOnlyThis = document.querySelector('#scanOnlyThis').value;
 		const doNotScanThis = document.querySelector('#doNotScanThis').value;
 		const notifyMails = document.querySelector('#notify_mails').value;
+		const maxScanSize = document.querySelector('#max-scan-size').value;
 
 		const response = await postData(OC.generateUrl('apps/gdatavaas/setconfig'), {
 			username: username,
@@ -74,7 +75,8 @@ document.addEventListener('DOMContentLoaded', async () => {
 			quarantineFolder,
 			scanOnlyThis,
 			doNotScanThis,
-			notifyMails
+			notifyMails,
+			maxScanSize
 		});
 		const msgElement = document.querySelector('#auth_save_msg');
 

templates/admin.php

@@ -62,6 +62,10 @@
 				<td><div title="<?php p($l->t('Mail addresses for notifications when malicious files are found or a user tries to upload them. Must be comma-separated.'));?>" class="visible"><label for="notify_mails"><?php p($l->t('Notify Mails'));?></label></div></td>
 				<td class="input_field"><input id="notify_mails" type="text" name="notify_mails" value="<?php p($_['notifyMail']); ?>"/></td>
 			</tr>
+			<tr class="max-scan-size">
+				<td><div title="<?php p($l->t('The maximum scan size for files to be scanned in MB. Files above this limit are tagged as “Won\'t Scan”.'));?>" class="visible"><label for="max-scan-size"><?php p($l->t('Maximum scan size'));?></label></div></td>
+				<td class="input_field"><input id="max-scan-size" type="number" min="0" name="max-scan-size" value="<?php p($_['maxScanSizeInMB']); ?>"/></td>
+			</tr>
 		</table>
 		<input class="submit-button" id="auth_submit" type="submit" value="<?php p($l->t('Save'));?>" />
 		<span id="auth_save_msg"></span>

tests/bats/functionality-parallel.bats

@@ -99,7 +99,7 @@ setup_file() {
 }
 
 @test "test wontscan tag for testuser" {
-    dd if=/dev/zero of=$FOLDER_PREFIX/too-large.dat  bs=1083741824  count=1
+    dd if=/dev/zero of=$FOLDER_PREFIX/too-large.dat  bs=268435457  count=1
 
     docker cp $FOLDER_PREFIX/too-large.dat nextcloud-container:/var/www/html/data/$TESTUSER/files/$TESTUSER.too-large.dat
     docker exec -i nextcloud-container chown www-data:www-data /var/www/html/data/$TESTUSER/files/$TESTUSER.too-large.dat