mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5870 from nextcloud/generate-system-wide-key-pair 

extend the identity proof manager to allow system wide key pairs
This commit is contained in:
Björn Schießle 2017-08-24 18:36:35 +02:00 committed by GitHub
parent f6f10b5932 31af5cc321
commit 60ee450809
7 changed files with 229 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/composer/composer/autoload_classmap.php
View File

@ -757,6 +757,7 @@ return array(
'OC\\Repair\\NC11\\MoveAvatarsBackgroundJob' => $baseDir . '/lib/private/Repair/NC11/MoveAvatarsBackgroundJob.php',
'OC\\Repair\\NC12\\InstallCoreBundle' => $baseDir . '/lib/private/Repair/NC12/InstallCoreBundle.php',
'OC\\Repair\\NC12\\UpdateLanguageCodes' => $baseDir . '/lib/private/Repair/NC12/UpdateLanguageCodes.php',
'OC\\Repair\\NC13\\RepairIdentityProofKeyFolders' => $baseDir . '/lib/private/Repair/NC13/RepairIdentityProofKeyFolders.php',
'OC\\Repair\\NC13\\RepairInvalidPaths' => $baseDir . '/lib/private/Repair/NC13/RepairInvalidPaths.php',
'OC\\Repair\\OldGroupMembershipShares' => $baseDir . '/lib/private/Repair/OldGroupMembershipShares.php',
'OC\\Repair\\Owncloud\\DropAccountTermsTable' => $baseDir . '/lib/private/Repair/Owncloud/DropAccountTermsTable.php',

1
lib/composer/composer/autoload_static.php
View File

@ -787,6 +787,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OC\\Repair\\NC11\\MoveAvatarsBackgroundJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC11/MoveAvatarsBackgroundJob.php',
'OC\\Repair\\NC12\\InstallCoreBundle' => __DIR__ . '/../../..' . '/lib/private/Repair/NC12/InstallCoreBundle.php',
'OC\\Repair\\NC12\\UpdateLanguageCodes' => __DIR__ . '/../../..' . '/lib/private/Repair/NC12/UpdateLanguageCodes.php',
'OC\\Repair\\NC13\\RepairIdentityProofKeyFolders' => __DIR__ . '/../../..' . '/lib/private/Repair/NC13/RepairIdentityProofKeyFolders.php',
'OC\\Repair\\NC13\\RepairInvalidPaths' => __DIR__ . '/../../..' . '/lib/private/Repair/NC13/RepairInvalidPaths.php',
'OC\\Repair\\OldGroupMembershipShares' => __DIR__ . '/../../..' . '/lib/private/Repair/OldGroupMembershipShares.php',
'OC\\Repair\\Owncloud\\DropAccountTermsTable' => __DIR__ . '/../../..' . '/lib/private/Repair/Owncloud/DropAccountTermsTable.php',

3
lib/private/AppFramework/DependencyInjection/DIContainer.php
View File

@ -171,7 +171,8 @@ class DIContainer extends SimpleContainer implements IAppContainer {
$this->registerService(\OC\Security\IdentityProof\Manager::class, function ($c) {
return new \OC\Security\IdentityProof\Manager(
$this->getServer()->query(\OC\Files\AppData\Factory::class),
$this->getServer()->getCrypto()
$this->getServer()->getCrypto(),
$this->getServer()->getConfig()
);
});

5
lib/private/Repair.php
View File

@ -31,6 +31,7 @@
namespace OC;
use OC\App\AppStore\Bundles\BundleFetcher;
use OC\Files\AppData\Factory;
use OC\Repair\CleanTags;
use OC\Repair\Collation;
use OC\Repair\MoveUpdaterStepFile;
@ -39,6 +40,7 @@ use OC\Repair\NC11\FixMountStorages;
use OC\Repair\NC11\MoveAvatars;
use OC\Repair\NC12\InstallCoreBundle;
use OC\Repair\NC12\UpdateLanguageCodes;
use OC\Repair\NC13\RepairIdentityProofKeyFolders;
use OC\Repair\OldGroupMembershipShares;
use OC\Repair\Owncloud\DropAccountTermsTable;
use OC\Repair\Owncloud\SaveAccountsTableData;
@ -146,7 +148,8 @@ class Repair implements IOutput{
\OC::$server->getConfig(),
\OC::$server->query(Installer::class)
),
new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig())
new RepairInvalidPaths(\OC::$server->getDatabaseConnection(), \OC::$server->getConfig()),
new RepairIdentityProofKeyFolders(\OC::$server->getConfig(), \OC::$server->query(Factory::class), \OC::$server->getRootFolder()),
];
}

110
lib/private/Repair/NC13/RepairIdentityProofKeyFolders.php Normal file
View File

