-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38080 from nextcloud/enh/add-occ-command-for-lega…
…cy-filekey Add an occ command to scan files for legacy file key in use and get rid of those
- Loading branch information
Showing
7 changed files
with
179 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| <?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\Encryption\Exceptions\DecryptionFailedException; | ||
| use OC\Files\FileInfo; | ||
| 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 DropLegacyFileKey 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:drop-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.'); | ||
| 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'); | ||
| $this->migrateSinglefile($path, $item, $output); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $clean; | ||
| } | ||
|
|
||
| private function migrateSinglefile(string $path, FileInfo $fileInfo, OutputInterface $output): void { | ||
| $source = $path; | ||
| $target = $path . '.reencrypted.' . time(); | ||
|
|
||
| try { | ||
| $this->rootView->copy($source, $target); | ||
| $copyResource = $this->rootView->fopen($target, 'r'); | ||
| $sourceResource = $this->rootView->fopen($source, 'w'); | ||
| if ($copyResource === false || $sourceResource === false) { | ||
| throw new DecryptionFailedException('Failed to open '.$source.' or '.$target); | ||
| } | ||
| if (stream_copy_to_stream($copyResource, $sourceResource) === false) { | ||
| $output->writeln('<error>Failed to copy '.$target.' data into '.$source.'</error>'); | ||
| $output->writeln('<error>Leaving both files in there to avoid data loss</error>'); | ||
| return; | ||
| } | ||
| $this->rootView->touch($source, $fileInfo->getMTime()); | ||
| $this->rootView->unlink($target); | ||
| $output->writeln('<info>Migrated ' . $source . '</info>', OutputInterface::VERBOSITY_VERBOSE); | ||
| } catch (DecryptionFailedException $e) { | ||
| if ($this->rootView->file_exists($target)) { | ||
| $this->rootView->unlink($target); | ||
| } | ||
| $output->writeln('<error>Failed to migrate ' . $path . '</error>'); | ||
| $output->writeln('<error>' . $e . '</error>', OutputInterface::VERBOSITY_VERBOSE); | ||
| } finally { | ||
| if (is_resource($copyResource)) { | ||
| fclose($copyResource); | ||
| } | ||
| if (is_resource($sourceResource)) { | ||
| fclose($sourceResource); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * setup user file system | ||
| */ | ||
| protected function setupUserFS(string $uid): void { | ||
| \OC_Util::tearDownFS(); | ||
| \OC_Util::setupFS($uid); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters