123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556 |
- <?php
- /**
- * ownCloud
- *
- * @copyright (C) 2015 ownCloud, Inc.
- *
- * @author Bjoern Schiessle <schiessle@owncloud.com>
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or any later version.
- *
- * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
- */
- namespace Test\Encryption\Keys;
- use OC\Encryption\Keys\Storage;
- use Test\TestCase;
- class StorageTest extends TestCase {
- /** @var Storage */
- protected $storage;
- /** @var \PHPUnit_Framework_MockObject_MockObject */
- protected $util;
- /** @var \PHPUnit_Framework_MockObject_MockObject */
- protected $view;
- /** @var \PHPUnit_Framework_MockObject_MockObject */
- protected $config;
- public function setUp() {
- parent::setUp();
- $this->util = $this->getMockBuilder('OC\Encryption\Util')
- ->disableOriginalConstructor()
- ->getMock();
- $this->view = $this->getMockBuilder('OC\Files\View')
- ->disableOriginalConstructor()
- ->getMock();
- $this->config = $this->getMockBuilder('OCP\IConfig')
- ->disableOriginalConstructor()
- ->getMock();
- $this->storage = new Storage($this->view, $this->util);
- }
- public function testSetFileKey() {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturn(array('user1', '/files/foo.txt'));
- $this->util->expects($this->any())
- ->method('stripPartialFileExtension')
- ->willReturnArgument(0);
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(false);
- $this->view->expects($this->once())
- ->method('file_put_contents')
- ->with($this->equalTo('/user1/files_encryption/keys/files/foo.txt/encModule/fileKey'),
- $this->equalTo('key'))
- ->willReturn(strlen('key'));
- $this->assertTrue(
- $this->storage->setFileKey('user1/files/foo.txt', 'fileKey', 'key', 'encModule')
- );
- }
- public function dataTestGetFileKey() {
- return [
- ['/files/foo.txt', '/files/foo.txt', true, 'key'],
- ['/files/foo.txt.ocTransferId2111130212.part', '/files/foo.txt', true, 'key'],
- ['/files/foo.txt.ocTransferId2111130212.part', '/files/foo.txt', false, 'key2'],
- ];
- }
- /**
- * @dataProvider dataTestGetFileKey
- *
- * @param string $path
- * @param string $strippedPartialName
- * @param bool $originalKeyExists
- * @param string $expectedKeyContent
- */
- public function testGetFileKey($path, $strippedPartialName, $originalKeyExists, $expectedKeyContent) {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturnMap([
- ['user1/files/foo.txt', ['user1', '/files/foo.txt']],
- ['user1/files/foo.txt.ocTransferId2111130212.part', ['user1', '/files/foo.txt.ocTransferId2111130212.part']],
- ]);
- // we need to strip away the part file extension in order to reuse a
- // existing key if it exists, otherwise versions will break
- $this->util->expects($this->once())
- ->method('stripPartialFileExtension')
- ->willReturn('user1' . $strippedPartialName);
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(false);
- $this->view->expects($this->at(0))
- ->method('file_exists')
- ->with($this->equalTo('/user1/files_encryption/keys' . $strippedPartialName . '/encModule/fileKey'))
- ->willReturn($originalKeyExists);
- if (!$originalKeyExists) {
- $this->view->expects($this->at(1))
- ->method('file_exists')
- ->with($this->equalTo('/user1/files_encryption/keys' . $path . '/encModule/fileKey'))
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('file_get_contents')
- ->with($this->equalTo('/user1/files_encryption/keys' . $path . '/encModule/fileKey'))
- ->willReturn('key2');
- } else {
- $this->view->expects($this->once())
- ->method('file_get_contents')
- ->with($this->equalTo('/user1/files_encryption/keys' . $strippedPartialName . '/encModule/fileKey'))
- ->willReturn('key');
- }
- $this->assertSame($expectedKeyContent,
- $this->storage->getFileKey('user1' . $path, 'fileKey', 'encModule')
- );
- }
- public function testSetFileKeySystemWide() {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturn(array('user1', '/files/foo.txt'));
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(true);
- $this->util->expects($this->any())
- ->method('stripPartialFileExtension')
- ->willReturnArgument(0);
- $this->view->expects($this->once())
- ->method('file_put_contents')
- ->with($this->equalTo('/files_encryption/keys/files/foo.txt/encModule/fileKey'),
- $this->equalTo('key'))
- ->willReturn(strlen('key'));
- $this->assertTrue(
- $this->storage->setFileKey('user1/files/foo.txt', 'fileKey', 'key', 'encModule')
- );
- }
- public function testGetFileKeySystemWide() {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturn(array('user1', '/files/foo.txt'));
- $this->util->expects($this->any())
- ->method('stripPartialFileExtension')
- ->willReturnArgument(0);
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('file_get_contents')
- ->with($this->equalTo('/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn('key');
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn(true);
- $this->assertSame('key',
- $this->storage->getFileKey('user1/files/foo.txt', 'fileKey', 'encModule')
- );
- }
- public function testSetSystemUserKey() {
- $this->view->expects($this->once())
- ->method('file_put_contents')
- ->with($this->equalTo('/files_encryption/encModule/shareKey_56884'),
- $this->equalTo('key'))
- ->willReturn(strlen('key'));
- $this->assertTrue(
- $this->storage->setSystemUserKey('shareKey_56884', 'key', 'encModule')
- );
- }
- public function testSetUserKey() {
- $this->view->expects($this->once())
- ->method('file_put_contents')
- ->with($this->equalTo('/user1/files_encryption/encModule/user1.publicKey'),
- $this->equalTo('key'))
- ->willReturn(strlen('key'));
- $this->assertTrue(
- $this->storage->setUserKey('user1', 'publicKey', 'key', 'encModule')
- );
- }
- public function testGetSystemUserKey() {
- $this->view->expects($this->once())
- ->method('file_get_contents')
- ->with($this->equalTo('/files_encryption/encModule/shareKey_56884'))
- ->willReturn('key');
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/files_encryption/encModule/shareKey_56884'))
- ->willReturn(true);
- $this->assertSame('key',
- $this->storage->getSystemUserKey('shareKey_56884', 'encModule')
- );
- }
- public function testGetUserKey() {
- $this->view->expects($this->once())
- ->method('file_get_contents')
- ->with($this->equalTo('/user1/files_encryption/encModule/user1.publicKey'))
- ->willReturn('key');
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/user1/files_encryption/encModule/user1.publicKey'))
- ->willReturn(true);
- $this->assertSame('key',
- $this->storage->getUserKey('user1', 'publicKey', 'encModule')
- );
- }
- public function testDeleteUserKey() {
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/user1/files_encryption/encModule/user1.publicKey'))
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('unlink')
- ->with($this->equalTo('/user1/files_encryption/encModule/user1.publicKey'))
- ->willReturn(true);
- $this->assertTrue(
- $this->storage->deleteUserKey('user1', 'publicKey', 'encModule')
- );
- }
- public function testDeleteSystemUserKey() {
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/files_encryption/encModule/shareKey_56884'))
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('unlink')
- ->with($this->equalTo('/files_encryption/encModule/shareKey_56884'))
- ->willReturn(true);
- $this->assertTrue(
- $this->storage->deleteSystemUserKey('shareKey_56884', 'encModule')
- );
- }
- public function testDeleteFileKeySystemWide() {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturn(array('user1', '/files/foo.txt'));
- $this->util->expects($this->any())
- ->method('stripPartialFileExtension')
- ->willReturnArgument(0);
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('unlink')
- ->with($this->equalTo('/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn(true);
- $this->assertTrue(
- $this->storage->deleteFileKey('user1/files/foo.txt', 'fileKey', 'encModule')
- );
- }
- public function testDeleteFileKey() {
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->willReturn(array('user1', '/files/foo.txt'));
- $this->util->expects($this->any())
- ->method('stripPartialFileExtension')
- ->willReturnArgument(0);
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn(false);
- $this->view->expects($this->once())
- ->method('file_exists')
- ->with($this->equalTo('/user1/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('unlink')
- ->with($this->equalTo('/user1/files_encryption/keys/files/foo.txt/encModule/fileKey'))
- ->willReturn(true);
- $this->assertTrue(
- $this->storage->deleteFileKey('user1/files/foo.txt', 'fileKey', 'encModule')
- );
- }
- /**
- * @dataProvider dataProviderCopyRename
- */
- public function testRenameKeys($source, $target, $systemWideMountSource, $systemWideMountTarget, $expectedSource, $expectedTarget) {
- $this->view->expects($this->any())
- ->method('file_exists')
- ->willReturn(true);
- $this->view->expects($this->any())
- ->method('is_dir')
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('rename')
- ->with(
- $this->equalTo($expectedSource),
- $this->equalTo($expectedTarget))
- ->willReturn(true);
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->will($this->returnCallback(array($this, 'getUidAndFilenameCallback')));
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturnCallback(function($path, $owner) use ($systemWideMountSource, $systemWideMountTarget) {
- if(strpos($path, 'source.txt') !== false) {
- return $systemWideMountSource;
- }
- return $systemWideMountTarget;
- });
- $this->storage->renameKeys($source, $target);
- }
- /**
- * @dataProvider dataProviderCopyRename
- */
- public function testCopyKeys($source, $target, $systemWideMountSource, $systemWideMountTarget , $expectedSource, $expectedTarget) {
- $this->view->expects($this->any())
- ->method('file_exists')
- ->willReturn(true);
- $this->view->expects($this->any())
- ->method('is_dir')
- ->willReturn(true);
- $this->view->expects($this->once())
- ->method('copy')
- ->with(
- $this->equalTo($expectedSource),
- $this->equalTo($expectedTarget))
- ->willReturn(true);
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->will($this->returnCallback(array($this, 'getUidAndFilenameCallback')));
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturnCallback(function($path, $owner) use ($systemWideMountSource, $systemWideMountTarget) {
- if(strpos($path, 'source.txt') !== false) {
- return $systemWideMountSource;
- }
- return $systemWideMountTarget;
- });
- $this->storage->copyKeys($source, $target);
- }
- public function getUidAndFilenameCallback() {
- $args = func_get_args();
- $path = $args[0];
- $parts = explode('/', $path);
- return array($parts[1], '/' . implode('/', array_slice($parts, 2)));
- }
- public function dataProviderCopyRename() {
- return array(
- array('/user1/files/source.txt', '/user1/files/target.txt', false, false,
- '/user1/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- array('/user1/files/foo/source.txt', '/user1/files/target.txt', false, false,
- '/user1/files_encryption/keys/files/foo/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- array('/user1/files/source.txt', '/user1/files/foo/target.txt', false, false,
- '/user1/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/foo/target.txt/'),
- array('/user1/files/source.txt', '/user1/files/foo/target.txt', true, true,
- '/files_encryption/keys/files/source.txt/', '/files_encryption/keys/files/foo/target.txt/'),
- array('/user1/files/source.txt', '/user1/files/target.txt', false, true,
- '/user1/files_encryption/keys/files/source.txt/', '/files_encryption/keys/files/target.txt/'),
- array('/user1/files/source.txt', '/user1/files/target.txt', true, false,
- '/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- array('/user2/files/source.txt', '/user1/files/target.txt', false, false,
- '/user2/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- array('/user2/files/foo/source.txt', '/user1/files/target.txt', false, false,
- '/user2/files_encryption/keys/files/foo/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- array('/user2/files/source.txt', '/user1/files/foo/target.txt', false, false,
- '/user2/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/foo/target.txt/'),
- array('/user2/files/source.txt', '/user1/files/foo/target.txt', true, true,
- '/files_encryption/keys/files/source.txt/', '/files_encryption/keys/files/foo/target.txt/'),
- array('/user2/files/source.txt', '/user1/files/target.txt', false, true,
- '/user2/files_encryption/keys/files/source.txt/', '/files_encryption/keys/files/target.txt/'),
- array('/user2/files/source.txt', '/user1/files/target.txt', true, false,
- '/files_encryption/keys/files/source.txt/', '/user1/files_encryption/keys/files/target.txt/'),
- );
- }
- /**
- * @dataProvider dataTestGetPathToKeys
- *
- * @param string $path
- * @param boolean $systemWideMountPoint
- * @param string $storageRoot
- * @param string $expected
- */
- public function testGetPathToKeys($path, $systemWideMountPoint, $storageRoot, $expected) {
- $this->invokePrivate($this->storage, 'root_dir', [$storageRoot]);
- $this->util->expects($this->any())
- ->method('getUidAndFilename')
- ->will($this->returnCallback(array($this, 'getUidAndFilenameCallback')));
- $this->util->expects($this->any())
- ->method('isSystemWideMountPoint')
- ->willReturn($systemWideMountPoint);
- $this->assertSame($expected,
- self::invokePrivate($this->storage, 'getPathToKeys', [$path])
- );
- }
- public function dataTestGetPathToKeys() {
- return [
- ['/user1/files/source.txt', false, '', '/user1/files_encryption/keys/files/source.txt/'],
- ['/user1/files/source.txt', true, '', '/files_encryption/keys/files/source.txt/'],
- ['/user1/files/source.txt', false, 'storageRoot', '/storageRoot/user1/files_encryption/keys/files/source.txt/'],
- ['/user1/files/source.txt', true, 'storageRoot', '/storageRoot/files_encryption/keys/files/source.txt/'],
- ];
- }
- public function testKeySetPreparation() {
- $this->view->expects($this->any())
- ->method('file_exists')
- ->willReturn(false);
- $this->view->expects($this->any())
- ->method('is_dir')
- ->willReturn(false);
- $this->view->expects($this->any())
- ->method('mkdir')
- ->will($this->returnCallback(array($this, 'mkdirCallback')));
- $this->mkdirStack = array(
- '/user1/files_encryption/keys/foo',
- '/user1/files_encryption/keys',
- '/user1/files_encryption',
- '/user1');
- self::invokePrivate($this->storage, 'keySetPreparation', array('/user1/files_encryption/keys/foo'));
- }
- public function mkdirCallback() {
- $args = func_get_args();
- $expected = array_pop($this->mkdirStack);
- $this->assertSame($expected, $args[0]);
- }
- /**
- * @dataProvider dataTestGetFileKeyDir
- *
- * @param bool $isSystemWideMountPoint
- * @param string $storageRoot
- * @param string $expected
- */
- public function testGetFileKeyDir($isSystemWideMountPoint, $storageRoot, $expected) {
- $path = '/user1/files/foo/bar.txt';
- $owner = 'user1';
- $relativePath = '/foo/bar.txt';
- $this->invokePrivate($this->storage, 'root_dir', [$storageRoot]);
- $this->util->expects($this->once())->method('isSystemWideMountPoint')
- ->willReturn($isSystemWideMountPoint);
- $this->util->expects($this->once())->method('getUidAndFilename')
- ->with($path)->willReturn([$owner, $relativePath]);
- $this->assertSame($expected,
- $this->invokePrivate($this->storage, 'getFileKeyDir', ['OC_DEFAULT_MODULE', $path])
- );
- }
- public function dataTestGetFileKeyDir() {
- return [
- [false, '', '/user1/files_encryption/keys/foo/bar.txt/OC_DEFAULT_MODULE/'],
- [true, '', '/files_encryption/keys/foo/bar.txt/OC_DEFAULT_MODULE/'],
- [false, 'newStorageRoot', '/newStorageRoot/user1/files_encryption/keys/foo/bar.txt/OC_DEFAULT_MODULE/'],
- [true, 'newStorageRoot', '/newStorageRoot/files_encryption/keys/foo/bar.txt/OC_DEFAULT_MODULE/'],
- ];
- }
- /**
- * @dataProvider dataTestBackupUserKeys
- * @param bool $createBackupDir
- */
- public function testBackupUserKeys($createBackupDir) {
- $storage = $this->getMockBuilder('OC\Encryption\Keys\Storage')
- ->setConstructorArgs([$this->view, $this->util])
- ->setMethods(['getTimestamp'])
- ->getMock();
- $storage->expects($this->any())->method('getTimestamp')->willReturn('1234567');
- $this->view->expects($this->once())->method('file_exists')
- ->with('user1/files_encryption/backup')->willReturn(!$createBackupDir);
- if ($createBackupDir) {
- $this->view->expects($this->at(1))->method('mkdir')
- ->with('user1/files_encryption/backup');
- $this->view->expects($this->at(2))->method('mkdir')
- ->with('user1/files_encryption/backup/test.encryptionModule.1234567');
- } else {
- $this->view->expects($this->once())->method('mkdir')
- ->with('user1/files_encryption/backup/test.encryptionModule.1234567');
- }
- $this->view->expects($this->once())->method('copy')
- ->with(
- 'user1/files_encryption/encryptionModule',
- 'user1/files_encryption/backup/test.encryptionModule.1234567'
- )->willReturn(true);
- $this->assertTrue($storage->backupUserKeys('encryptionModule', 'test', 'user1'));
- }
- public function dataTestBackupUserKeys() {
- return [
- [true], [false]
- ];
- }
- }
|