412 lines
16 KiB
PHP
412 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
|
* @author Björn Schießle <schiessle@owncloud.com>
|
|
* @author Florin Peter <github@florin-peter.de>
|
|
* @author Joas Schilling <nickvergessen@owncloud.com>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Sam Tuke <mail@samtuke.com>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
*
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* This program 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, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OCA\Files_Encryption\Tests;
|
|
|
|
/**
|
|
* Class Keymanager
|
|
*/
|
|
class Keymanager extends TestCase {
|
|
|
|
const TEST_USER = "test-keymanager-user.dot";
|
|
|
|
public $userId;
|
|
public $pass;
|
|
public static $stateFilesTrashbin;
|
|
/**
|
|
* @var \OC\Files\View
|
|
*/
|
|
public $view;
|
|
public $randomKey;
|
|
public $dataShort;
|
|
|
|
public static function setUpBeforeClass() {
|
|
parent::setUpBeforeClass();
|
|
|
|
// disable file proxy by default
|
|
\OC_FileProxy::$enabled = false;
|
|
|
|
// remember files_trashbin state
|
|
self::$stateFilesTrashbin = \OC_App::isEnabled('files_trashbin');
|
|
|
|
// we don't want to tests with app files_trashbin enabled
|
|
\OC_App::disable('files_trashbin');
|
|
|
|
// create test user
|
|
\OC_User::deleteUser(self::TEST_USER);
|
|
parent::loginHelper(self::TEST_USER, true);
|
|
}
|
|
|
|
protected function setUp() {
|
|
parent::setUp();
|
|
// set content for encrypting / decrypting in tests
|
|
$this->dataLong = file_get_contents(__DIR__ . '/../lib/crypt.php');
|
|
$this->dataShort = 'hats';
|
|
$this->dataUrl = __DIR__ . '/../lib/crypt.php';
|
|
$this->legacyData = __DIR__ . '/legacy-text.txt';
|
|
$this->legacyEncryptedData = __DIR__ . '/legacy-encrypted-text.txt';
|
|
$this->randomKey = \OCA\Files_Encryption\Crypt::generateKey();
|
|
|
|
$keypair = \OCA\Files_Encryption\Crypt::createKeypair();
|
|
$this->genPublicKey = $keypair['publicKey'];
|
|
$this->genPrivateKey = $keypair['privateKey'];
|
|
|
|
$this->view = new \OC\Files\View('/');
|
|
|
|
self::loginHelper(self::TEST_USER);
|
|
$this->userId = self::TEST_USER;
|
|
$this->pass = self::TEST_USER;
|
|
|
|
$userHome = \OC_User::getHome($this->userId);
|
|
$this->dataDir = str_replace('/' . $this->userId, '', $userHome);
|
|
}
|
|
|
|
function tearDown() {
|
|
$this->view->deleteAll('/' . self::TEST_USER . '/files_encryption/keys');
|
|
parent::tearDown();
|
|
}
|
|
|
|
public static function tearDownAfterClass() {
|
|
\OC_FileProxy::$enabled = true;
|
|
|
|
// cleanup test user
|
|
\OC_User::deleteUser(self::TEST_USER);
|
|
// reset app files_trashbin
|
|
if (self::$stateFilesTrashbin) {
|
|
\OC_App::enable('files_trashbin');
|
|
}
|
|
|
|
parent::tearDownAfterClass();
|
|
}
|
|
|
|
function testKeyCacheUpdate() {
|
|
$testUser = 'testKeyCacheUpdate';
|
|
\OCA\Files_Encryption\Keymanager::setPublicKey('oldKey', $testUser);
|
|
|
|
$this->assertSame('oldKey',
|
|
\OCA\Files_Encryption\Keymanager::getPublicKey($this->view, $testUser));
|
|
|
|
// update key
|
|
\OCA\Files_Encryption\Keymanager::setPublicKey('newKey', $testUser);
|
|
|
|
$this->assertSame('newKey',
|
|
\OCA\Files_Encryption\Keymanager::getPublicKey($this->view, $testUser));
|
|
|
|
// cleanup
|
|
\OCA\Files_Encryption\Keymanager::deletePublicKey($this->view, $testUser);
|
|
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testGetPrivateKey() {
|
|
|
|
$key = \OCA\Files_Encryption\Keymanager::getPrivateKey($this->view, $this->userId);
|
|
|
|
$privateKey = \OCA\Files_Encryption\Crypt::decryptPrivateKey($key, $this->pass);
|
|
|
|
$res = openssl_pkey_get_private($privateKey);
|
|
|
|
$this->assertTrue(is_resource($res));
|
|
|
|
$sslInfo = openssl_pkey_get_details($res);
|
|
|
|
$this->assertArrayHasKey('key', $sslInfo);
|
|
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testGetPublicKey() {
|
|
|
|
$publiceKey = \OCA\Files_Encryption\Keymanager::getPublicKey($this->view, $this->userId);
|
|
|
|
$res = openssl_pkey_get_public($publiceKey);
|
|
|
|
$this->assertTrue(is_resource($res));
|
|
|
|
$sslInfo = openssl_pkey_get_details($res);
|
|
|
|
$this->assertArrayHasKey('key', $sslInfo);
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testSetFileKey() {
|
|
|
|
$key = $this->randomKey;
|
|
|
|
$file = 'unittest-' . $this->getUniqueID() . '.txt';
|
|
|
|
$util = new \OCA\Files_Encryption\Util($this->view, $this->userId);
|
|
|
|
// Disable encryption proxy to prevent recursive calls
|
|
$proxyStatus = \OC_FileProxy::$enabled;
|
|
\OC_FileProxy::$enabled = false;
|
|
|
|
$this->view->file_put_contents($this->userId . '/files/' . $file, $this->dataShort);
|
|
|
|
\OCA\Files_Encryption\Keymanager::setFileKey($this->view, $util, $file, $key);
|
|
|
|
$this->assertTrue($this->view->file_exists('/' . $this->userId . '/files_encryption/keys/' . $file . '/fileKey'));
|
|
|
|
// cleanup
|
|
$this->view->unlink('/' . $this->userId . '/files/' . $file);
|
|
|
|
// change encryption proxy to previous state
|
|
\OC_FileProxy::$enabled = $proxyStatus;
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testSetPrivateKey() {
|
|
|
|
$key = "dummy key";
|
|
|
|
\OCA\Files_Encryption\Keymanager::setPrivateKey($key, 'dummyUser');
|
|
|
|
$this->assertTrue($this->view->file_exists('/dummyUser/files_encryption/dummyUser.privateKey'));
|
|
|
|
//clean up
|
|
$this->view->deleteAll('/dummyUser');
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testSetPrivateSystemKey() {
|
|
|
|
$key = "dummy key";
|
|
$keyName = "myDummyKey";
|
|
$encHeader = \OCA\Files_Encryption\Crypt::generateHeader();
|
|
|
|
\OCA\Files_Encryption\Keymanager::setPrivateSystemKey($key, $keyName);
|
|
|
|
$this->assertTrue($this->view->file_exists('/files_encryption/' . $keyName . '.privateKey'));
|
|
|
|
$result = \OCA\Files_Encryption\Keymanager::getPrivateSystemKey($keyName);
|
|
|
|
$this->assertSame($encHeader . $key, $result);
|
|
|
|
// clean up
|
|
$this->view->unlink('/files_encryption/' . $keyName.'.privateKey');
|
|
}
|
|
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testGetUserKeys() {
|
|
|
|
$keys = \OCA\Files_Encryption\Keymanager::getUserKeys($this->view, $this->userId);
|
|
|
|
$resPublic = openssl_pkey_get_public($keys['publicKey']);
|
|
|
|
$this->assertTrue(is_resource($resPublic));
|
|
|
|
$sslInfoPublic = openssl_pkey_get_details($resPublic);
|
|
|
|
$this->assertArrayHasKey('key', $sslInfoPublic);
|
|
|
|
$privateKey = \OCA\Files_Encryption\Crypt::decryptPrivateKey($keys['privateKey'], $this->pass);
|
|
|
|
$resPrivate = openssl_pkey_get_private($privateKey);
|
|
|
|
$this->assertTrue(is_resource($resPrivate));
|
|
|
|
$sslInfoPrivate = openssl_pkey_get_details($resPrivate);
|
|
|
|
$this->assertArrayHasKey('key', $sslInfoPrivate);
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testRecursiveDelShareKeysFolder() {
|
|
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files/folder1');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files/folder1/existingFile.txt', 'data');
|
|
|
|
// create folder structure for some dummy share key files
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/file2');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/file2');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file1');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file2');
|
|
|
|
// create some dummy share keys
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user1.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/' . self::TEST_USER . '.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/user1.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/user1.test.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/test-keymanager-userxdot.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/userx.' . self::TEST_USER . '.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/' . self::TEST_USER . '.userx.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/user1.' . self::TEST_USER . '.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/' . self::TEST_USER . '.user1.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file2/user2.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/file2/user3.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/file2/user3.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file1/user1.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file2/user2.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file2/user3.shareKey', 'data');
|
|
|
|
// recursive delete share keys from user1 and user2
|
|
\OCA\Files_Encryption\Keymanager::delShareKey($this->view,
|
|
array('user1', 'user2', self::TEST_USER),
|
|
\OCA\Files_Encryption\Keymanager::getKeyPath($this->view, new \OCA\Files_Encryption\Util($this->view, self::TEST_USER), '/folder1'),
|
|
self::TEST_USER,
|
|
'/folder1');
|
|
|
|
// check if share keys from user1 and user2 are deleted
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user1.shareKey'));
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/share-keys/folder1/file1/user1.shareKey'));
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/share-keys/folder1/file2/user2.shareKey'));
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/share-keys/folder1/subfolder/subsubfolder/file1/user1.shareKey'));
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/share-keys/folder1/subfolder/subsubfolder/file2/user2.shareKey'));
|
|
|
|
// check if share keys from user3 still exists
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file2/user3.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/subsubfolder/file2/user3.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/subfolder/file2/user3.shareKey'));
|
|
|
|
// check if share keys for user or file with similar name
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/user1.test.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/test-keymanager-userxdot.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/' . self::TEST_USER . '.userx.shareKey'));
|
|
// FIXME: this case currently cannot be distinguished, needs further fixing
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/userx.' . self::TEST_USER . '.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/user1.' . self::TEST_USER . '.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/file1/' . self::TEST_USER . '.user1.shareKey'));
|
|
|
|
// owner key from existing file should still exists because the file is still there
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/' . self::TEST_USER . '.shareKey'));
|
|
|
|
// cleanup
|
|
$this->view->deleteAll('/' . self::TEST_USER . '/files/folder1');
|
|
|
|
}
|
|
|
|
/**
|
|
* @medium
|
|
*/
|
|
function testRecursiveDelShareKeysFile() {
|
|
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files/folder1');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files/folder1/existingFile.txt', 'data');
|
|
|
|
// create folder structure for some dummy share key files
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1');
|
|
$this->view->mkdir('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt');
|
|
|
|
// create some dummy share keys
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user1.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user2.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user3.shareKey', 'data');
|
|
$this->view->file_put_contents('/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/' . self::TEST_USER . '.shareKey', 'data');
|
|
|
|
// recursive delete share keys from user1 and user2
|
|
\OCA\Files_Encryption\Keymanager::delShareKey($this->view,
|
|
array('user1', 'user2', self::TEST_USER),
|
|
\OCA\Files_Encryption\Keymanager::getKeyPath($this->view, new \OCA\Files_Encryption\Util($this->view, self::TEST_USER), '/folder1/existingFile.txt'),
|
|
self::TEST_USER,
|
|
'/folder1/existingFile.txt');
|
|
|
|
|
|
// check if share keys from user1 and user2 are deleted
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile/user1.shareKey'));
|
|
$this->assertFalse($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile/user2.shareKey'));
|
|
|
|
// check if share keys for user3 and owner
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/' . self::TEST_USER . '.shareKey'));
|
|
$this->assertTrue($this->view->file_exists(
|
|
'/' . self::TEST_USER . '/files_encryption/keys/folder1/existingFile.txt/user3.shareKey'));
|
|
// cleanup
|
|
$this->view->deleteAll('/' . self::TEST_USER . '/files/folder1');
|
|
|
|
}
|
|
|
|
function testKeySetPreperation() {
|
|
$basePath = '/' . self::TEST_USER . '/files';
|
|
$path = '/folder1/subfolder/subsubfolder/file.txt';
|
|
|
|
$this->assertFalse($this->view->is_dir($basePath . '/testKeySetPreperation'));
|
|
|
|
TestProtectedKeymanagerMethods::testKeySetPreperation($this->view, $basePath . $path);
|
|
|
|
// check if directory structure was created
|
|
$this->assertTrue($this->view->is_dir($basePath . $path));
|
|
|
|
// cleanup
|
|
$this->view->deleteAll($basePath . '/folder1');
|
|
|
|
}
|
|
}
|
|
|
|
/**
|
|
* dummy class to access protected methods of \OCA\Files_Encryption\Keymanager for testing
|
|
*/
|
|
class TestProtectedKeymanagerMethods extends \OCA\Files_Encryption\Keymanager {
|
|
|
|
/**
|
|
* @param \OC\Files\View $view relative to data/
|
|
* @param string $path
|
|
* @param string $basePath
|
|
*/
|
|
public static function testKeySetPreperation($view, $path) {
|
|
self::keySetPreparation($view, $path);
|
|
}
|
|
}
|