server/apps/files_encryption/lib/proxy.php

434 lines
11 KiB
PHP
Raw Normal View History

2011-10-21 15:02:11 +00:00
<?php
/**
2013-05-19 23:24:36 +00:00
* ownCloud
*
* @author Sam Tuke, Robin Appelman
* @copyright 2012 Sam Tuke samtuke@owncloud.com, Robin Appelman
* icewind1991@gmail.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/>.
*
*/
2011-10-21 15:02:11 +00:00
/**
2013-05-19 23:24:36 +00:00
* @brief Encryption proxy which handles filesystem operations before and after
* execution and encrypts, and handles keyfiles accordingly. Used for
* webui.
*/
namespace OCA\Encryption;
2013-05-19 23:24:36 +00:00
/**
* Class Proxy
* @package OCA\Encryption
*/
2013-05-27 15:26:58 +00:00
class Proxy extends \OC_FileProxy {
private static $blackList = null; //mimetypes blacklisted from encryption
private static $unencryptedSizes = array(); // remember unencrypted size
private static $fopenMode = array(); // remember the fopen mode
2013-05-19 23:24:36 +00:00
2011-11-24 00:44:54 +00:00
/**
* Check if a file requires encryption
2011-11-24 00:44:54 +00:00
* @param string $path
* @return bool
*
* Tests if server side encryption is enabled, and file is allowed by blacklists
2011-11-24 00:44:54 +00:00
*/
2013-05-27 15:26:58 +00:00
private static function shouldEncrypt($path) {
2013-05-19 23:24:36 +00:00
$userId = Helper::getUser($path);
if (\OCP\App::isEnabled('files_encryption') === false || Crypt::mode() !== 'server' ||
strpos($path, '/' . $userId . '/files') !== 0) {
2012-04-18 14:02:35 +00:00
return false;
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
if (is_null(self::$blackList)) {
self::$blackList = explode(',', \OCP\Config::getAppValue('files_encryption', 'type_blacklist', ''));
2011-11-24 00:44:54 +00:00
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
if (Crypt::isCatfileContent($path)) {
2011-11-24 00:44:54 +00:00
return true;
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
$extension = substr($path, strrpos($path, '.') + 1);
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
if (array_search($extension, self::$blackList) === false) {
2011-11-24 00:44:54 +00:00
return true;
}
2013-05-19 23:24:36 +00:00
return false;
2011-11-24 00:44:54 +00:00
}
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
/**
* @param $path
* @param $data
* @return bool
*/
2013-05-27 15:26:58 +00:00
public function preFile_put_contents($path, &$data) {
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
if (self::shouldEncrypt($path)) {
2013-04-23 17:08:52 +00:00
2013-05-27 15:26:58 +00:00
if (!is_resource($data)) {
2013-04-23 17:08:52 +00:00
// get root view
2013-05-27 15:26:58 +00:00
$view = new \OC_FilesystemView('/');
2013-05-19 23:24:36 +00:00
// get relative path
$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
2013-05-19 23:24:36 +00:00
if (!isset($relativePath)) {
return true;
2013-05-15 22:31:17 +00:00
}
2013-04-23 17:08:52 +00:00
// create random cache folder
$cacheFolder = rand();
$path_slices = explode('/', \OC_Filesystem::normalizePath($path));
$path_slices[2] = "cache/".$cacheFolder;
$tmpPath = implode('/', $path_slices);
$handle = fopen('crypt://' . $tmpPath, 'w');
if (is_resource($handle)) {
// write data to stream
fwrite($handle, $data);
2013-05-19 23:24:36 +00:00
// close stream
fclose($handle);
2013-05-19 23:24:36 +00:00
// disable encryption proxy to prevent recursive calls
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
2013-05-19 23:24:36 +00:00
// get encrypted content
$data = $view->file_get_contents($tmpPath);
// store new unenecrypted size so that it can be updated
// in the post proxy
2013-12-16 14:24:11 +00:00
$tmpFileInfo = $view->getFileInfo($tmpPath);
if ( isset($tmpFileInfo['size']) ) {
self::$unencryptedSizes[\OC_Filesystem::normalizePath($path)] = $tmpFileInfo['size'];
}
2013-12-16 14:24:11 +00:00
// remove our temp file
$view->deleteAll('/' . \OCP\User::getUser() . '/cache/' . $cacheFolder);
2013-05-19 23:24:36 +00:00
// re-enable proxy - our work is done
\OC_FileProxy::$enabled = $proxyStatus;
}
2011-10-21 15:02:11 +00:00
}
}
2013-04-23 17:08:52 +00:00
return true;
2013-05-19 23:24:36 +00:00
}
2013-05-19 23:24:36 +00:00
/**
* @brief update file cache with the new unencrypted size after file was written
* @param string $path
* @param mixed $result
* @return mixed
*/
public function postFile_put_contents($path, $result) {
$normalizedPath = \OC_Filesystem::normalizePath($path);
if ( isset(self::$unencryptedSizes[$normalizedPath]) ) {
$view = new \OC_FilesystemView('/');
$view->putFileInfo($normalizedPath,
array('encrypted' => true, 'unencrypted_size' => self::$unencryptedSizes[$normalizedPath]));
unset(self::$unencryptedSizes[$normalizedPath]);
}
return $result;
}
/**
* @param string $path Path of file from which has been read
* @param string $data Data that has been read from file
*/
2013-05-27 15:26:58 +00:00
public function postFile_get_contents($path, $data) {
2013-05-19 23:24:36 +00:00
$plainData = null;
2013-05-27 15:26:58 +00:00
$view = new \OC_FilesystemView('/');
2013-05-19 23:24:36 +00:00
// init session
$session = new \OCA\Encryption\Session($view);
2013-05-19 23:24:36 +00:00
// If data is a catfile
if (
Crypt::mode() === 'server'
2013-05-27 15:26:58 +00:00
&& Crypt::isCatfileContent($data)
) {
2013-05-19 23:24:36 +00:00
2013-07-30 08:14:17 +00:00
$handle = fopen('crypt://' . $path, 'r');
2013-05-19 23:24:36 +00:00
if (is_resource($handle)) {
while (($plainDataChunk = fgets($handle, 8192)) !== false) {
$plainData .= $plainDataChunk;
}
}
} elseif (
2013-05-19 23:24:36 +00:00
Crypt::mode() == 'server'
&& \OC::$session->exists('legacyenckey')
2013-05-27 15:26:58 +00:00
&& Crypt::isEncryptedMeta($path)
) {
// Disable encryption proxy to prevent recursive calls
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
$plainData = Crypt::legacyBlockDecrypt($data, $session->getLegacyKey());
2013-05-19 23:24:36 +00:00
\OC_FileProxy::$enabled = $proxyStatus;
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
if (!isset($plainData)) {
2013-05-19 23:24:36 +00:00
$plainData = $data;
2013-05-19 23:24:36 +00:00
}
2013-05-19 23:24:36 +00:00
return $plainData;
2013-05-19 23:24:36 +00:00
2011-10-21 15:02:11 +00:00
}
2013-05-19 23:24:36 +00:00
/**
2013-05-19 23:24:36 +00:00
* @param $path
* @return bool
*/
2013-05-27 15:26:58 +00:00
public function postTouch($path) {
$this->handleFile($path);
2013-05-19 23:24:36 +00:00
return true;
}
/**
* @brief remember initial fopen mode because sometimes it gets changed during the request
* @param string $path path
* @param string $mode type of access
*/
public function preFopen($path, $mode) {
self::$fopenMode[$path] = $mode;
}
2013-05-19 23:24:36 +00:00
/**
* @param $path
* @param $result
* @return resource
*/
2013-05-27 15:26:58 +00:00
public function postFopen($path, &$result) {
$path = \OC\Files\Filesystem::normalizePath($path);
2013-05-27 15:26:58 +00:00
if (!$result) {
2013-04-23 17:08:52 +00:00
2011-11-24 00:44:54 +00:00
return $result;
2013-05-19 23:24:36 +00:00
2011-11-24 00:44:54 +00:00
}
2013-04-23 17:08:52 +00:00
// split the path parts
$pathParts = explode('/', $path);
// don't try to encrypt/decrypt cache chunks or files in the trash bin
if (isset($pathParts[2]) && ($pathParts[2] === 'cache' || $pathParts[2] === 'files_trashbin')) {
2013-05-19 23:24:36 +00:00
return $result;
}
// Disable encryption proxy to prevent recursive calls
2013-05-19 23:24:36 +00:00
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
// if we remember the mode from the pre proxy we re-use it
// oterwise we fall back to stream_get_meta_data()
if (isset(self::$fopenMode[$path])) {
$mode = self::$fopenMode[$path];
unset(self::$fopenMode[$path]);
} else {
$meta = stream_get_meta_data($result);
$mode = $meta['mode'];
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
$view = new \OC_FilesystemView('');
2013-05-19 23:24:36 +00:00
$userId = Helper::getUser($path);
$util = new Util($view, $userId);
2013-05-19 23:24:36 +00:00
2012-11-22 19:36:48 +00:00
// If file is already encrypted, decrypt using crypto protocol
2013-05-19 23:24:36 +00:00
if (
Crypt::mode() === 'server'
2013-05-27 15:26:58 +00:00
&& $util->isEncryptedPath($path)
) {
2013-05-19 23:24:36 +00:00
2012-11-22 19:36:48 +00:00
// Close the original encrypted file
2013-05-27 15:26:58 +00:00
fclose($result);
2013-05-19 23:24:36 +00:00
2013-09-25 17:23:07 +00:00
// Open the file using the crypto stream wrapper
// protocol and let it do the decryption work instead
$result = fopen('crypt://' . $path, $mode);
2013-05-19 23:24:36 +00:00
} elseif (
self::shouldEncrypt($path)
and $mode !== 'r'
and $mode !== 'rb'
) {
$result = fopen('crypt://' . $path, $mode);
2012-11-22 14:08:19 +00:00
}
2013-05-19 23:24:36 +00:00
2012-11-14 13:58:57 +00:00
// Re-enable the proxy
\OC_FileProxy::$enabled = $proxyStatus;
2013-05-19 23:24:36 +00:00
2011-11-24 00:44:54 +00:00
return $result;
2013-05-19 23:24:36 +00:00
2011-10-21 15:02:11 +00:00
}
2012-02-15 20:44:58 +00:00
2013-05-19 23:24:36 +00:00
/**
* @param $path
* @param $data
* @return array
*/
2013-05-27 15:26:58 +00:00
public function postGetFileInfo($path, $data) {
2013-05-19 23:24:36 +00:00
// if path is a folder do nothing
2014-01-17 13:38:14 +00:00
if (\OCP\App::isEnabled('files_encryption') && $data !== false && array_key_exists('size', $data)) {
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
// Disable encryption proxy to prevent recursive calls
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
// get file size
2013-05-27 15:26:58 +00:00
$data['size'] = self::postFileSize($path, $data['size']);
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
// Re-enable the proxy
\OC_FileProxy::$enabled = $proxyStatus;
}
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
return $data;
}
2013-04-23 17:08:52 +00:00
2013-05-19 23:24:36 +00:00
/**
* @param $path
* @param $size
* @return bool
*/
2013-05-27 15:26:58 +00:00
public function postFileSize($path, $size) {
2013-04-23 17:08:52 +00:00
2013-05-27 15:26:58 +00:00
$view = new \OC_FilesystemView('/');
2013-04-23 17:08:52 +00:00
$userId = Helper::getUser($path);
$util = new Util($view, $userId);
// if encryption is no longer enabled or if the files aren't migrated yet
// we return the default file size
if(!\OCP\App::isEnabled('files_encryption') ||
$util->getMigrationStatus() !== Util::MIGRATION_COMPLETED) {
return $size;
}
2013-05-19 23:24:36 +00:00
// if path is a folder do nothing
2013-05-27 15:26:58 +00:00
if ($view->is_dir($path)) {
2013-05-19 23:24:36 +00:00
return $size;
}
// get relative path
$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
2013-05-07 11:42:08 +00:00
2013-05-19 23:24:36 +00:00
// if path is empty we cannot resolve anything
if (empty($relativePath)) {
2013-05-19 23:24:36 +00:00
return $size;
}
2013-05-21 19:09:25 +00:00
$fileInfo = false;
// get file info from database/cache if not .part file
if (!Helper::isPartialFilePath($path)) {
$proxyState = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
2013-05-27 15:26:58 +00:00
$fileInfo = $view->getFileInfo($path);
\OC_FileProxy::$enabled = $proxyState;
2013-05-21 19:09:25 +00:00
}
2013-05-19 23:24:36 +00:00
// if file is encrypted return real file size
2014-01-17 11:56:17 +00:00
if ($fileInfo && $fileInfo['encrypted'] === true) {
// try to fix unencrypted file size if it doesn't look plausible
2013-10-16 09:24:56 +00:00
if ((int)$fileInfo['size'] > 0 && (int)$fileInfo['unencrypted_size'] === 0 ) {
$fixSize = $util->getFileSize($path);
$fileInfo['unencrypted_size'] = $fixSize;
// put file info if not .part file
if (!Helper::isPartialFilePath($relativePath)) {
$view->putFileInfo($path, $fileInfo);
}
}
2013-05-19 23:24:36 +00:00
$size = $fileInfo['unencrypted_size'];
} else {
// self healing if file was removed from file cache
2014-01-17 13:38:14 +00:00
if (!$fileInfo) {
2013-05-21 19:09:25 +00:00
$fileInfo = array();
}
2013-05-19 23:24:36 +00:00
2013-05-27 15:26:58 +00:00
$fixSize = $util->getFileSize($path);
if ($fixSize > 0) {
2013-05-21 19:09:25 +00:00
$size = $fixSize;
2013-05-19 23:24:36 +00:00
2013-05-21 19:09:25 +00:00
$fileInfo['encrypted'] = true;
$fileInfo['unencrypted_size'] = $size;
// put file info if not .part file
if (!Helper::isPartialFilePath($relativePath)) {
2013-05-27 15:26:58 +00:00
$view->putFileInfo($path, $fileInfo);
2013-05-19 23:24:36 +00:00
}
}
2013-05-21 19:09:25 +00:00
2013-05-19 23:24:36 +00:00
}
return $size;
}
2013-04-30 18:44:42 +00:00
2013-05-19 23:24:36 +00:00
/**
* @param $path
*/
2013-05-27 15:26:58 +00:00
public function handleFile($path) {
2013-04-30 18:44:42 +00:00
2013-05-19 23:24:36 +00:00
// Disable encryption proxy to prevent recursive calls
$proxyStatus = \OC_FileProxy::$enabled;
\OC_FileProxy::$enabled = false;
2013-05-27 15:26:58 +00:00
$view = new \OC_FilesystemView('/');
$session = new \OCA\Encryption\Session($view);
$userId = Helper::getUser($path);
2013-05-27 15:26:58 +00:00
$util = new Util($view, $userId);
// split the path parts
$pathParts = explode('/', $path);
// get relative path
$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
2013-05-19 23:24:36 +00:00
// only if file is on 'files' folder fix file size and sharing
if (isset($pathParts[2]) && $pathParts[2] === 'files' && $util->fixFileSize($path)) {
2013-05-19 23:24:36 +00:00
// get sharing app state
$sharingEnabled = \OCP\Share::isEnabled();
2013-05-19 23:24:36 +00:00
// get users
$usersSharing = $util->getSharingUsersArray($sharingEnabled, $relativePath);
2013-05-19 23:24:36 +00:00
// update sharing-keys
$util->setSharedFileKeyfiles($session, $usersSharing, $relativePath);
2013-05-19 23:24:36 +00:00
}
2013-05-19 23:24:36 +00:00
\OC_FileProxy::$enabled = $proxyStatus;
}
}