Changes to encryption wrapper #28774

sharidas · 2017-08-23T08:04:17Z

Changes made to encryption wrapper so that we can
get the commands like transfer-ownership or recreate
masterkey work. This change doesn't alter the core
functionality of copy or fopen function. The arguments
passed to the function remains same as other wrappers.

Signed-off-by: Sujith H sharidasan@owncloud.com

Description

Changes made to the ecnryption warpper and view to get the transfer-ownership command recreate master key work. Basically there was a problem which caused to change the arguments passed to the routines like fopen or copy. With this change we don't have to alter them. But we use flags to control the code flow for the commands.

Related Issue

Motivation and Context

This change would prevent the modification to common routines which were made to arguments of functions like fopen or copy etc.

How Has This Been Tested?

Scratch installation of oC and create 2 users
Verified transfer ownership command works with and without encryption between two users.
Verified Recreate command for master key works on the same setup.

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

PVince81

great progress, see comments

let's use the static approach

PVince81 · 2017-08-23T08:45:27Z

apps/files/lib/Command/TransferOwnership.php

+		 * If encryption is enabled and masterkey is the option selected
+		 * kindly use the CustomView wrapper.
+		 */
+		/*if ($this->encryptionManager->isEnabled() &&


please remove

PVince81 · 2017-08-23T08:47:13Z

lib/private/Files/Storage/Wrapper/Encryption.php

@@ -86,6 +86,10 @@ class Encryption extends Wrapper {
 	/** @var  ArrayCache */
 	private $arrayCache;

+	private $sourcePath;
+
+	private $decryptedFile = false;


so if I understand correctly, this flag only affects write operations ?

If yes, call it $disableWriteEncryption instead and the methods setDisableWriteEncryption()

PVince81 · 2017-08-23T08:47:50Z

lib/private/Files/Storage/Wrapper/Encryption.php

