. * */ # Bugs # ---- # Sharing a file to a user without encryption set up will not provide them with access but won't notify the sharer # Sharing files to other users currently broken (due to merge + ongoing implementation of support for lost password recovery) # Timeouts on first login due to encryption of very large files (fix in progress, as a result streaming is currently broken) # Sharing all files to admin for recovery purposes still in progress # Possibly public links are broken (not tested since last merge of master) # getOwner() currently returns false in all circumstances, unsure what code is returning this... # encryptAll during login mangles paths: /files/files/ # encryptAll is accessing files via encryption proxy - perhaps proxies should be disabled? # Sharekeys appear to not be deleted when their parent file is, and thus get orphaned # Missing features # ---------------- # Make sure user knows if large files weren't encrypted # Support for resharing encrypted files # Test # ---- # Test that writing files works when recovery is enabled, and sharing API is disabled # Test trashbin support // Old 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" namespace OCA\Encryption; /** * @brief Class for utilities relating to encrypted file storage system * @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: //// 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: //// 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: //// 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 // Admin UI: //// 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. // Sharing: //// TODO: add support for encrypting to multiple public keys //// TODO: add support for decrypting to multiple private keys // Integration testing: //// 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; // 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 public function __construct( \OC_FilesystemView $view, $userId, $client = false ) { $this->view = $view; $this->userId = $userId; $this->client = $client; $this->userDir = '/' . $this->userId; $this->fileFolderName = 'files'; $this->userFilesDir = '/' . $this->userId . '/' . $this->fileFolderName; // TODO: Does this need to be user configurable? $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 } public function ready() { if( !$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 ) ) { return false; } else { return true; } } /** * @brief Sets up user folders and keys for serverside encryption * @param $passphrase passphrase to encrypt server-stored private key with */ public function setupServerSide( $passphrase = null ) { // Set directories to check / create $setUpDirs = array( $this->userDir , $this->userFilesDir , $this->publicKeyDir , $this->encryptionDir , $this->keyfilesPath , $this->shareKeysPath ); // Check / create all necessary dirs foreach ( $setUpDirs as $dirPath ) { if( !$this->view->file_exists( $dirPath ) ) { $this->view->mkdir( $dirPath ); } } // Create user keypair if ( ! $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 $this->view->file_put_contents( $this->publicKeyPath, $keypair['publicKey'] ); // Encrypt private key with user pwd as passphrase $encryptedPrivateKey = Crypt::symmetricEncryptFileContent( $keypair['privateKey'], $passphrase ); // Save private key $this->view->file_put_contents( $this->privateKeyPath, $encryptedPrivateKey ); \OC_FileProxy::$enabled = true; } return true; } /** * @brief Check whether pwd recovery is enabled for a given user * @return bool * @note If records are not being returned, check for a hidden space * at the start of the uid in db */ public function recoveryEnabled() { $sql = 'SELECT recovery FROM `*PREFIX*encryption` WHERE uid = ?'; $args = array( $this->userId ); $query = \OCP\DB::prepare( $sql ); $result = $query->execute( $args ); // Set default in case no records found $recoveryEnabled = 0; while( $row = $result->fetchRow() ) { $recoveryEnabled = $row['recovery']; } return $recoveryEnabled; } /** * @brief Enable / disable pwd recovery for a given user * @param bool $enabled Whether to enable or disable recovery * @return bool */ public function setRecovery( $enabled ) { $sql = 'UPDATE *PREFIX*encryption SET recovery = ? WHERE uid = ?'; // Ensure value is an integer $enabled = intval( $enabled ); $args = array( $enabled, $this->userId ); $query = \OCP\DB::prepare( $sql ); if ( $query->execute( $args ) ) { return true; } else { return false; } } /** * @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 findEncFiles( $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 ) ) { while ( false !== ( $file = readdir( $handle ) ) ) { if ( $file != "." && $file != ".." ) { $filePath = $directory . '/' . $this->view->getRelativePath( '/' . $file ); $relPath = $this->stripUserFilesPath( $filePath ); // If the path is a directory, search // its contents if ( $this->view->is_dir( $filePath ) ) { $this->findEncFiles( $filePath ); // If the path is a file, determine // its encryption status } elseif ( $this->view->is_file( $filePath ) ) { // Disable proxies again, some- // where they got re-enabled :/ \OC_FileProxy::$enabled = false; $data = $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::isCatfileContent( $data ) ) { $found['encrypted'][] = array( 'name' => $file, 'path' => $filePath ); // If the file uses old // encryption system } elseif ( Crypt::isLegacyEncryptedContent( $this->tail( $filePath, 3 ), $relPath ) ) { $found['legacy'][] = array( 'name' => $file, 'path' => $filePath ); // If the file is not encrypted } else { $found['plain'][] = array( 'name' => $file, 'path' => $relPath ); } } } } \OC_FileProxy::$enabled = true; if ( empty( $found ) ) { return false; } else { return $found; } } \OC_FileProxy::$enabled = true; return false; } /** * @brief Fetch the last lines of a file efficiently * @note Safe to use on large files; does not read entire file to memory * @note Derivative of http://tekkie.flashbit.net/php/tail-functionality-in-php */ public function tail( $filename, $numLines ) { \OC_FileProxy::$enabled = false; $text = ''; $pos = -1; $handle = $this->view->fopen( $filename, 'r' ); while ( $numLines > 0 ) { --$pos; if( fseek( $handle, $pos, SEEK_END ) !== 0 ) { rewind( $handle ); $numLines = 0; } elseif ( fgetc( $handle ) === "\n" ) { --$numLines; } $block_size = ( -$pos ) % 8192; if ( $block_size === 0 || $numLines === 0 ) { $text = fread( $handle, ( $block_size === 0 ? 8192 : $block_size ) ) . $text; } } fclose( $handle ); \OC_FileProxy::$enabled = true; return $text; } /** * @brief Check if a given path identifies an encrypted file * @return true / false */ public function isEncryptedPath( $path ) { // Disable encryption proxy so data retreived is in its // original form \OC_FileProxy::$enabled = false; $data = $this->view->file_get_contents( $path ); \OC_FileProxy::$enabled = true; return Crypt::isCatfileContent( $data ); } /** * @brief Format a path to be relative to the /user/files/ directory */ public function stripUserFilesPath( $path ) { $trimmed = ltrim( $path, '/' ); $split = explode( '/', $trimmed ); $sliced = array_slice( $split, 2 ); $relPath = implode( '/', $sliced ); return $relPath; } /** * @brief Format a shared path to be relative to the /user/files/ directory * @note Expects a path like /uid/files/Shared/filepath */ public function stripSharedFilePath( $path ) { $trimmed = ltrim( $path, '/' ); $split = explode( '/', $trimmed ); $sliced = array_slice( $split, 3 ); $relPath = implode( '/', $sliced ); return $relPath; } public function isSharedPath( $path ) { $trimmed = ltrim( $path, '/' ); $split = explode( '/', $trimmed ); if ( $split[2] == "Shared" ) { return true; } else { return false; } } /** * @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->findEncFiles( $dirPath ) ) { // Disable proxy to prevent file being encrypted twice \OC_FileProxy::$enabled = false; // Encrypt unencrypted files foreach ( $found['plain'] as $plainFile ) { // Open plain file handle // Open enc file handle // Read plain file in chunks //relative to data//file $relPath = $plainFile['path']; //relative to /data $rawPath = $this->userId . '/files/' . $plainFile['path']; // Open handle with for binary reading $plainHandle = $this->view->fopen( $rawPath, 'rb' ); // Open handle with for binary writing $encHandle = fopen( 'crypt://' . $relPath . '.tmp', 'wb' ); // Overwrite the existing file with the encrypted one //$this->view->file_put_contents( $plainFile['path'], $encrypted['data'] ); $size = stream_copy_to_stream( $plainHandle, $encHandle ); $this->view->rename($rawPath . '.tmp', $rawPath); // Fetch the key that has just been set/updated by the stream //$encKey = Keymanager::getFileKey( $this->view, $this->userId, $relPath ); // Save keyfile //Keymanager::setFileKey( $this->view, $relPath, $this->userId, $encKey ); // Add the file to the cache \OC\Files\Filesystem::putFileInfo( $plainFile['path'], array( 'encrypted'=>true, 'size' => $size ), '' ); } // 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 = $legacyFile['path']; $rawPath = $this->userId . '/files/' . $plainFile['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( $rawPath, $recrypted['data'] ); $size = strlen( $recrypted['data'] ); // Add the file to the cache \OC\Files\Filesystem::putFileInfo( $rawPath, 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; } } /** * @brief Return important encryption related paths * @param string $pathName Name of the directory to return the path of * @return string path */ public function getPath( $pathName ) { switch ( $pathName ) { case 'publicKeyDir': return $this->publicKeyDir; break; case 'encryptionDir': return $this->encryptionDir; break; case 'keyfilesPath': return $this->keyfilesPath; break; case 'publicKeyPath': return $this->publicKeyPath; break; case 'privateKeyPath': return $this->privateKeyPath; break; } } /** * @brief get path of a file. * @param $fileId id of the file * @return path of the file */ public static function fileIdToPath( $fileId ) { $query = \OC_DB::prepare( 'SELECT `path`' .' FROM `*PREFIX*filecache`' .' WHERE `fileid` = ?' ); $result = $query->execute( array( $fileId ) ); $row = $result->fetchRow(); return substr( $row['path'], 5 ); } /** * @brief Filter an array of UIDs to return only ones ready for sharing * @param array $unfilteredUsers users to be checked for sharing readiness * @return multi-dimensional array. keys: ready, unready */ public function filterShareReadyUsers( $unfilteredUsers ) { // This array will collect the filtered IDs $readyIds = $unreadyIds = array(); // Loop through users and create array of UIDs that need new keyfiles foreach ( $unfilteredUsers as $user ) { $util = new Util( $this->view, $user ); // Check that the user is encryption capable, or is the // public system user 'ownCloud' (for public shares) if ( $util->ready() or $user == 'ownCloud' ) { // Construct array of ready UIDs for Keymanager{} $readyIds[] = $user; } else { // Construct array of unready UIDs for Keymanager{} $unreadyIds[] = $user; // Log warning; we can't do necessary setup here // because we don't have the user passphrase \OC_Log::write( 'Encryption library', '"'.$user.'" is not setup for encryption', \OC_Log::WARN ); } } return array ( 'ready' => $readyIds , 'unready' => $unreadyIds ); } /** * @brief Expand given path to all sub files & folders * @param string $path path which needs to be updated * @return array $pathsArray all found file paths * @note Paths of directories excluded, only *file* paths are returned */ public function getPaths( $path ) { // Default return value is success $result = true; // Make path include 'files' dir for OC_FSV operations $fPath = 'files' . $path; // If we're handling a single file if ( ! $this->view->is_dir( $fPath ) ) { $pathsArray[] = $path; // If we're handling a folder (recursively) } else { $subFiles = $this->view->getDirectoryContent( $fPath ); foreach ( $subFiles as $file ) { $filePath = substr( $file['path'], 5 ); // If this is a nested file if ( ! $this->view->is_dir( $fPath ) ) { // Add the file path to array $pathsArray[] = $path; } else { // If this is a nested folder $dirPaths = $this->getPaths( $filePath ); // Add all subfiles & folders to the array $pathsArray = array_merge( $dirPaths, $pathsArray ); } } } return $pathsArray; } /** * @brief Decrypt a keyfile without knowing how it was encrypted * @param string $filePath * @param string $fileOwner * @param string $privateKey * @note Checks whether file was encrypted with openssl_seal or * openssl_encrypt, and decrypts accrdingly * @note This was used when 2 types of encryption for keyfiles was used, * but now we've switched to exclusively using openssl_seal() */ public function decryptUnknownKeyfile( $filePath, $fileOwner, $privateKey ) { // Get the encrypted keyfile // NOTE: the keyfile format depends on how it was encrypted! At // this stage we don't know how it was encrypted $encKeyfile = Keymanager::getFileKey( $this->view, $this->userId, $filePath ); // We need to decrypt the keyfile // Has the file been shared yet? if ( $this->userId == $fileOwner && ! Keymanager::getShareKey( $this->view, $this->userId, $filePath ) // NOTE: we can't use isShared() here because it's a post share hook so it always returns true ) { // The file has no shareKey, and its keyfile must be // decrypted conventionally $plainKeyfile = Crypt::keyDecrypt( $encKeyfile, $privateKey ); } else { // The file has a shareKey and must use it for decryption $shareKey = Keymanager::getShareKey( $this->view, $this->userId, $filePath ); $plainKeyfile = Crypt::multiKeyDecrypt( $encKeyfile, $shareKey, $privateKey ); } return $plainKeyfile; } /** * @brief Encrypt keyfile to multiple users * @param array $users list of users which should be able to access the file * @param string $filePath path of the file to be shared */ public function setSharedFileKeyfiles( Session $session, array $users, $filePath ) { // Make sure users are capable of sharing $filteredUids = $this->filterShareReadyUsers( $users ); // trigger_error( print_r($filteredUids, 1) ); if ( ! empty( $filteredUids['unready'] ) ) { // Notify user of unready userDir // TODO: Move this out of here; it belongs somewhere else \OCP\JSON::error(); } // Get public keys for each user, ready for generating sharekeys $userPubKeys = Keymanager::getPublicKeys( $this->view, $filteredUids['ready'] ); \OC_FileProxy::$enabled = false; // Get the current users's private key for decrypting existing keyfile $privateKey = $session->getPrivateKey(); $fileOwner = \OC\Files\Filesystem::getOwner( $filePath ); // Decrypt keyfile $plainKeyfile = $this->decryptUnknownKeyfile( $filePath, $fileOwner, $privateKey ); // Re-enc keyfile to (additional) sharekeys $multiEncKey = Crypt::multiKeyEncrypt( $plainKeyfile, $userPubKeys ); // Save the recrypted key to it's owner's keyfiles directory // Save new sharekeys to all necessary user directory // TODO: Reuse the keyfile, it it exists, instead of making a new one if ( ! Keymanager::setFileKey( $this->view, $filePath, $fileOwner, $multiEncKey['data'] ) || ! Keymanager::setShareKeys( $this->view, $filePath, $multiEncKey['keys'] ) ) { trigger_error( "SET Share keys failed" ); } // Delete existing keyfile // Do this last to ensure file is recoverable in case of error // Keymanager::deleteFileKey( $this->view, $this->userId, $params['fileTarget'] ); \OC_FileProxy::$enabled = true; return true; } /** * @brief Find, sanitise and format users sharing a file * @note This wraps other methods into a portable bundle */ public function getSharingUsersArray( $sharingEnabled, $filePath ) { // Check if key recovery is enabled $recoveryEnabled = $this->recoveryEnabled(); // Make sure that a share key is generated for the owner too list($owner, $ownerPath) = $this->getUidAndFilename($filePath); //$userIds = array( $this->userId ); $userIds = array(); if ( $sharingEnabled ) { // Find out who, if anyone, is sharing the file $shareUids = \OCP\Share::getUsersSharingFile( $ownerPath, $owner,true, true, true ); $userIds = array_merge( $userIds, $shareUids ); } // If recovery is enabled, add the // Admin UID to list of users to share to if ( $recoveryEnabled ) { // FIXME: Create a separate admin user purely for recovery, and create method in util for fetching this id from DB? $adminUid = 'recoveryAdmin'; $userIds[] = $adminUid; } // Remove duplicate UIDs $uniqueUserIds = array_unique ( $userIds ); return $uniqueUserIds; } /** * @brief get uid of the owners of the file and the path to the file * @param $path Path of the file to check * @note $shareFilePath must be relative to data/UID/files. Files * relative to /Shared are also acceptable * @return array */ public function getUidAndFilename( $path ) { $fileOwnerUid = \OC\Files\Filesystem::getOwner( $path ); // Check that UID is valid if ( ! \OCP\User::userExists( $fileOwnerUid ) ) { throw new \Exception( 'Could not find owner (UID = "' . var_export( $fileOwnerUid, 1 ) . '") of file "' . $path . '"' ); } // NOTE: Bah, this dependency should be elsewhere \OC\Files\Filesystem::initMountPoints( $fileOwnerUid ); // If the file owner is the currently logged in user if ( $fileOwnerUid == $this->userId ) { // Assume the path supplied is correct $filename = $path; } else { $info = \OC\Files\Filesystem::getFileInfo( $path ); $ownerView = new \OC\Files\View( '/' . $fileOwnerUid . '/files' ); // Fetch real file path from DB $filename = $ownerView->getPath( $info['fileid'] ); // TODO: Check that this returns a path without including the user data dir } // Make path relative for use by $view $relpath = $fileOwnerUid . '/' . $this->fileFolderName . '/' . $filename; // Check that the filename we're using is working if ( $this->view->file_exists( $relpath ) ) { return array ( $fileOwnerUid, $filename ); } else { throw new \Exception( 'Supplied path could not be resolved "' . $path . '"' ); } } }