Skip to content

[stable31] fix(encryption): Ignore shared files in encrypt-all command #54262

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

Merged
merged 2 commits into from
Aug 7, 2025
Merged

[stable31] fix(encryption): Ignore shared files in encrypt-all command #54262

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
a96733b
fix(encryption): Ignore shared files in encrypt-all command
come-nc Aug 4, 2025
efd541c
chore(encryption): Adapt tests to code changes
come-nc Aug 4, 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
23 changes: 10 additions & 13 deletions apps/encryption/lib/Crypto/EncryptAll.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use OCA\Encryption\KeyManager;
use OCA\Encryption\Users\Setup;
use OCA\Encryption\Util;
use OCP\Files\FileInfo;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IUser;
Expand Down Expand Up @@ -202,15 +203,19 @@ protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
while ($root = array_pop($directories)) {
$content = $this->rootView->getDirectoryContent($root);
foreach ($content as $file) {
$path = $root . '/' . $file['name'];
if ($this->rootView->is_dir($path)) {
$path = $root . '/' . $file->getName();
if ($file->isShared()) {
$progress->setMessage("Skip shared file/folder $path");
$progress->advance();
continue;
} elseif ($file->getType() === FileInfo::TYPE_FOLDER) {
$directories[] = $path;
continue;
} else {
$progress->setMessage("encrypt files for user $userCount: $path");
$progress->advance();
try {
if ($this->encryptFile($path) === false) {
if ($this->encryptFile($file, $path) === false) {
$progress->setMessage("encrypt files for user $userCount: $path (already encrypted)");
$progress->advance();
}
Expand All @@ -231,17 +236,9 @@ protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
}
}

/**
* encrypt file
*
* @param string $path
* @return bool
*/
protected function encryptFile($path) {

protected function encryptFile(FileInfo $fileInfo, string $path): bool {
// skip already encrypted files
$fileInfo = $this->rootView->getFileInfo($path);
if ($fileInfo !== false && $fileInfo->isEncrypted()) {
if ($fileInfo->isEncrypted()) {
return true;
}

Expand Down
102 changes: 59 additions & 43 deletions apps/encryption/tests/Crypto/EncryptAllTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
Expand Down Expand Up @@ -30,6 +32,7 @@
use Test\TestCase;

class EncryptAllTest extends TestCase {

protected KeyManager&MockObject $keyManager;
protected Util&MockObject $util;
protected IUserManager&MockObject $userManager;
Expand All @@ -46,8 +49,7 @@ class EncryptAllTest extends TestCase {
protected ISecureRandom&MockObject $secureRandom;
protected LoggerInterface&MockObject $logger;

/** @var EncryptAll */
protected $encryptAll;
protected EncryptAll $encryptAll;

protected function setUp(): void {
parent::setUp();
Expand Down Expand Up @@ -80,7 +82,7 @@ protected function setUp(): void {

/**
* We need format method to return a string
* @var OutputFormatterInterface|\PHPUnit\Framework\MockObject\MockObject
* @var OutputFormatterInterface&MockObject
*/
$outputFormatter = $this->createMock(OutputFormatterInterface::class);
$outputFormatter->method('isDecorated')->willReturn(false);
Expand Down Expand Up @@ -112,6 +114,13 @@ protected function setUp(): void {
);
}

protected function createFileInfoMock($type, string $name): FileInfo&MockObject {
$fileInfo = $this->createMock(FileInfo::class);
$fileInfo->method('getType')->willReturn($type);
$fileInfo->method('getName')->willReturn($name);
return $fileInfo;
}

public function testEncryptAll(): void {
/** @var EncryptAll&MockObject $encryptAll */
$encryptAll = $this->getMockBuilder(EncryptAll::class)
Expand All @@ -131,7 +140,7 @@ public function testEncryptAll(): void {
$this->logger,
]
)
->setMethods(['createKeyPairs', 'encryptAllUsersFiles', 'outputPasswords'])
->onlyMethods(['createKeyPairs', 'encryptAllUsersFiles', 'outputPasswords'])
->getMock();

$this->util->expects($this->any())->method('isMasterKeyEnabled')->willReturn(false);
Expand Down Expand Up @@ -161,7 +170,7 @@ public function testEncryptAllWithMasterKey(): void {
$this->logger,
]
)
->setMethods(['createKeyPairs', 'encryptAllUsersFiles', 'outputPasswords'])
->onlyMethods(['createKeyPairs', 'encryptAllUsersFiles', 'outputPasswords'])
->getMock();

$this->util->expects($this->any())->method('isMasterKeyEnabled')->willReturn(true);
Expand Down Expand Up @@ -192,7 +201,7 @@ public function testCreateKeyPairs(): void {
$this->logger,
]
)
->setMethods(['setupUserFS', 'generateOneTimePassword'])
->onlyMethods(['setupUserFS', 'generateOneTimePassword'])
->getMock();


Expand Down Expand Up @@ -225,7 +234,7 @@ function ($user) {
}

public function testEncryptAllUsersFiles(): void {
/** @var EncryptAll | \PHPUnit\Framework\MockObject\MockObject $encryptAll */
/** @var EncryptAll&MockObject $encryptAll */
$encryptAll = $this->getMockBuilder(EncryptAll::class)
->setConstructorArgs(
[
Expand All @@ -243,7 +252,7 @@ public function testEncryptAllUsersFiles(): void {
$this->logger,
]
)
->setMethods(['encryptUsersFiles'])
->onlyMethods(['encryptUsersFiles'])
->getMock();

$this->util->expects($this->any())->method('isMasterKeyEnabled')->willReturn(false);
Expand All @@ -252,17 +261,22 @@ public function testEncryptAllUsersFiles(): void {
$this->invokePrivate($encryptAll, 'output', [$this->outputInterface]);
$this->invokePrivate($encryptAll, 'userPasswords', [['user1' => 'pwd1', 'user2' => 'pwd2']]);

$encryptAll->expects($this->exactly(2))->method('encryptUsersFiles')
->withConsecutive(
['user1'],
['user2'],
);
$encryptAllCalls = [];
$encryptAll->expects($this->exactly(2))
->method('encryptUsersFiles')
->willReturnCallback(function ($uid) use (&$encryptAllCalls): void {
$encryptAllCalls[] = $uid;
});

$this->invokePrivate($encryptAll, 'encryptAllUsersFiles');
self::assertEquals([
'user1',
'user2',
], $encryptAllCalls);
}

public function testEncryptUsersFiles(): void {
/** @var EncryptAll | \PHPUnit\Framework\MockObject\MockObject $encryptAll */
/** @var EncryptAll&MockObject $encryptAll */
$encryptAll = $this->getMockBuilder(EncryptAll::class)
->setConstructorArgs(
[
Expand All @@ -280,40 +294,39 @@ public function testEncryptUsersFiles(): void {
$this->logger,
]
)
->setMethods(['encryptFile', 'setupUserFS'])
->onlyMethods(['encryptFile', 'setupUserFS'])
->getMock();

$this->util->expects($this->any())->method('isMasterKeyEnabled')->willReturn(false);

$this->view->expects($this->exactly(2))->method('getDirectoryContent')
->withConsecutive(
['/user1/files'],
['/user1/files/foo'],
)->willReturnOnConsecutiveCalls(
->willReturnMap([
[
['name' => 'foo', 'type' => 'dir'],
['name' => 'bar', 'type' => 'file'],
'/user1/files',
'',
null,
[
$this->createFileInfoMock(FileInfo::TYPE_FOLDER, 'foo'),
$this->createFileInfoMock(FileInfo::TYPE_FILE, 'bar'),
],
],
[
['name' => 'subfile', 'type' => 'file']
]
);

$this->view->expects($this->any())->method('is_dir')
->willReturnCallback(
function ($path) {
if ($path === '/user1/files/foo') {
return true;
}
return false;
}
);
'/user1/files/foo',
'',
null,
[
$this->createFileInfoMock(FileInfo::TYPE_FILE, 'subfile'),
],
],
]);

$encryptAll->expects($this->exactly(2))->method('encryptFile')
->withConsecutive(
['/user1/files/bar'],
['/user1/files/foo/subfile'],
);
$encryptAllCalls = [];
$encryptAll->expects($this->exactly(2))
->method('encryptFile')
->willReturnCallback(function (FileInfo $file, string $path) use (&$encryptAllCalls): bool {
$encryptAllCalls[] = $path;
return true;
});

$outputFormatter = $this->createMock(OutputFormatterInterface::class);
$outputFormatter->method('isDecorated')->willReturn(false);
Expand All @@ -323,6 +336,10 @@ function ($path) {
$progressBar = new ProgressBar($this->outputInterface);

$this->invokePrivate($encryptAll, 'encryptUsersFiles', ['user1', $progressBar, '']);
self::assertEquals([
'/user1/files/bar',
'/user1/files/foo/subfile',
], $encryptAllCalls);
}

public function testGenerateOneTimePassword(): void {
Expand All @@ -343,8 +360,7 @@ public function testEncryptFile($isEncrypted): void {
$fileInfo = $this->createMock(FileInfo::class);
$fileInfo->expects($this->any())->method('isEncrypted')
->willReturn($isEncrypted);
$this->view->expects($this->any())->method('getFileInfo')
->willReturn($fileInfo);
$this->view->expects($this->never())->method('getFileInfo');


if ($isEncrypted) {
Expand All @@ -356,11 +372,11 @@ public function testEncryptFile($isEncrypted): void {
}

$this->assertTrue(
$this->invokePrivate($this->encryptAll, 'encryptFile', ['foo.txt'])
$this->invokePrivate($this->encryptAll, 'encryptFile', [$fileInfo, 'foo.txt'])
);
}

public function dataTestEncryptFile() {
public static function dataTestEncryptFile(): array {
return [
[true],
[false],
Expand Down
56 changes: 17 additions & 39 deletions tests/Core/Command/Encryption/EncryptAllTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
Expand All @@ -12,59 +13,36 @@
use OCP\Encryption\IEncryptionModule;
use OCP\Encryption\IManager;
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 EncryptAllTest extends TestCase {
/** @var \PHPUnit\Framework\MockObject\MockObject | \OCP\IConfig */
protected $config;

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

/** @var \PHPUnit\Framework\MockObject\MockObject | \OCP\App\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 | \OCP\Encryption\IEncryptionModule */
protected $encryptionModule;
private IConfig&MockObject $config;
private IManager&MockObject $encryptionManager;
private IAppManager&MockObject $appManager;
private InputInterface&MockObject $consoleInput;
private OutputInterface&MockObject $consoleOutput;
private QuestionHelper&MockObject $questionHelper;
private IEncryptionModule&MockObject $encryptionModule;

/** @var EncryptAll */
protected $command;
private EncryptAll $command;

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->encryptionModule = $this->getMockBuilder(IEncryptionModule::class)
->disableOriginalConstructor()
->getMock();
$this->questionHelper = $this->getMockBuilder(QuestionHelper::class)
->disableOriginalConstructor()
->getMock();
$this->consoleInput = $this->getMockBuilder(InputInterface::class)->getMock();
$this->config = $this->createMock(IConfig::class);
$this->encryptionManager = $this->createMock(IManager::class);
$this->appManager = $this->createMock(IAppManager::class);
$this->encryptionModule = $this->createMock(IEncryptionModule::class);
$this->questionHelper = $this->createMock(QuestionHelper::class);
$this->consoleInput = $this->createMock(InputInterface::class);
$this->consoleInput->expects($this->any())
->method('isInteractive')
->willReturn(true);
$this->consoleOutput = $this->getMockBuilder(OutputInterface::class)->getMock();
$this->consoleOutput = $this->createMock(OutputInterface::class);
}

public function testEncryptAll(): void {
Expand Down
Loading