+	 * Set the flag to true, so that the file would be
+	 * in the decrypted state.
+	 */
+	public function setDecryptedFileFlag() {


Just pass the flag as argument, no need to write two methods...

PVince81 · 2017-08-23T08:49:31Z

lib/private/Files/View.php

+	 * the storage's set value for decrypted file flag is called.
+	 */
+
+	public function setDecryptedFile() {


I'd prefer that the View doesn't know anything about encryption. Encryption is just like a plugin that inserts itself so it's not good that the core code like View relies on encryption specific things.

Let's make flag static in the Encryption class above instead and set it from outside. That should do for now.

PVince81 · 2017-08-23T08:51:45Z

lib/private/Files/Storage/Wrapper/Encryption.php

-					$size, $unencryptedSize, $headerSize, $signed, $sourceFileOfRename);
+					$size, $unencryptedSize, $headerSize, $signed, $this->sourcePath[$path]);
+
+				if (isset($this->sourcePath[$path])) {


you need to call isset earlier, else line 478 is going to throw a warning when not set

@sharidas did you miss this comment ?

No, I thought in a different way. wrap() expects either null or string from$this->sourcePath[$path]. So if $this->sourcePath[$path] not set then I set as null at https://github.com/owncloud/core/pull/28774/files#diff-938b56891f3079e628cfda1c331911b7R476 .
Else if its set then unset at line 484. Terrible idea?

PVince81 · 2017-08-23T08:52:10Z

lib/private/Files/Storage/Wrapper/Encryption.php

 				} else {
-					$target = $this->fopen($targetInternalPath, 'w');
+					$this->sourcePath[$targetInternalPath] = null;


use unset for maximum deletion

sharidas · 2017-08-23T12:02:40Z

Removed changes from View which points to encryption.
Removed the comment ( code comment )
Renamed the variable $decryptedFile to $disableWriteEncryption and also renamed the function associated with the operation to setDisableWriteEncryption(). Argument is passed to setDisableWriteEncryption() for operation set or unset.
[x]

PVince81 · 2017-08-23T13:31:30Z

lib/private/Files/Storage/Wrapper/Encryption.php

+				 * for write mode.
+				 */
+				if (self::$disableWriteEncryption && ($mode !== 'r')) {
+					return fopen($this->storage->getSourcePath($path), $mode);


This is going to break horribly with external storage because you are doing a fopen directly on the filesystem.

Use $this->getWrapperStorage()->fopen() instead

@PVince81 Updated in my latest PR. Thanks for pointing it out.

sharidas · 2017-08-24T06:56:24Z

lib/private/Files/Storage/Wrapper/Encryption.php

-					$this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode,
-					$size, $unencryptedSize, $headerSize, $signed, $sourceFileOfRename);
+
+				if (isset($this->sourcePath[$path])) {


Hope this looks better.

PVince81 · 2017-08-24T07:44:22Z

lib/private/Files/Storage/Wrapper/Encryption.php

+	 *
+	 * @param $isDisabled bool
+	 */
+	public function setDisableWriteEncryption($isDisabled) {


function must be static

sharidas · 2017-08-24T09:29:07Z

Made the function setDisableWriteEncryption static.
Used a local variable to pass the $this->sourcePath[$path] if its set else null to -> wrap()
Removed the view code

PVince81 · 2017-08-29T08:15:34Z

lib/private/Files/Storage/Wrapper/Encryption.php

@@ -86,6 +86,10 @@ class Encryption extends Wrapper {
 	/** @var  ArrayCache */
 	private $arrayCache;

+	private $sourcePath;


PHPDoc comments please

PVince81

👍 add missing PHP doc then this is good to go

Changes made to encryption wrapper so that we can get the commands like transfer-ownership or recreate masterkey work. This change doesn't alter the core functionality of copy or fopen function. The arguments passed to the function remains same as other wrappers. Signed-off-by: Sujith H <sharidasan@owncloud.com>

PVince81 · 2017-08-29T15:24:51Z

@sharidas please backport to stable10

sharidas · 2017-11-03T12:44:59Z

Backport of this PR: #28845

lock · 2019-08-02T03:01:44Z

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

sharidas self-assigned this Aug 23, 2017

sharidas added this to the development milestone Aug 23, 2017

sharidas added the 2 - Developing label Aug 23, 2017

PVince81 reviewed Aug 23, 2017

View reviewed changes

sharidas force-pushed the encryption-wrapper-work branch from 7e04194 to db6b456 Compare August 23, 2017 11:15

PVince81 reviewed Aug 23, 2017

View reviewed changes

sharidas force-pushed the encryption-wrapper-work branch 3 times, most recently from 533c1d7 to 313e91a Compare August 24, 2017 06:51

sharidas commented Aug 24, 2017

View reviewed changes

PVince81 reviewed Aug 24, 2017

View reviewed changes

sharidas force-pushed the encryption-wrapper-work branch from 313e91a to e440f98 Compare August 24, 2017 09:26

This was referenced Aug 28, 2017

Custom wrapper to handle commands in oC #28701

Closed

[WIP] Custom wrapper to handle commands in oC #28762

Closed

Change to re-create masterkeys #28145

Closed

sharidas added 3 - To Review and removed 2 - Developing labels Aug 28, 2017

PVince81 reviewed Aug 29, 2017

View reviewed changes

PVince81 approved these changes Aug 29, 2017

View reviewed changes

sharidas force-pushed the encryption-wrapper-work branch from e440f98 to e0a0851 Compare August 29, 2017 11:24

PVince81 merged commit d32b584 into master Aug 29, 2017

PVince81 deleted the encryption-wrapper-work branch August 29, 2017 15:24

PVince81 added the backport-request label Aug 29, 2017

sharidas mentioned this pull request Sep 14, 2017

Transfer ownership must work with master key #27427

Closed

2 tasks

PVince81 removed the backport-request label Nov 3, 2017

ownclouders added the status/STALE label Dec 20, 2017

lock bot locked as resolved and limited conversation to collaborators Aug 2, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes to encryption wrapper #28774

Changes to encryption wrapper #28774

sharidas commented Aug 23, 2017

PVince81 left a comment

PVince81 Aug 23, 2017

PVince81 Aug 23, 2017

PVince81 Aug 23, 2017

PVince81 Aug 23, 2017

PVince81 Aug 23, 2017

PVince81 Aug 23, 2017

sharidas Aug 23, 2017 •

edited

Loading

PVince81 Aug 23, 2017

sharidas commented Aug 23, 2017

PVince81 Aug 23, 2017

sharidas Aug 23, 2017

sharidas Aug 24, 2017

PVince81 Aug 24, 2017

sharidas Aug 24, 2017

sharidas commented Aug 24, 2017 •

edited

Loading

PVince81 Aug 29, 2017

PVince81 left a comment

PVince81 commented Aug 29, 2017

sharidas commented Nov 3, 2017

lock bot commented Aug 2, 2019

Changes to encryption wrapper #28774

Changes to encryption wrapper #28774

Conversation

sharidas commented Aug 23, 2017

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

PVince81 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharidas Aug 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharidas commented Aug 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharidas commented Aug 24, 2017 • edited Loading

Choose a reason for hiding this comment

PVince81 left a comment

Choose a reason for hiding this comment

PVince81 commented Aug 29, 2017

sharidas commented Nov 3, 2017

lock bot commented Aug 2, 2019

sharidas Aug 23, 2017 •

edited

Loading

sharidas commented Aug 24, 2017 •

edited

Loading