123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425 |
- <?php
- namespace OCA\Encryption\Tests\Crypto;
- use OC\Encryption\Exceptions\DecryptionFailedException;
- use OC\Files\View;
- use OCA\Encryption\Crypto\Crypt;
- use OCA\Encryption\Crypto\DecryptAll;
- use OCA\Encryption\Crypto\EncryptAll;
- use OCA\Encryption\Crypto\Encryption;
- use OCA\Encryption\Exceptions\PublicKeyMissingException;
- use OCA\Encryption\KeyManager;
- use OCA\Encryption\Session;
- use OCA\Encryption\Util;
- use OCP\Files\Storage\IStorage;
- use OCP\IL10N;
- use PHPUnit\Framework\MockObject\MockObject;
- use Psr\Log\LoggerInterface;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Output\OutputInterface;
- use Test\TestCase;
- class EncryptionTest extends TestCase {
-
- private $instance;
-
- private $keyManagerMock;
-
- private $encryptAllMock;
-
- private $decryptAllMock;
-
- private $sessionMock;
-
- private $cryptMock;
-
- private $utilMock;
-
- private $loggerMock;
-
- private $l10nMock;
- private IStorage&MockObject $storageMock;
- protected function setUp(): void {
- parent::setUp();
- $this->storageMock = $this->getMockBuilder(IStorage::class)
- ->disableOriginalConstructor()->getMock();
- $this->cryptMock = $this->getMockBuilder(Crypt::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->utilMock = $this->getMockBuilder(Util::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->keyManagerMock = $this->getMockBuilder(KeyManager::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->sessionMock = $this->getMockBuilder(Session::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->encryptAllMock = $this->getMockBuilder(EncryptAll::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->decryptAllMock = $this->getMockBuilder(DecryptAll::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->loggerMock = $this->getMockBuilder(LoggerInterface::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->l10nMock = $this->getMockBuilder(IL10N::class)
- ->disableOriginalConstructor()
- ->getMock();
- $this->l10nMock->expects($this->any())
- ->method('t')
- ->with($this->anything())
- ->willReturnArgument(0);
- $this->instance = new Encryption(
- $this->cryptMock,
- $this->keyManagerMock,
- $this->utilMock,
- $this->sessionMock,
- $this->encryptAllMock,
- $this->decryptAllMock,
- $this->loggerMock,
- $this->l10nMock
- );
- }
-
- public function testEndUser1(): void {
- $this->sessionMock->expects($this->once())
- ->method('decryptAllModeActivated')
- ->willReturn(false);
- $this->instance->begin('/foo/bar', 'user1', 'r', [], ['users' => ['user1', 'user2', 'user3']]);
- $this->endTest();
- }
-
- public function testEndUser2(): void {
- $this->sessionMock->expects($this->once())
- ->method('decryptAllModeActivated')
- ->willReturn(false);
- $this->expectException(PublicKeyMissingException::class);
- $this->instance->begin('/foo/bar', 'user2', 'r', [], ['users' => ['user1', 'user2', 'user3']]);
- $this->endTest();
- }
-
- public function endTest() {
-
- self::invokePrivate($this->instance, 'isWriteOperation', [true]);
- self::invokePrivate($this->instance, 'writeCache', ['']);
- $this->keyManagerMock->expects($this->any())
- ->method('getPublicKey')
- ->willReturnCallback([$this, 'getPublicKeyCallback']);
- $this->keyManagerMock->expects($this->any())
- ->method('addSystemKeys')
- ->willReturnCallback([$this, 'addSystemKeysCallback']);
- $this->cryptMock->expects($this->any())
- ->method('multiKeyEncrypt')
- ->willReturn([]);
- $this->instance->end('/foo/bar');
- }
- public function getPublicKeyCallback($uid) {
- if ($uid === 'user2') {
- throw new PublicKeyMissingException($uid);
- }
- return $uid;
- }
- public function addSystemKeysCallback($accessList, $publicKeys) {
- $this->assertSame(2, count($publicKeys));
- $this->assertArrayHasKey('user1', $publicKeys);
- $this->assertArrayHasKey('user3', $publicKeys);
- return $publicKeys;
- }
-
- public function testGetPathToRealFile($path, $expected): void {
- $this->assertSame($expected,
- self::invokePrivate($this->instance, 'getPathToRealFile', [$path])
- );
- }
- public function dataProviderForTestGetPathToRealFile() {
- return [
- ['/user/files/foo/bar.txt', '/user/files/foo/bar.txt'],
- ['/user/files/foo.txt', '/user/files/foo.txt'],
- ['/user/files_versions/foo.txt.v543534', '/user/files/foo.txt'],
- ['/user/files_versions/foo/bar.txt.v5454', '/user/files/foo/bar.txt'],
- ];
- }
-
- public function testBegin($mode, $header, $legacyCipher, $defaultCipher, $fileKey, $expected): void {
- $this->sessionMock->expects($this->once())
- ->method('decryptAllModeActivated')
- ->willReturn(false);
- $this->sessionMock->expects($this->never())->method('getDecryptAllUid');
- $this->sessionMock->expects($this->never())->method('getDecryptAllKey');
- $this->keyManagerMock->expects($this->never())->method('getEncryptedFileKey');
- $this->keyManagerMock->expects($this->never())->method('getShareKey');
- $this->cryptMock->expects($this->never())->method('multiKeyDecrypt');
- $this->cryptMock->expects($this->any())
- ->method('getCipher')
- ->willReturn($defaultCipher);
- $this->cryptMock->expects($this->any())
- ->method('getLegacyCipher')
- ->willReturn($legacyCipher);
- if (empty($fileKey)) {
- $this->cryptMock->expects($this->once())
- ->method('generateFileKey')
- ->willReturn('fileKey');
- } else {
- $this->cryptMock->expects($this->never())
- ->method('generateFileKey');
- }
- $this->keyManagerMock->expects($this->once())
- ->method('getFileKey')
- ->willReturn($fileKey);
- $result = $this->instance->begin('/user/files/foo.txt', 'user', $mode, $header, []);
- $this->assertArrayHasKey('cipher', $result);
- $this->assertSame($expected, $result['cipher']);
- if ($mode === 'w') {
- $this->assertTrue(self::invokePrivate($this->instance, 'isWriteOperation'));
- } else {
- $this->assertFalse(self::invokePrivate($this->instance, 'isWriteOperation'));
- }
- }
- public function dataTestBegin() {
- return [
- ['w', ['cipher' => 'myCipher'], 'legacyCipher', 'defaultCipher', 'fileKey', 'defaultCipher'],
- ['r', ['cipher' => 'myCipher'], 'legacyCipher', 'defaultCipher', 'fileKey', 'myCipher'],
- ['w', [], 'legacyCipher', 'defaultCipher', '', 'defaultCipher'],
- ['r', [], 'legacyCipher', 'defaultCipher', 'file_key', 'legacyCipher'],
- ];
- }
-
- public function testBeginDecryptAll(): void {
- $path = '/user/files/foo.txt';
- $fileKey = 'fileKey';
- $this->sessionMock->expects($this->once())
- ->method('decryptAllModeActivated')
- ->willReturn(true);
- $this->keyManagerMock->expects($this->once())
- ->method('getFileKey')
- ->with($path, 'user', null, true)
- ->willReturn($fileKey);
- $this->instance->begin($path, 'user', 'r', [], []);
- $this->assertSame($fileKey,
- $this->invokePrivate($this->instance, 'fileKey')
- );
- }
-
- public function testBeginInitMasterKey(): void {
- $this->sessionMock->expects($this->once())
- ->method('decryptAllModeActivated')
- ->willReturn(false);
- $this->sessionMock->expects($this->once())->method('isReady')->willReturn(false);
- $this->utilMock->expects($this->once())->method('isMasterKeyEnabled')
- ->willReturn(true);
- $this->keyManagerMock->expects($this->once())->method('init')->with('', '');
- $this->instance->begin('/user/files/welcome.txt', 'user', 'r', [], []);
- }
-
- public function testUpdate($fileKey, $expected): void {
- $this->keyManagerMock->expects($this->once())
- ->method('getFileKey')->willReturn($fileKey);
- $this->keyManagerMock->expects($this->any())
- ->method('getPublicKey')->willReturn('publicKey');
- $this->keyManagerMock->expects($this->any())
- ->method('addSystemKeys')
- ->willReturnCallback(function ($accessList, $publicKeys) {
- return $publicKeys;
- });
- $this->keyManagerMock->expects($this->never())->method('getVersion');
- $this->keyManagerMock->expects($this->never())->method('setVersion');
- $this->assertSame($expected,
- $this->instance->update('path', 'user1', ['users' => ['user1']])
- );
- }
- public function dataTestUpdate() {
- return [
- ['', false],
- ['fileKey', true]
- ];
- }
- public function testUpdateNoUsers(): void {
- $this->invokePrivate($this->instance, 'rememberVersion', [['path' => 2]]);
- $this->keyManagerMock->expects($this->never())->method('getFileKey');
- $this->keyManagerMock->expects($this->never())->method('getPublicKey');
- $this->keyManagerMock->expects($this->never())->method('addSystemKeys');
- $this->keyManagerMock->expects($this->once())->method('setVersion')
- ->willReturnCallback(function ($path, $version, $view): void {
- $this->assertSame('path', $path);
- $this->assertSame(2, $version);
- $this->assertTrue($view instanceof View);
- });
- $this->instance->update('path', 'user1', []);
- }
-
- public function testUpdateMissingPublicKey(): void {
- $this->keyManagerMock->expects($this->once())
- ->method('getFileKey')->willReturn('fileKey');
- $this->keyManagerMock->expects($this->any())
- ->method('getPublicKey')->willReturnCallback(
- function ($user): void {
- throw new PublicKeyMissingException($user);
- }
- );
- $this->keyManagerMock->expects($this->any())
- ->method('addSystemKeys')
- ->willReturnCallback(function ($accessList, $publicKeys) {
- return $publicKeys;
- });
- $this->cryptMock->expects($this->once())->method('multiKeyEncrypt')
- ->willReturnCallback(
- function ($fileKey, $publicKeys) {
- $this->assertEmpty($publicKeys);
- $this->assertSame('fileKey', $fileKey);
- return [];
- }
- );
- $this->keyManagerMock->expects($this->never())->method('getVersion');
- $this->keyManagerMock->expects($this->never())->method('setVersion');
- $this->assertTrue(
- $this->instance->update('path', 'user1', ['users' => ['user1']])
- );
- }
-
- public function testShouldEncrypt($path, $shouldEncryptHomeStorage, $isHomeStorage, $expected): void {
- $this->utilMock->expects($this->once())->method('shouldEncryptHomeStorage')
- ->willReturn($shouldEncryptHomeStorage);
- if ($shouldEncryptHomeStorage === false) {
- $this->storageMock->expects($this->once())->method('instanceOfStorage')
- ->with('\OCP\Files\IHomeStorage')->willReturn($isHomeStorage);
- $this->utilMock->expects($this->once())->method('getStorage')->with($path)
- ->willReturn($this->storageMock);
- }
- $this->assertSame($expected,
- $this->instance->shouldEncrypt($path)
- );
- }
- public function dataTestShouldEncrypt() {
- return [
- ['/user1/files/foo.txt', true, true, true],
- ['/user1/files_versions/foo.txt', true, true, true],
- ['/user1/files_trashbin/foo.txt', true, true, true],
- ['/user1/some_folder/foo.txt', true, true, false],
- ['/user1/foo.txt', true, true, false],
- ['/user1/files', true, true, false],
- ['/user1/files_trashbin', true, true, false],
- ['/user1/files_versions', true, true, false],
-
- ['/user1/files/foo.txt', false, true, false],
- ['/user1/files_versions/foo.txt', false, false, true],
- ];
- }
- public function testDecrypt(): void {
- $this->expectException(DecryptionFailedException::class);
- $this->expectExceptionMessage('Cannot decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
- $this->instance->decrypt('abc');
- }
- public function testPrepareDecryptAll(): void {
-
- $input = $this->createMock(InputInterface::class);
-
- $output = $this->createMock(OutputInterface::class);
- $this->decryptAllMock->expects($this->once())->method('prepare')
- ->with($input, $output, 'user');
- $this->instance->prepareDecryptAll($input, $output, 'user');
- }
- }
|