nextcloud/apps/encryption/lib/Recovery.php

330 lines
8.2 KiB
PHP
Raw Normal View History

2015-02-24 21:05:19 +03:00
<?php
/**
2016-05-26 20:56:05 +03:00
* @author Björn Schießle <bjoern@schiessle.org>
* @author Clark Tomlinson <fallen013@gmail.com>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-02-24 21:05:19 +03:00
* @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\Encryption;
use OCA\Encryption\Crypto\Crypt;
use OCP\Encryption\Keys\IStorage;
2015-02-24 21:05:19 +03:00
use OCP\IConfig;
use OCP\IUser;
use OCP\IUserSession;
use OCP\PreConditionNotMetException;
2015-02-24 21:05:19 +03:00
use OCP\Security\ISecureRandom;
use OC\Files\View;
use OCP\Encryption\IFile;
2015-02-24 21:05:19 +03:00
class Recovery {
/**
* @var null|IUser
*/
protected $user;
/**
* @var Crypt
*/
protected $crypt;
/**
* @var ISecureRandom
*/
private $random;
/**
* @var KeyManager
*/
private $keyManager;
/**
* @var IConfig
*/
private $config;
/**
* @var IStorage
2015-02-24 21:05:19 +03:00
*/
private $keyStorage;
/**
* @var View
*/
private $view;
/**
* @var IFile
*/
private $file;
2015-02-24 21:05:19 +03:00
/**
* @param IUserSession $user
2015-02-24 21:05:19 +03:00
* @param Crypt $crypt
* @param ISecureRandom $random
* @param KeyManager $keyManager
* @param IConfig $config
* @param IStorage $keyStorage
* @param IFile $file
* @param View $view
2015-02-24 21:05:19 +03:00
*/
public function __construct(IUserSession $user,
2015-02-24 21:05:19 +03:00
Crypt $crypt,
ISecureRandom $random,
KeyManager $keyManager,
IConfig $config,
IStorage $keyStorage,
IFile $file,
View $view) {
2015-03-31 18:13:36 +03:00
$this->user = ($user && $user->isLoggedIn()) ? $user->getUser() : false;
2015-02-24 21:05:19 +03:00
$this->crypt = $crypt;
$this->random = $random;
$this->keyManager = $keyManager;
$this->config = $config;
$this->keyStorage = $keyStorage;
$this->view = $view;
$this->file = $file;
2015-02-24 21:05:19 +03:00
}
/**
* @param string $password
2015-02-24 21:05:19 +03:00
* @return bool
*/
public function enableAdminRecovery($password) {
2015-02-24 21:05:19 +03:00
$appConfig = $this->config;
$keyManager = $this->keyManager;
if (!$keyManager->recoveryKeyExists()) {
$keyPair = $this->crypt->createKeyPair();
if(!is_array($keyPair)) {
return false;
}
2015-02-24 21:05:19 +03:00
$this->keyManager->setRecoveryKey($password, $keyPair);
2015-02-24 21:05:19 +03:00
}
if ($keyManager->checkRecoveryPassword($password)) {
$appConfig->setAppValue('encryption', 'recoveryAdminEnabled', 1);
return true;
}
return false;
}
/**
* change recovery key id
*
* @param string $newPassword
* @param string $oldPassword
* @return bool
*/
public function changeRecoveryKeyPassword($newPassword, $oldPassword) {
$recoveryKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
$decryptedRecoveryKey = $this->crypt->decryptPrivateKey($recoveryKey, $oldPassword);
if($decryptedRecoveryKey === false) {
return false;
}
$encryptedRecoveryKey = $this->crypt->encryptPrivateKey($decryptedRecoveryKey, $newPassword);
$header = $this->crypt->generateHeader();
if ($encryptedRecoveryKey) {
$this->keyManager->setSystemPrivateKey($this->keyManager->getRecoveryKeyId(), $header . $encryptedRecoveryKey);
return true;
}
return false;
}
2015-02-24 21:05:19 +03:00
/**
* @param string $recoveryPassword
2015-02-24 21:05:19 +03:00
* @return bool
*/
public function disableAdminRecovery($recoveryPassword) {
$keyManager = $this->keyManager;
if ($keyManager->checkRecoveryPassword($recoveryPassword)) {
// Set recoveryAdmin as disabled
$this->config->setAppValue('encryption', 'recoveryAdminEnabled', 0);
return true;
}
return false;
}
/**
2015-04-01 15:24:56 +03:00
* check if recovery is enabled for user
*
* @param string $user if no user is given we check the current logged-in user
*
* @return bool
*/
2015-04-01 15:24:56 +03:00
public function isRecoveryEnabledForUser($user = '') {
$uid = empty($user) ? $this->user->getUID() : $user;
$recoveryMode = $this->config->getUserValue($uid,
'encryption',
'recoveryEnabled',
0);
return ($recoveryMode === '1');
}
2015-04-01 15:24:56 +03:00
/**
* check if recovery is key is enabled by the administrator
*
* @return bool
*/
public function isRecoveryKeyEnabled() {
$enabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', 0);
return ($enabled === '1');
}
/**
* @param string $value
* @return bool
*/
public function setRecoveryForUser($value) {
try {
$this->config->setUserValue($this->user->getUID(),
'encryption',
'recoveryEnabled',
$value);
if ($value === '1') {
2015-03-31 18:13:36 +03:00
$this->addRecoveryKeys('/' . $this->user->getUID() . '/files/');
} else {
2015-03-31 20:24:52 +03:00
$this->removeRecoveryKeys('/' . $this->user->getUID() . '/files/');
}
return true;
} catch (PreConditionNotMetException $e) {
return false;
}
}
/**
* add recovery key to all encrypted files
* @param string $path
*/
2015-03-31 20:24:52 +03:00
private function addRecoveryKeys($path) {
$dirContent = $this->view->getDirectoryContent($path);
foreach ($dirContent as $item) {
2015-03-31 18:13:36 +03:00
$filePath = $item->getPath();
if ($item['type'] === 'dir') {
$this->addRecoveryKeys($filePath . '/');
} else {
2015-03-31 18:13:36 +03:00
$fileKey = $this->keyManager->getFileKey($filePath, $this->user->getUID());
if (!empty($fileKey)) {
2015-03-31 18:13:36 +03:00
$accessList = $this->file->getAccessList($filePath);
$publicKeys = array();
foreach ($accessList['users'] as $uid) {
2015-03-31 18:13:36 +03:00
$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
}
$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->user->getUID());
2015-03-31 18:13:36 +03:00
$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
2015-03-31 18:13:36 +03:00
$this->keyManager->setAllFileKeys($filePath, $encryptedKeyfiles);
}
}
}
}
/**
* remove recovery key to all encrypted files
* @param string $path
*/
2015-03-31 20:24:52 +03:00
private function removeRecoveryKeys($path) {
$dirContent = $this->view->getDirectoryContent($path);
foreach ($dirContent as $item) {
2015-03-31 20:24:52 +03:00
$filePath = $item->getPath();
if ($item['type'] === 'dir') {
$this->removeRecoveryKeys($filePath . '/');
} else {
$this->keyManager->deleteShareKey($filePath, $this->keyManager->getRecoveryKeyId());
}
}
}
/**
2015-04-01 15:24:56 +03:00
* recover users files with the recovery key
*
* @param string $recoveryPassword
* @param string $user
*/
2015-04-01 15:24:56 +03:00
public function recoverUsersFiles($recoveryPassword, $user) {
$encryptedKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
$privateKey = $this->crypt->decryptPrivateKey($encryptedKey, $recoveryPassword);
if($privateKey !== false) {
$this->recoverAllFiles('/' . $user . '/files/', $privateKey, $user);
}
}
/**
* recover users files
*
* @param string $path
* @param string $privateKey
* @param string $uid
*/
private function recoverAllFiles($path, $privateKey, $uid) {
2015-04-01 15:24:56 +03:00
$dirContent = $this->view->getDirectoryContent($path);
foreach ($dirContent as $item) {
// Get relative path from encryption/keyfiles
2015-04-01 15:24:56 +03:00
$filePath = $item->getPath();
if ($this->view->is_dir($filePath)) {
$this->recoverAllFiles($filePath . '/', $privateKey, $uid);
} else {
$this->recoverFile($filePath, $privateKey, $uid);
}
}
}
/**
* recover file
*
2015-04-01 15:24:56 +03:00
* @param string $path
* @param string $privateKey
* @param string $uid
*/
private function recoverFile($path, $privateKey, $uid) {
2015-04-01 15:24:56 +03:00
$encryptedFileKey = $this->keyManager->getEncryptedFileKey($path);
$shareKey = $this->keyManager->getShareKey($path, $this->keyManager->getRecoveryKeyId());
if ($encryptedFileKey && $shareKey && $privateKey) {
$fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
$shareKey,
$privateKey);
}
2015-04-01 15:24:56 +03:00
if (!empty($fileKey)) {
$accessList = $this->file->getAccessList($path);
$publicKeys = array();
foreach ($accessList['users'] as $user) {
$publicKeys[$user] = $this->keyManager->getPublicKey($user);
2015-04-01 15:24:56 +03:00
}
$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
2015-04-01 15:24:56 +03:00
$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
$this->keyManager->setAllFileKeys($path, $encryptedKeyfiles);
}
}
2015-02-24 21:05:19 +03:00
}