Skip to content

feat(encryption): Support running decrypt-all when encryption is already disabled #55861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
come-nc wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(encryption): Support running decrypt-all when encryption is already disabled #55861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a618466
feat(encryption): Support running decrypt-all when encryption is alre…
come-nc Oct 20, 2025
c11cc64
chore: update psalm baseline
come-nc Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions build/psalm-baseline.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3148,15 +3148,6 @@
<code><![CDATA[\OC_Util::tearDownFS()]]></code>
</DeprecatedMethod>
</file>
<file src="core/Command/Encryption/DecryptAll.php">
<DeprecatedMethod>
<code><![CDATA[setAppValue]]></code>
<code><![CDATA[setAppValue]]></code>
<code><![CDATA[setAppValue]]></code>
<code><![CDATA[setAppValue]]></code>
<code><![CDATA[setAppValue]]></code>
</DeprecatedMethod>
</file>
<file src="core/Command/Encryption/Disable.php">
<DeprecatedMethod>
<code><![CDATA[getAppValue]]></code>
Expand Down
33 changes: 20 additions & 13 deletions core/Command/Encryption/DecryptAll.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/

namespace OC\Core\Command\Encryption;

use OCP\App\IAppManager;
use OCP\Encryption\IManager;
use OCP\IAppConfig;
use OCP\IConfig;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\QuestionHelper;
Expand All @@ -22,9 +23,9 @@ class DecryptAll extends Command {
protected bool $wasMaintenanceModeEnabled = false;

public function __construct(
protected IManager $encryptionManager,
protected IAppManager $appManager,
protected IConfig $config,
protected IAppConfig $appConfig,
protected \OC\Encryption\DecryptAll $decryptAll,
protected QuestionHelper $questionHelper,
) {
Expand Down Expand Up @@ -88,14 +89,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
return 1;
}

$originallyEnabled = $this->appConfig->getValueBool('core', 'encryption_enabled');
try {
if ($this->encryptionManager->isEnabled() === true) {
if ($originallyEnabled) {
$output->write('Disable server side encryption... ');
$this->config->setAppValue('core', 'encryption_enabled', 'no');
$this->appConfig->setValueBool('core', 'encryption_enabled', false);
$output->writeln('done.');
} else {
$output->writeln('Server side encryption not enabled. Nothing to do.');
return 0;
}

$uid = $input->getArgument('user');
Expand All @@ -118,23 +119,29 @@ protected function execute(InputInterface $input, OutputInterface $output): int
$result = $this->decryptAll->decryptAll($input, $output, $user);
if ($result === false) {
$output->writeln(' aborted.');
if ($originallyEnabled) {
$output->writeln('Server side encryption remains enabled');
$this->appConfig->setValueBool('core', 'encryption_enabled', true);
}
} elseif (($uid !== '') && $originallyEnabled) {
$output->writeln('Server side encryption remains enabled');
$this->config->setAppValue('core', 'encryption_enabled', 'yes');
} elseif ($uid !== '') {
$output->writeln('Server side encryption remains enabled');
$this->config->setAppValue('core', 'encryption_enabled', 'yes');
$this->appConfig->setValueBool('core', 'encryption_enabled', true);
}
$this->resetMaintenanceAndTrashbin();
return 0;
}
$output->write('Enable server side encryption... ');
$this->config->setAppValue('core', 'encryption_enabled', 'yes');
$output->writeln('done.');
if ($originallyEnabled) {
$output->write('Enable server side encryption... ');
$this->appConfig->setValueBool('core', 'encryption_enabled', true);
$output->writeln('done.');
}
$output->writeln('aborted');
return 1;
} catch (\Exception $e) {
// enable server side encryption again if something went wrong
$this->config->setAppValue('core', 'encryption_enabled', 'yes');
if ($originallyEnabled) {
$this->appConfig->setValueBool('core', 'encryption_enabled', true);
}
$this->resetMaintenanceAndTrashbin();
throw $e;
}
Expand Down
111 changes: 47 additions & 64 deletions tests/Core/Command/Encryption/DecryptAllTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,32 @@

use OC\Core\Command\Encryption\DecryptAll;
use OCP\App\IAppManager;
use OCP\Encryption\IManager;
use OCP\IAppConfig;
use OCP\IConfig;
use PHPUnit\Framework\MockObject\MockObject;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Test\TestCase;

class DecryptAllTest extends TestCase {
/** @var \PHPUnit\Framework\MockObject\MockObject|IConfig */
protected $config;

/** @var \PHPUnit\Framework\MockObject\MockObject | \OCP\Encryption\IManager */
protected $encryptionManager;

/** @var \PHPUnit\Framework\MockObject\MockObject|IAppManager */
protected $appManager;

/** @var \PHPUnit\Framework\MockObject\MockObject | \Symfony\Component\Console\Input\InputInterface */
protected $consoleInput;

/** @var \PHPUnit\Framework\MockObject\MockObject | \Symfony\Component\Console\Output\OutputInterface */
protected $consoleOutput;

/** @var \PHPUnit\Framework\MockObject\MockObject | \Symfony\Component\Console\Helper\QuestionHelper */
protected $questionHelper;

/** @var \PHPUnit\Framework\MockObject\MockObject | \OC\Encryption\DecryptAll */
protected $decryptAll;
private MockObject&IConfig $config;
private MockObject&IAppConfig $appConfig;
private MockObject&IAppManager $appManager;
private MockObject&InputInterface $consoleInput;
private MockObject&OutputInterface $consoleOutput;
private MockObject&QuestionHelper $questionHelper;
private MockObject&\OC\Encryption\DecryptAll $decryptAll;

protected function setUp(): void {
parent::setUp();

$this->config = $this->getMockBuilder(IConfig::class)
->disableOriginalConstructor()
->getMock();
$this->encryptionManager = $this->getMockBuilder(IManager::class)
->disableOriginalConstructor()
->getMock();
$this->appManager = $this->getMockBuilder(IAppManager::class)
->disableOriginalConstructor()
->getMock();
$this->questionHelper = $this->getMockBuilder(QuestionHelper::class)
->disableOriginalConstructor()
->getMock();
$this->decryptAll = $this->getMockBuilder(\OC\Encryption\DecryptAll::class)
->disableOriginalConstructor()->getMock();
$this->config = $this->createMock(IConfig::class);
$this->appConfig = $this->createMock(IAppConfig::class);
$this->appManager = $this->createMock(IAppManager::class);
$this->questionHelper = $this->createMock(QuestionHelper::class);
$this->decryptAll = $this->createMock(\OC\Encryption\DecryptAll::class);

$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
$this->consoleInput->expects($this->any())
->method('isInteractive')
Expand Down Expand Up @@ -92,9 +72,9 @@ public function testMaintenanceAndTrashbin(): void {
->with('files_trashbin');

$instance = new DecryptAll(
$this->encryptionManager,
$this->appManager,
$this->config,
$this->appConfig,
$this->decryptAll,
$this->questionHelper
);
Expand All @@ -113,15 +93,16 @@ public function testMaintenanceAndTrashbin(): void {
#[\PHPUnit\Framework\Attributes\DataProvider('dataTestExecute')]
public function testExecute($encryptionEnabled, $continue): void {
$instance = new DecryptAll(
$this->encryptionManager,
$this->appManager,
$this->config,
$this->appConfig,
$this->decryptAll,
$this->questionHelper
);

$this->encryptionManager->expects($this->once())
->method('isEnabled')
$this->appConfig->expects($this->once())
->method('getValueBool')
->with('core', 'encryption_enabled')
->willReturn($encryptionEnabled);

$this->consoleInput->expects($this->any())
Expand All @@ -131,29 +112,29 @@ public function testExecute($encryptionEnabled, $continue): void {

if ($encryptionEnabled) {
$calls = [
['core', 'encryption_enabled', 'no'],
['core', 'encryption_enabled', 'yes'],
['core', 'encryption_enabled', false, false],
['core', 'encryption_enabled', true, false],
];
$this->config->expects($this->exactly(2))
->method('setAppValue')
->willReturnCallback(function () use (&$calls): void {
$this->appConfig->expects($this->exactly(count($calls)))
->method('setValueBool')
->willReturnCallback(function () use (&$calls): bool {
$expected = array_shift($calls);
$this->assertEquals($expected, func_get_args());
return true;
});
$this->questionHelper->expects($this->once())
->method('ask')
->willReturn($continue);
if ($continue) {
$this->decryptAll->expects($this->once())
->method('decryptAll')
->with($this->consoleInput, $this->consoleOutput, 'user1');
} else {
$this->decryptAll->expects($this->never())->method('decryptAll');
}
} else {
$this->config->expects($this->never())->method('setAppValue');
$this->appConfig->expects($this->never())
->method('setValueBool');
}
$this->questionHelper->expects($this->once())
->method('ask')
->willReturn($continue);
if ($continue) {
$this->decryptAll->expects($this->once())
->method('decryptAll')
->with($this->consoleInput, $this->consoleOutput, 'user1');
} else {
$this->decryptAll->expects($this->never())->method('decryptAll');
$this->questionHelper->expects($this->never())->method('ask');
}

$this->invokePrivate($instance, 'execute', [$this->consoleInput, $this->consoleOutput]);
Expand All @@ -173,26 +154,28 @@ public function testExecuteFailure(): void {
$this->expectException(\Exception::class);

$instance = new DecryptAll(
$this->encryptionManager,
$this->appManager,
$this->config,
$this->appConfig,
$this->decryptAll,
$this->questionHelper
);

// make sure that we enable encryption again after a exception was thrown
$calls = [
['core', 'encryption_enabled', 'no'],
['core', 'encryption_enabled', 'yes'],
['core', 'encryption_enabled', false, false],
['core', 'encryption_enabled', true, false],
];
$this->config->expects($this->exactly(2))
->method('setAppValue')
->willReturnCallback(function () use (&$calls): void {
$this->appConfig->expects($this->exactly(2))
->method('setValuebool')
->willReturnCallback(function () use (&$calls): bool {
$expected = array_shift($calls);
$this->assertEquals($expected, func_get_args());
return true;
});
$this->encryptionManager->expects($this->once())
->method('isEnabled')
$this->appConfig->expects($this->once())
->method('getValueBool')
->with('core', 'encryption_enabled')
->willReturn(true);

$this->consoleInput->expects($this->any())
Expand Down
Loading