1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
<?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);
}
|
