nextcloud/apps/files_encryption/tests/keymanager.php

261 lines
7.2 KiB
PHP
Raw Normal View History

<?php
/**
* Copyright (c) 2012 Sam Tuke <samtuke@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
require_once __DIR__ . '/../../../lib/base.php';
require_once __DIR__ . '/../lib/crypt.php';
require_once __DIR__ . '/../lib/keymanager.php';
require_once __DIR__ . '/../lib/proxy.php';
require_once __DIR__ . '/../lib/stream.php';
require_once __DIR__ . '/../lib/util.php';
require_once __DIR__ . '/../lib/helper.php';
require_once __DIR__ . '/../appinfo/app.php';
require_once __DIR__ . '/util.php';
use OCA\Encryption;
2013-05-20 00:28:48 +04:00
/**
* Class Test_Encryption_Keymanager
*/
class Test_Encryption_Keymanager extends \PHPUnit_Framework_TestCase {
2013-05-20 00:28:48 +04:00
const TEST_USER = "test-keymanager-user";
2013-05-20 00:28:48 +04:00
public $userId;
public $pass;
public $stateFilesTrashbin;
/**
* @var OC\Files\View
2013-05-20 00:28:48 +04:00
*/
public $view;
public $randomKey;
2013-05-22 02:55:16 +04:00
public $dataShort;
2013-05-20 00:28:48 +04:00
public static function setUpBeforeClass() {
2013-05-20 03:24:36 +04:00
// reset backend
\OC_User::clearBackends();
\OC_User::useBackend('database');
// Filesystem related hooks
\OCA\Encryption\Helper::registerFilesystemHooks();
// clear and register hooks
\OC_FileProxy::clearProxies();
\OC_FileProxy::register(new OCA\Encryption\Proxy());
// disable file proxy by default
\OC_FileProxy::$enabled = false;
2013-05-20 03:24:36 +04:00
// create test user
\OC_User::deleteUser(\Test_Encryption_Keymanager::TEST_USER);
\Test_Encryption_Util::loginHelper(\Test_Encryption_Keymanager::TEST_USER, true);
}
function 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 = Encryption\Crypt::generateKey();
2013-05-20 03:24:36 +04:00
$keypair = Encryption\Crypt::createKeypair();
2013-05-20 03:24:36 +04:00
$this->genPublicKey = $keypair['publicKey'];
$this->genPrivateKey = $keypair['privateKey'];
$this->view = new \OC\Files\View('/');
\OC_User::setUserId(\Test_Encryption_Keymanager::TEST_USER);
$this->userId = \Test_Encryption_Keymanager::TEST_USER;
$this->pass = \Test_Encryption_Keymanager::TEST_USER;
$userHome = \OC_User::getHome($this->userId);
$this->dataDir = str_replace('/' . $this->userId, '', $userHome);
2013-05-17 03:07:26 +04:00
// remember files_trashbin state
$this->stateFilesTrashbin = OC_App::isEnabled('files_trashbin');
2013-05-17 03:07:26 +04:00
// we don't want to tests with app files_trashbin enabled
\OC_App::disable('files_trashbin');
}
2013-05-20 03:24:36 +04:00
function tearDown() {
2013-05-17 03:07:26 +04:00
// reset app files_trashbin
if ($this->stateFilesTrashbin) {
OC_App::enable('files_trashbin');
}
else {
OC_App::disable('files_trashbin');
2013-05-17 03:07:26 +04:00
}
}
public static function tearDownAfterClass() {
\OC_FileProxy::$enabled = true;
// cleanup test user
\OC_User::deleteUser(\Test_Encryption_Keymanager::TEST_USER);
}
2013-06-10 11:31:22 +04:00
/**
* @medium
*/
function testGetPrivateKey() {
2013-05-20 03:24:36 +04:00
$key = Encryption\Keymanager::getPrivateKey($this->view, $this->userId);
2013-04-30 03:54:19 +04:00
$privateKey = Encryption\Crypt::symmetricDecryptFileContent($key, $this->pass);
2013-04-30 03:54:19 +04:00
$res = openssl_pkey_get_private($privateKey);
2013-04-30 03:54:19 +04:00
$this->assertTrue(is_resource($res));
2013-05-19 00:00:35 +04:00
$sslInfo = openssl_pkey_get_details($res);
2013-05-19 00:00:35 +04:00
$this->assertArrayHasKey('key', $sslInfo);
2013-05-20 03:24:36 +04:00
}
2013-06-10 11:31:22 +04:00
/**
* @medium
*/
function testGetPublicKey() {
2013-05-20 03:24:36 +04:00
$publiceKey = Encryption\Keymanager::getPublicKey($this->view, $this->userId);
2013-05-19 00:00:35 +04:00
$res = openssl_pkey_get_public($publiceKey);
2013-05-19 00:00:35 +04:00
$this->assertTrue(is_resource($res));
2013-05-19 00:00:35 +04:00
$sslInfo = openssl_pkey_get_details($res);
2013-05-19 00:00:35 +04:00
$this->assertArrayHasKey('key', $sslInfo);
}
2013-05-20 03:24:36 +04:00
/**
* @small
*/
function testGetFilenameFromShareKey() {
$this->assertEquals("file",
\TestProtectedKeymanagerMethods::testGetFilenameFromShareKey("file.user.shareKey"));
$this->assertEquals("file.name.with.dots",
\TestProtectedKeymanagerMethods::testGetFilenameFromShareKey("file.name.with.dots.user.shareKey"));
$this->assertFalse(\TestProtectedKeymanagerMethods::testGetFilenameFromShareKey("file.txt"));
}
2013-06-10 11:31:22 +04:00
/**
* @medium
*/
function testSetFileKey() {
2013-05-20 03:24:36 +04:00
$key = $this->randomKey;
2013-05-20 03:24:36 +04:00
$file = 'unittest-' . uniqid() . '.txt';
$util = new Encryption\Util($this->view, $this->userId);
2013-05-20 03:24:36 +04:00
// 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);
2013-05-20 03:24:36 +04:00
Encryption\Keymanager::setFileKey($this->view, $util, $file, $key);
$this->assertTrue($this->view->file_exists('/' . $this->userId . '/files_encryption/keyfiles/' . $file . '.key'));
2013-05-17 03:07:26 +04:00
// cleanup
$this->view->unlink('/' . $this->userId . '/files/' . $file);
2013-05-17 03:07:26 +04:00
2013-05-22 02:55:16 +04:00
// change encryption proxy to previous state
2013-05-17 03:07:26 +04:00
\OC_FileProxy::$enabled = $proxyStatus;
}
2013-05-20 03:24:36 +04:00
2013-06-10 11:31:22 +04:00
/**
* @medium
*/
function testGetUserKeys() {
2013-05-20 03:24:36 +04:00
$keys = Encryption\Keymanager::getUserKeys($this->view, $this->userId);
2013-04-30 03:54:19 +04:00
$resPublic = openssl_pkey_get_public($keys['publicKey']);
2013-04-30 03:54:19 +04:00
$this->assertTrue(is_resource($resPublic));
2013-04-30 03:54:19 +04:00
$sslInfoPublic = openssl_pkey_get_details($resPublic);
2013-04-30 03:54:19 +04:00
$this->assertArrayHasKey('key', $sslInfoPublic);
2013-05-19 00:25:47 +04:00
$privateKey = Encryption\Crypt::symmetricDecryptFileContent($keys['privateKey'], $this->pass);
2013-05-19 00:25:47 +04:00
$resPrivate = openssl_pkey_get_private($privateKey);
2013-05-19 00:25:47 +04:00
$this->assertTrue(is_resource($resPrivate));
2013-05-19 00:25:47 +04:00
$sslInfoPrivate = openssl_pkey_get_details($resPrivate);
2013-05-19 00:25:47 +04:00
$this->assertArrayHasKey('key', $sslInfoPrivate);
}
2013-05-22 02:55:16 +04:00
2013-06-10 11:31:22 +04:00
/**
* @medium
*/
function testRecursiveDelShareKeys() {
2013-05-22 02:55:16 +04:00
// generate filename
$filename = '/tmp-' . uniqid() . '.txt';
2013-05-22 02:55:16 +04:00
// create folder structure
$this->view->mkdir('/'.Test_Encryption_Keymanager::TEST_USER.'/files/folder1');
$this->view->mkdir('/'.Test_Encryption_Keymanager::TEST_USER.'/files/folder1/subfolder');
$this->view->mkdir('/'.Test_Encryption_Keymanager::TEST_USER.'/files/folder1/subfolder/subsubfolder');
2013-05-22 02:55:16 +04:00
// enable encryption proxy
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = true;
// save file with content
2013-07-30 20:21:23 +04:00
$cryptedFile = file_put_contents('crypt:///'.Test_Encryption_Keymanager::TEST_USER.'/files/folder1/subfolder/subsubfolder' . $filename, $this->dataShort);
2013-05-22 02:55:16 +04:00
// test that data was successfully written
$this->assertTrue(is_int($cryptedFile));
2013-05-22 02:55:16 +04:00
// change encryption proxy to previous state
\OC_FileProxy::$enabled = $proxyStatus;
// recursive delete keys
Encryption\Keymanager::delShareKey($this->view, array('admin'), '/folder1/');
2013-05-22 02:55:16 +04:00
// check if share key not exists
$this->assertFalse($this->view->file_exists(
'/admin/files_encryption/share-keys/folder1/subfolder/subsubfolder/' . $filename . '.admin.shareKey'));
2013-05-22 02:55:16 +04:00
// enable encryption proxy
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = true;
// cleanup
$this->view->unlink('/admin/files/folder1');
2013-05-22 02:55:16 +04:00
// change encryption proxy to previous state
\OC_FileProxy::$enabled = $proxyStatus;
}
}
/**
* dummy class to access protected methods of \OCA\Encryption\Keymanager for testing
*/
class TestProtectedKeymanagerMethods extends \OCA\Encryption\Keymanager {
/**
* @param string $sharekey
*/
public static function testGetFilenameFromShareKey($sharekey) {
return self::getFilenameFromShareKey($sharekey);
}
}