end") * * @return string remained data which should be written to the file in case * of a write operation * * @since 8.1.0 * @since 9.0.0 parameter $position added */ public function end($path, $position); /** * encrypt data * * @param string $data you want to encrypt * @param string $position position of the block we want to encrypt (starts with '0') * * @return mixed encrypted data * * @since 8.1.0 * @since 9.0.0 parameter $position added */ public function encrypt($data, $position); /** * decrypt data * * @param string $data you want to decrypt * @param int|string $position position of the block we want to decrypt * * @return mixed decrypted data * * @since 8.1.0 * @since 9.0.0 parameter $position added */ public function decrypt($data, $position); /** * update encrypted file, e.g. give additional users access to the file * * @param string $path path to the file which should be updated * @param string $uid of the user who performs the operation * @param array $accessList who has access to the file contains the key 'users' and 'public' * @return boolean * @since 8.1.0 */ public function update($path, $uid, array $accessList); /** * should the file be encrypted or not * * @param string $path * @return boolean * @since 8.1.0 */ public function shouldEncrypt($path); /** * get size of the unencrypted payload per block. * ownCloud read/write files with a block size of 8192 byte * * @param bool $signed * @return int * @since 8.1.0 optional parameter $signed was added in 9.0.0 */ public function getUnencryptedBlockSize($signed = false); /** * check if the encryption module is able to read the file, * e.g. if all encryption keys exists * * @param string $path * @param string $uid user for whom we want to check if he can read the file * @return boolean * @since 8.1.0 */ public function isReadable($path, $uid); /** * Initial encryption of all files * * @param InputInterface $input * @param OutputInterface $output write some status information to the terminal during encryption * @since 8.2.0 */ public function encryptAll(InputInterface $input, OutputInterface $output); /** * prepare encryption module to decrypt all files * * @param InputInterface $input * @param OutputInterface $output write some status information to the terminal during encryption * @param $user (optional) for which the files should be decrypted, default = all users * @return bool return false on failure or if it isn't supported by the module * @since 8.2.0 */ public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = ''); /** * Check if the module is ready to be used by that specific user. * In case a module is not ready - because e.g. key pairs have not been generated * upon login this method can return false before any operation starts and might * cause issues during operations. * * @param string $user * @return boolean * @since 9.1.0 */ public function isReadyForUser($user); /** * Does the encryption module needs a detailed list of users with access to the file? * For example if the encryption module uses per-user encryption keys and needs to know * the users with access to the file to encrypt/decrypt it. * * @since 13.0.0 * @return bool */ public function needDetailedAccessList(); }