diff --git a/apps/files_encryption/appinfo/app.php b/apps/files_encryption/appinfo/app.php index 31b430d37a..e426f237bb 100644 --- a/apps/files_encryption/appinfo/app.php +++ b/apps/files_encryption/appinfo/app.php @@ -10,21 +10,31 @@ OC::$CLASSPATH['OCA\Encryption\Session'] = 'apps/files_encryption/lib/session.ph OC_FileProxy::register( new OCA\Encryption\Proxy() ); -OCP\Util::connectHook( 'OC_User','post_login', 'OCA\Encryption\Hooks', 'login' ); +// User-related hooks +OCP\Util::connectHook( 'OC_User', 'post_login', 'OCA\Encryption\Hooks', 'login' ); +OCP\Util::connectHook( 'OC_User', 'post_setPassword','OCA\Encryption\Hooks', 'setPassphrase' ); + +// Sharing-related hooks +OCP\Util::connectHook( 'OCP\Share', 'post_shared', 'OCA\Encryption\Hooks', 'postShared' ); +OCP\Util::connectHook( 'OCP\Share', 'pre_unshare', 'OCA\Encryption\Hooks', 'preUnshare' ); +OCP\Util::connectHook( 'OCP\Share', 'pre_unshareAll', 'OCA\Encryption\Hooks', 'preUnshareAll' ); + +// Webdav-related hooks OCP\Util::connectHook( 'OC_Webdav_Properties', 'update', 'OCA\Encryption\Hooks', 'updateKeyfile' ); -OCP\Util::connectHook( 'OC_User','post_setPassword','OCA\Encryption\Hooks' ,'setPassphrase' ); stream_wrapper_register( 'crypt', 'OCA\Encryption\Stream' ); $session = new OCA\Encryption\Session(); if ( -! $session->getPrivateKey( \OCP\USER::getUser() ) -&& OCP\User::isLoggedIn() -&& OCA\Encryption\Crypt::mode() == 'server' + ! $session->getPrivateKey( \OCP\USER::getUser() ) + && OCP\User::isLoggedIn() + && OCA\Encryption\Crypt::mode() == 'server' ) { - // Force the user to re-log in if the encryption key isn't unlocked (happens when a user is logged in before the encryption app is enabled) + // Force the user to log-in again if the encryption key isn't unlocked + // (happens when a user is logged in before the encryption app is + // enabled) OCP\User::logout(); header( "Location: " . OC::$WEBROOT.'/' ); @@ -33,5 +43,6 @@ if ( } -OCP\App::registerAdmin( 'files_encryption', 'settings'); +// Reguster settings scripts +OCP\App::registerAdmin( 'files_encryption', 'settings' ); OCP\App::registerPersonal( 'files_encryption', 'settings-personal' ); \ No newline at end of file diff --git a/apps/files_encryption/appinfo/spec.txt b/apps/files_encryption/appinfo/spec.txt new file mode 100644 index 0000000000..2d22dffe08 --- /dev/null +++ b/apps/files_encryption/appinfo/spec.txt @@ -0,0 +1,19 @@ +Encrypted files +--------------- + +- Each encrypted file has at least two components: the encrypted data file + ('catfile'), and it's corresponding key file ('keyfile'). Shared files have an + additional key file ('share key'). The catfile contains the encrypted data + concatenated with delimiter text, followed by the initialisation vector ('IV'), + and padding. e.g.: + + [encrypted data string][delimiter][IV][padding] + [anhAAjAmcGXqj1X9g==][00iv00][MSHU5N5gECP7aAg7][xx] (square braces added) + +Notes +----- + +- The user passphrase is required in order to set up or upgrade the app. New + keypair generation, and the re-encryption of legacy encrypted files requires + it. Therefore an appinfo/update.php script cannot be used, and upgrade logic + is handled in the login hook listener. \ No newline at end of file diff --git a/apps/files_encryption/appinfo/version b/apps/files_encryption/appinfo/version index 7dff5b8921..1d71ef9744 100644 --- a/apps/files_encryption/appinfo/version +++ b/apps/files_encryption/appinfo/version @@ -1 +1 @@ -0.2.1 \ No newline at end of file +0.3 \ No newline at end of file diff --git a/apps/files_encryption/hooks/hooks.php b/apps/files_encryption/hooks/hooks.php index c2f9724783..065ef9d241 100644 --- a/apps/files_encryption/hooks/hooks.php +++ b/apps/files_encryption/hooks/hooks.php @@ -1,4 +1,5 @@ ready() ) { - - \OC_Log::write( 'Encryption library', 'User account "' . $params['uid'] . '" is not ready for encryption; configuration started' , \OC_Log::DEBUG ); - - return $util->setupServerSide( $params['password'] ); - - } + $util = new Util( $view, $params['uid'] ); - \OC_FileProxy::$enabled = false; + if ( ! $util->ready() ) { - $encryptedKey = Keymanager::getPrivateKey( $view, $params['uid'] ); + \OC_Log::write( 'Encryption library', 'User account "' . $params['uid'] . '" is not ready for encryption; configuration started', \OC_Log::DEBUG ); - \OC_FileProxy::$enabled = true; - - # TODO: dont manually encrypt the private keyfile - use the config options of openssl_pkey_export instead for better mobile compatibility - - $privateKey = Crypt::symmetricDecryptFileContent( $encryptedKey, $params['password'] ); - - $session = new Session(); - - $session->setPrivateKey( $privateKey, $params['uid'] ); - - $view1 = new \OC_FilesystemView( '/' . $params['uid'] ); - - // Set legacy encryption key if it exists, to support - // depreciated encryption system - if ( + return $util->setupServerSide( $params['password'] ); + + } + + \OC_FileProxy::$enabled = false; + + $encryptedKey = Keymanager::getPrivateKey( $view, $params['uid'] ); + + \OC_FileProxy::$enabled = true; + + $privateKey = Crypt::symmetricDecryptFileContent( $encryptedKey, $params['password'] ); + + $session = new Session(); + + $session->setPrivateKey( $privateKey, $params['uid'] ); + + $view1 = new \OC_FilesystemView( '/' . $params['uid'] ); + + // Set legacy encryption key if it exists, to support + // depreciated encryption system + if ( $view1->file_exists( 'encryption.key' ) - && $legacyKey = $view1->file_get_contents( 'encryption.key' ) - ) { - - $_SESSION['legacyenckey'] = Crypt::legacyDecrypt( $legacyKey, $params['password'] ); + && $encLegacyKey = $view1->file_get_contents( 'encryption.key' ) + ) { + + $plainLegacyKey = Crypt::legacyDecrypt( $encLegacyKey, $params['password'] ); - } -// } + $session->setLegacyKey( $plainLegacyKey ); + + } + + $publicKey = Keymanager::getPublicKey( $view, $params['uid'] ); + + // Encrypt existing user files: + // This serves to upgrade old versions of the encryption + // app (see appinfo/spec.txt) + if ( + $util->encryptAll( $publicKey, '/' . $params['uid'] . '/' . 'files', $session->getLegacyKey(), $params['password'] ) + ) { + + \OC_Log::write( + 'Encryption library', 'Encryption of existing files belonging to "' . $params['uid'] . '" started at login' + , \OC_Log::INFO + ); + + } return true; @@ -104,9 +119,9 @@ class Hooks { // Save private key Keymanager::setPrivateKey( $encryptedPrivateKey ); - # NOTE: Session does not need to be updated as the - # private key has not changed, only the passphrase - # used to decrypt it has changed + // NOTE: Session does not need to be updated as the + // private key has not changed, only the passphrase + // used to decrypt it has changed } @@ -121,8 +136,11 @@ class Hooks { if ( isset( $params['properties']['key'] ) ) { - Keymanager::setFileKey( $params['path'], $params['properties']['key'] ); - + $view = new \OC_FilesystemView( '/' ); + $userId = \OCP\User::getUser(); + + Keymanager::setFileKey( $view, $params['path'], $userId, $params['properties']['key'] ); + } else { \OC_Log::write( @@ -138,6 +156,41 @@ class Hooks { } + /** + * @brief + */ + public static function postShared( $params ) { + + // Delete existing catfile + Keymanager::deleteFileKey( ); + + // Generate new catfile and env keys + Crypt::multiKeyEncrypt( $plainContent, $publicKeys ); + + // Save env keys to user folders + + + } + + /** + * @brief + */ + public static function preUnshare( $params ) { + + // Delete existing catfile + + // Generate new catfile and env keys + + // Save env keys to user folders + } + + /** + * @brief + */ + public static function preUnshareAll( $params ) { + + trigger_error( "preUnshareAll" ); + + } + } - -?> \ No newline at end of file diff --git a/apps/files_encryption/lib/crypt.php b/apps/files_encryption/lib/crypt.php index fddc89dae5..e3ffacabc9 100755 --- a/apps/files_encryption/lib/crypt.php +++ b/apps/files_encryption/lib/crypt.php @@ -1,4 +1,5 @@ password change faster -// - IMPORTANT! Check if the block lenght of the encrypted data stays the same +// - Add a setting "Don´t encrypt files larger than xx because of performance" +// - Don't use a password directly as encryption key. but a key which is +// stored on the server and encrypted with the user password. -> change pass +// faster /** * Class for common cryptography functionality @@ -93,7 +92,10 @@ class Crypt { * @brief Add arbitrary padding to encrypted data * @param string $data data to be padded * @return padded data - * @note In order to end up with data exactly 8192 bytes long we must add two letters. It is impossible to achieve exactly 8192 length blocks with encryption alone, hence padding is added to achieve the required length. + * @note In order to end up with data exactly 8192 bytes long we must + * add two letters. It is impossible to achieve exactly 8192 length + * blocks with encryption alone, hence padding is added to achieve the + * required length. */ public static function addPadding( $data ) { @@ -118,7 +120,7 @@ class Crypt { } else { - # TODO: log the fact that unpadded data was submitted for removal of padding + // TODO: log the fact that unpadded data was submitted for removal of padding return false; } @@ -130,7 +132,7 @@ class Crypt { * @return true / false * @note see also OCA\Encryption\Util->isEncryptedPath() */ - public static function isEncryptedContent( $content ) { + public static function isCatfile( $content ) { if ( !$content ) { @@ -168,10 +170,10 @@ class Crypt { */ public static function isEncryptedMeta( $path ) { - # TODO: Use DI to get OC_FileCache_Cached out of here + // TODO: Use DI to get \OC\Files\Filesystem out of here // Fetch all file metadata from DB - $metadata = \OC_FileCache_Cached::get( $path, '' ); + $metadata = \OC\Files\Filesystem::getFileInfo( $path, '' ); // Return encryption status return isset( $metadata['encrypted'] ) and ( bool )$metadata['encrypted']; @@ -180,19 +182,22 @@ class Crypt { /** * @brief Check if a file is encrypted via legacy system + * @param string $relPath The path of the file, relative to user/data; + * e.g. filename or /Docs/filename, NOT admin/files/filename * @return true / false */ - public static function isLegacyEncryptedContent( $content ) { + public static function isLegacyEncryptedContent( $data, $relPath ) { // Fetch all file metadata from DB - $metadata = \OC_FileCache_Cached::get( $content, '' ); - - // If a file is flagged with encryption in DB, but isn't a valid content + IV combination, it's probably using the legacy encryption system + $metadata = \OC\Files\Filesystem::getFileInfo( $relPath, '' ); + + // If a file is flagged with encryption in DB, but isn't a + // valid content + IV combination, it's probably using the + // legacy encryption system if ( - $content - and isset( $metadata['encrypted'] ) - and $metadata['encrypted'] === true - and !self::isEncryptedContent( $content ) + isset( $metadata['encrypted'] ) + and $metadata['encrypted'] === true + and ! self::isCatfile( $data ) ) { return true; @@ -217,7 +222,7 @@ class Crypt { } else { - \OC_Log::write( 'Encryption library', 'Encryption (symmetric) of content failed' , \OC_Log::ERROR ); + \OC_Log::write( 'Encryption library', 'Encryption (symmetric) of content failed', \OC_Log::ERROR ); return false; @@ -313,7 +318,7 @@ class Crypt { } else { - \OC_Log::write( 'Encryption library', 'Encryption (symmetric) of keyfile content failed' , \OC_Log::ERROR ); + \OC_Log::write( 'Encryption library', 'Encryption (symmetric) of keyfile content failed', \OC_Log::ERROR ); return false; @@ -390,6 +395,8 @@ class Crypt { */ public static function multiKeyEncrypt( $plainContent, array $publicKeys ) { + // Set empty vars to be set by openssl by reference + $sealed = ''; $envKeys = array(); if( openssl_seal( $plainContent, $sealed, $envKeys, $publicKeys ) ) { @@ -429,7 +436,7 @@ class Crypt { } else { - \OC_Log::write( 'Encryption library', 'Decryption (asymmetric) of sealed content failed' , \OC_Log::ERROR ); + \OC_Log::write( 'Encryption library', 'Decryption (asymmetric) of sealed content failed', \OC_Log::ERROR ); return false; @@ -577,7 +584,7 @@ class Crypt { if ( !$strong ) { // If OpenSSL indicates randomness is insecure, log error - \OC_Log::write( 'Encryption library', 'Insecure symmetric key was generated using openssl_random_pseudo_bytes()' , \OC_Log::WARN ); + \OC_Log::write( 'Encryption library', 'Insecure symmetric key was generated using openssl_random_pseudo_bytes()', \OC_Log::WARN ); } @@ -621,18 +628,27 @@ class Crypt { } - public static function changekeypasscode($oldPassword, $newPassword) { + public static function changekeypasscode( $oldPassword, $newPassword ) { - if(\OCP\User::isLoggedIn()){ + if ( \OCP\User::isLoggedIn() ) { + $key = Keymanager::getPrivateKey( $user, $view ); - if ( ($key = Crypt::symmetricDecryptFileContent($key,$oldpasswd)) ) { - if ( ($key = Crypt::symmetricEncryptFileContent($key, $newpasswd)) ) { - Keymanager::setPrivateKey($key); + + if ( ( $key = Crypt::symmetricDecryptFileContent($key,$oldpasswd) ) ) { + + if ( ( $key = Crypt::symmetricEncryptFileContent( $key, $newpasswd ) ) ) { + + Keymanager::setPrivateKey( $key ); + return true; } + } + } + return false; + } /** @@ -723,10 +739,8 @@ class Crypt { */ public static function legacyRecrypt( $legacyContent, $legacyPassphrase, $newPassphrase ) { - # TODO: write me + // TODO: write me } -} - -?> \ No newline at end of file +} \ No newline at end of file diff --git a/apps/files_encryption/lib/keymanager.php b/apps/files_encryption/lib/keymanager.php index 706e1c2661..43af70dacc 100755 --- a/apps/files_encryption/lib/keymanager.php +++ b/apps/files_encryption/lib/keymanager.php @@ -1,5 +1,6 @@ execute( array ( $filepath, $userId, $filepath ) ); -// -// $users = array(); -// -// if ( $row = $result->fetchRow() ) -// { -// $source = $row['source']; -// $owner = $row['uid_owner']; -// $users[] = $owner; -// // get the uids of all user with access to the file -// $query = \OC_DB::prepare( "SELECT source, uid_shared_with FROM `*PREFIX*sharing` WHERE source = ?" ); -// $result = $query->execute( array ($source)); -// while ( ($row = $result->fetchRow()) ) { -// $users[] = $row['uid_shared_with']; -// -// } -// -// } + } else { @@ -146,63 +114,87 @@ class Keymanager { } + /** + * @brief store file encryption key + * + * @param string $path relative path of the file, including filename + * @param string $key + * @return bool true/false + * @note The keyfile is not encrypted here. Client code must + * asymmetrically encrypt the keyfile before passing it to this method + */ + public static function setFileKey( \OC_FilesystemView $view, $path, $userId, $catfile ) { + + $basePath = '/' . $userId . '/files_encryption/keyfiles'; + + $targetPath = self::keySetPreparation( $view, $path, $basePath, $userId ); + + if ( $view->is_dir( $basePath . '/' . $targetPath ) ) { + + + + } else { + + // Save the keyfile in parallel directory + return $view->file_put_contents( $basePath . '/' . $targetPath . '.key', $catfile ); + + } + + } + /** * @brief retrieve keyfile for an encrypted file * @param string file name - * @return string file key or false + * @return string file key or false on failure * @note The keyfile returned is asymmetrically encrypted. Decryption * of the keyfile must be performed by client code */ public static function getFileKey( \OC_FilesystemView $view, $userId, $filePath ) { $filePath_f = ltrim( $filePath, '/' ); + + $catfilePath = '/' . $userId . '/files_encryption/keyfiles/' . $filePath_f . '.key'; + + if ( $view->file_exists( $catfilePath ) ) { -// // update $keypath and $userId if path point to a file shared by someone else -// $query = \OC_DB::prepare( "SELECT uid_owner, source, target FROM `*PREFIX*sharing` WHERE target = ? AND uid_shared_with = ?" ); -// -// $result = $query->execute( array ('/'.$userId.'/files/'.$keypath, $userId)); -// -// if ($row = $result->fetchRow()) { -// -// $keypath = $row['source']; -// $keypath_parts = explode( '/', $keypath ); -// $userId = $keypath_parts[1]; -// $keypath = str_replace( '/' . $userId . '/files/', '', $keypath ); -// -// } - - return $view->file_get_contents( '/' . $userId . '/files_encryption/keyfiles/' . $filePath_f . '.key' ); + return $view->file_get_contents( $catfilePath ); + + } else { + + return false; + + } } /** - * @brief retrieve file encryption key + * @brief Delete a keyfile * - * @param string file name - * @return string file key or false + * @param OC_FilesystemView $view + * @param string $userId username + * @param string $path path of the file the key belongs to + * @return bool Outcome of unlink operation + * @note $path must be relative to data/user/files. e.g. mydoc.txt NOT + * /data/admin/files/mydoc.txt */ - public static function deleteFileKey( $path, $staticUserClass = 'OCP\User' ) { + public static function deleteFileKey( \OC_FilesystemView $view, $userId, $path ) { - $keypath = ltrim( $path, '/' ); - $user = $staticUserClass::getUser(); - - // update $keypath and $user if path point to a file shared by someone else -// $query = \OC_DB::prepare( "SELECT uid_owner, source, target FROM `*PREFIX*sharing` WHERE target = ? AND uid_shared_with = ?" ); -// -// $result = $query->execute( array ('/'.$user.'/files/'.$keypath, $user)); -// -// if ($row = $result->fetchRow()) { -// -// $keypath = $row['source']; -// $keypath_parts = explode( '/', $keypath ); -// $user = $keypath_parts[1]; -// $keypath = str_replace( '/' . $user . '/files/', '', $keypath ); -// -// } + $trimmed = ltrim( $path, '/' ); + $keyPath = '/' . $userId . '/files_encryption/keyfiles/' . $trimmed . '.key'; - $view = new \OC_FilesystemView('/'.$user.'/files_encryption/keyfiles/'); + // Unlink doesn't tell us if file was deleted (not found returns + // true), so we perform our own test + if ( $view->file_exists( $keyPath ) ) { - return $view->unlink( $keypath . '.key' ); + return $view->unlink( $keyPath ); + + } else { + + \OC_Log::write( 'Encryption library', 'Could not delete keyfile; does not exist: "' . $keyPath, \OC_Log::ERROR ); + + return false; + + } } @@ -238,7 +230,7 @@ class Keymanager { */ public static function setUserKeys($privatekey, $publickey) { - return (self::setPrivateKey($privatekey) && self::setPublicKey($publickey)); + return ( self::setPrivateKey( $privatekey ) && self::setPublicKey( $publickey ) ); } @@ -263,71 +255,39 @@ class Keymanager { } /** - * @brief store file encryption key - * - * @param string $path relative path of the file, including filename - * @param string $key - * @return bool true/false - * @note The keyfile is not encrypted here. Client code must - * asymmetrically encrypt the keyfile before passing it to this method + * @note 'shareKey' is a more user-friendly name for env_key */ - public static function setFileKey( $path, $key, $view = Null, $dbClassName = '\OC_DB') { - - $targetPath = ltrim( $path, '/' ); - $user = \OCP\User::getUser(); + public static function setShareKey( \OC_FilesystemView $view, $path, $userId, $shareKey ) { -// // update $keytarget and $user if key belongs to a file shared by someone else -// $query = $dbClassName::prepare( "SELECT uid_owner, source, target FROM `*PREFIX*sharing` WHERE target = ? AND uid_shared_with = ?" ); -// -// $result = $query->execute( array ( '/'.$user.'/files/'.$targetPath, $user ) ); -// -// if ( $row = $result->fetchRow( ) ) { -// -// $targetPath = $row['source']; -// -// $targetPath_parts = explode( '/', $targetPath ); -// -// $user = $targetPath_parts[1]; -// -// $rootview = new \OC_FilesystemView( '/' ); -// -// if ( ! $rootview->is_writable( $targetPath ) ) { -// -// \OC_Log::write( 'Encryption library', "File Key not updated because you don't have write access for the corresponding file", \OC_Log::ERROR ); -// -// return false; -// -// } -// -// $targetPath = str_replace( '/'.$user.'/files/', '', $targetPath ); -// -// //TODO: check for write permission on shared file once the new sharing API is in place -// -// } + $basePath = '/' . $userId . '/files_encryption/share-keys'; + + $shareKeyPath = self::keySetPreparation( $view, $path, $basePath, $userId ); + + return $view->file_put_contents( $basePath . '/' . $shareKeyPath . '.shareKey', $shareKey ); + + } + + /** + * @brief Make preparations to vars and filesystem for saving a keyfile + */ + public static function keySetPreparation( \OC_FilesystemView $view, $path, $basePath, $userId ) { + + $targetPath = ltrim( $path, '/' ); $path_parts = pathinfo( $targetPath ); - if ( !$view ) { - - $view = new \OC_FilesystemView( '/' ); - - } - - $view->chroot( '/' . $user . '/files_encryption/keyfiles' ); - // If the file resides within a subdirectory, create it if ( isset( $path_parts['dirname'] ) - && ! $view->file_exists( $path_parts['dirname'] ) + && ! $view->file_exists( $basePath . '/' . $path_parts['dirname'] ) ) { - $view->mkdir( $path_parts['dirname'] ); + $view->mkdir( $basePath . '/' . $path_parts['dirname'] ); } - // Save the keyfile in parallel directory - return $view->file_put_contents( '/' . $targetPath . '.key', $key ); - + return $targetPath; + } /** diff --git a/apps/files_encryption/lib/proxy.php b/apps/files_encryption/lib/proxy.php index 52f47dba29..55cddf2bec 100644 --- a/apps/files_encryption/lib/proxy.php +++ b/apps/files_encryption/lib/proxy.php @@ -22,6 +22,12 @@ * */ +/** +* @brief Encryption proxy which handles filesystem operations before and after +* execution and encrypts, and handles keyfiles accordingly. Used for +* webui. +*/ + namespace OCA\Encryption; class Proxy extends \OC_FileProxy { @@ -42,8 +48,8 @@ class Proxy extends \OC_FileProxy { if ( is_null( self::$enableEncryption ) ) { if ( - \OCP\Config::getAppValue( 'files_encryption', 'enable_encryption', 'true' ) == 'true' - && Crypt::mode() == 'server' + \OCP\Config::getAppValue( 'files_encryption', 'enable_encryption', 'true' ) == 'true' + && Crypt::mode() == 'server' ) { self::$enableEncryption = true; @@ -64,19 +70,19 @@ class Proxy extends \OC_FileProxy { if ( is_null(self::$blackList ) ) { - self::$blackList = explode(',', \OCP\Config::getAppValue( 'files_encryption','type_blacklist','jpg,png,jpeg,avi,mpg,mpeg,mkv,mp3,oga,ogv,ogg' ) ); + self::$blackList = explode(',', \OCP\Config::getAppValue( 'files_encryption', 'type_blacklist', 'jpg,png,jpeg,avi,mpg,mpeg,mkv,mp3,oga,ogv,ogg' ) ); } - if ( Crypt::isEncryptedContent( $path ) ) { + if ( Crypt::isCatfile( $path ) ) { return true; } - $extension = substr( $path, strrpos( $path,'.' ) +1 ); + $extension = substr( $path, strrpos( $path, '.' ) +1 ); - if ( array_search( $extension, self::$blackList ) === false ){ + if ( array_search( $extension, self::$blackList ) === false ) { return true; @@ -101,6 +107,8 @@ class Proxy extends \OC_FileProxy { // Disable encryption proxy to prevent recursive calls \OC_FileProxy::$enabled = false; + // TODO: Check if file is shared, if so, use multiKeyEncrypt + // Encrypt plain data and fetch key $encrypted = Crypt::keyEncryptKeyfile( $data, Keymanager::getPublicKey( $rootView, $userId ) ); @@ -113,14 +121,15 @@ class Proxy extends \OC_FileProxy { $filePath = '/' . implode( '/', $filePath ); - # TODO: make keyfile dir dynamic from app config - $view = new \OC_FilesystemView( '/' . $userId . '/files_encryption/keyfiles' ); + // TODO: make keyfile dir dynamic from app config + + $view = new \OC_FilesystemView( '/' ); // Save keyfile for newly encrypted file in parallel directory tree - Keymanager::setFileKey( $filePath, $encrypted['key'], $view, '\OC_DB' ); + Keymanager::setFileKey( $view, $filePath, $userId, $encrypted['key'] ); // Update the file cache with file info - \OC_FileCache::put( $path, array( 'encrypted'=>true, 'size' => $size ), '' ); + \OC\Files\Filesystem::putFileInfo( $path, array( 'encrypted'=>true, 'size' => $size ), '' ); // Re-enable proxy - our work is done \OC_FileProxy::$enabled = true; @@ -136,15 +145,15 @@ class Proxy extends \OC_FileProxy { */ public function postFile_get_contents( $path, $data ) { - # TODO: Use dependency injection to add required args for view and user etc. to this method + // TODO: Use dependency injection to add required args for view and user etc. to this method // Disable encryption proxy to prevent recursive calls \OC_FileProxy::$enabled = false; // If data is a catfile if ( - Crypt::mode() == 'server' - && Crypt::isEncryptedContent( $data ) + Crypt::mode() == 'server' + && Crypt::isCatfile( $data ) ) { $split = explode( '/', $path ); @@ -153,12 +162,14 @@ class Proxy extends \OC_FileProxy { $filePath = '/' . implode( '/', $filePath ); - //$cached = \OC_FileCache_Cached::get( $path, '' ); + //$cached = \OC\Files\Filesystem::getFileInfo( $path, '' ); $view = new \OC_FilesystemView( '' ); $userId = \OCP\USER::getUser(); + // TODO: Check if file is shared, if so, use multiKeyDecrypt + $encryptedKeyfile = Keymanager::getFileKey( $view, $userId, $filePath ); $session = new Session(); @@ -187,6 +198,79 @@ class Proxy extends \OC_FileProxy { } + /** + * @brief When a file is deleted, remove its keyfile also + */ + public function preUnlink( $path ) { + + // Disable encryption proxy to prevent recursive calls + \OC_FileProxy::$enabled = false; + + $view = new \OC_FilesystemView( '/' ); + + $userId = \OCP\USER::getUser(); + + // Format path to be relative to user files dir + $trimmed = ltrim( $path, '/' ); + $split = explode( '/', $trimmed ); + $sliced = array_slice( $split, 2 ); + $relPath = implode( '/', $sliced ); + + if ( $view->is_dir( $path ) ) { + + // Dirs must be handled separately as deleteFileKey + // doesn't handle them + $view->unlink( $userId . '/' . 'files_encryption' . '/' . 'keyfiles' . '/'. $relPath ); + + } else { + + // Delete keyfile so it isn't orphaned + $result = Keymanager::deleteFileKey( $view, $userId, $relPath ); + + \OC_FileProxy::$enabled = true; + + return $result; + + } + + } + + /** + * @brief When a file is renamed, rename its keyfile also + * @return bool Result of rename() + * @note This is pre rather than post because using post didn't work + */ + public function preRename( $oldPath, $newPath ) { + + // Disable encryption proxy to prevent recursive calls + \OC_FileProxy::$enabled = false; + + $view = new \OC_FilesystemView( '/' ); + + $userId = \OCP\USER::getUser(); + + // Format paths to be relative to user files dir + $oldTrimmed = ltrim( $oldPath, '/' ); + $oldSplit = explode( '/', $oldTrimmed ); + $oldSliced = array_slice( $oldSplit, 2 ); + $oldRelPath = implode( '/', $oldSliced ); + $oldKeyfilePath = $userId . '/' . 'files_encryption' . '/' . 'keyfiles' . '/' . $oldRelPath . '.key'; + + $newTrimmed = ltrim( $newPath, '/' ); + $newSplit = explode( '/', $newTrimmed ); + $newSliced = array_slice( $newSplit, 2 ); + $newRelPath = implode( '/', $newSliced ); + $newKeyfilePath = $userId . '/' . 'files_encryption' . '/' . 'keyfiles' . '/' . $newRelPath . '.key'; + + // Rename keyfile so it isn't orphaned + $result = $view->rename( $oldKeyfilePath, $newKeyfilePath ); + + \OC_FileProxy::$enabled = true; + + return $result; + + } + public function postFopen( $path, &$result ){ if ( !$result ) { @@ -210,8 +294,8 @@ class Proxy extends \OC_FileProxy { // If file is already encrypted, decrypt using crypto protocol if ( - Crypt::mode() == 'server' - && $util->isEncryptedPath( $path ) + Crypt::mode() == 'server' + && $util->isEncryptedPath( $path ) ) { // Close the original encrypted file @@ -223,9 +307,9 @@ class Proxy extends \OC_FileProxy { } elseif ( - self::shouldEncrypt( $path ) - and $meta ['mode'] != 'r' - and $meta['mode'] != 'rb' + self::shouldEncrypt( $path ) + and $meta ['mode'] != 'r' + and $meta['mode'] != 'rb' ) { // If the file is not yet encrypted, but should be // encrypted when it's saved (it's not read only) @@ -263,27 +347,43 @@ class Proxy extends \OC_FileProxy { } - public function postGetMimeType($path,$mime){ - if( Crypt::isEncryptedContent($path)){ - $mime = \OCP\Files::getMimeType('crypt://'.$path,'w'); + public function postGetMimeType( $path, $mime ) { + + if ( Crypt::isCatfile( $path ) ) { + + $mime = \OCP\Files::getMimeType( 'crypt://' . $path, 'w' ); + } + return $mime; + } - public function postStat($path,$data){ - if( Crypt::isEncryptedContent($path)){ - $cached= \OC_FileCache_Cached::get($path,''); - $data['size']=$cached['size']; + public function postStat( $path, $data ) { + + if ( Crypt::isCatfile( $path ) ) { + + $cached = \OC\Files\Filesystem::getFileInfo( $path, '' ); + + $data['size'] = $cached['size']; + } + return $data; } - public function postFileSize($path,$size){ - if( Crypt::isEncryptedContent($path)){ - $cached = \OC_FileCache_Cached::get($path,''); + public function postFileSize( $path, $size ) { + + if ( Crypt::isCatfile( $path ) ) { + + $cached = \OC\Files\Filesystem::getFileInfo( $path, '' ); + return $cached['size']; - }else{ + + } else { + return $size; + } } } diff --git a/apps/files_encryption/lib/session.php b/apps/files_encryption/lib/session.php index 85d533fde7..769a40b359 100644 --- a/apps/files_encryption/lib/session.php +++ b/apps/files_encryption/lib/session.php @@ -29,11 +29,11 @@ namespace OCA\Encryption; class Session { /** - * @brief Sets user id for session and triggers emit + * @brief Sets user private key to session * @return bool * */ - public function setPrivateKey( $privateKey, $userId ) { + public function setPrivateKey( $privateKey ) { $_SESSION['privateKey'] = $privateKey; @@ -42,15 +42,15 @@ class Session { } /** - * @brief Gets user id for session and triggers emit + * @brief Gets user private key from session * @returns string $privateKey The user's plaintext private key * */ - public function getPrivateKey( $userId ) { + public function getPrivateKey() { if ( - isset( $_SESSION['privateKey'] ) - && !empty( $_SESSION['privateKey'] ) + isset( $_SESSION['privateKey'] ) + && !empty( $_SESSION['privateKey'] ) ) { return $_SESSION['privateKey']; @@ -62,5 +62,42 @@ class Session { } } + + /** + * @brief Sets user legacy key to session + * @return bool + * + */ + public function setLegacyKey( $legacyKey ) { + + if ( $_SESSION['legacyKey'] = $legacyKey ) { + + return true; + + } + + } + + /** + * @brief Gets user legacy key from session + * @returns string $legacyKey The user's plaintext legacy key + * + */ + public function getLegacyKey() { + + if ( + isset( $_SESSION['legacyKey'] ) + && !empty( $_SESSION['legacyKey'] ) + ) { + + return $_SESSION['legacyKey']; + + } else { + + return false; + + } + + } } \ No newline at end of file diff --git a/apps/files_encryption/lib/stream.php b/apps/files_encryption/lib/stream.php index f482e2d75a..d4b993b4c0 100644 --- a/apps/files_encryption/lib/stream.php +++ b/apps/files_encryption/lib/stream.php @@ -49,9 +49,10 @@ class Stream { public static $sourceStreams = array(); - # TODO: make all below properties private again once unit testing is configured correctly + // TODO: make all below properties private again once unit testing is + // configured correctly public $rawPath; // The raw path received by stream_open - public $path_f; // The raw path formatted to include username and data directory + public $path_f; // The raw path formatted to include username and data dir private $userId; private $handle; // Resource returned by fopen private $path; @@ -235,10 +236,12 @@ class Stream { */ public function getKey() { - // If a keyfile already exists for a file named identically to file to be written + // If a keyfile already exists for a file named identically to + // file to be written if ( self::$view->file_exists( $this->userId . '/'. 'files_encryption' . '/' . 'keyfiles' . '/' . $this->rawPath . '.key' ) ) { - # TODO: add error handling for when file exists but no keyfile + // TODO: add error handling for when file exists but no + // keyfile // Fetch existing keyfile $this->encKeyfile = Keymanager::getFileKey( $this->rootView, $this->userId, $this->rawPath ); @@ -266,13 +269,14 @@ class Stream { // Only get the user again if it isn't already set if ( empty( $this->userId ) ) { - # TODO: Move this user call out of here - it belongs elsewhere + // TODO: Move this user call out of here - it belongs + // elsewhere $this->userId = \OCP\User::getUser(); } - # TODO: Add a method for getting the user in case OCP\User:: - # getUser() doesn't work (can that scenario ever occur?) + // TODO: Add a method for getting the user in case OCP\User:: + // getUser() doesn't work (can that scenario ever occur?) } @@ -287,7 +291,10 @@ class Stream { */ public function stream_write( $data ) { - // Disable the file proxies so that encryption is not automatically attempted when the file is written to disk - we are handling that separately here and we don't want to get into an infinite loop + // Disable the file proxies so that encryption is not + // automatically attempted when the file is written to disk - + // we are handling that separately here and we don't want to + // get into an infinite loop \OC_FileProxy::$enabled = false; // Get the length of the unencrypted data that we are handling @@ -296,14 +303,19 @@ class Stream { // So far this round, no data has been written $written = 0; - // Find out where we are up to in the writing of data to the file + // Find out where we are up to in the writing of data to the + // file $pointer = ftell( $this->handle ); // Make sure the userId is set $this->getuser(); + // TODO: Check if file is shared, if so, use multiKeyEncrypt and + // save shareKeys in necessary user directories + // Get / generate the keyfile for the file we're handling - // If we're writing a new file (not overwriting an existing one), save the newly generated keyfile + // If we're writing a new file (not overwriting an existing + // one), save the newly generated keyfile if ( ! $this->getKey() ) { $this->keyfile = Crypt::generateKey(); @@ -312,26 +324,32 @@ class Stream { $this->encKeyfile = Crypt::keyEncrypt( $this->keyfile, $this->publicKey ); - // Save the new encrypted file key - Keymanager::setFileKey( $this->rawPath, $this->encKeyfile, new \OC_FilesystemView( '/' ) ); + $view = new \OC_FilesystemView( '/' ); + $userId = \OCP\User::getUser(); - # TODO: move this new OCFSV out of here some how, use DI + // Save the new encrypted file key + Keymanager::setFileKey( $view, $this->rawPath, $userId, $this->encKeyfile ); } - // If extra data is left over from the last round, make sure it is integrated into the next 6126 / 8192 block + // If extra data is left over from the last round, make sure it + // is integrated into the next 6126 / 8192 block if ( $this->writeCache ) { // Concat writeCache to start of $data $data = $this->writeCache . $data; - // Clear the write cache, ready for resuse - it has been flushed and its old contents processed + // Clear the write cache, ready for resuse - it has been + // flushed and its old contents processed $this->writeCache = ''; } // // // Make sure we always start on a block start - if ( 0 != ( $pointer % 8192 ) ) { // if the current positoin of file indicator is not aligned to a 8192 byte block, fix it so that it is + if ( 0 != ( $pointer % 8192 ) ) { + // if the current position of + // file indicator is not aligned to a 8192 byte block, fix it + // so that it is // fseek( $this->handle, - ( $pointer % 8192 ), SEEK_CUR ); // @@ -356,14 +374,22 @@ class Stream { // // While there still remains somed data to be processed & written while( strlen( $data ) > 0 ) { // -// // Remaining length for this iteration, not of the entire file (may be greater than 8192 bytes) +// // Remaining length for this iteration, not of the +// // entire file (may be greater than 8192 bytes) // $remainingLength = strlen( $data ); // -// // If data remaining to be written is less than the size of 1 6126 byte block +// // If data remaining to be written is less than the +// // size of 1 6126 byte block if ( strlen( $data ) < 6126 ) { // Set writeCache to contents of $data - // The writeCache will be carried over to the next write round, and added to the start of $data to ensure that written blocks are always the correct length. If there is still data in writeCache after the writing round has finished, then the data will be written to disk by $this->flush(). + // The writeCache will be carried over to the + // next write round, and added to the start of + // $data to ensure that written blocks are + // always the correct length. If there is still + // data in writeCache after the writing round + // has finished, then the data will be written + // to disk by $this->flush(). $this->writeCache = $data; // Clear $data ready for next round @@ -376,13 +402,17 @@ class Stream { $encrypted = $this->preWriteEncrypt( $chunk, $this->keyfile ); - // Write the data chunk to disk. This will be addended to the last data chunk if the file being handled totals more than 6126 bytes + // Write the data chunk to disk. This will be + // addended to the last data chunk if the file + // being handled totals more than 6126 bytes fwrite( $this->handle, $encrypted ); $writtenLen = strlen( $encrypted ); //fseek( $this->handle, $writtenLen, SEEK_CUR ); - // Remove the chunk we just processed from $data, leaving only unprocessed data in $data var, for handling on the next round + // Remove the chunk we just processed from + // $data, leaving only unprocessed data in $data + // var, for handling on the next round $data = substr( $data, 6126 ); } @@ -396,16 +426,16 @@ class Stream { } - public function stream_set_option($option,$arg1,$arg2) { + public function stream_set_option( $option, $arg1, $arg2 ) { switch($option) { case STREAM_OPTION_BLOCKING: - stream_set_blocking($this->handle,$arg1); + stream_set_blocking( $this->handle, $arg1 ); break; case STREAM_OPTION_READ_TIMEOUT: - stream_set_timeout($this->handle,$arg1,$arg2); + stream_set_timeout( $this->handle, $arg1, $arg2 ); break; case STREAM_OPTION_WRITE_BUFFER: - stream_set_write_buffer($this->handle,$arg1,$arg2); + stream_set_write_buffer( $this->handle, $arg1, $arg2 ); } } @@ -413,13 +443,14 @@ class Stream { return fstat($this->handle); } - public function stream_lock($mode) { - flock($this->handle,$mode); + public function stream_lock( $mode ) { + flock( $this->handle, $mode ); } public function stream_flush() { - return fflush($this->handle); // Not a typo: http://php.net/manual/en/function.fflush.php + return fflush( $this->handle ); + // Not a typo: http://php.net/manual/en/function.fflush.php } @@ -453,7 +484,7 @@ class Stream { and $this->meta['mode']!='rb' ) { - \OC_FileCache::put( $this->path, array( 'encrypted' => true, 'size' => $this->size ), '' ); + \OC\Files\Filesystem::putFileInfo( $this->path, array( 'encrypted' => true, 'size' => $this->size ), '' ); } diff --git a/apps/files_encryption/lib/util.php b/apps/files_encryption/lib/util.php index cd46d23108..355ffb90ef 100644 --- a/apps/files_encryption/lib/util.php +++ b/apps/files_encryption/lib/util.php @@ -24,81 +24,89 @@ // Todo: // - Crypt/decrypt button in the userinterface // - Setting if crypto should be on by default -// - Add a setting "Don´t encrypt files larger than xx because of performance reasons" -// - Transparent decrypt/encrypt in filesystem.php. Autodetect if a file is encrypted (.encrypted extension) -// - Don't use a password directly as encryption key. but a key which is stored on the server and encrypted with the user password. -> password change faster +// - Add a setting "Don´t encrypt files larger than xx because of performance +// reasons" +// - Transparent decrypt/encrypt in filesystem.php. Autodetect if a file is +// encrypted (.encrypted extension) +// - Don't use a password directly as encryption key. but a key which is +// stored on the server and encrypted with the user password. -> password +// change faster // - IMPORTANT! Check if the block lenght of the encrypted data stays the same namespace OCA\Encryption; /** * @brief Class for utilities relating to encrypted file storage system - * @param $view OC_FilesystemView object, expected to have OC '/' as root path - * @param $client flag indicating status of client side encryption. Currently + * @param OC_FilesystemView $view expected to have OC '/' as root path + * @param string $userId ID of the logged in user + * @param int $client indicating status of client side encryption. Currently * unused, likely to become obsolete shortly */ class Util { - # Web UI: + // Web UI: - ## DONE: files created via web ui are encrypted - ## DONE: file created & encrypted via web ui are readable in web ui - ## DONE: file created & encrypted via web ui are readable via webdav + //// DONE: files created via web ui are encrypted + //// DONE: file created & encrypted via web ui are readable in web ui + //// DONE: file created & encrypted via web ui are readable via webdav - # WebDAV: + // WebDAV: - ## DONE: new data filled files added via webdav get encrypted - ## DONE: new data filled files added via webdav are readable via webdav - ## DONE: reading unencrypted files when encryption is enabled works via webdav - ## DONE: files created & encrypted via web ui are readable via webdav + //// DONE: new data filled files added via webdav get encrypted + //// DONE: new data filled files added via webdav are readable via webdav + //// DONE: reading unencrypted files when encryption is enabled works via + //// webdav + //// DONE: files created & encrypted via web ui are readable via webdav - # Legacy support: + // Legacy support: - ## DONE: add method to check if file is encrypted using new system - ## DONE: add method to check if file is encrypted using old system - ## DONE: add method to fetch legacy key - ## DONE: add method to decrypt legacy encrypted data + //// DONE: add method to check if file is encrypted using new system + //// DONE: add method to check if file is encrypted using old system + //// DONE: add method to fetch legacy key + //// DONE: add method to decrypt legacy encrypted data - ## TODO: add method to encrypt all user files using new system - ## TODO: add method to decrypt all user files using new system - ## TODO: add method to encrypt all user files using old system - ## TODO: add method to decrypt all user files using old system + //// TODO: add method to encrypt all user files using new system + //// TODO: add method to decrypt all user files using new system + //// TODO: add method to encrypt all user files using old system + //// TODO: add method to decrypt all user files using old system - # Admin UI: + // Admin UI: - ## DONE: changing user password also changes encryption passphrase + //// DONE: changing user password also changes encryption passphrase - ## TODO: add support for optional recovery in case of lost passphrase / keys - ## TODO: add admin optional required long passphrase for users - ## TODO: add UI buttons for encrypt / decrypt everything - ## TODO: implement flag system to allow user to specify encryption by folder, subfolder, etc. + //// TODO: add support for optional recovery in case of lost passphrase / keys + //// TODO: add admin optional required long passphrase for users + //// TODO: add UI buttons for encrypt / decrypt everything + //// TODO: implement flag system to allow user to specify encryption by folder, subfolder, etc. - # Sharing: + // Sharing: - ## TODO: add support for encrypting to multiple public keys - ## TODO: add support for decrypting to multiple private keys + //// TODO: add support for encrypting to multiple public keys + //// TODO: add support for decrypting to multiple private keys - # Integration testing: + // Integration testing: - ## TODO: test new encryption with webdav - ## TODO: test new encryption with versioning - ## TODO: test new encryption with sharing - ## TODO: test new encryption with proxies + //// TODO: test new encryption with webdav + //// TODO: test new encryption with versioning + //// TODO: test new encryption with sharing + //// TODO: test new encryption with proxies private $view; // OC_FilesystemView object for filesystem operations + private $userId; // ID of the currently logged-in user private $pwd; // User Password private $client; // Client side encryption mode flag - private $publicKeyDir; // Directory containing all public user keys - private $encryptionDir; // Directory containing user's files_encryption - private $keyfilesPath; // Directory containing user's keyfiles + private $publicKeyDir; // Dir containing all public user keys + private $encryptionDir; // Dir containing user's files_encryption + private $keyfilesPath; // Dir containing user's keyfiles + private $shareKeysPath; // Dir containing env keys for shared files private $publicKeyPath; // Path to user's public key private $privateKeyPath; // Path to user's private key @@ -107,9 +115,12 @@ class Util { $this->view = $view; $this->userId = $userId; $this->client = $client; + $this->userDir = '/' . $this->userId; + $this->userFilesDir = '/' . $this->userId . '/' . 'files'; $this->publicKeyDir = '/' . 'public-keys'; $this->encryptionDir = '/' . $this->userId . '/' . 'files_encryption'; $this->keyfilesPath = $this->encryptionDir . '/' . 'keyfiles'; + $this->shareKeysPath = $this->encryptionDir . '/' . 'share-keys'; $this->publicKeyPath = $this->publicKeyDir . '/' . $this->userId . '.public.key'; // e.g. data/public-keys/admin.public.key $this->privateKeyPath = $this->encryptionDir . '/' . $this->userId . '.private.key'; // e.g. data/admin/admin.private.key @@ -118,7 +129,9 @@ class Util { public function ready() { if( - !$this->view->file_exists( $this->keyfilesPath ) + !$this->view->file_exists( $this->encryptionDir ) + or !$this->view->file_exists( $this->keyfilesPath ) + or !$this->view->file_exists( $this->shareKeysPath ) or !$this->view->file_exists( $this->publicKeyPath ) or !$this->view->file_exists( $this->privateKeyPath ) ) { @@ -139,6 +152,20 @@ class Util { */ public function setupServerSide( $passphrase = null ) { + // Create user dir + if( !$this->view->file_exists( $this->userDir ) ) { + + $this->view->mkdir( $this->userDir ); + + } + + // Create user files dir + if( !$this->view->file_exists( $this->userFilesDir ) ) { + + $this->view->mkdir( $this->userFilesDir ); + + } + // Create shared public key directory if( !$this->view->file_exists( $this->publicKeyDir ) ) { @@ -159,16 +186,23 @@ class Util { $this->view->mkdir( $this->keyfilesPath ); } + + // Create mirrored share env keys directory + if( !$this->view->file_exists( $this->shareKeysPath ) ) { + + $this->view->mkdir( $this->shareKeysPath ); + + } // Create user keypair if ( - !$this->view->file_exists( $this->publicKeyPath ) - or !$this->view->file_exists( $this->privateKeyPath ) + ! $this->view->file_exists( $this->publicKeyPath ) + or ! $this->view->file_exists( $this->privateKeyPath ) ) { // Generate keypair $keypair = Crypt::createKeypair(); - + \OC_FileProxy::$enabled = false; // Save public key @@ -188,48 +222,77 @@ class Util { } - public function findFiles( $directory, $type = 'plain' ) { - - # TODO: test finding non plain content + /** + * @brief Find all files and their encryption status within a directory + * @param string $directory The path of the parent directory to search + * @return mixed false if 0 found, array on success. Keys: name, path + + * @note $directory needs to be a path relative to OC data dir. e.g. + * /admin/files NOT /backup OR /home/www/oc/data/admin/files + */ + public function findFiles( $directory ) { + + // Disable proxy - we don't want files to be decrypted before + // we handle them + \OC_FileProxy::$enabled = false; + + $found = array( 'plain' => array(), 'encrypted' => array(), 'legacy' => array() ); + + if ( + $this->view->is_dir( $directory ) + && $handle = $this->view->opendir( $directory ) + ) { - if ( $handle = $this->view->opendir( $directory ) ) { - while ( false !== ( $file = readdir( $handle ) ) ) { - + if ( $file != "." && $file != ".." ) { - + $filePath = $directory . '/' . $this->view->getRelativePath( '/' . $file ); + $relPath = $this->stripUserFilesPath( $filePath ); - var_dump($filePath); - + // If the path is a directory, search + // its contents if ( $this->view->is_dir( $filePath ) ) { $this->findFiles( $filePath ); - + + // If the path is a file, determine + // its encryption status } elseif ( $this->view->is_file( $filePath ) ) { - - if ( $type == 'plain' ) { - - $this->files[] = array( 'name' => $file, 'path' => $filePath ); - - } elseif ( $type == 'encrypted' ) { - if ( Crypt::isEncryptedContent( $this->view->file_get_contents( $filePath ) ) ) { - - $this->files[] = array( 'name' => $file, 'path' => $filePath ); - - } + // Disable proxies again, some- + // where they got re-enabled :/ + \OC_FileProxy::$enabled = false; - } elseif ( $type == 'legacy' ) { + $data = $this->view->file_get_contents( $filePath ); - if ( Crypt::isLegacyEncryptedContent( $this->view->file_get_contents( $filePath ) ) ) { + // If the file is encrypted + // NOTE: If the userId is + // empty or not set, file will + // detected as plain + // NOTE: This is inefficient; + // scanning every file like this + // will eat server resources :( + if ( + Keymanager::getFileKey( $this->view, $this->userId, $file ) + && Crypt::isCatfile( $filePath ) + ) { + + $found['encrypted'][] = array( 'name' => $file, 'path' => $filePath ); + + // If the file uses old + // encryption system + } elseif ( Crypt::isLegacyEncryptedContent( $this->view->file_get_contents( $filePath ), $relPath ) ) { - $this->files[] = array( 'name' => $file, 'path' => $filePath ); + $found['legacy'][] = array( 'name' => $file, 'path' => $filePath ); - } + // If the file is not encrypted + } else { + + $found['plain'][] = array( 'name' => $file, 'path' => $filePath ); } @@ -239,18 +302,22 @@ class Util { } - if ( !empty( $this->files ) ) { + \OC_FileProxy::$enabled = true; - return $this->files; - - } else { + if ( empty( $found ) ) { return false; + } else { + + return $found; + } } + \OC_FileProxy::$enabled = true; + return false; } @@ -269,20 +336,101 @@ class Util { \OC_FileProxy::$enabled = true; - return Crypt::isEncryptedContent( $data ); + return Crypt::isCatfile( $data ); } - public function encryptAll( $directory ) { + /** + * @brief Format a path to be relative to the /user/files/ directory + */ + public function stripUserFilesPath( $path ) { - $plainFiles = $this->findFiles( $this->view, 'plain' ); + $trimmed = ltrim( $path, '/' ); + $split = explode( '/', $trimmed ); + $sliced = array_slice( $split, 2 ); + $relPath = implode( '/', $sliced ); - if ( $this->encryptFiles( $plainFiles ) ) { + return $relPath; + + } + + /** + * @brief Encrypt all files in a directory + * @param string $publicKey the public key to encrypt files with + * @param string $dirPath the directory whose files will be encrypted + * @note Encryption is recursive + */ + public function encryptAll( $publicKey, $dirPath, $legacyPassphrase = null, $newPassphrase = null ) { + + if ( $found = $this->findFiles( $dirPath ) ) { - return true; + // Disable proxy to prevent file being encrypted twice + \OC_FileProxy::$enabled = false; + + // Encrypt unencrypted files + foreach ( $found['plain'] as $plainFile ) { + + // Fetch data from file + $plainData = $this->view->file_get_contents( $plainFile['path'] ); + + // Encrypt data, generate catfile + $encrypted = Crypt::keyEncryptKeyfile( $plainData, $publicKey ); + + $relPath = $this->stripUserFilesPath( $plainFile['path'] ); + + // Save keyfile + Keymanager::setFileKey( $this->view, $relPath, $this->userId, $encrypted['key'] ); + + // Overwrite the existing file with the encrypted one + $this->view->file_put_contents( $plainFile['path'], $encrypted['data'] ); + + $size = strlen( $encrypted['data'] ); + + // Add the file to the cache + \OC\Files\Filesystem::putFileInfo( $plainFile['path'], array( 'encrypted'=>true, 'size' => $size ), '' ); + } + + // FIXME: Legacy recrypting here isn't finished yet + // Encrypt legacy encrypted files + if ( + ! empty( $legacyPassphrase ) + && ! empty( $newPassphrase ) + ) { + + foreach ( $found['legacy'] as $legacyFile ) { + + // Fetch data from file + $legacyData = $this->view->file_get_contents( $legacyFile['path'] ); + + // Recrypt data, generate catfile + $recrypted = Crypt::legacyKeyRecryptKeyfile( $legacyData, $legacyPassphrase, $publicKey, $newPassphrase ); + + $relPath = $this->stripUserFilesPath( $legacyFile['path'] ); + + // Save keyfile + Keymanager::setFileKey( $this->view, $relPath, $this->userId, $recrypted['key'] ); + + // Overwrite the existing file with the encrypted one + $this->view->file_put_contents( $legacyFile['path'], $recrypted['data'] ); + + $size = strlen( $recrypted['data'] ); + + // Add the file to the cache + \OC\Files\Filesystem::putFileInfo( $legacyFile['path'], array( 'encrypted'=>true, 'size' => $size ), '' ); + + } + + } + + \OC_FileProxy::$enabled = true; + + // If files were found, return true + return true; + } else { + // If no files were found, return false return false; } diff --git a/apps/files_encryption/settings-personal.php b/apps/files_encryption/settings-personal.php index 014288f2ef..6fe4ea6d56 100644 --- a/apps/files_encryption/settings-personal.php +++ b/apps/files_encryption/settings-personal.php @@ -1,29 +1,19 @@ + * Copyright (c) 2013 Sam Tuke * This file is licensed under the Affero General Public License version 3 or * later. * See the COPYING-README file. */ -$sysEncMode = \OC_Appconfig::getValue('files_encryption', 'mode', 'none'); +$tmpl = new OCP\Template( 'files_encryption', 'settings-personal'); -if ($sysEncMode == 'user') { +$blackList = explode( ',', \OCP\Config::getAppValue( 'files_encryption', 'type_blacklist', 'jpg,png,jpeg,avi,mpg,mpeg,mkv,mp3,oga,ogv,ogg' ) ); - $tmpl = new OCP\Template( 'files_encryption', 'settings-personal'); +$tmpl->assign( 'blacklist', $blackList ); - $query = \OC_DB::prepare( "SELECT mode FROM *PREFIX*encryption WHERE uid = ?" ); - $result = $query->execute(array(\OCP\User::getUser())); - - if ($row = $result->fetchRow()){ - $mode = $row['mode']; - } else { - $mode = 'none'; - } - - OCP\Util::addscript('files_encryption','settings-personal'); - $tmpl->assign('encryption_mode', $mode); - return $tmpl->fetchPage(); -} +OCP\Util::addscript('files_encryption','settings-personal'); + +return $tmpl->fetchPage(); return null; diff --git a/apps/files_encryption/templates/settings-personal.php b/apps/files_encryption/templates/settings-personal.php index 1274bd3bb5..1f71efb173 100644 --- a/apps/files_encryption/templates/settings-personal.php +++ b/apps/files_encryption/templates/settings-personal.php @@ -1,45 +1,22 @@
- t('Choose encryption mode:'); ?> + + t( 'Encryption' ); ?> +

