Add an occ command to scan files for legacy file key in use and get rid of those

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

2 files changed, 137 insertions, 2 deletions

diff --git a/apps/encryption/lib/Command/FixLegacyFileKey.php b/apps/encryption/lib/Command/FixLegacyFileKey.php
new file mode 100644
index 00000000000..fd3221a6c1f
--- /dev/null
+++ b/apps/encryption/lib/Command/FixLegacyFileKey.php
@@ -0,0 +1,136 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023, Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @author Côme Chilliet <come.chilliet@nextcloud.com>
+ *
+ * @license GNU AGPL version 3 or 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.
+ *
+ * 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/>.
+ *
+ */
+
+namespace OCA\Encryption\Command;
+
+use OC\Files\View;
+use OCA\Encryption\KeyManager;
+use OCP\Encryption\Exceptions\GenericEncryptionException;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class FixLegacyFileKey extends Command {
+	private View $rootView;
+
+	public function __construct(
+		private IUserManager $userManager,
+		private KeyManager $keyManager,
+	) {
+		parent::__construct();
+
+		$this->rootView = new View();
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('encryption:fix-legacy-filekey')
+			->setDescription('Scan the files for the legacy filekey format using RC4 and get rid of it (if master key is enabled)');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$result = true;
+
+		$output->writeln('<info>Scanning all files for legacy filekey</info>');
+
+		foreach ($this->userManager->getBackends() as $backend) {
+			$limit = 500;
+			$offset = 0;
+			do {
+				$users = $backend->getUsers('', $limit, $offset);
+				foreach ($users as $user) {
+					$output->writeln('Scanning all files for ' . $user);
+					$this->setupUserFS($user);
+					$result = $result && $this->scanFolder($output, '/' . $user);
+				}
+				$offset += $limit;
+			} while (count($users) >= $limit);
+		}
+
+		if ($result) {
+			$output->writeln('All scanned files are properly encrypted. You can disable the legacy compatibility mode.');
+			return 0;
+		}
+
+		return 1;
+	}
+
+	private function scanFolder(OutputInterface $output, string $folder): bool {
+		$clean = true;
+
+		foreach ($this->rootView->getDirectoryContent($folder) as $item) {
+			$path = $folder . '/' . $item['name'];
+			if ($this->rootView->is_dir($path)) {
+				if ($this->scanFolder($output, $path) === false) {
+					$clean = false;
+				}
+			} else {
+				if (!$item->isEncrypted()) {
+					// ignore
+					continue;
+				}
+
+				$stats = $this->rootView->stat($path);
+				if (!isset($stats['hasHeader']) || $stats['hasHeader'] === false) {
+					$clean = false;
+					$output->writeln('<error>' . $path . ' does not have a proper header</error>');
+				} else {
+					try {
+						$legacyFileKey = $this->keyManager->getFileKey($path, null, true);
+						if ($legacyFileKey === '') {
+							$output->writeln('Got an empty legacy filekey for ' . $path . ', continuing', OutputInterface::VERBOSITY_VERBOSE);
+							continue;
+						}
+					} catch (GenericEncryptionException $e) {
+						$output->writeln('Got a decryption error for legacy filekey for ' . $path . ', continuing', OutputInterface::VERBOSITY_VERBOSE);
+						continue;
+					}
+					/* If that did not throw and filekey is not empty, a legacy filekey is used */
+					$clean = false;
+					$output->writeln($path . ' is using a legacy filekey, migrating');
+					$file = $this->rootView->fopen($path, 'w+');
+					if ($file) {
+						fwrite($file, '');
+						fclose($file);
+					} else {
+						$output->writeln('<error>failed to open' . $path . '</error>');
+					}
+				}
+			}
+		}
+
+		return $clean;
+	}
+
+	/**
+	 * setup user file system
+	 */
+	protected function setupUserFS(string $uid): void {
+		\OC_Util::tearDownFS();
+		\OC_Util::setupFS($uid);
+	}
+}
diff --git a/apps/encryption/lib/Command/ScanLegacyFormat.php b/apps/encryption/lib/Command/ScanLegacyFormat.php
index dc6d43ee5b8..85a99a17845 100644
--- a/apps/encryption/lib/Command/ScanLegacyFormat.php
+++ b/apps/encryption/lib/Command/ScanLegacyFormat.php
@@ -36,7 +36,6 @@ use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ScanLegacyFormat extends Command {
-
 	/** @var Util */
 	protected $util;
 
@@ -89,7 +88,7 @@ class ScanLegacyFormat extends Command {
 				foreach ($users as $user) {
 					$output->writeln('Scanning all files for ' . $user);
 					$this->setupUserFS($user);
-					$result &= $this->scanFolder($output, '/' . $user);
+					$result = $result && $this->scanFolder($output, '/' . $user);
 				}
 				$offset += $limit;
 			} while (count($users) >= $limit);