@ -0,0 +1,110 @@
<?php
/**
* @copyright Copyright (c) 2017 Bjoern Schiessle <bjoern@schiessle.org>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Repair\NC13;
use OC\Files\AppData\Factory;
use OCP\Files\IRootFolder;
use OCP\Files\SimpleFS\ISimpleFolder;
use OCP\IConfig;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;
class RepairIdentityProofKeyFolders implements IRepairStep {
/** @var IConfig */
private $config;
/** @var \OC\Files\AppData\AppData */
private $appDataIdentityProof;
/** @var IRootFolder */
private $rootFolder;
/** @var string */
private $identityProofDir;
/**
* RepairIdentityProofKeyFolders constructor.
*
* @param IConfig $config
* @param Factory $appDataFactory
* @param IRootFolder $rootFolder
*/
public function __construct(IConfig $config, Factory $appDataFactory, IRootFolder $rootFolder) {
$this->config = $config;
$this->appDataIdentityProof = $appDataFactory->get('identityproof');
$this->rootFolder = $rootFolder;
$instanceId = $this->config->getSystemValue('instanceid', null);
if ($instanceId === null) {
throw new \RuntimeException('no instance id!');
}
$this->identityProofDir = 'appdata_' . $instanceId . '/identityproof/';
}
/**
* Returns the step's name
*
* @return string
* @since 9.1.0
*/
public function getName() {
return "Rename folder with user specific keys";
}
/**
* Run repair step.
* Must throw exception on error.
*
* @param IOutput $output
* @throws \Exception in case of failure
* @since 9.1.0
*/
public function run(IOutput $output) {
$versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
if (version_compare($versionFromBeforeUpdate, '13.0.0.1', '<=')) {
$count = $this->repair();
$output->info('Repaired ' . $count . ' folders');
}
}
/**
* rename all dirs with user specific keys to 'user-uid'
*
* @return int
*/
private function repair() {
$count = 0;
$dirListing = $this->appDataIdentityProof->getDirectoryListing();
/** @var ISimpleFolder $folder */
foreach ($dirListing as $folder) {
$name = $folder->getName();
$node = $this->rootFolder->get($this->identityProofDir . $name);
$node->move($this->identityProofDir . 'user-' . $name);
$count++;
}
return $count;
}
}

56
lib/private/Security/IdentityProof/Manager.php
View File

