2015-01-14 19:39:23 +00:00
|
|
|
<?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 OC\Files\Storage\Wrapper;
|
|
|
|
|
|
|
|
use OC\Encryption\Exceptions\ModuleDoesNotExistsException;
|
2015-04-02 12:44:58 +00:00
|
|
|
use OC\Files\Storage\LocalTempFileTrait;
|
2015-04-07 07:42:54 +00:00
|
|
|
use OCP\Files\Mount\IMountPoint;
|
2015-01-14 19:39:23 +00:00
|
|
|
|
|
|
|
class Encryption extends Wrapper {
|
|
|
|
|
2015-04-02 12:44:58 +00:00
|
|
|
use LocalTempFileTrait;
|
|
|
|
|
2015-01-14 19:39:23 +00:00
|
|
|
/** @var string */
|
|
|
|
private $mountPoint;
|
|
|
|
|
|
|
|
/** @var \OC\Encryption\Util */
|
|
|
|
private $util;
|
|
|
|
|
|
|
|
/** @var \OC\Encryption\Manager */
|
|
|
|
private $encryptionManager;
|
|
|
|
|
|
|
|
/** @var \OC\Log */
|
|
|
|
private $logger;
|
|
|
|
|
|
|
|
/** @var string */
|
|
|
|
private $uid;
|
|
|
|
|
|
|
|
/** @var array */
|
|
|
|
private $unencryptedSize;
|
|
|
|
|
2015-04-01 08:37:48 +00:00
|
|
|
/** @var \OC\Encryption\File */
|
|
|
|
private $fileHelper;
|
|
|
|
|
2015-04-07 07:42:54 +00:00
|
|
|
/** @var IMountPoint */
|
|
|
|
private $mount;
|
|
|
|
|
2015-01-14 19:39:23 +00:00
|
|
|
/**
|
|
|
|
* @param array $parameters
|
|
|
|
* @param \OC\Encryption\Manager $encryptionManager
|
|
|
|
* @param \OC\Encryption\Util $util
|
|
|
|
* @param \OC\Log $logger
|
2015-04-01 08:37:48 +00:00
|
|
|
* @param \OC\Encryption\File $fileHelper
|
2015-01-14 19:39:23 +00:00
|
|
|
* @param string $uid user who perform the read/write operation (null for public access)
|
|
|
|
*/
|
|
|
|
public function __construct(
|
|
|
|
$parameters,
|
|
|
|
\OC\Encryption\Manager $encryptionManager = null,
|
|
|
|
\OC\Encryption\Util $util = null,
|
|
|
|
\OC\Log $logger = null,
|
2015-04-01 08:37:48 +00:00
|
|
|
\OC\Encryption\File $fileHelper = null,
|
2015-01-14 19:39:23 +00:00
|
|
|
$uid = null
|
|
|
|
) {
|
|
|
|
|
|
|
|
$this->mountPoint = $parameters['mountPoint'];
|
2015-04-07 07:42:54 +00:00
|
|
|
$this->mount = $parameters['mount'];
|
2015-01-14 19:39:23 +00:00
|
|
|
$this->encryptionManager = $encryptionManager;
|
|
|
|
$this->util = $util;
|
|
|
|
$this->logger = $logger;
|
|
|
|
$this->uid = $uid;
|
2015-04-01 08:37:48 +00:00
|
|
|
$this->fileHelper = $fileHelper;
|
2015-01-14 19:39:23 +00:00
|
|
|
$this->unencryptedSize = array();
|
|
|
|
parent::__construct($parameters);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.filesize.php
|
|
|
|
* The result for filesize when called on a folder is required to be 0
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function filesize($path) {
|
|
|
|
$fullPath = $this->getFullPath($path);
|
2015-03-30 15:29:05 +00:00
|
|
|
$size = $this->storage->filesize($path);
|
2015-01-14 19:39:23 +00:00
|
|
|
|
|
|
|
$info = $this->getCache()->get($path);
|
|
|
|
|
2015-04-01 15:42:56 +00:00
|
|
|
if (isset($this->unencryptedSize[$fullPath])) {
|
2015-01-14 19:39:23 +00:00
|
|
|
$size = $this->unencryptedSize[$fullPath];
|
2015-04-01 15:42:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($info['fileid'])) {
|
2015-01-14 19:39:23 +00:00
|
|
|
$info['encrypted'] = true;
|
2015-03-30 15:29:05 +00:00
|
|
|
$info['size'] = $size;
|
2015-01-14 19:39:23 +00:00
|
|
|
$this->getCache()->put($path, $info);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $size;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.file_get_contents.php
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function file_get_contents($path) {
|
|
|
|
|
|
|
|
$encryptionModule = $this->getEncryptionModule($path);
|
|
|
|
|
|
|
|
if ($encryptionModule) {
|
2015-04-02 14:18:10 +00:00
|
|
|
$handle = $this->fopen($path, "r");
|
|
|
|
if (!$handle) {
|
|
|
|
return false;
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
2015-04-02 14:18:10 +00:00
|
|
|
$data = stream_get_contents($handle);
|
|
|
|
fclose($handle);
|
|
|
|
return $data;
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
2015-04-02 14:18:10 +00:00
|
|
|
return $this->storage->file_get_contents($path);
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.file_put_contents.php
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @param string $data
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function file_put_contents($path, $data) {
|
|
|
|
// file put content will always be translated to a stream write
|
|
|
|
$handle = $this->fopen($path, 'w');
|
2015-04-01 10:35:12 +00:00
|
|
|
$written = fwrite($handle, $data);
|
|
|
|
fclose($handle);
|
|
|
|
return $written;
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.unlink.php
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function unlink($path) {
|
|
|
|
if ($this->util->isExcluded($path)) {
|
|
|
|
return $this->storage->unlink($path);
|
|
|
|
}
|
|
|
|
|
|
|
|
$encryptionModule = $this->getEncryptionModule($path);
|
|
|
|
if ($encryptionModule) {
|
2015-04-02 12:44:58 +00:00
|
|
|
$keyStorage = $this->getKeyStorage($encryptionModule->getId());
|
|
|
|
$keyStorage->deleteAllFileKeys($this->getFullPath($path));
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return $this->storage->unlink($path);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.rename.php
|
|
|
|
*
|
|
|
|
* @param string $path1
|
|
|
|
* @param string $path2
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function rename($path1, $path2) {
|
|
|
|
if ($this->util->isExcluded($path1)) {
|
|
|
|
return $this->storage->rename($path1, $path2);
|
|
|
|
}
|
|
|
|
|
2015-04-02 14:25:01 +00:00
|
|
|
$source = $this->getFullPath($path1);
|
2015-01-14 19:39:23 +00:00
|
|
|
$result = $this->storage->rename($path1, $path2);
|
|
|
|
if ($result) {
|
2015-04-02 14:25:01 +00:00
|
|
|
$target = $this->getFullPath($path2);
|
2015-01-14 19:39:23 +00:00
|
|
|
$encryptionModule = $this->getEncryptionModule($path2);
|
|
|
|
if ($encryptionModule) {
|
2015-04-02 12:44:58 +00:00
|
|
|
$keyStorage = $this->getKeyStorage($encryptionModule->getId());
|
2015-04-02 14:25:01 +00:00
|
|
|
$keyStorage->renameKeys($source, $target);
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $result;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.copy.php
|
|
|
|
*
|
|
|
|
* @param string $path1
|
|
|
|
* @param string $path2
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function copy($path1, $path2) {
|
2015-04-02 14:25:01 +00:00
|
|
|
if ($this->util->isExcluded($path1)) {
|
|
|
|
return $this->storage->rename($path1, $path2);
|
|
|
|
}
|
|
|
|
|
|
|
|
$source = $this->getFullPath($path1);
|
|
|
|
$result = $this->storage->copy($path1, $path2);
|
|
|
|
if ($result) {
|
|
|
|
$target = $this->getFullPath($path2);
|
|
|
|
$encryptionModule = $this->getEncryptionModule($path2);
|
|
|
|
if ($encryptionModule) {
|
|
|
|
$keyStorage = $this->getKeyStorage($encryptionModule->getId());
|
|
|
|
$keyStorage->copyKeys($source, $target);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $result;
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.fopen.php
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @param string $mode
|
|
|
|
* @return resource
|
|
|
|
*/
|
|
|
|
public function fopen($path, $mode) {
|
|
|
|
|
|
|
|
$shouldEncrypt = false;
|
|
|
|
$encryptionModule = null;
|
|
|
|
$header = $this->getHeader($path);
|
|
|
|
$fullPath = $this->getFullPath($path);
|
|
|
|
$encryptionModuleId = $this->util->getEncryptionModuleId($header);
|
|
|
|
|
|
|
|
$size = $unencryptedSize = 0;
|
2015-04-02 15:16:27 +00:00
|
|
|
$targetExists = $this->file_exists($path);
|
|
|
|
$targetIsEncrypted = false;
|
|
|
|
if ($targetExists) {
|
2015-04-01 14:35:46 +00:00
|
|
|
// in case the file exists we require the explicit module as
|
|
|
|
// specified in the file header - otherwise we need to fail hard to
|
|
|
|
// prevent data loss on client side
|
|
|
|
if (!empty($encryptionModuleId)) {
|
2015-04-02 15:16:27 +00:00
|
|
|
$targetIsEncrypted = true;
|
2015-04-01 14:35:46 +00:00
|
|
|
$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
|
|
|
|
}
|
2015-04-02 15:16:27 +00:00
|
|
|
|
2015-01-14 19:39:23 +00:00
|
|
|
$size = $this->storage->filesize($path);
|
|
|
|
$unencryptedSize = $this->filesize($path);
|
|
|
|
}
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
|
|
|
if (
|
|
|
|
$mode === 'w'
|
|
|
|
|| $mode === 'w+'
|
|
|
|
|| $mode === 'wb'
|
|
|
|
|| $mode === 'wb+'
|
|
|
|
) {
|
|
|
|
if (!empty($encryptionModuleId)) {
|
|
|
|
$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
|
|
|
|
} else {
|
|
|
|
$encryptionModule = $this->encryptionManager->getDefaultEncryptionModule();
|
|
|
|
}
|
|
|
|
$shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath);
|
|
|
|
} else {
|
|
|
|
// only get encryption module if we found one in the header
|
|
|
|
if (!empty($encryptionModuleId)) {
|
|
|
|
$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
|
|
|
|
$shouldEncrypt = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} catch (ModuleDoesNotExistsException $e) {
|
|
|
|
$this->logger->warning('Encryption module "' . $encryptionModuleId .
|
|
|
|
'" not found, file will be stored unencrypted');
|
|
|
|
}
|
|
|
|
|
2015-04-02 15:16:27 +00:00
|
|
|
// encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt
|
|
|
|
$encEnabled = $this->encryptionManager->isEnabled();
|
2015-04-07 07:42:54 +00:00
|
|
|
if (!$encEnabled || !$this->mount->getOption('encrypt', true)) {
|
2015-04-02 15:16:27 +00:00
|
|
|
if (!$targetExists || !$targetIsEncrypted) {
|
|
|
|
$shouldEncrypt = false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-03-27 10:46:07 +00:00
|
|
|
if($shouldEncrypt === true && !$this->util->isExcluded($fullPath) && $encryptionModule !== null) {
|
2015-01-14 19:39:23 +00:00
|
|
|
$source = $this->storage->fopen($path, $mode);
|
|
|
|
$handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header,
|
2015-04-01 10:35:12 +00:00
|
|
|
$this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
|
2015-01-14 19:39:23 +00:00
|
|
|
$size, $unencryptedSize);
|
|
|
|
return $handle;
|
|
|
|
} else {
|
|
|
|
return $this->storage->fopen($path, $mode);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-04-02 12:44:58 +00:00
|
|
|
/**
|
|
|
|
* get the path to a local version of the file.
|
|
|
|
* The local version of the file can be temporary and doesn't have to be persistent across requests
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getLocalFile($path) {
|
|
|
|
return $this->getCachedFile($path);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the wrapped storage's value for isLocal()
|
|
|
|
*
|
|
|
|
* @return bool wrapped storage's isLocal() value
|
|
|
|
*/
|
|
|
|
public function isLocal() {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.stat.php
|
|
|
|
* only the following keys are required in the result: size and mtime
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function stat($path) {
|
|
|
|
$stat = $this->storage->stat($path);
|
|
|
|
$fileSize = $this->filesize($path);
|
|
|
|
$stat['size'] = $fileSize;
|
|
|
|
$stat[7] = $fileSize;
|
|
|
|
return $stat;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* see http://php.net/manual/en/function.hash.php
|
|
|
|
*
|
|
|
|
* @param string $type
|
|
|
|
* @param string $path
|
|
|
|
* @param bool $raw
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function hash($type, $path, $raw = false) {
|
|
|
|
$fh = $this->fopen($path, 'rb');
|
|
|
|
$ctx = hash_init($type);
|
|
|
|
hash_update_stream($ctx, $fh);
|
|
|
|
fclose($fh);
|
|
|
|
return hash_final($ctx, $raw);
|
|
|
|
}
|
|
|
|
|
2015-01-14 19:39:23 +00:00
|
|
|
/**
|
|
|
|
* return full path, including mount point
|
|
|
|
*
|
|
|
|
* @param string $path relative to mount point
|
|
|
|
* @return string full path including mount point
|
|
|
|
*/
|
|
|
|
protected function getFullPath($path) {
|
|
|
|
return \OC\Files\Filesystem::normalizePath($this->mountPoint . '/' . $path);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* read header from file
|
|
|
|
*
|
|
|
|
* @param string $path
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
protected function getHeader($path) {
|
|
|
|
$header = '';
|
|
|
|
if ($this->storage->file_exists($path)) {
|
|
|
|
$handle = $this->storage->fopen($path, 'r');
|
|
|
|
$header = fread($handle, $this->util->getHeaderSize());
|
|
|
|
fclose($handle);
|
|
|
|
}
|
|
|
|
return $this->util->readHeader($header);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* read encryption module needed to read/write the file located at $path
|
|
|
|
*
|
|
|
|
* @param string $path
|
2015-03-30 11:23:10 +00:00
|
|
|
* @return null|\OCP\Encryption\IEncryptionModule
|
|
|
|
* @throws ModuleDoesNotExistsException
|
|
|
|
* @throws \Exception
|
2015-01-14 19:39:23 +00:00
|
|
|
*/
|
|
|
|
protected function getEncryptionModule($path) {
|
|
|
|
$encryptionModule = null;
|
|
|
|
$header = $this->getHeader($path);
|
|
|
|
$encryptionModuleId = $this->util->getEncryptionModuleId($header);
|
|
|
|
if (!empty($encryptionModuleId)) {
|
|
|
|
try {
|
|
|
|
$encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId);
|
|
|
|
} catch (ModuleDoesNotExistsException $e) {
|
2015-03-30 11:23:10 +00:00
|
|
|
$this->logger->critical('Encryption module defined in "' . $path . '" not loaded!');
|
2015-01-14 19:39:23 +00:00
|
|
|
throw $e;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $encryptionModule;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function updateUnencryptedSize($path, $unencryptedSize) {
|
|
|
|
$this->unencryptedSize[$path] = $unencryptedSize;
|
|
|
|
}
|
|
|
|
|
2015-04-02 12:44:58 +00:00
|
|
|
/**
|
2015-04-02 15:53:40 +00:00
|
|
|
* @param string $encryptionModuleId
|
2015-04-02 12:44:58 +00:00
|
|
|
* @return \OCP\Encryption\Keys\IStorage
|
|
|
|
*/
|
|
|
|
protected function getKeyStorage($encryptionModuleId) {
|
|
|
|
$keyStorage = \OC::$server->getEncryptionKeyStorage($encryptionModuleId);
|
|
|
|
return $keyStorage;
|
|
|
|
}
|
|
|
|
|
2015-01-14 19:39:23 +00:00
|
|
|
}
|