- - - - /> - t('Client side encryption (most secure but makes it impossible to access your data from the web interface)'); ?> -
- - - /> - t('Server side encryption (allows you to access your files from the web interface and the desktop client)'); ?> -
- - - /> - t('None (no encryption at all)'); ?> -
+ t( 'File encryption is enabled.' ); ?>

+ +

+ t( 'The following file types will not be encrypted:' ); ?> +

+
    + +
  • + +
    • + +

    +
diff --git a/apps/files_encryption/templates/settings.php b/apps/files_encryption/templates/settings.php index 544ec793f3..f7ef8a8efe 100644 --- a/apps/files_encryption/templates/settings.php +++ b/apps/files_encryption/templates/settings.php @@ -1,77 +1,18 @@
- - t('Choose encryption mode:'); ?> - -

- - t('Important: Once you selected an encryption mode there is no way to change it back'); ?> - -

- -

- - /> + t( 'Encryption' ); ?> - t("Client side encryption (most secure but makes it impossible to access your data from the web interface)"); ?> + t( "Exclude the following file types from encryption:" ); ?>
- - /> - - t('Server side encryption (allows you to access your files from the web interface and the desktop client)'); ?> -
- - - /> - - t('User specific (let the user decide)'); ?> -
- - - /> - - t('None (no encryption at all)'); ?> -
- -

