@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
88 | 88 | $path = Filesystem::getPath($params['fileSource']); |
89 | 89 | list($owner, $ownerPath) = $this->getOwnerPath($path); |
90 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
90 | + $absPath = '/'.$owner.'/files/'.$ownerPath; |
|
91 | 91 | $this->update($absPath); |
92 | 92 | } |
93 | 93 | } |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
104 | 104 | $path = Filesystem::getPath($params['fileSource']); |
105 | 105 | list($owner, $ownerPath) = $this->getOwnerPath($path); |
106 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
106 | + $absPath = '/'.$owner.'/files/'.$ownerPath; |
|
107 | 107 | $this->update($absPath); |
108 | 108 | } |
109 | 109 | } |
@@ -117,7 +117,7 @@ discard block |
||
117 | 117 | */ |
118 | 118 | public function postRestore($params) { |
119 | 119 | if ($this->encryptionManager->isEnabled()) { |
120 | - $path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']); |
|
120 | + $path = Filesystem::normalizePath('/'.$this->uid.'/files/'.$params['filePath']); |
|
121 | 121 | $this->update($path); |
122 | 122 | } |
123 | 123 | } |
@@ -131,12 +131,12 @@ discard block |
||
131 | 131 | public function postRename($params) { |
132 | 132 | $source = $params['oldpath']; |
133 | 133 | $target = $params['newpath']; |
134 | - if( |
|
134 | + if ( |
|
135 | 135 | $this->encryptionManager->isEnabled() && |
136 | 136 | dirname($source) !== dirname($target) |
137 | 137 | ) { |
138 | 138 | list($owner, $ownerPath) = $this->getOwnerPath($target); |
139 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
139 | + $absPath = '/'.$owner.'/files/'.$ownerPath; |
|
140 | 140 | $this->update($absPath); |
141 | 141 | } |
142 | 142 | } |
@@ -151,10 +151,10 @@ discard block |
||
151 | 151 | protected function getOwnerPath($path) { |
152 | 152 | $info = Filesystem::getFileInfo($path); |
153 | 153 | $owner = Filesystem::getOwner($path); |
154 | - $view = new View('/' . $owner . '/files'); |
|
154 | + $view = new View('/'.$owner.'/files'); |
|
155 | 155 | $path = $view->getPath($info->getId()); |
156 | 156 | if ($path === null) { |
157 | - throw new \InvalidArgumentException('No file found for ' . $info->getId()); |
|
157 | + throw new \InvalidArgumentException('No file found for '.$info->getId()); |
|
158 | 158 | } |
159 | 159 | |
160 | 160 | return array($owner, $path); |
@@ -33,162 +33,162 @@ |
||
33 | 33 | */ |
34 | 34 | class Update { |
35 | 35 | |
36 | - /** @var \OC\Files\View */ |
|
37 | - protected $view; |
|
38 | - |
|
39 | - /** @var \OC\Encryption\Util */ |
|
40 | - protected $util; |
|
41 | - |
|
42 | - /** @var \OC\Files\Mount\Manager */ |
|
43 | - protected $mountManager; |
|
44 | - |
|
45 | - /** @var \OC\Encryption\Manager */ |
|
46 | - protected $encryptionManager; |
|
47 | - |
|
48 | - /** @var string */ |
|
49 | - protected $uid; |
|
50 | - |
|
51 | - /** @var \OC\Encryption\File */ |
|
52 | - protected $file; |
|
53 | - |
|
54 | - /** |
|
55 | - * |
|
56 | - * @param \OC\Files\View $view |
|
57 | - * @param \OC\Encryption\Util $util |
|
58 | - * @param \OC\Files\Mount\Manager $mountManager |
|
59 | - * @param \OC\Encryption\Manager $encryptionManager |
|
60 | - * @param \OC\Encryption\File $file |
|
61 | - * @param string $uid |
|
62 | - */ |
|
63 | - public function __construct( |
|
64 | - View $view, |
|
65 | - Util $util, |
|
66 | - Mount\Manager $mountManager, |
|
67 | - Manager $encryptionManager, |
|
68 | - File $file, |
|
69 | - $uid |
|
70 | - ) { |
|
71 | - |
|
72 | - $this->view = $view; |
|
73 | - $this->util = $util; |
|
74 | - $this->mountManager = $mountManager; |
|
75 | - $this->encryptionManager = $encryptionManager; |
|
76 | - $this->file = $file; |
|
77 | - $this->uid = $uid; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * hook after file was shared |
|
82 | - * |
|
83 | - * @param array $params |
|
84 | - */ |
|
85 | - public function postShared($params) { |
|
86 | - if ($this->encryptionManager->isEnabled()) { |
|
87 | - if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
|
88 | - $path = Filesystem::getPath($params['fileSource']); |
|
89 | - list($owner, $ownerPath) = $this->getOwnerPath($path); |
|
90 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
91 | - $this->update($absPath); |
|
92 | - } |
|
93 | - } |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * hook after file was unshared |
|
98 | - * |
|
99 | - * @param array $params |
|
100 | - */ |
|
101 | - public function postUnshared($params) { |
|
102 | - if ($this->encryptionManager->isEnabled()) { |
|
103 | - if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
|
104 | - $path = Filesystem::getPath($params['fileSource']); |
|
105 | - list($owner, $ownerPath) = $this->getOwnerPath($path); |
|
106 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
107 | - $this->update($absPath); |
|
108 | - } |
|
109 | - } |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * inform encryption module that a file was restored from the trash bin, |
|
114 | - * e.g. to update the encryption keys |
|
115 | - * |
|
116 | - * @param array $params |
|
117 | - */ |
|
118 | - public function postRestore($params) { |
|
119 | - if ($this->encryptionManager->isEnabled()) { |
|
120 | - $path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']); |
|
121 | - $this->update($path); |
|
122 | - } |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * inform encryption module that a file was renamed, |
|
127 | - * e.g. to update the encryption keys |
|
128 | - * |
|
129 | - * @param array $params |
|
130 | - */ |
|
131 | - public function postRename($params) { |
|
132 | - $source = $params['oldpath']; |
|
133 | - $target = $params['newpath']; |
|
134 | - if( |
|
135 | - $this->encryptionManager->isEnabled() && |
|
136 | - dirname($source) !== dirname($target) |
|
137 | - ) { |
|
138 | - list($owner, $ownerPath) = $this->getOwnerPath($target); |
|
139 | - $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
140 | - $this->update($absPath); |
|
141 | - } |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * get owner and path relative to data/<owner>/files |
|
146 | - * |
|
147 | - * @param string $path path to file for current user |
|
148 | - * @return array ['owner' => $owner, 'path' => $path] |
|
149 | - * @throw \InvalidArgumentException |
|
150 | - */ |
|
151 | - protected function getOwnerPath($path) { |
|
152 | - $info = Filesystem::getFileInfo($path); |
|
153 | - $owner = Filesystem::getOwner($path); |
|
154 | - $view = new View('/' . $owner . '/files'); |
|
155 | - $path = $view->getPath($info->getId()); |
|
156 | - if ($path === null) { |
|
157 | - throw new \InvalidArgumentException('No file found for ' . $info->getId()); |
|
158 | - } |
|
159 | - |
|
160 | - return array($owner, $path); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * notify encryption module about added/removed users from a file/folder |
|
165 | - * |
|
166 | - * @param string $path relative to data/ |
|
167 | - * @throws Exceptions\ModuleDoesNotExistsException |
|
168 | - */ |
|
169 | - public function update($path) { |
|
170 | - |
|
171 | - $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
172 | - |
|
173 | - // if the encryption module doesn't encrypt the files on a per-user basis |
|
174 | - // we have nothing to do here. |
|
175 | - if ($encryptionModule->needDetailedAccessList() === false) { |
|
176 | - return; |
|
177 | - } |
|
178 | - |
|
179 | - // if a folder was shared, get a list of all (sub-)folders |
|
180 | - if ($this->view->is_dir($path)) { |
|
181 | - $allFiles = $this->util->getAllFiles($path); |
|
182 | - } else { |
|
183 | - $allFiles = array($path); |
|
184 | - } |
|
185 | - |
|
186 | - |
|
187 | - |
|
188 | - foreach ($allFiles as $file) { |
|
189 | - $usersSharing = $this->file->getAccessList($file); |
|
190 | - $encryptionModule->update($file, $this->uid, $usersSharing); |
|
191 | - } |
|
192 | - } |
|
36 | + /** @var \OC\Files\View */ |
|
37 | + protected $view; |
|
38 | + |
|
39 | + /** @var \OC\Encryption\Util */ |
|
40 | + protected $util; |
|
41 | + |
|
42 | + /** @var \OC\Files\Mount\Manager */ |
|
43 | + protected $mountManager; |
|
44 | + |
|
45 | + /** @var \OC\Encryption\Manager */ |
|
46 | + protected $encryptionManager; |
|
47 | + |
|
48 | + /** @var string */ |
|
49 | + protected $uid; |
|
50 | + |
|
51 | + /** @var \OC\Encryption\File */ |
|
52 | + protected $file; |
|
53 | + |
|
54 | + /** |
|
55 | + * |
|
56 | + * @param \OC\Files\View $view |
|
57 | + * @param \OC\Encryption\Util $util |
|
58 | + * @param \OC\Files\Mount\Manager $mountManager |
|
59 | + * @param \OC\Encryption\Manager $encryptionManager |
|
60 | + * @param \OC\Encryption\File $file |
|
61 | + * @param string $uid |
|
62 | + */ |
|
63 | + public function __construct( |
|
64 | + View $view, |
|
65 | + Util $util, |
|
66 | + Mount\Manager $mountManager, |
|
67 | + Manager $encryptionManager, |
|
68 | + File $file, |
|
69 | + $uid |
|
70 | + ) { |
|
71 | + |
|
72 | + $this->view = $view; |
|
73 | + $this->util = $util; |
|
74 | + $this->mountManager = $mountManager; |
|
75 | + $this->encryptionManager = $encryptionManager; |
|
76 | + $this->file = $file; |
|
77 | + $this->uid = $uid; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * hook after file was shared |
|
82 | + * |
|
83 | + * @param array $params |
|
84 | + */ |
|
85 | + public function postShared($params) { |
|
86 | + if ($this->encryptionManager->isEnabled()) { |
|
87 | + if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
|
88 | + $path = Filesystem::getPath($params['fileSource']); |
|
89 | + list($owner, $ownerPath) = $this->getOwnerPath($path); |
|
90 | + $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
91 | + $this->update($absPath); |
|
92 | + } |
|
93 | + } |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * hook after file was unshared |
|
98 | + * |
|
99 | + * @param array $params |
|
100 | + */ |
|
101 | + public function postUnshared($params) { |
|
102 | + if ($this->encryptionManager->isEnabled()) { |
|
103 | + if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') { |
|
104 | + $path = Filesystem::getPath($params['fileSource']); |
|
105 | + list($owner, $ownerPath) = $this->getOwnerPath($path); |
|
106 | + $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
107 | + $this->update($absPath); |
|
108 | + } |
|
109 | + } |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * inform encryption module that a file was restored from the trash bin, |
|
114 | + * e.g. to update the encryption keys |
|
115 | + * |
|
116 | + * @param array $params |
|
117 | + */ |
|
118 | + public function postRestore($params) { |
|
119 | + if ($this->encryptionManager->isEnabled()) { |
|
120 | + $path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']); |
|
121 | + $this->update($path); |
|
122 | + } |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * inform encryption module that a file was renamed, |
|
127 | + * e.g. to update the encryption keys |
|
128 | + * |
|
129 | + * @param array $params |
|
130 | + */ |
|
131 | + public function postRename($params) { |
|
132 | + $source = $params['oldpath']; |
|
133 | + $target = $params['newpath']; |
|
134 | + if( |
|
135 | + $this->encryptionManager->isEnabled() && |
|
136 | + dirname($source) !== dirname($target) |
|
137 | + ) { |
|
138 | + list($owner, $ownerPath) = $this->getOwnerPath($target); |
|
139 | + $absPath = '/' . $owner . '/files/' . $ownerPath; |
|
140 | + $this->update($absPath); |
|
141 | + } |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * get owner and path relative to data/<owner>/files |
|
146 | + * |
|
147 | + * @param string $path path to file for current user |
|
148 | + * @return array ['owner' => $owner, 'path' => $path] |
|
149 | + * @throw \InvalidArgumentException |
|
150 | + */ |
|
151 | + protected function getOwnerPath($path) { |
|
152 | + $info = Filesystem::getFileInfo($path); |
|
153 | + $owner = Filesystem::getOwner($path); |
|
154 | + $view = new View('/' . $owner . '/files'); |
|
155 | + $path = $view->getPath($info->getId()); |
|
156 | + if ($path === null) { |
|
157 | + throw new \InvalidArgumentException('No file found for ' . $info->getId()); |
|
158 | + } |
|
159 | + |
|
160 | + return array($owner, $path); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * notify encryption module about added/removed users from a file/folder |
|
165 | + * |
|
166 | + * @param string $path relative to data/ |
|
167 | + * @throws Exceptions\ModuleDoesNotExistsException |
|
168 | + */ |
|
169 | + public function update($path) { |
|
170 | + |
|
171 | + $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
172 | + |
|
173 | + // if the encryption module doesn't encrypt the files on a per-user basis |
|
174 | + // we have nothing to do here. |
|
175 | + if ($encryptionModule->needDetailedAccessList() === false) { |
|
176 | + return; |
|
177 | + } |
|
178 | + |
|
179 | + // if a folder was shared, get a list of all (sub-)folders |
|
180 | + if ($this->view->is_dir($path)) { |
|
181 | + $allFiles = $this->util->getAllFiles($path); |
|
182 | + } else { |
|
183 | + $allFiles = array($path); |
|
184 | + } |
|
185 | + |
|
186 | + |
|
187 | + |
|
188 | + foreach ($allFiles as $file) { |
|
189 | + $usersSharing = $this->file->getAccessList($file); |
|
190 | + $encryptionModule->update($file, $this->uid, $usersSharing); |
|
191 | + } |
|
192 | + } |
|
193 | 193 | |
194 | 194 | } |
@@ -27,12 +27,12 @@ |
||
27 | 27 | |
28 | 28 | class ModuleAlreadyExistsException extends GenericEncryptionException { |
29 | 29 | |
30 | - /** |
|
31 | - * @param string $id |
|
32 | - * @param string $name |
|
33 | - */ |
|
34 | - public function __construct($id, $name) { |
|
35 | - parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"'); |
|
36 | - } |
|
30 | + /** |
|
31 | + * @param string $id |
|
32 | + * @param string $name |
|
33 | + */ |
|
34 | + public function __construct($id, $name) { |
|
35 | + parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"'); |
|
36 | + } |
|
37 | 37 | |
38 | 38 | } |
@@ -32,7 +32,7 @@ |
||
32 | 32 | * @param string $name |
33 | 33 | */ |
34 | 34 | public function __construct($id, $name) { |
35 | - parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"'); |
|
35 | + parent::__construct('Id "'.$id.'" already used by encryption module "'.$name.'"'); |
|
36 | 36 | } |
37 | 37 | |
38 | 38 | } |
@@ -28,8 +28,8 @@ |
||
28 | 28 | |
29 | 29 | class EncryptionHeaderToLargeException extends GenericEncryptionException { |
30 | 30 | |
31 | - public function __construct() { |
|
32 | - parent::__construct('max header size exceeded'); |
|
33 | - } |
|
31 | + public function __construct() { |
|
32 | + parent::__construct('max header size exceeded'); |
|
33 | + } |
|
34 | 34 | |
35 | 35 | } |
@@ -27,10 +27,10 @@ |
||
27 | 27 | |
28 | 28 | class EncryptionHeaderKeyExistsException extends GenericEncryptionException { |
29 | 29 | |
30 | - /** |
|
31 | - * @param string $key |
|
32 | - */ |
|
33 | - public function __construct($key) { |
|
34 | - parent::__construct('header key "'. $key . '" already reserved by ownCloud'); |
|
35 | - } |
|
30 | + /** |
|
31 | + * @param string $key |
|
32 | + */ |
|
33 | + public function __construct($key) { |
|
34 | + parent::__construct('header key "'. $key . '" already reserved by ownCloud'); |
|
35 | + } |
|
36 | 36 | } |
@@ -31,6 +31,6 @@ |
||
31 | 31 | * @param string $key |
32 | 32 | */ |
33 | 33 | public function __construct($key) { |
34 | - parent::__construct('header key "'. $key . '" already reserved by ownCloud'); |
|
34 | + parent::__construct('header key "'.$key.'" already reserved by ownCloud'); |
|
35 | 35 | } |
36 | 36 | } |
@@ -26,6 +26,6 @@ |
||
26 | 26 | |
27 | 27 | use OCP\Encryption\Exceptions\GenericEncryptionException; |
28 | 28 | |
29 | -class EncryptionFailedException extends GenericEncryptionException{ |
|
29 | +class EncryptionFailedException extends GenericEncryptionException { |
|
30 | 30 | |
31 | 31 | } |
@@ -26,6 +26,6 @@ |
||
26 | 26 | |
27 | 27 | use OCP\Encryption\Exceptions\GenericEncryptionException; |
28 | 28 | |
29 | -class EmptyEncryptionDataException extends GenericEncryptionException{ |
|
29 | +class EmptyEncryptionDataException extends GenericEncryptionException { |
|
30 | 30 | |
31 | 31 | } |
@@ -58,7 +58,7 @@ |
||
58 | 58 | // always add owner to the list of users with access to the file |
59 | 59 | $userIds = array($owner); |
60 | 60 | |
61 | - if (!$this->util->isFile($owner . '/' . $ownerPath)) { |
|
61 | + if (!$this->util->isFile($owner.'/'.$ownerPath)) { |
|
62 | 62 | return array('users' => $userIds, 'public' => false); |
63 | 63 | } |
64 | 64 |
@@ -31,95 +31,95 @@ |
||
31 | 31 | |
32 | 32 | class File implements \OCP\Encryption\IFile { |
33 | 33 | |
34 | - /** @var Util */ |
|
35 | - protected $util; |
|
36 | - |
|
37 | - /** @var IRootFolder */ |
|
38 | - private $rootFolder; |
|
39 | - |
|
40 | - /** @var IManager */ |
|
41 | - private $shareManager; |
|
42 | - |
|
43 | - /** |
|
44 | - * cache results of already checked folders |
|
45 | - * |
|
46 | - * @var array |
|
47 | - */ |
|
48 | - protected $cache; |
|
49 | - |
|
50 | - public function __construct(Util $util, |
|
51 | - IRootFolder $rootFolder, |
|
52 | - IManager $shareManager) { |
|
53 | - $this->util = $util; |
|
54 | - $this->cache = new CappedMemoryCache(); |
|
55 | - $this->rootFolder = $rootFolder; |
|
56 | - $this->shareManager = $shareManager; |
|
57 | - } |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * get list of users with access to the file |
|
62 | - * |
|
63 | - * @param string $path to the file |
|
64 | - * @return array ['users' => $uniqueUserIds, 'public' => $public] |
|
65 | - */ |
|
66 | - public function getAccessList($path) { |
|
67 | - |
|
68 | - // Make sure that a share key is generated for the owner too |
|
69 | - list($owner, $ownerPath) = $this->util->getUidAndFilename($path); |
|
70 | - |
|
71 | - // always add owner to the list of users with access to the file |
|
72 | - $userIds = array($owner); |
|
73 | - |
|
74 | - if (!$this->util->isFile($owner . '/' . $ownerPath)) { |
|
75 | - return array('users' => $userIds, 'public' => false); |
|
76 | - } |
|
77 | - |
|
78 | - $ownerPath = substr($ownerPath, strlen('/files')); |
|
79 | - $userFolder = $this->rootFolder->getUserFolder($owner); |
|
80 | - try { |
|
81 | - $file = $userFolder->get($ownerPath); |
|
82 | - } catch (NotFoundException $e) { |
|
83 | - $file = null; |
|
84 | - } |
|
85 | - $ownerPath = $this->util->stripPartialFileExtension($ownerPath); |
|
86 | - |
|
87 | - // first get the shares for the parent and cache the result so that we don't |
|
88 | - // need to check all parents for every file |
|
89 | - $parent = dirname($ownerPath); |
|
90 | - $parentNode = $userFolder->get($parent); |
|
91 | - if (isset($this->cache[$parent])) { |
|
92 | - $resultForParents = $this->cache[$parent]; |
|
93 | - } else { |
|
94 | - $resultForParents = $this->shareManager->getAccessList($parentNode); |
|
95 | - $this->cache[$parent] = $resultForParents; |
|
96 | - } |
|
97 | - $userIds = array_merge($userIds, $resultForParents['users']); |
|
98 | - $public = $resultForParents['public'] || $resultForParents['remote']; |
|
99 | - |
|
100 | - |
|
101 | - // Find out who, if anyone, is sharing the file |
|
102 | - if ($file !== null) { |
|
103 | - $resultForFile = $this->shareManager->getAccessList($file, false); |
|
104 | - $userIds = array_merge($userIds, $resultForFile['users']); |
|
105 | - $public = $resultForFile['public'] || $resultForFile['remote'] || $public; |
|
106 | - } |
|
107 | - |
|
108 | - // check if it is a group mount |
|
109 | - if (\OCP\App::isEnabled("files_external")) { |
|
110 | - $mounts = \OC_Mount_Config::getSystemMountPoints(); |
|
111 | - foreach ($mounts as $mount) { |
|
112 | - if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) { |
|
113 | - $mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']); |
|
114 | - $userIds = array_merge($userIds, $mountedFor); |
|
115 | - } |
|
116 | - } |
|
117 | - } |
|
118 | - |
|
119 | - // Remove duplicate UIDs |
|
120 | - $uniqueUserIds = array_unique($userIds); |
|
121 | - |
|
122 | - return array('users' => $uniqueUserIds, 'public' => $public); |
|
123 | - } |
|
34 | + /** @var Util */ |
|
35 | + protected $util; |
|
36 | + |
|
37 | + /** @var IRootFolder */ |
|
38 | + private $rootFolder; |
|
39 | + |
|
40 | + /** @var IManager */ |
|
41 | + private $shareManager; |
|
42 | + |
|
43 | + /** |
|
44 | + * cache results of already checked folders |
|
45 | + * |
|
46 | + * @var array |
|
47 | + */ |
|
48 | + protected $cache; |
|
49 | + |
|
50 | + public function __construct(Util $util, |
|
51 | + IRootFolder $rootFolder, |
|
52 | + IManager $shareManager) { |
|
53 | + $this->util = $util; |
|
54 | + $this->cache = new CappedMemoryCache(); |
|
55 | + $this->rootFolder = $rootFolder; |
|
56 | + $this->shareManager = $shareManager; |
|
57 | + } |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * get list of users with access to the file |
|
62 | + * |
|
63 | + * @param string $path to the file |
|
64 | + * @return array ['users' => $uniqueUserIds, 'public' => $public] |
|
65 | + */ |
|
66 | + public function getAccessList($path) { |
|
67 | + |
|
68 | + // Make sure that a share key is generated for the owner too |
|
69 | + list($owner, $ownerPath) = $this->util->getUidAndFilename($path); |
|
70 | + |
|
71 | + // always add owner to the list of users with access to the file |
|
72 | + $userIds = array($owner); |
|
73 | + |
|
74 | + if (!$this->util->isFile($owner . '/' . $ownerPath)) { |
|
75 | + return array('users' => $userIds, 'public' => false); |
|
76 | + } |
|
77 | + |
|
78 | + $ownerPath = substr($ownerPath, strlen('/files')); |
|
79 | + $userFolder = $this->rootFolder->getUserFolder($owner); |
|
80 | + try { |
|
81 | + $file = $userFolder->get($ownerPath); |
|
82 | + } catch (NotFoundException $e) { |
|
83 | + $file = null; |
|
84 | + } |
|
85 | + $ownerPath = $this->util->stripPartialFileExtension($ownerPath); |
|
86 | + |
|
87 | + // first get the shares for the parent and cache the result so that we don't |
|
88 | + // need to check all parents for every file |
|
89 | + $parent = dirname($ownerPath); |
|
90 | + $parentNode = $userFolder->get($parent); |
|
91 | + if (isset($this->cache[$parent])) { |
|
92 | + $resultForParents = $this->cache[$parent]; |
|
93 | + } else { |
|
94 | + $resultForParents = $this->shareManager->getAccessList($parentNode); |
|
95 | + $this->cache[$parent] = $resultForParents; |
|
96 | + } |
|
97 | + $userIds = array_merge($userIds, $resultForParents['users']); |
|
98 | + $public = $resultForParents['public'] || $resultForParents['remote']; |
|
99 | + |
|
100 | + |
|
101 | + // Find out who, if anyone, is sharing the file |
|
102 | + if ($file !== null) { |
|
103 | + $resultForFile = $this->shareManager->getAccessList($file, false); |
|
104 | + $userIds = array_merge($userIds, $resultForFile['users']); |
|
105 | + $public = $resultForFile['public'] || $resultForFile['remote'] || $public; |
|
106 | + } |
|
107 | + |
|
108 | + // check if it is a group mount |
|
109 | + if (\OCP\App::isEnabled("files_external")) { |
|
110 | + $mounts = \OC_Mount_Config::getSystemMountPoints(); |
|
111 | + foreach ($mounts as $mount) { |
|
112 | + if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) { |
|
113 | + $mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']); |
|
114 | + $userIds = array_merge($userIds, $mountedFor); |
|
115 | + } |
|
116 | + } |
|
117 | + } |
|
118 | + |
|
119 | + // Remove duplicate UIDs |
|
120 | + $uniqueUserIds = array_unique($userIds); |
|
121 | + |
|
122 | + return array('users' => $uniqueUserIds, 'public' => $public); |
|
123 | + } |
|
124 | 124 | |
125 | 125 | } |
@@ -66,8 +66,8 @@ discard block |
||
66 | 66 | $this->util = $util; |
67 | 67 | |
68 | 68 | $this->encryption_base_dir = '/files_encryption'; |
69 | - $this->keys_base_dir = $this->encryption_base_dir .'/keys'; |
|
70 | - $this->backup_base_dir = $this->encryption_base_dir .'/backup'; |
|
69 | + $this->keys_base_dir = $this->encryption_base_dir.'/keys'; |
|
70 | + $this->backup_base_dir = $this->encryption_base_dir.'/backup'; |
|
71 | 71 | $this->root_dir = $this->util->getKeyStorageRoot(); |
72 | 72 | } |
73 | 73 | |
@@ -85,14 +85,14 @@ discard block |
||
85 | 85 | public function getFileKey($path, $keyId, $encryptionModuleId) { |
86 | 86 | $realFile = $this->util->stripPartialFileExtension($path); |
87 | 87 | $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile); |
88 | - $key = $this->getKey($keyDir . $keyId); |
|
88 | + $key = $this->getKey($keyDir.$keyId); |
|
89 | 89 | |
90 | 90 | if ($key === '' && $realFile !== $path) { |
91 | 91 | // Check if the part file has keys and use them, if no normal keys |
92 | 92 | // exist. This is required to fix copyBetweenStorage() when we |
93 | 93 | // rename a .part file over storage borders. |
94 | 94 | $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
95 | - $key = $this->getKey($keyDir . $keyId); |
|
95 | + $key = $this->getKey($keyDir.$keyId); |
|
96 | 96 | } |
97 | 97 | |
98 | 98 | return $key; |
@@ -119,7 +119,7 @@ discard block |
||
119 | 119 | */ |
120 | 120 | public function setFileKey($path, $keyId, $key, $encryptionModuleId) { |
121 | 121 | $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
122 | - return $this->setKey($keyDir . $keyId, $key); |
|
122 | + return $this->setKey($keyDir.$keyId, $key); |
|
123 | 123 | } |
124 | 124 | |
125 | 125 | /** |
@@ -143,7 +143,7 @@ discard block |
||
143 | 143 | */ |
144 | 144 | public function deleteFileKey($path, $keyId, $encryptionModuleId) { |
145 | 145 | $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
146 | - return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId); |
|
146 | + return !$this->view->file_exists($keyDir.$keyId) || $this->view->unlink($keyDir.$keyId); |
|
147 | 147 | } |
148 | 148 | |
149 | 149 | /** |
@@ -173,10 +173,10 @@ discard block |
||
173 | 173 | protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) { |
174 | 174 | |
175 | 175 | if ($uid === null) { |
176 | - $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId; |
|
176 | + $path = $this->root_dir.'/'.$this->encryption_base_dir.'/'.$encryptionModuleId.'/'.$keyId; |
|
177 | 177 | } else { |
178 | - $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/' |
|
179 | - . $encryptionModuleId . '/' . $uid . '.' . $keyId; |
|
178 | + $path = $this->root_dir.'/'.$uid.$this->encryption_base_dir.'/' |
|
179 | + . $encryptionModuleId.'/'.$uid.'.'.$keyId; |
|
180 | 180 | } |
181 | 181 | |
182 | 182 | return \OC\Files\Filesystem::normalizePath($path); |
@@ -194,7 +194,7 @@ discard block |
||
194 | 194 | |
195 | 195 | if ($this->view->file_exists($path)) { |
196 | 196 | if (isset($this->keyCache[$path])) { |
197 | - $key = $this->keyCache[$path]; |
|
197 | + $key = $this->keyCache[$path]; |
|
198 | 198 | } else { |
199 | 199 | $key = $this->view->file_get_contents($path); |
200 | 200 | $this->keyCache[$path] = $key; |
@@ -238,12 +238,12 @@ discard block |
||
238 | 238 | |
239 | 239 | // in case of system wide mount points the keys are stored directly in the data directory |
240 | 240 | if ($this->util->isSystemWideMountPoint($filename, $owner)) { |
241 | - $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/'; |
|
241 | + $keyPath = $this->root_dir.'/'.$this->keys_base_dir.$filename.'/'; |
|
242 | 242 | } else { |
243 | - $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/'; |
|
243 | + $keyPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$filename.'/'; |
|
244 | 244 | } |
245 | 245 | |
246 | - return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false); |
|
246 | + return Filesystem::normalizePath($keyPath.$encryptionModuleId.'/', false); |
|
247 | 247 | } |
248 | 248 | |
249 | 249 | /** |
@@ -300,13 +300,13 @@ discard block |
||
300 | 300 | * @since 12.0.0 |
301 | 301 | */ |
302 | 302 | public function backupUserKeys($encryptionModuleId, $purpose, $uid) { |
303 | - $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId; |
|
304 | - $backupDir = $uid . $this->backup_base_dir; |
|
303 | + $source = $uid.$this->encryption_base_dir.'/'.$encryptionModuleId; |
|
304 | + $backupDir = $uid.$this->backup_base_dir; |
|
305 | 305 | if (!$this->view->file_exists($backupDir)) { |
306 | 306 | $this->view->mkdir($backupDir); |
307 | 307 | } |
308 | 308 | |
309 | - $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp(); |
|
309 | + $backupDir = $backupDir.'/'.$purpose.'.'.$encryptionModuleId.'.'.$this->getTimestamp(); |
|
310 | 310 | $this->view->mkdir($backupDir); |
311 | 311 | |
312 | 312 | return $this->view->copy($source, $backupDir); |
@@ -332,9 +332,9 @@ discard block |
||
332 | 332 | $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner); |
333 | 333 | |
334 | 334 | if ($systemWideMountPoint) { |
335 | - $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/'; |
|
335 | + $systemPath = $this->root_dir.'/'.$this->keys_base_dir.$relativePath.'/'; |
|
336 | 336 | } else { |
337 | - $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/'; |
|
337 | + $systemPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$relativePath.'/'; |
|
338 | 338 | } |
339 | 339 | |
340 | 340 | return Filesystem::normalizePath($systemPath, false); |
@@ -351,7 +351,7 @@ discard block |
||
351 | 351 | $sub_dirs = explode('/', ltrim($path, '/')); |
352 | 352 | $dir = ''; |
353 | 353 | foreach ($sub_dirs as $sub_dir) { |
354 | - $dir .= '/' . $sub_dir; |
|
354 | + $dir .= '/'.$sub_dir; |
|
355 | 355 | if (!$this->view->is_dir($dir)) { |
356 | 356 | $this->view->mkdir($dir); |
357 | 357 | } |
@@ -32,345 +32,345 @@ |
||
32 | 32 | |
33 | 33 | class Storage implements IStorage { |
34 | 34 | |
35 | - // hidden file which indicate that the folder is a valid key storage |
|
36 | - const KEY_STORAGE_MARKER = '.oc_key_storage'; |
|
37 | - |
|
38 | - /** @var View */ |
|
39 | - private $view; |
|
40 | - |
|
41 | - /** @var Util */ |
|
42 | - private $util; |
|
43 | - |
|
44 | - // base dir where all the file related keys are stored |
|
45 | - /** @var string */ |
|
46 | - private $keys_base_dir; |
|
47 | - |
|
48 | - // root of the key storage default is empty which means that we use the data folder |
|
49 | - /** @var string */ |
|
50 | - private $root_dir; |
|
51 | - |
|
52 | - /** @var string */ |
|
53 | - private $encryption_base_dir; |
|
54 | - |
|
55 | - /** @var string */ |
|
56 | - private $backup_base_dir; |
|
57 | - |
|
58 | - /** @var array */ |
|
59 | - private $keyCache = []; |
|
60 | - |
|
61 | - /** |
|
62 | - * @param View $view |
|
63 | - * @param Util $util |
|
64 | - */ |
|
65 | - public function __construct(View $view, Util $util) { |
|
66 | - $this->view = $view; |
|
67 | - $this->util = $util; |
|
68 | - |
|
69 | - $this->encryption_base_dir = '/files_encryption'; |
|
70 | - $this->keys_base_dir = $this->encryption_base_dir .'/keys'; |
|
71 | - $this->backup_base_dir = $this->encryption_base_dir .'/backup'; |
|
72 | - $this->root_dir = $this->util->getKeyStorageRoot(); |
|
73 | - } |
|
74 | - |
|
75 | - /** |
|
76 | - * @inheritdoc |
|
77 | - */ |
|
78 | - public function getUserKey($uid, $keyId, $encryptionModuleId) { |
|
79 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
80 | - return $this->getKey($path); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * @inheritdoc |
|
85 | - */ |
|
86 | - public function getFileKey($path, $keyId, $encryptionModuleId) { |
|
87 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
88 | - $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile); |
|
89 | - $key = $this->getKey($keyDir . $keyId); |
|
90 | - |
|
91 | - if ($key === '' && $realFile !== $path) { |
|
92 | - // Check if the part file has keys and use them, if no normal keys |
|
93 | - // exist. This is required to fix copyBetweenStorage() when we |
|
94 | - // rename a .part file over storage borders. |
|
95 | - $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
96 | - $key = $this->getKey($keyDir . $keyId); |
|
97 | - } |
|
98 | - |
|
99 | - return $key; |
|
100 | - } |
|
101 | - |
|
102 | - /** |
|
103 | - * @inheritdoc |
|
104 | - */ |
|
105 | - public function getSystemUserKey($keyId, $encryptionModuleId) { |
|
106 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
107 | - return $this->getKey($path); |
|
108 | - } |
|
109 | - |
|
110 | - /** |
|
111 | - * @inheritdoc |
|
112 | - */ |
|
113 | - public function setUserKey($uid, $keyId, $key, $encryptionModuleId) { |
|
114 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
115 | - return $this->setKey($path, $key); |
|
116 | - } |
|
117 | - |
|
118 | - /** |
|
119 | - * @inheritdoc |
|
120 | - */ |
|
121 | - public function setFileKey($path, $keyId, $key, $encryptionModuleId) { |
|
122 | - $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
123 | - return $this->setKey($keyDir . $keyId, $key); |
|
124 | - } |
|
125 | - |
|
126 | - /** |
|
127 | - * @inheritdoc |
|
128 | - */ |
|
129 | - public function setSystemUserKey($keyId, $key, $encryptionModuleId) { |
|
130 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
131 | - return $this->setKey($path, $key); |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * @inheritdoc |
|
136 | - */ |
|
137 | - public function deleteUserKey($uid, $keyId, $encryptionModuleId) { |
|
138 | - try { |
|
139 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
140 | - return !$this->view->file_exists($path) || $this->view->unlink($path); |
|
141 | - } catch (NoUserException $e) { |
|
142 | - // this exception can come from initMountPoints() from setupUserMounts() |
|
143 | - // for a deleted user. |
|
144 | - // |
|
145 | - // It means, that: |
|
146 | - // - we are not running in alternative storage mode because we don't call |
|
147 | - // initMountPoints() in that mode |
|
148 | - // - the keys were in the user's home but since the user was deleted, the |
|
149 | - // user's home is gone and so are the keys |
|
150 | - // |
|
151 | - // So there is nothing to do, just ignore. |
|
152 | - } |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * @inheritdoc |
|
157 | - */ |
|
158 | - public function deleteFileKey($path, $keyId, $encryptionModuleId) { |
|
159 | - $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
160 | - return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * @inheritdoc |
|
165 | - */ |
|
166 | - public function deleteAllFileKeys($path) { |
|
167 | - $keyDir = $this->getFileKeyDir('', $path); |
|
168 | - return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir); |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * @inheritdoc |
|
173 | - */ |
|
174 | - public function deleteSystemUserKey($keyId, $encryptionModuleId) { |
|
175 | - $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
176 | - return !$this->view->file_exists($path) || $this->view->unlink($path); |
|
177 | - } |
|
178 | - |
|
179 | - /** |
|
180 | - * construct path to users key |
|
181 | - * |
|
182 | - * @param string $encryptionModuleId |
|
183 | - * @param string $keyId |
|
184 | - * @param string $uid |
|
185 | - * @return string |
|
186 | - */ |
|
187 | - protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) { |
|
188 | - |
|
189 | - if ($uid === null) { |
|
190 | - $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId; |
|
191 | - } else { |
|
192 | - $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/' |
|
193 | - . $encryptionModuleId . '/' . $uid . '.' . $keyId; |
|
194 | - } |
|
195 | - |
|
196 | - return \OC\Files\Filesystem::normalizePath($path); |
|
197 | - } |
|
198 | - |
|
199 | - /** |
|
200 | - * read key from hard disk |
|
201 | - * |
|
202 | - * @param string $path to key |
|
203 | - * @return string |
|
204 | - */ |
|
205 | - private function getKey($path) { |
|
206 | - |
|
207 | - $key = ''; |
|
208 | - |
|
209 | - if ($this->view->file_exists($path)) { |
|
210 | - if (isset($this->keyCache[$path])) { |
|
211 | - $key = $this->keyCache[$path]; |
|
212 | - } else { |
|
213 | - $key = $this->view->file_get_contents($path); |
|
214 | - $this->keyCache[$path] = $key; |
|
215 | - } |
|
216 | - } |
|
217 | - |
|
218 | - return $key; |
|
219 | - } |
|
220 | - |
|
221 | - /** |
|
222 | - * write key to disk |
|
223 | - * |
|
224 | - * |
|
225 | - * @param string $path path to key directory |
|
226 | - * @param string $key key |
|
227 | - * @return bool |
|
228 | - */ |
|
229 | - private function setKey($path, $key) { |
|
230 | - $this->keySetPreparation(dirname($path)); |
|
231 | - |
|
232 | - $result = $this->view->file_put_contents($path, $key); |
|
233 | - |
|
234 | - if (is_int($result) && $result > 0) { |
|
235 | - $this->keyCache[$path] = $key; |
|
236 | - return true; |
|
237 | - } |
|
238 | - |
|
239 | - return false; |
|
240 | - } |
|
241 | - |
|
242 | - /** |
|
243 | - * get path to key folder for a given file |
|
244 | - * |
|
245 | - * @param string $encryptionModuleId |
|
246 | - * @param string $path path to the file, relative to data/ |
|
247 | - * @return string |
|
248 | - */ |
|
249 | - private function getFileKeyDir($encryptionModuleId, $path) { |
|
250 | - |
|
251 | - list($owner, $filename) = $this->util->getUidAndFilename($path); |
|
252 | - |
|
253 | - // in case of system wide mount points the keys are stored directly in the data directory |
|
254 | - if ($this->util->isSystemWideMountPoint($filename, $owner)) { |
|
255 | - $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/'; |
|
256 | - } else { |
|
257 | - $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/'; |
|
258 | - } |
|
259 | - |
|
260 | - return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false); |
|
261 | - } |
|
262 | - |
|
263 | - /** |
|
264 | - * move keys if a file was renamed |
|
265 | - * |
|
266 | - * @param string $source |
|
267 | - * @param string $target |
|
268 | - * @return boolean |
|
269 | - */ |
|
270 | - public function renameKeys($source, $target) { |
|
271 | - |
|
272 | - $sourcePath = $this->getPathToKeys($source); |
|
273 | - $targetPath = $this->getPathToKeys($target); |
|
274 | - |
|
275 | - if ($this->view->file_exists($sourcePath)) { |
|
276 | - $this->keySetPreparation(dirname($targetPath)); |
|
277 | - $this->view->rename($sourcePath, $targetPath); |
|
278 | - |
|
279 | - return true; |
|
280 | - } |
|
281 | - |
|
282 | - return false; |
|
283 | - } |
|
284 | - |
|
285 | - |
|
286 | - /** |
|
287 | - * copy keys if a file was renamed |
|
288 | - * |
|
289 | - * @param string $source |
|
290 | - * @param string $target |
|
291 | - * @return boolean |
|
292 | - */ |
|
293 | - public function copyKeys($source, $target) { |
|
294 | - |
|
295 | - $sourcePath = $this->getPathToKeys($source); |
|
296 | - $targetPath = $this->getPathToKeys($target); |
|
297 | - |
|
298 | - if ($this->view->file_exists($sourcePath)) { |
|
299 | - $this->keySetPreparation(dirname($targetPath)); |
|
300 | - $this->view->copy($sourcePath, $targetPath); |
|
301 | - return true; |
|
302 | - } |
|
303 | - |
|
304 | - return false; |
|
305 | - } |
|
306 | - |
|
307 | - /** |
|
308 | - * backup keys of a given encryption module |
|
309 | - * |
|
310 | - * @param string $encryptionModuleId |
|
311 | - * @param string $purpose |
|
312 | - * @param string $uid |
|
313 | - * @return bool |
|
314 | - * @since 12.0.0 |
|
315 | - */ |
|
316 | - public function backupUserKeys($encryptionModuleId, $purpose, $uid) { |
|
317 | - $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId; |
|
318 | - $backupDir = $uid . $this->backup_base_dir; |
|
319 | - if (!$this->view->file_exists($backupDir)) { |
|
320 | - $this->view->mkdir($backupDir); |
|
321 | - } |
|
322 | - |
|
323 | - $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp(); |
|
324 | - $this->view->mkdir($backupDir); |
|
325 | - |
|
326 | - return $this->view->copy($source, $backupDir); |
|
327 | - } |
|
328 | - |
|
329 | - /** |
|
330 | - * get the current timestamp |
|
331 | - * |
|
332 | - * @return int |
|
333 | - */ |
|
334 | - protected function getTimestamp() { |
|
335 | - return time(); |
|
336 | - } |
|
337 | - |
|
338 | - /** |
|
339 | - * get system wide path and detect mount points |
|
340 | - * |
|
341 | - * @param string $path |
|
342 | - * @return string |
|
343 | - */ |
|
344 | - protected function getPathToKeys($path) { |
|
345 | - list($owner, $relativePath) = $this->util->getUidAndFilename($path); |
|
346 | - $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner); |
|
347 | - |
|
348 | - if ($systemWideMountPoint) { |
|
349 | - $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/'; |
|
350 | - } else { |
|
351 | - $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/'; |
|
352 | - } |
|
353 | - |
|
354 | - return Filesystem::normalizePath($systemPath, false); |
|
355 | - } |
|
356 | - |
|
357 | - /** |
|
358 | - * Make preparations to filesystem for saving a key file |
|
359 | - * |
|
360 | - * @param string $path relative to the views root |
|
361 | - */ |
|
362 | - protected function keySetPreparation($path) { |
|
363 | - // If the file resides within a subdirectory, create it |
|
364 | - if (!$this->view->file_exists($path)) { |
|
365 | - $sub_dirs = explode('/', ltrim($path, '/')); |
|
366 | - $dir = ''; |
|
367 | - foreach ($sub_dirs as $sub_dir) { |
|
368 | - $dir .= '/' . $sub_dir; |
|
369 | - if (!$this->view->is_dir($dir)) { |
|
370 | - $this->view->mkdir($dir); |
|
371 | - } |
|
372 | - } |
|
373 | - } |
|
374 | - } |
|
35 | + // hidden file which indicate that the folder is a valid key storage |
|
36 | + const KEY_STORAGE_MARKER = '.oc_key_storage'; |
|
37 | + |
|
38 | + /** @var View */ |
|
39 | + private $view; |
|
40 | + |
|
41 | + /** @var Util */ |
|
42 | + private $util; |
|
43 | + |
|
44 | + // base dir where all the file related keys are stored |
|
45 | + /** @var string */ |
|
46 | + private $keys_base_dir; |
|
47 | + |
|
48 | + // root of the key storage default is empty which means that we use the data folder |
|
49 | + /** @var string */ |
|
50 | + private $root_dir; |
|
51 | + |
|
52 | + /** @var string */ |
|
53 | + private $encryption_base_dir; |
|
54 | + |
|
55 | + /** @var string */ |
|
56 | + private $backup_base_dir; |
|
57 | + |
|
58 | + /** @var array */ |
|
59 | + private $keyCache = []; |
|
60 | + |
|
61 | + /** |
|
62 | + * @param View $view |
|
63 | + * @param Util $util |
|
64 | + */ |
|
65 | + public function __construct(View $view, Util $util) { |
|
66 | + $this->view = $view; |
|
67 | + $this->util = $util; |
|
68 | + |
|
69 | + $this->encryption_base_dir = '/files_encryption'; |
|
70 | + $this->keys_base_dir = $this->encryption_base_dir .'/keys'; |
|
71 | + $this->backup_base_dir = $this->encryption_base_dir .'/backup'; |
|
72 | + $this->root_dir = $this->util->getKeyStorageRoot(); |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * @inheritdoc |
|
77 | + */ |
|
78 | + public function getUserKey($uid, $keyId, $encryptionModuleId) { |
|
79 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
80 | + return $this->getKey($path); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * @inheritdoc |
|
85 | + */ |
|
86 | + public function getFileKey($path, $keyId, $encryptionModuleId) { |
|
87 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
88 | + $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile); |
|
89 | + $key = $this->getKey($keyDir . $keyId); |
|
90 | + |
|
91 | + if ($key === '' && $realFile !== $path) { |
|
92 | + // Check if the part file has keys and use them, if no normal keys |
|
93 | + // exist. This is required to fix copyBetweenStorage() when we |
|
94 | + // rename a .part file over storage borders. |
|
95 | + $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
96 | + $key = $this->getKey($keyDir . $keyId); |
|
97 | + } |
|
98 | + |
|
99 | + return $key; |
|
100 | + } |
|
101 | + |
|
102 | + /** |
|
103 | + * @inheritdoc |
|
104 | + */ |
|
105 | + public function getSystemUserKey($keyId, $encryptionModuleId) { |
|
106 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
107 | + return $this->getKey($path); |
|
108 | + } |
|
109 | + |
|
110 | + /** |
|
111 | + * @inheritdoc |
|
112 | + */ |
|
113 | + public function setUserKey($uid, $keyId, $key, $encryptionModuleId) { |
|
114 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
115 | + return $this->setKey($path, $key); |
|
116 | + } |
|
117 | + |
|
118 | + /** |
|
119 | + * @inheritdoc |
|
120 | + */ |
|
121 | + public function setFileKey($path, $keyId, $key, $encryptionModuleId) { |
|
122 | + $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
123 | + return $this->setKey($keyDir . $keyId, $key); |
|
124 | + } |
|
125 | + |
|
126 | + /** |
|
127 | + * @inheritdoc |
|
128 | + */ |
|
129 | + public function setSystemUserKey($keyId, $key, $encryptionModuleId) { |
|
130 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
131 | + return $this->setKey($path, $key); |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * @inheritdoc |
|
136 | + */ |
|
137 | + public function deleteUserKey($uid, $keyId, $encryptionModuleId) { |
|
138 | + try { |
|
139 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid); |
|
140 | + return !$this->view->file_exists($path) || $this->view->unlink($path); |
|
141 | + } catch (NoUserException $e) { |
|
142 | + // this exception can come from initMountPoints() from setupUserMounts() |
|
143 | + // for a deleted user. |
|
144 | + // |
|
145 | + // It means, that: |
|
146 | + // - we are not running in alternative storage mode because we don't call |
|
147 | + // initMountPoints() in that mode |
|
148 | + // - the keys were in the user's home but since the user was deleted, the |
|
149 | + // user's home is gone and so are the keys |
|
150 | + // |
|
151 | + // So there is nothing to do, just ignore. |
|
152 | + } |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * @inheritdoc |
|
157 | + */ |
|
158 | + public function deleteFileKey($path, $keyId, $encryptionModuleId) { |
|
159 | + $keyDir = $this->getFileKeyDir($encryptionModuleId, $path); |
|
160 | + return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * @inheritdoc |
|
165 | + */ |
|
166 | + public function deleteAllFileKeys($path) { |
|
167 | + $keyDir = $this->getFileKeyDir('', $path); |
|
168 | + return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir); |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * @inheritdoc |
|
173 | + */ |
|
174 | + public function deleteSystemUserKey($keyId, $encryptionModuleId) { |
|
175 | + $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null); |
|
176 | + return !$this->view->file_exists($path) || $this->view->unlink($path); |
|
177 | + } |
|
178 | + |
|
179 | + /** |
|
180 | + * construct path to users key |
|
181 | + * |
|
182 | + * @param string $encryptionModuleId |
|
183 | + * @param string $keyId |
|
184 | + * @param string $uid |
|
185 | + * @return string |
|
186 | + */ |
|
187 | + protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) { |
|
188 | + |
|
189 | + if ($uid === null) { |
|
190 | + $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId; |
|
191 | + } else { |
|
192 | + $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/' |
|
193 | + . $encryptionModuleId . '/' . $uid . '.' . $keyId; |
|
194 | + } |
|
195 | + |
|
196 | + return \OC\Files\Filesystem::normalizePath($path); |
|
197 | + } |
|
198 | + |
|
199 | + /** |
|
200 | + * read key from hard disk |
|
201 | + * |
|
202 | + * @param string $path to key |
|
203 | + * @return string |
|
204 | + */ |
|
205 | + private function getKey($path) { |
|
206 | + |
|
207 | + $key = ''; |
|
208 | + |
|
209 | + if ($this->view->file_exists($path)) { |
|
210 | + if (isset($this->keyCache[$path])) { |
|
211 | + $key = $this->keyCache[$path]; |
|
212 | + } else { |
|
213 | + $key = $this->view->file_get_contents($path); |
|
214 | + $this->keyCache[$path] = $key; |
|
215 | + } |
|
216 | + } |
|
217 | + |
|
218 | + return $key; |
|
219 | + } |
|
220 | + |
|
221 | + /** |
|
222 | + * write key to disk |
|
223 | + * |
|
224 | + * |
|
225 | + * @param string $path path to key directory |
|
226 | + * @param string $key key |
|
227 | + * @return bool |
|
228 | + */ |
|
229 | + private function setKey($path, $key) { |
|
230 | + $this->keySetPreparation(dirname($path)); |
|
231 | + |
|
232 | + $result = $this->view->file_put_contents($path, $key); |
|
233 | + |
|
234 | + if (is_int($result) && $result > 0) { |
|
235 | + $this->keyCache[$path] = $key; |
|
236 | + return true; |
|
237 | + } |
|
238 | + |
|
239 | + return false; |
|
240 | + } |
|
241 | + |
|
242 | + /** |
|
243 | + * get path to key folder for a given file |
|
244 | + * |
|
245 | + * @param string $encryptionModuleId |
|
246 | + * @param string $path path to the file, relative to data/ |
|
247 | + * @return string |
|
248 | + */ |
|
249 | + private function getFileKeyDir($encryptionModuleId, $path) { |
|
250 | + |
|
251 | + list($owner, $filename) = $this->util->getUidAndFilename($path); |
|
252 | + |
|
253 | + // in case of system wide mount points the keys are stored directly in the data directory |
|
254 | + if ($this->util->isSystemWideMountPoint($filename, $owner)) { |
|
255 | + $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/'; |
|
256 | + } else { |
|
257 | + $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/'; |
|
258 | + } |
|
259 | + |
|
260 | + return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false); |
|
261 | + } |
|
262 | + |
|
263 | + /** |
|
264 | + * move keys if a file was renamed |
|
265 | + * |
|
266 | + * @param string $source |
|
267 | + * @param string $target |
|
268 | + * @return boolean |
|
269 | + */ |
|
270 | + public function renameKeys($source, $target) { |
|
271 | + |
|
272 | + $sourcePath = $this->getPathToKeys($source); |
|
273 | + $targetPath = $this->getPathToKeys($target); |
|
274 | + |
|
275 | + if ($this->view->file_exists($sourcePath)) { |
|
276 | + $this->keySetPreparation(dirname($targetPath)); |
|
277 | + $this->view->rename($sourcePath, $targetPath); |
|
278 | + |
|
279 | + return true; |
|
280 | + } |
|
281 | + |
|
282 | + return false; |
|
283 | + } |
|
284 | + |
|
285 | + |
|
286 | + /** |
|
287 | + * copy keys if a file was renamed |
|
288 | + * |
|
289 | + * @param string $source |
|
290 | + * @param string $target |
|
291 | + * @return boolean |
|
292 | + */ |
|
293 | + public function copyKeys($source, $target) { |
|
294 | + |
|
295 | + $sourcePath = $this->getPathToKeys($source); |
|
296 | + $targetPath = $this->getPathToKeys($target); |
|
297 | + |
|
298 | + if ($this->view->file_exists($sourcePath)) { |
|
299 | + $this->keySetPreparation(dirname($targetPath)); |
|
300 | + $this->view->copy($sourcePath, $targetPath); |
|
301 | + return true; |
|
302 | + } |
|
303 | + |
|
304 | + return false; |
|
305 | + } |
|
306 | + |
|
307 | + /** |
|
308 | + * backup keys of a given encryption module |
|
309 | + * |
|
310 | + * @param string $encryptionModuleId |
|
311 | + * @param string $purpose |
|
312 | + * @param string $uid |
|
313 | + * @return bool |
|
314 | + * @since 12.0.0 |
|
315 | + */ |
|
316 | + public function backupUserKeys($encryptionModuleId, $purpose, $uid) { |
|
317 | + $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId; |
|
318 | + $backupDir = $uid . $this->backup_base_dir; |
|
319 | + if (!$this->view->file_exists($backupDir)) { |
|
320 | + $this->view->mkdir($backupDir); |
|
321 | + } |
|
322 | + |
|
323 | + $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp(); |
|
324 | + $this->view->mkdir($backupDir); |
|
325 | + |
|
326 | + return $this->view->copy($source, $backupDir); |
|
327 | + } |
|
328 | + |
|
329 | + /** |
|
330 | + * get the current timestamp |
|
331 | + * |
|
332 | + * @return int |
|
333 | + */ |
|
334 | + protected function getTimestamp() { |
|
335 | + return time(); |
|
336 | + } |
|
337 | + |
|
338 | + /** |
|
339 | + * get system wide path and detect mount points |
|
340 | + * |
|
341 | + * @param string $path |
|
342 | + * @return string |
|
343 | + */ |
|
344 | + protected function getPathToKeys($path) { |
|
345 | + list($owner, $relativePath) = $this->util->getUidAndFilename($path); |
|
346 | + $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner); |
|
347 | + |
|
348 | + if ($systemWideMountPoint) { |
|
349 | + $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/'; |
|
350 | + } else { |
|
351 | + $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/'; |
|
352 | + } |
|
353 | + |
|
354 | + return Filesystem::normalizePath($systemPath, false); |
|
355 | + } |
|
356 | + |
|
357 | + /** |
|
358 | + * Make preparations to filesystem for saving a key file |
|
359 | + * |
|
360 | + * @param string $path relative to the views root |
|
361 | + */ |
|
362 | + protected function keySetPreparation($path) { |
|
363 | + // If the file resides within a subdirectory, create it |
|
364 | + if (!$this->view->file_exists($path)) { |
|
365 | + $sub_dirs = explode('/', ltrim($path, '/')); |
|
366 | + $dir = ''; |
|
367 | + foreach ($sub_dirs as $sub_dir) { |
|
368 | + $dir .= '/' . $sub_dir; |
|
369 | + if (!$this->view->is_dir($dir)) { |
|
370 | + $this->view->mkdir($dir); |
|
371 | + } |
|
372 | + } |
|
373 | + } |
|
374 | + } |
|
375 | 375 | |
376 | 376 | } |
@@ -274,7 +274,7 @@ |
||
274 | 274 | } |
275 | 275 | |
276 | 276 | // check if key storage is mounted correctly |
277 | - if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) { |
|
277 | + if ($this->rootView->file_exists($rootDir.'/'.Storage::KEY_STORAGE_MARKER)) { |
|
278 | 278 | return true; |
279 | 279 | } |
280 | 280 |
@@ -39,242 +39,242 @@ |
||
39 | 39 | |
40 | 40 | class Manager implements IManager { |
41 | 41 | |
42 | - /** @var array */ |
|
43 | - protected $encryptionModules; |
|
44 | - |
|
45 | - /** @var IConfig */ |
|
46 | - protected $config; |
|
47 | - |
|
48 | - /** @var ILogger */ |
|
49 | - protected $logger; |
|
50 | - |
|
51 | - /** @var Il10n */ |
|
52 | - protected $l; |
|
53 | - |
|
54 | - /** @var View */ |
|
55 | - protected $rootView; |
|
56 | - |
|
57 | - /** @var Util */ |
|
58 | - protected $util; |
|
59 | - |
|
60 | - /** @var ArrayCache */ |
|
61 | - protected $arrayCache; |
|
62 | - |
|
63 | - /** |
|
64 | - * @param IConfig $config |
|
65 | - * @param ILogger $logger |
|
66 | - * @param IL10N $l10n |
|
67 | - * @param View $rootView |
|
68 | - * @param Util $util |
|
69 | - * @param ArrayCache $arrayCache |
|
70 | - */ |
|
71 | - public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) { |
|
72 | - $this->encryptionModules = array(); |
|
73 | - $this->config = $config; |
|
74 | - $this->logger = $logger; |
|
75 | - $this->l = $l10n; |
|
76 | - $this->rootView = $rootView; |
|
77 | - $this->util = $util; |
|
78 | - $this->arrayCache = $arrayCache; |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * Check if encryption is enabled |
|
83 | - * |
|
84 | - * @return bool true if enabled, false if not |
|
85 | - */ |
|
86 | - public function isEnabled() { |
|
87 | - |
|
88 | - $installed = $this->config->getSystemValue('installed', false); |
|
89 | - if (!$installed) { |
|
90 | - return false; |
|
91 | - } |
|
92 | - |
|
93 | - $enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no'); |
|
94 | - return $enabled === 'yes'; |
|
95 | - } |
|
96 | - |
|
97 | - /** |
|
98 | - * check if new encryption is ready |
|
99 | - * |
|
100 | - * @return bool |
|
101 | - * @throws ServiceUnavailableException |
|
102 | - */ |
|
103 | - public function isReady() { |
|
104 | - |
|
105 | - if ($this->isKeyStorageReady() === false) { |
|
106 | - throw new ServiceUnavailableException('Key Storage is not ready'); |
|
107 | - } |
|
108 | - |
|
109 | - return true; |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * @param string $user |
|
114 | - */ |
|
115 | - public function isReadyForUser($user) { |
|
116 | - if (!$this->isReady()) { |
|
117 | - return false; |
|
118 | - } |
|
119 | - |
|
120 | - foreach ($this->getEncryptionModules() as $module) { |
|
121 | - /** @var IEncryptionModule $m */ |
|
122 | - $m = call_user_func($module['callback']); |
|
123 | - if (!$m->isReadyForUser($user)) { |
|
124 | - return false; |
|
125 | - } |
|
126 | - } |
|
127 | - |
|
128 | - return true; |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * Registers an callback function which must return an encryption module instance |
|
133 | - * |
|
134 | - * @param string $id |
|
135 | - * @param string $displayName |
|
136 | - * @param callable $callback |
|
137 | - * @throws Exceptions\ModuleAlreadyExistsException |
|
138 | - */ |
|
139 | - public function registerEncryptionModule($id, $displayName, callable $callback) { |
|
140 | - |
|
141 | - if (isset($this->encryptionModules[$id])) { |
|
142 | - throw new Exceptions\ModuleAlreadyExistsException($id, $displayName); |
|
143 | - } |
|
144 | - |
|
145 | - $this->encryptionModules[$id] = [ |
|
146 | - 'id' => $id, |
|
147 | - 'displayName' => $displayName, |
|
148 | - 'callback' => $callback, |
|
149 | - ]; |
|
150 | - |
|
151 | - $defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId(); |
|
152 | - |
|
153 | - if (empty($defaultEncryptionModuleId)) { |
|
154 | - $this->setDefaultEncryptionModule($id); |
|
155 | - } |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * Unregisters an encryption module |
|
160 | - * |
|
161 | - * @param string $moduleId |
|
162 | - */ |
|
163 | - public function unregisterEncryptionModule($moduleId) { |
|
164 | - unset($this->encryptionModules[$moduleId]); |
|
165 | - } |
|
166 | - |
|
167 | - /** |
|
168 | - * get a list of all encryption modules |
|
169 | - * |
|
170 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
171 | - */ |
|
172 | - public function getEncryptionModules() { |
|
173 | - return $this->encryptionModules; |
|
174 | - } |
|
175 | - |
|
176 | - /** |
|
177 | - * get a specific encryption module |
|
178 | - * |
|
179 | - * @param string $moduleId |
|
180 | - * @return IEncryptionModule |
|
181 | - * @throws Exceptions\ModuleDoesNotExistsException |
|
182 | - */ |
|
183 | - public function getEncryptionModule($moduleId = '') { |
|
184 | - if (!empty($moduleId)) { |
|
185 | - if (isset($this->encryptionModules[$moduleId])) { |
|
186 | - return call_user_func($this->encryptionModules[$moduleId]['callback']); |
|
187 | - } else { |
|
188 | - $message = "Module with ID: $moduleId does not exist."; |
|
189 | - $hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]); |
|
190 | - throw new Exceptions\ModuleDoesNotExistsException($message, $hint); |
|
191 | - } |
|
192 | - } else { |
|
193 | - return $this->getDefaultEncryptionModule(); |
|
194 | - } |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * get default encryption module |
|
199 | - * |
|
200 | - * @return \OCP\Encryption\IEncryptionModule |
|
201 | - * @throws Exceptions\ModuleDoesNotExistsException |
|
202 | - */ |
|
203 | - protected function getDefaultEncryptionModule() { |
|
204 | - $defaultModuleId = $this->getDefaultEncryptionModuleId(); |
|
205 | - if (!empty($defaultModuleId)) { |
|
206 | - if (isset($this->encryptionModules[$defaultModuleId])) { |
|
207 | - return call_user_func($this->encryptionModules[$defaultModuleId]['callback']); |
|
208 | - } else { |
|
209 | - $message = 'Default encryption module not loaded'; |
|
210 | - throw new Exceptions\ModuleDoesNotExistsException($message); |
|
211 | - } |
|
212 | - } else { |
|
213 | - $message = 'No default encryption module defined'; |
|
214 | - throw new Exceptions\ModuleDoesNotExistsException($message); |
|
215 | - } |
|
216 | - |
|
217 | - } |
|
218 | - |
|
219 | - /** |
|
220 | - * set default encryption module Id |
|
221 | - * |
|
222 | - * @param string $moduleId |
|
223 | - * @return bool |
|
224 | - */ |
|
225 | - public function setDefaultEncryptionModule($moduleId) { |
|
226 | - try { |
|
227 | - $this->getEncryptionModule($moduleId); |
|
228 | - } catch (\Exception $e) { |
|
229 | - return false; |
|
230 | - } |
|
231 | - |
|
232 | - $this->config->setAppValue('core', 'default_encryption_module', $moduleId); |
|
233 | - return true; |
|
234 | - } |
|
235 | - |
|
236 | - /** |
|
237 | - * get default encryption module Id |
|
238 | - * |
|
239 | - * @return string |
|
240 | - */ |
|
241 | - public function getDefaultEncryptionModuleId() { |
|
242 | - return $this->config->getAppValue('core', 'default_encryption_module'); |
|
243 | - } |
|
244 | - |
|
245 | - /** |
|
246 | - * Add storage wrapper |
|
247 | - */ |
|
248 | - public function setupStorage() { |
|
249 | - // If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper |
|
250 | - if (!empty($this->encryptionModules) || $this->isEnabled()) { |
|
251 | - $encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger); |
|
252 | - Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2); |
|
253 | - } |
|
254 | - } |
|
255 | - |
|
256 | - |
|
257 | - /** |
|
258 | - * check if key storage is ready |
|
259 | - * |
|
260 | - * @return bool |
|
261 | - */ |
|
262 | - protected function isKeyStorageReady() { |
|
263 | - |
|
264 | - $rootDir = $this->util->getKeyStorageRoot(); |
|
265 | - |
|
266 | - // the default root is always valid |
|
267 | - if ($rootDir === '') { |
|
268 | - return true; |
|
269 | - } |
|
270 | - |
|
271 | - // check if key storage is mounted correctly |
|
272 | - if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) { |
|
273 | - return true; |
|
274 | - } |
|
275 | - |
|
276 | - return false; |
|
277 | - } |
|
42 | + /** @var array */ |
|
43 | + protected $encryptionModules; |
|
44 | + |
|
45 | + /** @var IConfig */ |
|
46 | + protected $config; |
|
47 | + |
|
48 | + /** @var ILogger */ |
|
49 | + protected $logger; |
|
50 | + |
|
51 | + /** @var Il10n */ |
|
52 | + protected $l; |
|
53 | + |
|
54 | + /** @var View */ |
|
55 | + protected $rootView; |
|
56 | + |
|
57 | + /** @var Util */ |
|
58 | + protected $util; |
|
59 | + |
|
60 | + /** @var ArrayCache */ |
|
61 | + protected $arrayCache; |
|
62 | + |
|
63 | + /** |
|
64 | + * @param IConfig $config |
|
65 | + * @param ILogger $logger |
|
66 | + * @param IL10N $l10n |
|
67 | + * @param View $rootView |
|
68 | + * @param Util $util |
|
69 | + * @param ArrayCache $arrayCache |
|
70 | + */ |
|
71 | + public function __construct(IConfig $config, ILogger $logger, IL10N $l10n, View $rootView, Util $util, ArrayCache $arrayCache) { |
|
72 | + $this->encryptionModules = array(); |
|
73 | + $this->config = $config; |
|
74 | + $this->logger = $logger; |
|
75 | + $this->l = $l10n; |
|
76 | + $this->rootView = $rootView; |
|
77 | + $this->util = $util; |
|
78 | + $this->arrayCache = $arrayCache; |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * Check if encryption is enabled |
|
83 | + * |
|
84 | + * @return bool true if enabled, false if not |
|
85 | + */ |
|
86 | + public function isEnabled() { |
|
87 | + |
|
88 | + $installed = $this->config->getSystemValue('installed', false); |
|
89 | + if (!$installed) { |
|
90 | + return false; |
|
91 | + } |
|
92 | + |
|
93 | + $enabled = $this->config->getAppValue('core', 'encryption_enabled', 'no'); |
|
94 | + return $enabled === 'yes'; |
|
95 | + } |
|
96 | + |
|
97 | + /** |
|
98 | + * check if new encryption is ready |
|
99 | + * |
|
100 | + * @return bool |
|
101 | + * @throws ServiceUnavailableException |
|
102 | + */ |
|
103 | + public function isReady() { |
|
104 | + |
|
105 | + if ($this->isKeyStorageReady() === false) { |
|
106 | + throw new ServiceUnavailableException('Key Storage is not ready'); |
|
107 | + } |
|
108 | + |
|
109 | + return true; |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * @param string $user |
|
114 | + */ |
|
115 | + public function isReadyForUser($user) { |
|
116 | + if (!$this->isReady()) { |
|
117 | + return false; |
|
118 | + } |
|
119 | + |
|
120 | + foreach ($this->getEncryptionModules() as $module) { |
|
121 | + /** @var IEncryptionModule $m */ |
|
122 | + $m = call_user_func($module['callback']); |
|
123 | + if (!$m->isReadyForUser($user)) { |
|
124 | + return false; |
|
125 | + } |
|
126 | + } |
|
127 | + |
|
128 | + return true; |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * Registers an callback function which must return an encryption module instance |
|
133 | + * |
|
134 | + * @param string $id |
|
135 | + * @param string $displayName |
|
136 | + * @param callable $callback |
|
137 | + * @throws Exceptions\ModuleAlreadyExistsException |
|
138 | + */ |
|
139 | + public function registerEncryptionModule($id, $displayName, callable $callback) { |
|
140 | + |
|
141 | + if (isset($this->encryptionModules[$id])) { |
|
142 | + throw new Exceptions\ModuleAlreadyExistsException($id, $displayName); |
|
143 | + } |
|
144 | + |
|
145 | + $this->encryptionModules[$id] = [ |
|
146 | + 'id' => $id, |
|
147 | + 'displayName' => $displayName, |
|
148 | + 'callback' => $callback, |
|
149 | + ]; |
|
150 | + |
|
151 | + $defaultEncryptionModuleId = $this->getDefaultEncryptionModuleId(); |
|
152 | + |
|
153 | + if (empty($defaultEncryptionModuleId)) { |
|
154 | + $this->setDefaultEncryptionModule($id); |
|
155 | + } |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * Unregisters an encryption module |
|
160 | + * |
|
161 | + * @param string $moduleId |
|
162 | + */ |
|
163 | + public function unregisterEncryptionModule($moduleId) { |
|
164 | + unset($this->encryptionModules[$moduleId]); |
|
165 | + } |
|
166 | + |
|
167 | + /** |
|
168 | + * get a list of all encryption modules |
|
169 | + * |
|
170 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
171 | + */ |
|
172 | + public function getEncryptionModules() { |
|
173 | + return $this->encryptionModules; |
|
174 | + } |
|
175 | + |
|
176 | + /** |
|
177 | + * get a specific encryption module |
|
178 | + * |
|
179 | + * @param string $moduleId |
|
180 | + * @return IEncryptionModule |
|
181 | + * @throws Exceptions\ModuleDoesNotExistsException |
|
182 | + */ |
|
183 | + public function getEncryptionModule($moduleId = '') { |
|
184 | + if (!empty($moduleId)) { |
|
185 | + if (isset($this->encryptionModules[$moduleId])) { |
|
186 | + return call_user_func($this->encryptionModules[$moduleId]['callback']); |
|
187 | + } else { |
|
188 | + $message = "Module with ID: $moduleId does not exist."; |
|
189 | + $hint = $this->l->t('Module with ID: %s does not exist. Please enable it in your apps settings or contact your administrator.', [$moduleId]); |
|
190 | + throw new Exceptions\ModuleDoesNotExistsException($message, $hint); |
|
191 | + } |
|
192 | + } else { |
|
193 | + return $this->getDefaultEncryptionModule(); |
|
194 | + } |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * get default encryption module |
|
199 | + * |
|
200 | + * @return \OCP\Encryption\IEncryptionModule |
|
201 | + * @throws Exceptions\ModuleDoesNotExistsException |
|
202 | + */ |
|
203 | + protected function getDefaultEncryptionModule() { |
|
204 | + $defaultModuleId = $this->getDefaultEncryptionModuleId(); |
|
205 | + if (!empty($defaultModuleId)) { |
|
206 | + if (isset($this->encryptionModules[$defaultModuleId])) { |
|
207 | + return call_user_func($this->encryptionModules[$defaultModuleId]['callback']); |
|
208 | + } else { |
|
209 | + $message = 'Default encryption module not loaded'; |
|
210 | + throw new Exceptions\ModuleDoesNotExistsException($message); |
|
211 | + } |
|
212 | + } else { |
|
213 | + $message = 'No default encryption module defined'; |
|
214 | + throw new Exceptions\ModuleDoesNotExistsException($message); |
|
215 | + } |
|
216 | + |
|
217 | + } |
|
218 | + |
|
219 | + /** |
|
220 | + * set default encryption module Id |
|
221 | + * |
|
222 | + * @param string $moduleId |
|
223 | + * @return bool |
|
224 | + */ |
|
225 | + public function setDefaultEncryptionModule($moduleId) { |
|
226 | + try { |
|
227 | + $this->getEncryptionModule($moduleId); |
|
228 | + } catch (\Exception $e) { |
|
229 | + return false; |
|
230 | + } |
|
231 | + |
|
232 | + $this->config->setAppValue('core', 'default_encryption_module', $moduleId); |
|
233 | + return true; |
|
234 | + } |
|
235 | + |
|
236 | + /** |
|
237 | + * get default encryption module Id |
|
238 | + * |
|
239 | + * @return string |
|
240 | + */ |
|
241 | + public function getDefaultEncryptionModuleId() { |
|
242 | + return $this->config->getAppValue('core', 'default_encryption_module'); |
|
243 | + } |
|
244 | + |
|
245 | + /** |
|
246 | + * Add storage wrapper |
|
247 | + */ |
|
248 | + public function setupStorage() { |
|
249 | + // If encryption is disabled and there are no loaded modules it makes no sense to load the wrapper |
|
250 | + if (!empty($this->encryptionModules) || $this->isEnabled()) { |
|
251 | + $encryptionWrapper = new EncryptionWrapper($this->arrayCache, $this, $this->logger); |
|
252 | + Filesystem::addStorageWrapper('oc_encryption', array($encryptionWrapper, 'wrapStorage'), 2); |
|
253 | + } |
|
254 | + } |
|
255 | + |
|
256 | + |
|
257 | + /** |
|
258 | + * check if key storage is ready |
|
259 | + * |
|
260 | + * @return bool |
|
261 | + */ |
|
262 | + protected function isKeyStorageReady() { |
|
263 | + |
|
264 | + $rootDir = $this->util->getKeyStorageRoot(); |
|
265 | + |
|
266 | + // the default root is always valid |
|
267 | + if ($rootDir === '') { |
|
268 | + return true; |
|
269 | + } |
|
270 | + |
|
271 | + // check if key storage is mounted correctly |
|
272 | + if ($this->rootView->file_exists($rootDir . '/' . Storage::KEY_STORAGE_MARKER)) { |
|
273 | + return true; |
|
274 | + } |
|
275 | + |
|
276 | + return false; |
|
277 | + } |
|
278 | 278 | |
279 | 279 | |
280 | 280 | } |