Blame view

sources/apps/files_encryption/lib/proxy.php 11 KB
03e52840d   Kload   Init
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
  <?php
  
  /**
   * ownCloud
   *
   * @author Sam Tuke, Robin Appelman
   * @copyright 2012 Sam Tuke samtuke@owncloud.com, Robin Appelman
   * icewind1991@gmail.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * @brief Encryption proxy which handles filesystem operations before and after
   *        execution and encrypts, and handles keyfiles accordingly. Used for
   *        webui.
   */
  
  namespace OCA\Encryption;
  
  /**
   * Class Proxy
   * @package OCA\Encryption
   */
  class Proxy extends \OC_FileProxy {
  
  	private static $blackList = null; //mimetypes blacklisted from encryption
a293d369c   Kload   Update sources to...
40
41
  	private static $unencryptedSizes = array(); // remember unencrypted size
  	private static $fopenMode = array(); // remember the fopen mode
03e52840d   Kload   Init
42
43
44
45
46
47
48
49
50
  
  	/**
  	 * Check if a file requires encryption
  	 * @param string $path
  	 * @return bool
  	 *
  	 * Tests if server side encryption is enabled, and file is allowed by blacklists
  	 */
  	private static function shouldEncrypt($path) {
31b7f2792   Kload   Upgrade to ownclo...
51
52
53
54
  		$userId = Helper::getUser($path);
  
  		if (\OCP\App::isEnabled('files_encryption') === false || Crypt::mode() !== 'server' ||
  				strpos($path, '/' . $userId . '/files') !== 0) {
03e52840d   Kload   Init
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
  			return false;
  		}
  
  		if (is_null(self::$blackList)) {
  			self::$blackList = explode(',', \OCP\Config::getAppValue('files_encryption', 'type_blacklist', ''));
  		}
  
  		if (Crypt::isCatfileContent($path)) {
  			return true;
  		}
  
  		$extension = substr($path, strrpos($path, '.') + 1);
  
  		if (array_search($extension, self::$blackList) === false) {
  			return true;
  		}
  
  		return false;
  	}
  
  	/**
  	 * @param $path
  	 * @param $data
  	 * @return bool
  	 */
  	public function preFile_put_contents($path, &$data) {
  
  		if (self::shouldEncrypt($path)) {
  
  			if (!is_resource($data)) {
  
  				// get root view
  				$view = new \OC_FilesystemView('/');
  
  				// get relative path
  				$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
  
  				if (!isset($relativePath)) {
  					return true;
  				}
31b7f2792   Kload   Upgrade to ownclo...
95
96
97
98
99
100
101
  				// create random cache folder
  				$cacheFolder = rand();
  				$path_slices = explode('/', \OC_Filesystem::normalizePath($path));
  				$path_slices[2] = "cache/".$cacheFolder;
  				$tmpPath = implode('/', $path_slices);
  
  				$handle = fopen('crypt://' . $tmpPath, 'w');
03e52840d   Kload   Init
102
103
104
105
106
107
108
109
110
111
112
113
114
  				if (is_resource($handle)) {
  
  					// write data to stream
  					fwrite($handle, $data);
  
  					// close stream
  					fclose($handle);
  
  					// disable encryption proxy to prevent recursive calls
  					$proxyStatus = \OC_FileProxy::$enabled;
  					\OC_FileProxy::$enabled = false;
  
  					// get encrypted content
31b7f2792   Kload   Upgrade to ownclo...
115
  					$data = $view->file_get_contents($tmpPath);
03e52840d   Kload   Init
116

a293d369c   Kload   Update sources to...
117
118
119
120
121
122
  					// store new unenecrypted size so that it can be updated
  					// in the post proxy
  					$tmpFileInfo = $view->getFileInfo($tmpPath);
  					if ( isset($tmpFileInfo['size']) ) {
  						self::$unencryptedSizes[\OC_Filesystem::normalizePath($path)] = $tmpFileInfo['size'];
  					}
03e52840d   Kload   Init
123
  					// remove our temp file
31b7f2792   Kload   Upgrade to ownclo...
124
  					$view->deleteAll('/' . \OCP\User::getUser() . '/cache/' . $cacheFolder);
03e52840d   Kload   Init
125
126
127
  
  					// re-enable proxy - our work is done
  					\OC_FileProxy::$enabled = $proxyStatus;
837968727   Kload   [enh] Upgrade to ...
128
129
  				} else {
  					return false;
03e52840d   Kload   Init
130
131
132
133
134
135
136
137
138
  				}
  			}
  		}
  
  		return true;
  
  	}
  
  	/**
a293d369c   Kload   Update sources to...
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
  	 * @brief update file cache with the new unencrypted size after file was written
  	 * @param string $path
  	 * @param mixed $result
  	 * @return mixed
  	 */
  	public function postFile_put_contents($path, $result) {
  		$normalizedPath = \OC_Filesystem::normalizePath($path);
  		if ( isset(self::$unencryptedSizes[$normalizedPath]) ) {
  			$view = new \OC_FilesystemView('/');
  			$view->putFileInfo($normalizedPath,
  					array('encrypted' => true, 'unencrypted_size' => self::$unencryptedSizes[$normalizedPath]));
  			unset(self::$unencryptedSizes[$normalizedPath]);
  		}
  
  		return $result;
  	}
  
  	/**
03e52840d   Kload   Init
157
158
159
160
161
162
163
  	 * @param string $path Path of file from which has been read
  	 * @param string $data Data that has been read from file
  	 */
  	public function postFile_get_contents($path, $data) {
  
  		$plainData = null;
  		$view = new \OC_FilesystemView('/');
03e52840d   Kload   Init
164
165
166
167
168
169
170
171
  		// init session
  		$session = new \OCA\Encryption\Session($view);
  
  		// If data is a catfile
  		if (
  			Crypt::mode() === 'server'
  			&& Crypt::isCatfileContent($data)
  		) {
31b7f2792   Kload   Upgrade to ownclo...
172
  			$handle = fopen('crypt://' . $path, 'r');
03e52840d   Kload   Init
173
174
175
176
177
178
179
180
181
  
  			if (is_resource($handle)) {
  				while (($plainDataChunk = fgets($handle, 8192)) !== false) {
  					$plainData .= $plainDataChunk;
  				}
  			}
  
  		} elseif (
  			Crypt::mode() == 'server'
31b7f2792   Kload   Upgrade to ownclo...
182
  			&& \OC::$session->exists('legacyenckey')
03e52840d   Kload   Init
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
  			&& Crypt::isEncryptedMeta($path)
  		) {
  			// Disable encryption proxy to prevent recursive calls
  			$proxyStatus = \OC_FileProxy::$enabled;
  			\OC_FileProxy::$enabled = false;
  
  			$plainData = Crypt::legacyBlockDecrypt($data, $session->getLegacyKey());
  
  			\OC_FileProxy::$enabled = $proxyStatus;
  		}
  
  		if (!isset($plainData)) {
  
  			$plainData = $data;
  
  		}
  
  		return $plainData;
  
  	}
  
  	/**
03e52840d   Kload   Init
205
206
207
208
209
210
211
212
213
214
  	 * @param $path
  	 * @return bool
  	 */
  	public function postTouch($path) {
  		$this->handleFile($path);
  
  		return true;
  	}
  
  	/**
a293d369c   Kload   Update sources to...
215
216
217
218
219
220
221
222
223
224
  	 * @brief remember initial fopen mode because sometimes it gets changed during the request
  	 * @param string $path path
  	 * @param string $mode type of access
  	 */
  	public function preFopen($path, $mode) {
  		self::$fopenMode[$path] = $mode;
  	}
  
  
  	/**
03e52840d   Kload   Init
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
  	 * @param $path
  	 * @param $result
  	 * @return resource
  	 */
  	public function postFopen($path, &$result) {
  
  		$path = \OC\Files\Filesystem::normalizePath($path);
  
  		if (!$result) {
  
  			return $result;
  
  		}
  
  		// split the path parts
  		$pathParts = explode('/', $path);
a293d369c   Kload   Update sources to...
241
242
  		// don't try to encrypt/decrypt cache chunks or files in the trash bin
  		if (isset($pathParts[2]) && ($pathParts[2] === 'cache' || $pathParts[2] === 'files_trashbin')) {
03e52840d   Kload   Init
243
244
245
246
247
248
  			return $result;
  		}
  
  		// Disable encryption proxy to prevent recursive calls
  		$proxyStatus = \OC_FileProxy::$enabled;
  		\OC_FileProxy::$enabled = false;
a293d369c   Kload   Update sources to...
249
250
251
252
253
254
255
256
257
  		// if we remember the mode from the pre proxy we re-use it
  		// oterwise we fall back to stream_get_meta_data()
  		if (isset(self::$fopenMode[$path])) {
  			$mode = self::$fopenMode[$path];
  			unset(self::$fopenMode[$path]);
  		} else {
  			$meta = stream_get_meta_data($result);
  			$mode = $meta['mode'];
  		}
03e52840d   Kload   Init
258
259
  
  		$view = new \OC_FilesystemView('');
31b7f2792   Kload   Upgrade to ownclo...
260
261
  		$userId = Helper::getUser($path);
  		$util = new Util($view, $userId);
03e52840d   Kload   Init
262
263
264
265
266
267
268
269
270
271
272
273
  
  		// If file is already encrypted, decrypt using crypto protocol
  		if (
  			Crypt::mode() === 'server'
  			&& $util->isEncryptedPath($path)
  		) {
  
  			// Close the original encrypted file
  			fclose($result);
  
  			// Open the file using the crypto stream wrapper
  			// protocol and let it do the decryption work instead
a293d369c   Kload   Update sources to...
274
  			$result = fopen('crypt://' . $path, $mode);
03e52840d   Kload   Init
275
276
  
  		} elseif (
a293d369c   Kload   Update sources to...
277
278
279
  				self::shouldEncrypt($path)
  				and $mode !== 'r'
  				and $mode !== 'rb'
03e52840d   Kload   Init
280
  		) {
a293d369c   Kload   Update sources to...
281
  			$result = fopen('crypt://' . $path, $mode);
03e52840d   Kload   Init
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
  		}
  
  		// Re-enable the proxy
  		\OC_FileProxy::$enabled = $proxyStatus;
  
  		return $result;
  
  	}
  
  	/**
  	 * @param $path
  	 * @param $data
  	 * @return array
  	 */
  	public function postGetFileInfo($path, $data) {
  
  		// if path is a folder do nothing
  		if (\OCP\App::isEnabled('files_encryption') && is_array($data) && array_key_exists('size', $data)) {
  
  			// Disable encryption proxy to prevent recursive calls
  			$proxyStatus = \OC_FileProxy::$enabled;
  			\OC_FileProxy::$enabled = false;
  
  			// get file size
  			$data['size'] = self::postFileSize($path, $data['size']);
  
  			// Re-enable the proxy
  			\OC_FileProxy::$enabled = $proxyStatus;
  		}
  
  		return $data;
  	}
  
  	/**
  	 * @param $path
  	 * @param $size
  	 * @return bool
  	 */
  	public function postFileSize($path, $size) {
  
  		$view = new \OC_FilesystemView('/');
31b7f2792   Kload   Upgrade to ownclo...
323
  		$userId = Helper::getUser($path);
03e52840d   Kload   Init
324
325
326
327
328
329
330
331
332
333
334
  		$util = new Util($view, $userId);
  
  		// if encryption is no longer enabled or if the files aren't migrated yet
  		// we return the default file size
  		if(!\OCP\App::isEnabled('files_encryption') ||
  				$util->getMigrationStatus() !== Util::MIGRATION_COMPLETED) {
  			return $size;
  		}
  
  		// if path is a folder do nothing
  		if ($view->is_dir($path)) {
837968727   Kload   [enh] Upgrade to ...
335
336
337
338
339
340
341
  			$proxyState = \OC_FileProxy::$enabled;
  			\OC_FileProxy::$enabled = false;
  			$fileInfo = $view->getFileInfo($path);
  			\OC_FileProxy::$enabled = $proxyState;
  			if (isset($fileInfo['unencrypted_size']) && $fileInfo['unencrypted_size'] > 0) {
  				return $fileInfo['unencrypted_size'];
  			}
03e52840d   Kload   Init
342
343
344
345
346
347
348
349
350
351
352
353
354
  			return $size;
  		}
  
  		// get relative path
  		$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
  
  		// if path is empty we cannot resolve anything
  		if (empty($relativePath)) {
  			return $size;
  		}
  
  		$fileInfo = false;
  		// get file info from database/cache if not .part file
31b7f2792   Kload   Upgrade to ownclo...
355
356
357
  		if (!Helper::isPartialFilePath($path)) {
  			$proxyState = \OC_FileProxy::$enabled;
  			\OC_FileProxy::$enabled = false;
03e52840d   Kload   Init
358
  			$fileInfo = $view->getFileInfo($path);
31b7f2792   Kload   Upgrade to ownclo...
359
  			\OC_FileProxy::$enabled = $proxyState;
03e52840d   Kload   Init
360
361
362
363
364
  		}
  
  		// if file is encrypted return real file size
  		if (is_array($fileInfo) && $fileInfo['encrypted'] === true) {
  			// try to fix unencrypted file size if it doesn't look plausible
31b7f2792   Kload   Upgrade to ownclo...
365
  			if ((int)$fileInfo['size'] > 0 && (int)$fileInfo['unencrypted_size'] === 0 ) {
03e52840d   Kload   Init
366
367
368
  				$fixSize = $util->getFileSize($path);
  				$fileInfo['unencrypted_size'] = $fixSize;
  				// put file info if not .part file
31b7f2792   Kload   Upgrade to ownclo...
369
  				if (!Helper::isPartialFilePath($relativePath)) {
03e52840d   Kload   Init
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
  					$view->putFileInfo($path, $fileInfo);
  				}
  			}
  			$size = $fileInfo['unencrypted_size'];
  		} else {
  			// self healing if file was removed from file cache
  			if (!is_array($fileInfo)) {
  				$fileInfo = array();
  			}
  
  			$fixSize = $util->getFileSize($path);
  			if ($fixSize > 0) {
  				$size = $fixSize;
  
  				$fileInfo['encrypted'] = true;
  				$fileInfo['unencrypted_size'] = $size;
  
  				// put file info if not .part file
31b7f2792   Kload   Upgrade to ownclo...
388
  				if (!Helper::isPartialFilePath($relativePath)) {
03e52840d   Kload   Init
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
  					$view->putFileInfo($path, $fileInfo);
  				}
  			}
  
  		}
  		return $size;
  	}
  
  	/**
  	 * @param $path
  	 */
  	public function handleFile($path) {
  
  		// Disable encryption proxy to prevent recursive calls
  		$proxyStatus = \OC_FileProxy::$enabled;
  		\OC_FileProxy::$enabled = false;
  
  		$view = new \OC_FilesystemView('/');
  		$session = new \OCA\Encryption\Session($view);
31b7f2792   Kload   Upgrade to ownclo...
408
  		$userId = Helper::getUser($path);
03e52840d   Kload   Init
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  		$util = new Util($view, $userId);
  
  		// split the path parts
  		$pathParts = explode('/', $path);
  
  		// get relative path
  		$relativePath = \OCA\Encryption\Helper::stripUserFilesPath($path);
  
  		// only if file is on 'files' folder fix file size and sharing
  		if (isset($pathParts[2]) && $pathParts[2] === 'files' && $util->fixFileSize($path)) {
  
  			// get sharing app state
  			$sharingEnabled = \OCP\Share::isEnabled();
  
  			// get users
  			$usersSharing = $util->getSharingUsersArray($sharingEnabled, $relativePath);
  
  			// update sharing-keys
  			$util->setSharedFileKeyfiles($session, $usersSharing, $relativePath);
  		}
  
  		\OC_FileProxy::$enabled = $proxyStatus;
  	}
  }