123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- <?php
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
- namespace OCP\Encryption\Keys;
- /**
- * Interface IStorage
- *
- * @since 8.1.0
- */
- interface IStorage {
- /**
- * get user specific key
- *
- * @param string $uid ID if the user for whom we want the key
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return mixed key
- * @since 8.1.0
- */
- public function getUserKey($uid, $keyId, $encryptionModuleId);
- /**
- * get file specific key
- *
- * @param string $path path to file
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return mixed key
- * @since 8.1.0
- */
- public function getFileKey($path, $keyId, $encryptionModuleId);
- /**
- * get system-wide encryption keys not related to a specific user,
- * e.g something like a key for public link shares
- *
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return mixed key
- * @since 8.1.0
- */
- public function getSystemUserKey($keyId, $encryptionModuleId);
- /**
- * set user specific key
- *
- * @param string $uid ID if the user for whom we want the key
- * @param string $keyId id of the key
- * @param mixed $key
- * @param string $encryptionModuleId
- * @since 8.1.0
- */
- public function setUserKey($uid, $keyId, $key, $encryptionModuleId);
- /**
- * set file specific key
- *
- * @param string $path path to file
- * @param string $keyId id of the key
- * @param mixed $key
- * @param string $encryptionModuleId
- * @since 8.1.0
- */
- public function setFileKey($path, $keyId, $key, $encryptionModuleId);
- /**
- * set system-wide encryption keys not related to a specific user,
- * e.g something like a key for public link shares
- *
- * @param string $keyId id of the key
- * @param mixed $key
- * @param string $encryptionModuleId
- *
- * @return mixed key
- * @since 8.1.0
- */
- public function setSystemUserKey($keyId, $key, $encryptionModuleId);
- /**
- * delete user specific key
- *
- * @param string $uid ID if the user for whom we want to delete the key
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return boolean False when the key could not be deleted
- * @since 8.1.0
- */
- public function deleteUserKey($uid, $keyId, $encryptionModuleId);
- /**
- * delete file specific key
- *
- * @param string $path path to file
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return boolean False when the key could not be deleted
- * @since 8.1.0
- */
- public function deleteFileKey($path, $keyId, $encryptionModuleId);
- /**
- * delete all file keys for a given file
- *
- * @param string $path to the file
- *
- * @return boolean False when the keys could not be deleted
- * @since 8.1.0
- */
- public function deleteAllFileKeys($path);
- /**
- * delete system-wide encryption keys not related to a specific user,
- * e.g something like a key for public link shares
- *
- * @param string $keyId id of the key
- * @param string $encryptionModuleId
- *
- * @return boolean False when the key could not be deleted
- * @since 8.1.0
- */
- public function deleteSystemUserKey($keyId, $encryptionModuleId);
- /**
- * copy keys if a file was renamed
- *
- * @param string $source
- * @param string $target
- * @return boolean
- * @since 8.1.0
- */
- public function renameKeys($source, $target);
- /**
- * move keys if a file was renamed
- *
- * @param string $source
- * @param string $target
- * @return boolean
- * @since 8.1.0
- */
- public function copyKeys($source, $target);
- /**
- * backup keys of a given encryption module
- *
- * @param string $encryptionModuleId
- * @param string $purpose
- * @param string $uid
- * @return bool
- * @since 12.0.0
- */
- public function backupUserKeys($encryptionModuleId, $purpose, $uid);
- }
|