wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Stop decryption when maintenance mode is enabled, fixes #8311

Browse source 
Signed-off-by: Ruben Homs <ruben@homs.codes>
This commit is contained in:
Ruben Homs 2018-10-29 15:36:16 +01:00
parent 50dbdeea46
commit 98047e8c1c
No known key found for this signature in database
GPG key ID: 6885E9DD1E14BC1F
6 changed files with 99 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
core/Command/Encryption/DecryptAll.php
View file

@ -132,6 +132,15 @@ class DecryptAll extends Command {
return;
}
$isMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
if ($isMaintenanceModeEnabled) {
$output->writeln("Maintenance mode must be disabled when starting decryption,");
$output->writeln("in order to load the relevant encryption modules correctly.");
$output->writeln("Your instance will automatically be put to maintenance mode");
$output->writeln("during the actual decryption of the files.");
return;
}
try {
if ($this->encryptionManager->isEnabled() === true) {
$output->write('Disable server side encryption... ');

18
core/Command/Encryption/ListModules.php
View file

@ -24,6 +24,7 @@ namespace OC\Core\Command\Encryption;
use OC\Core\Command\Base;
use OCP\Encryption\IManager;
use OCP\IConfig;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
@ -31,12 +32,20 @@ class ListModules extends Base {
/** @var IManager */
protected $encryptionManager;
/** @var IConfig */
protected $config;
/**
* @param IManager $encryptionManager
* @param IConfig $config
*/
public function __construct(IManager $encryptionManager) {
public function __construct(
IManager $encryptionManager,
IConfig $config
) {
parent::__construct();
$this->encryptionManager = $encryptionManager;
$this->config = $config;
}
protected function configure() {
@ -49,6 +58,13 @@ class ListModules extends Base {
}
protected function execute(InputInterface $input, OutputInterface $output) {
$isMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
if ($isMaintenanceModeEnabled) {
$output->writeln("Maintenance mode must be disabled when listing modules");
$output->writeln("in order to list the relevant encryption modules correctly.");
return;
}
$encryptionModules = $this->encryptionManager->getEncryptionModules();
$defaultEncryptionModuleId = $this->encryptionManager->getDefaultEncryptionModuleId();

18
core/Command/Encryption/SetDefaultModule.php
View file

@ -24,6 +24,7 @@ namespace OC\Core\Command\Encryption;
use OCP\Encryption\IManager;
use OCP\IConfig;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
@ -33,12 +34,20 @@ class SetDefaultModule extends Command {
/** @var IManager */
protected $encryptionManager;
/** @var IConfig */
protected $config;
/**
* @param IManager $encryptionManager
* @param IConfig $config
*/
public function __construct(IManager $encryptionManager) {
public function __construct(
IManager $encryptionManager,
IConfig $config
) {
parent::__construct();
$this->encryptionManager = $encryptionManager;
$this->config = $config;
}
protected function configure() {
@ -56,6 +65,13 @@ class SetDefaultModule extends Command {
}
protected function execute(InputInterface $input, OutputInterface $output) {
$isMaintenanceModeEnabled = $this->config->getSystemValue('maintenance', false);
if ($isMaintenanceModeEnabled) {
$output->writeln("Maintenance mode must be disabled when setting default module,");
$output->writeln("in order to load the relevant encryption modules correctly.");
return;
}
$moduleId = $input->getArgument('module');
if ($moduleId === $this->encryptionManager->getDefaultEncryptionModuleId()) {

4
core/register_command.php
View file

@ -99,8 +99,8 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
$application->add(new OC\Core\Command\Encryption\Disable(\OC::$server->getConfig()));
$application->add(new OC\Core\Command\Encryption\Enable(\OC::$server->getConfig(), \OC::$server->getEncryptionManager()));
$application->add(new OC\Core\Command\Encryption\ListModules(\OC::$server->getEncryptionManager()));
$application->add(new OC\Core\Command\Encryption\SetDefaultModule(\OC::$server->getEncryptionManager()));
$application->add(new OC\Core\Command\Encryption\ListModules(\OC::$server->getEncryptionManager(), \OC::$server->getConfig()));
$application->add(new OC\Core\Command\Encryption\SetDefaultModule(\OC::$server->getEncryptionManager(), \OC::$server->getConfig()));
$application->add(new OC\Core\Command\Encryption\Status(\OC::$server->getEncryptionManager()));
$application->add(new OC\Core\Command\Encryption\EncryptAll(\OC::$server->getEncryptionManager(), \OC::$server->getAppManager(), \OC::$server->getConfig(), new \Symfony\Component\Console\Helper\QuestionHelper()));
$application->add(new OC\Core\Command\Encryption\DecryptAll(

8
tests/Core/Command/Encryption/DecryptAllTest.php
View file

@ -148,7 +148,7 @@ class DecryptAllTest extends TestCase {
->willReturn('user1');
if ($encryptionEnabled) {
$this->config->expects($this->at(0))
$this->config->expects($this->at(1))
->method('setAppValue')
->with('core', 'encryption_enabled', 'no');
$this->questionHelper->expects($this->once())
@ -160,7 +160,7 @@ class DecryptAllTest extends TestCase {
->with($this->consoleInput, $this->consoleOutput, 'user1');
} else {
$this->decryptAll->expects($this->never())->method('decryptAll');
$this->config->expects($this->at(1))
$this->config->expects($this->at(2))
->method('setAppValue')
->with('core', 'encryption_enabled', 'yes');
}
@ -194,12 +194,12 @@ class DecryptAllTest extends TestCase {
$this->questionHelper
);
$this->config->expects($this->at(0))
$this->config->expects($this->at(1))
->method('setAppValue')
->with('core', 'encryption_enabled', 'no');
// make sure that we enable encryption again after a exception was thrown
$this->config->expects($this->at(3))
$this->config->expects($this->at(4))
->method('setAppValue')
->with('core', 'encryption_enabled', 'yes');

54
tests/Core/Command/Encryption/SetDefaultModuleTest.php
View file

@ -24,13 +24,16 @@ namespace Tests\Core\Command\Encryption;
use OC\Core\Command\Encryption\SetDefaultModule;
use OCP\Encryption\IManager;
use OCP\IConfig;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Test\TestCase;
class SetDefaultModuleTest extends TestCase {
/** @var \PHPUnit_Framework_MockObject_MockObject */
/** @var \PHPUnit_Framework_MockObject_MockObject|IManager */
protected $manager;
/** @var \PHPUnit_Framework_MockObject_MockObject|IConfig */
protected $config;
/** @var \PHPUnit_Framework_MockObject_MockObject */
protected $consoleInput;
/** @var \PHPUnit_Framework_MockObject_MockObject */
@ -42,14 +45,16 @@ class SetDefaultModuleTest extends TestCase {
protected function setUp() {
parent::setUp();
$manager = $this->manager = $this->getMockBuilder(IManager::class)
$this->manager = $this->getMockBuilder(IManager::class)
->disableOriginalConstructor()
->getMock();
$this->config = $this->getMockBuilder(IConfig::class)
->getMock();
$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock();
/** @var \OCP\Encryption\IManager $manager */
$this->command = new SetDefaultModule($manager);
$this->command = new SetDefaultModule($this->manager, $this->config);
}
@ -79,6 +84,12 @@ class SetDefaultModuleTest extends TestCase {
$this->manager->expects($this->once())
->method('getDefaultEncryptionModuleId')
->willReturn($oldModule);
$this->config->expects($this->once())
->method('getSystemValue')
->with('maintenance', false)
->willReturn(false);
if ($updateModule) {
$this->manager->expects($this->once())
->method('setDefaultEncryptionModule')
@ -92,4 +103,39 @@ class SetDefaultModuleTest extends TestCase {
self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
}
/**
* @dataProvider dataSetDefaultModule
*
* @param string $oldModule
* @param string $newModule
* @param string $updateModule
* @param bool $updateSuccess
* @param string $expectedString
*/
public function testMaintenanceMode($oldModule, $newModule, $updateModule, $updateSuccess, $expectedString) {
$this->consoleInput->expects($this->never())
->method('getArgument')
->with('module')
->willReturn($newModule);
$this->manager->expects($this->never())
->method('getDefaultEncryptionModuleId')
->willReturn($oldModule);
$this->config->expects($this->once())
->method('getSystemValue')
->with('maintenance', false)
->willReturn(true);
$this->consoleOutput->expects($this->at(0))
->method('writeln')
->with($this->stringContains('Maintenance mode must be disabled when setting default module,'));
$this->consoleOutput->expects($this->at(1))
->method('writeln')
->with($this->stringContains('in order to load the relevant encryption modules correctly.'));
self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
}
}