@ -23,6 +23,7 @@ namespace OC\Security\IdentityProof;
use OC\Files\AppData\Factory;
use OCP\Files\IAppData;
use OCP\IConfig;
use OCP\IUser;
use OCP\Security\ICrypto;
@ -31,15 +32,21 @@ class Manager {
private $appData;
/** @var ICrypto */
private $crypto;
/** @var IConfig */
private $config;
/**
* @param Factory $appDataFactory
* @param ICrypto $crypto
* @param IConfig $config
*/
public function __construct(Factory $appDataFactory,
ICrypto $crypto) {
ICrypto $crypto,
IConfig $config
) {
$this->appData = $appDataFactory->get('identityproof');
$this->crypto = $crypto;
$this->config = $config;
}
/**
@ -66,20 +73,20 @@ class Manager {
}
/**
* Generate a key for $user
* Generate a key for a given ID
* Note: If a key already exists it will be overwritten
*
* @param IUser $user
* @param string $id key id
* @return Key
*/
protected function generateKey(IUser $user) {
protected function generateKey($id) {
list($publicKey, $privateKey) = $this->generateKeyPair();
// Write the private and public key to the disk
try {
$this->appData->newFolder($user->getUID());
$this->appData->newFolder($id);
} catch (\Exception $e) {}
$folder = $this->appData->getFolder($user->getUID());
$folder = $this->appData->getFolder($id);
$folder->newFile('private')
->putContent($this->crypto->encrypt($privateKey));
$folder->newFile('public')
@ -89,21 +96,48 @@ class Manager {
}
/**
* Get public and private key for $user
* Get key for a specific id
*
* @param IUser $user
* @param string $id
* @return Key
*/
public function getKey(IUser $user) {
protected function retrieveKey($id) {
try {
$folder = $this->appData->getFolder($user->getUID());
$folder = $this->appData->getFolder($id);
$privateKey = $this->crypto->decrypt(
$folder->getFile('private')->getContent()
);
$publicKey = $folder->getFile('public')->getContent();
return new Key($publicKey, $privateKey);
} catch (\Exception $e) {
return $this->generateKey($user);
return $this->generateKey($id);
}
}
/**
* Get public and private key for $user
*
* @param IUser $user
* @return Key
*/
public function getKey(IUser $user) {
$uid = $user->getUID();
return $this->retrieveKey('user-' . $uid);
}
/**
* Get instance wide public and private key
*
* @return Key
* @throws \RuntimeException
*/
public function getSystemKey() {
$instanceId = $this->config->getSystemValue('instanceid', null);
if ($instanceId === null) {
throw new \RuntimeException('no instance id!');
}
return $this->retrieveKey('system-' . $instanceId);
}
}

81
tests/lib/Security/IdentityProof/ManagerTest.php
View File

@ -27,8 +27,10 @@ use OC\Security\IdentityProof\Manager;
use OCP\Files\IAppData;
use OCP\Files\SimpleFS\ISimpleFile;
use OCP\Files\SimpleFS\ISimpleFolder;
use OCP\IConfig;
use OCP\IUser;
use OCP\Security\ICrypto;
use SebastianBergmann\Comparator\MockObjectComparator;
use Test\TestCase;
class ManagerTest extends TestCase {
@ -40,6 +42,8 @@ class ManagerTest extends TestCase {
private $crypto;
/** @var Manager|\PHPUnit_Framework_MockObject_MockObject */
private $manager;
/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
private $config;
public function setUp() {
parent::setUp();
@ -47,19 +51,37 @@ class ManagerTest extends TestCase {
/** @var Factory|\PHPUnit_Framework_MockObject_MockObject $factory */
$this->factory = $this->createMock(Factory::class);
$this->appData = $this->createMock(IAppData::class);
$this->config = $this->createMock(IConfig::class);
$this->factory->expects($this->any())
->method('get')
->with('identityproof')
->willReturn($this->appData);
$this->crypto = $this->createMock(ICrypto::class);
$this->manager = $this->getMockBuilder(Manager::class)
->setConstructorArgs([
$this->manager = $this->getManager(['generateKeyPair']);
}
/**
* create manager object
*
* @param array $setMethods
* @return Manager|\PHPUnit_Framework_MockObject_MockObject
*/
protected function getManager($setMethods = []) {
if (empty($setMethods)) {
return new Manager(
$this->factory,
$this->crypto
])
->setMethods(['generateKeyPair'])
->getMock();
$this->crypto,
$this->config
);
} else {
return $this->getMockBuilder(Manager::class)
->setConstructorArgs([
$this->factory,
$this->crypto,
$this->config
])->setMethods($setMethods)->getMock();
}
}
public function testGetKeyWithExistingKey() {
@ -97,7 +119,7 @@ class ManagerTest extends TestCase {
$this->appData
->expects($this->once())
->method('getFolder')
->with('MyUid')
->with('user-MyUid')
->willReturn($folder);
$expected = new Key('MyPublicKey', 'MyPrivateKey');
@ -107,13 +129,13 @@ class ManagerTest extends TestCase {
public function testGetKeyWithNotExistingKey() {
$user = $this->createMock(IUser::class);
$user
->expects($this->exactly(3))
->expects($this->once())
->method('getUID')
->willReturn('MyUid');
$this->appData
->expects($this->at(0))
->method('getFolder')
->with('MyUid')
->with('user-MyUid')
->willThrowException(new \Exception());
$this->manager
->expects($this->once())
@ -122,7 +144,7 @@ class ManagerTest extends TestCase {
$this->appData
->expects($this->at(1))
->method('newFolder')
->with('MyUid');
->with('user-MyUid');
$folder = $this->createMock(ISimpleFolder::class);
$this->crypto
->expects($this->once())
@ -152,7 +174,7 @@ class ManagerTest extends TestCase {
$this->appData
->expects($this->at(2))
->method('getFolder')
->with('MyUid')
->with('user-MyUid')
->willReturn($folder);
@ -161,10 +183,7 @@ class ManagerTest extends TestCase {
}
public function testGenerateKeyPair() {
$manager = new Manager(
$this->factory,
$this->crypto
);
$manager = $this->getManager();
$data = 'MyTestData';
list($resultPublicKey, $resultPrivateKey) = self::invokePrivate($manager, 'generateKeyPair');
@ -174,4 +193,36 @@ class ManagerTest extends TestCase {
$this->assertSame(1, openssl_verify($data, $signature, $resultPublicKey));
$this->assertSame(2048, $details['bits']);
}
public function testGetSystemKey() {
$manager = $this->getManager(['retrieveKey']);
/** @var Key|\PHPUnit_Framework_MockObject_MockObject $key */
$key = $this->createMock(Key::class);
$this->config->expects($this->once())->method('getSystemValue')
->with('instanceid', null)->willReturn('instanceId');
$manager->expects($this->once())->method('retrieveKey')->with('system-instanceId')
->willReturn($key);
$this->assertSame($key, $manager->getSystemKey());
}
/**
* @expectedException \RuntimeException
*/
public function testGetSystemKeyFailure() {
$manager = $this->getManager(['retrieveKey']);
/** @var Key|\PHPUnit_Framework_MockObject_MockObject $key */
$key = $this->createMock(Key::class);
$this->config->expects($this->once())->method('getSystemValue')
->with('instanceid', null)->willReturn(null);
$manager->getSystemKey();
}
}