-

- t('Encryption'); ?> - - t("Exclude the following file types from encryption"); ?> -

diff --git a/apps/files_encryption/test/crypt.php b/apps/files_encryption/test/crypt.php index 19c10ab0ab..aa87ec3282 100755 --- a/apps/files_encryption/test/crypt.php +++ b/apps/files_encryption/test/crypt.php @@ -416,13 +416,13 @@ class Test_Crypt extends \PHPUnit_Framework_TestCase { function testIsEncryptedContent() { - $this->assertFalse( Encryption\Crypt::isEncryptedContent( $this->dataUrl ) ); + $this->assertFalse( Encryption\Crypt::isCatfile( $this->dataUrl ) ); - $this->assertFalse( Encryption\Crypt::isEncryptedContent( $this->legacyEncryptedData ) ); + $this->assertFalse( Encryption\Crypt::isCatfile( $this->legacyEncryptedData ) ); $keyfileContent = Encryption\Crypt::symmetricEncryptFileContent( $this->dataUrl, 'hat' ); - $this->assertTrue( Encryption\Crypt::isEncryptedContent( $keyfileContent ) ); + $this->assertTrue( Encryption\Crypt::isCatfile( $keyfileContent ) ); } diff --git a/apps/files_encryption/test/keymanager.php b/apps/files_encryption/test/keymanager.php index f02d6eb5f7..bf453fe316 100644 --- a/apps/files_encryption/test/keymanager.php +++ b/apps/files_encryption/test/keymanager.php @@ -79,15 +79,13 @@ class Test_Keymanager extends \PHPUnit_Framework_TestCase { # NOTE: This cannot be tested until we are able to break out # of the FileSystemView data directory root -// $key = Crypt::symmetricEncryptFileContentKeyfile( $this->data, 'hat' ); -// -// $tmpPath = sys_get_temp_dir(). '/' . 'testSetFileKey'; -// -// $view = new \OC_FilesystemView( '/tmp/' ); -// -// //$view = new \OC_FilesystemView( '/' . $this->userId . '/files_encryption/keyfiles' ); -// -// Encryption\Keymanager::setFileKey( $tmpPath, $key['key'], $view ); + $key = Encryption\Crypt::symmetricEncryptFileContentKeyfile( $this->randomKey, 'hat' ); + + $path = 'unittest-'.time().'txt'; + + //$view = new \OC_FilesystemView( '/' . $this->userId . '/files_encryption/keyfiles' ); + + Encryption\Keymanager::setFileKey( $this->view, $path, $this->userId, $key['key'] ); } diff --git a/apps/files_encryption/test/util.php b/apps/files_encryption/test/util.php index a299ec67f5..1cdeff8008 100755 --- a/apps/files_encryption/test/util.php +++ b/apps/files_encryption/test/util.php @@ -51,7 +51,7 @@ class Test_Enc_Util extends \PHPUnit_Framework_TestCase { $this->publicKeyPath = $this->publicKeyDir . '/' . $this->userId . '.public.key'; // e.g. data/public-keys/admin.public.key $this->privateKeyPath = $this->encryptionDir . '/' . $this->userId . '.private.key'; // e.g. data/admin/admin.private.key - $this->view = new OC_FilesystemView( '/admin' ); + $this->view = new \OC_FilesystemView( '/' ); $this->mockView = m::mock('OC_FilesystemView'); $this->util = new Encryption\Util( $this->mockView, $this->userId ); @@ -88,8 +88,8 @@ class Test_Enc_Util extends \PHPUnit_Framework_TestCase { $mockView = m::mock('OC_FilesystemView'); - $mockView->shouldReceive( 'file_exists' )->times(4)->andReturn( false ); - $mockView->shouldReceive( 'mkdir' )->times(3)->andReturn( true ); + $mockView->shouldReceive( 'file_exists' )->times(5)->andReturn( false ); + $mockView->shouldReceive( 'mkdir' )->times(4)->andReturn( true ); $mockView->shouldReceive( 'file_put_contents' )->withAnyArgs(); $util = new Encryption\Util( $mockView, $this->userId ); @@ -105,7 +105,7 @@ class Test_Enc_Util extends \PHPUnit_Framework_TestCase { $mockView = m::mock('OC_FilesystemView'); - $mockView->shouldReceive( 'file_exists' )->times(5)->andReturn( true ); + $mockView->shouldReceive( 'file_exists' )->times(6)->andReturn( true ); $mockView->shouldReceive( 'file_put_contents' )->withAnyArgs(); $util = new Encryption\Util( $mockView, $this->userId ); @@ -149,6 +149,21 @@ class Test_Enc_Util extends \PHPUnit_Framework_TestCase { # then false will be returned. Use strict ordering? } + + function testFindFiles() { + +// $this->view->chroot( "/data/{$this->userId}/files" ); + + $util = new Encryption\Util( $this->view, $this->userId ); + + $files = $util->findFiles( '/', 'encrypted' ); + + var_dump( $files ); + + # TODO: Add more tests here to check that if any of the dirs are + # then false will be returned. Use strict ordering? + + } // /** // * @brief test decryption using legacy blowfish method diff --git a/lib/files/filesystem.php b/lib/files/filesystem.php index 65d9ffab48..71bf3d8708 100644 --- a/lib/files/filesystem.php +++ b/lib/files/filesystem.php @@ -527,8 +527,7 @@ class Filesystem { } /** - * normalize a path - * + * @brief Fix common problems with a file path * @param string $path * @param bool $stripTrailingSlash * @return string @@ -537,21 +536,21 @@ class Filesystem { if ($path == '') { return '/'; } -//no windows style slashes + //no windows style slashes $path = str_replace('\\', '/', $path); -//add leading slash + //add leading slash if ($path[0] !== '/') { $path = '/' . $path; } -//remove duplicate slashes + //remove duplicate slashes while (strpos($path, '//') !== false) { $path = str_replace('//', '/', $path); } -//remove trailing slash + //remove trailing slash if ($stripTrailingSlash and strlen($path) > 1 and substr($path, -1, 1) === '/') { $path = substr($path, 0, -1); } -//normalize unicode if possible + //normalize unicode if possible if (class_exists('Normalizer')) { $path = \Normalizer::normalize($path); } diff --git a/lib/public/share.php b/lib/public/share.php index 7d806fafd0..9aacf5e344 100644 --- a/lib/public/share.php +++ b/lib/public/share.php @@ -342,6 +342,13 @@ class Share { */ public static function unshare($itemType, $itemSource, $shareType, $shareWith) { if ($item = self::getItems($itemType, $itemSource, $shareType, $shareWith, \OC_User::getUser(), self::FORMAT_NONE, null, 1)) { + // Pass all the vars we have for now, they may be useful + \OC_Hook::emit('OCP\Share', 'pre_unshare', array( + 'itemType' => $itemType, + 'itemSource' => $itemSource, + 'shareType' => $shareType, + 'shareWith' => $shareWith, + )); self::delete($item['id']); return true; } @@ -356,6 +363,12 @@ class Share { */ public static function unshareAll($itemType, $itemSource) { if ($shares = self::getItemShared($itemType, $itemSource)) { + // Pass all the vars we have for now, they may be useful + \OC_Hook::emit('OCP\Share', 'pre_unshareAll', array( + 'itemType' => $itemType, + 'itemSource' => $itemSource, + 'shares' => $shares + )); foreach ($shares as $share) { self::delete($share['id']); } @@ -764,8 +777,8 @@ class Share { if ( isset($row['share_with']) && $row['share_with'] != '') { $row['share_with_displayname'] = \OCP\User::getDisplayName($row['share_with']); } - if ( isset($row['uid_owner']) && $row['uid_owner'] != '') { - $row['displayname_owner'] = \OCP\User::getDisplayName($row['uid_owner']); + if ( isset($row['uid_owner']) && $row['uid_owner'] != '') { + $row['displayname_owner'] = \OCP\User::getDisplayName($row['uid_owner']); } $items[$row['id']] = $row;