This change helps user to switch between master keys #27512

sharidas · 2017-03-27T13:47:24Z

and user specific keys.

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

Description

This change helps us to make master key as default for encryption instead of default configuration we had.

Related Issue

fixes #26847

Motivation and Context

How Has This Been Tested?

Testing yet to be done. This has only UI change.

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.

mention-bot · 2017-03-27T13:47:25Z

@sharidas, thanks for your PR! By analyzing the history of the files in this pull request, we identified @DeepDiver1975, @PVince81 and @tomneedham to be potential reviewers.

sharidas · 2017-03-27T13:48:29Z

I would like to know if the UI part looks ok?

sharidas · 2017-03-27T13:59:01Z

@felixheidecke Any suggestion?

felixheidecke · 2017-03-27T14:33:01Z

@sharidas Could you provide a few screenshots? Would be the fastest way to get feedback ;-)

PVince81 · 2017-03-27T14:38:31Z

settings/js/admin.js

+		$('#confirm-encryption-warning').addClass("hidden");
+	}
+
+	if ($('#enableEncryption').prop("checked") == true) {


always use strict equality ===.

please setup jshint/jslint, it will show you warnings for this

PVince81 · 2017-03-27T14:41:17Z

settings/js/admin.js

@@ -41,6 +41,61 @@ $(document).ready(function(){
 		$('#encryptionAPI div#EncryptionWarning').toggleClass('hidden');
 	});

+	function selectEncryptionBehavior() {
+		$('#confirm-encryption-warning').addClass("hidden");


this code is difficult to read

I suggest to have only a single method, like "onChange" which then toggles the options based on the conditions.
For example:

$('#encryptionAPI').toggleClass(!userSpecificEncryption, 'hidden')

This way you only need a single row instead of having it appear three times in different functions

PVince81 · 2017-03-27T14:42:26Z

settings/js/admin.js

+	});
+
+	$('#reconfirm-encryption-type').click(function (event) {
+		console.log("I am clicked the value selected is = ", $('#keyTypeId option:selected').val());


remove logging

PVince81 · 2017-03-27T14:44:25Z

settings/js/admin.js

+		console.log("I am clicked the value selected is = ", $('#keyTypeId option:selected').val());
+		if ($('#keyTypeId option:selected').val() == 'masterkey') {
+			OC.AppConfig.setValue('encryption', 'useMasterKey', '1');
+			location.reload();


the function OC.AppConfig.setValue() does an ajax call, so if you reload the page directly after that there is a slight risk of race condition in which the value isn't completely saved. Usually when reloading the page the browser will abort all ajax connections.

only reload the page once the ajax call finished

PVince81 · 2017-03-27T14:44:54Z

settings/templates/panels/admin/encryption.php

+	<select id="keyTypeId" name="keyType">
+		<option value="nokey">Please select an encryption option</option>
+		<option value="masterkey" <?php echo \OC::$server->getAppConfig()->getValue('encryption', 'useMasterKey', 0) !== 0 ? 'selected' : ''; ?>>Master Key</option>
+		<option value="customkey">User-specific key</option>


text translation missing, please recheck all the texts and make sure you're using the translation function

sharidas · 2017-03-30T14:34:53Z

@PVince81 I have updated the patch set with the changes mentioned below:

Replaced the drop texts with the translation function
Used ajaxStop function after the setValue's used.
Removed console.log which was there in the code.
Used === for equality check.
Wrote a single function which gets called for the onChange event of the drop down selection.
Tried adding some comments, to make the code readable.

Let me know if the code looks better, else I can refactor again.

sharidas · 2017-03-31T07:53:08Z

@felixheidecke Below are the screenshots:
a) The initial page when user clicks on the encryption ( after encryption app is enabled and user re-logins back to the UI)

b) The drop down select has 3 options. Of them default is what user sees in encryption page, unless user selects any of the other two and configures.
c) The second option in the drop down is : "Master Key". When user selects that from the drop down the following page appears on screen:

c a) When master key is selected the user is asked with a warning message. This warning message helps user understand that once selected it cannot be reverted.
c b ) If user clicks "Enable Selection" of master key, then the page reloads and you see a screen as shown below:

d) If user selects the 3rd option which is: "User-specific key" this is how the screen appears

d a) Once the user clicks "Enable server-side encryption" the screen appears as shown below:

d b) Once the user clicks "Enable encryption" this is how the screen appears:

d c) After entering the pasword for recovery key the screen appears as shown below:

e) Once the selection of master key or user specific key is made I have made a provision to disable the select ( drop down).
Let me know if the screenshot helps you :)

PVince81 · 2017-03-31T09:19:54Z

settings/js/admin.js

+			OC.AppConfig.setValue('core', 'encryption_enabled', 'yes');
+			OC.AppConfig.setValue("encryption", "encryptHomeStorage", '0');
+			OC.AppConfig.setValue('encryption', 'useMasterKey', '1');
+			$(document).ajaxStop(function () {


No, this will break in some cases.

Not only this code is doing ajax calls. There are background processes like the notifications app, the heartbeat, etc that will trigger ajax calls.

A better approach is to use promises:

adjust setValue and other methods to return the result of $.post or other ajax calls

use $.when(call1, call2, call3).then(function() { ... }) to find out when all the three calls have finished.

PVince81 · 2017-03-31T09:24:19Z

The flow is wrong, "Enable server-side encryption" must always be the first entry.
Then after that the selection of encryption type.

Also, remember that this checkbox "Enable server-side encryption" is about enabling the encryption subsystem/engine in core, not enabling a specific module.

The code with the encryption type selection needs to be part of the "Default encryption module" app (aka plugin). Keep in mind that other developers can write their own "Custom encryption module" (aka plugin) in which case the new dropdown is not relevant at all.

The encryption module code is in the "apps/encryption" folder. Please move the dropdown logic there.

PVince81 · 2017-03-31T09:29:35Z

Flow as follows:

Admin enables the app "default encryption module"
Admin goes to admin page
Admin clicks "Enable server-side encryption" then "Enable encryption"
Admin scrolls down to the "Encryption" section (let's rename it to "Default encryption module")
Admin selects encryption type (which is the only visible item at this stage)
If admin picked "user-keys": now display all old fields
- if admin picked "master-key": no further fields

The dropdown needs a button "Select this mode".
Once clicked, the dropdown must disappear and be replaced with a label: "Encryption type: xyz" which cannot be changed any more.

sharidas · 2017-03-31T15:35:23Z

@PVince81 Thanks for the review comments. I have updated the PR and below are the changes made in the updated PR:

Made the work flow as follows:
After enabling the encryption app and after re-login, admin when navigates to "encryption" page
a) "Encryption" has been renamed to "Default encryption module"
b) Once user selects either of the options: "Master Key" or "User-specific Key", a "select this mode" button appears
c) Once the button is clicked based on the respective mode, the drop down and the button is not visible to the user. And a label appers "Encryption: master key" if master was selected or "Encryption: User specific key" if user specific key was selected.
d) If user had opted for the master key then page reload happens
e) The logic for the user specific key remains the same.

Let me know how the current PR looks?

PVince81 · 2017-04-03T08:18:00Z

BUG: Getting this message after "enable encryption" then "enable default encryption module app":
"Encryption App is enabled but your keys are not initialized, please log-out and log-in again"

This message shouldn't appear until an encryption type has been selected, because this message is only relevant for user-key mode encryption.

TODO: change the button text to "Permanently select this mode"
BUG: do not display anything under the dropdown until a mode is selected. So selecting "user-key" should not show anything either. Once the selection is made, the dropdown disappears forever and the rest of the form can appear.

PVince81 · 2017-04-03T08:20:54Z

Enabling the modes worked fine, nice!

PVince81 · 2017-04-03T08:21:50Z

apps/encryption/js/settings-admin.js

+
+	encryptionTypeSelection($("#keyTypeId :selected").val(), "static");
+
+	OC.AppConfig.getValue("encryption", "useMasterKey", function ($value) {


note: a way to prevent reading these values with ajax would be to append them into the template on the PHP side then read them out with JS.

PVince81 · 2017-04-03T08:23:59Z

apps/encryption/js/settings-admin.js

+		//Action to be taken when "Select this mode" button is selected.
+		$("#select-mode,#keyTypeId").addClass("hidden");
+		if($("#keyTypeId :selected").val() === "masterkey") {
+			$.when(OC.AppConfig.setValue("encryption", "encryptHomeStorage", '0'),


this cannot work properly, you didn't adjust OC.AppConfig.setValue to actually return the ajax object

well, the two "setValue" calls do work, but the final callback to reload the page is never called

sharidas · 2017-04-04T08:56:35Z

@PVince81 I have updated the PR for review by making the changes as follows:

Fixed bug : Getting this message after "enable encryption" then "enable default encryption module app": "Encryption App is enabled but your keys are not initialized, please log-out and log-in again"
Changed button text to "Permanently select this mode"
Once the user clicks the "Permanently select this mode", the rest of the form is displayed and the drop down is not displayed for ever.
For the getValue thing, I have moved the call to the PHP template and the JS code reads from there.
I have made adjustments to call the 2 setValue and passed the promise objects to when. I did a verification using firebug. When page reload is called, the setValues are seen to be completed their job. Verified in the network response section of firebug.

Hope the updated PR looks fine.

sharidas · 2017-05-03T12:13:11Z

PVince81 · 2017-05-04T10:06:22Z

add spinner while encryption is being enabled. It took a few seconds to enable master key and it makes the UI look broken (check how other spinners are displayed for example in the share panel, there's a CSS class for it)
the text "Encryption: master key" that appears after going to that page again after enabling, the text must not display a hand cursor as it's not clickable

Otherwise this looked good in my quick local tests.

sharidas · 2017-05-05T07:38:56Z

apps/encryption/js/settings-admin.js

+	$("#select-mode").click(function () {
+		//Action to be taken when "Select this mode" button is selected.
+		$("#loadSpinner").toggleClass("hidden");
+		$("#loadSpinner").addClass("loading");


Does this spinner look ok?

Argh, global ids again ? What if another section also has a spinenr called "loadSpinner" ?

Please use class names instead.
The only id that's acceptable here is the parent element #encryptionKeySelection, so use a selector like #encryptionKeySelection .loading when toggling or something.

And when toggling please force the value to "true" as you might not know what its previous state is.

sharidas · 2017-05-05T08:37:49Z

apps/encryption/js/settings-admin.js

+
+	$("#select-mode").click(function () {
+		//Action to be taken when "Select this mode" button is selected.
+		$("#encryptionKeySelection").toggleClass("loading", true);


This looks better, right? I have tested the same.

Did you test it ?

The spinner only shortly appears at the very right of the row and disappears very quickly.

Also looking at the code it looks like it sets the class on the whole container, which looks wrong.
The spinner should have its own div element.

sharidas · 2017-05-05T13:51:47Z

apps/encryption/js/settings-admin.js

+		//Action to be taken when "Select this mode" button is selected.
+		var $loadSpinner = $('#encryptionKeySelection').find('div.hidden').first();
+		$loadSpinner.toggleClass('hidden',false);
+		$loadSpinner.toggleClass('loading',true);


Made the modification by having the div for spinner. And now atleast the spinner doesn't vanish quickly.

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

PVince81 · 2017-05-08T07:13:47Z

Looks good now 👍

lock · 2019-08-03T11:02:06Z

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 added the 3 - To Review label Mar 27, 2017

PVince81 reviewed Mar 27, 2017

View reviewed changes

sharidas force-pushed the encryption-task-26847 branch 4 times, most recently from e8c665d to 71b3eda Compare March 30, 2017 14:29

PVince81 reviewed Mar 31, 2017

View reviewed changes

sharidas force-pushed the encryption-task-26847 branch 3 times, most recently from 06754f9 to 80440bd Compare March 31, 2017 15:31

PVince81 added this to the 10.0.1 milestone Apr 3, 2017

PVince81 reviewed Apr 3, 2017

View reviewed changes

sharidas force-pushed the encryption-task-26847 branch from 80440bd to f0d7d69 Compare April 4, 2017 08:43

sharidas force-pushed the encryption-task-26847 branch 4 times, most recently from 37631d0 to 2dc6abe Compare May 3, 2017 12:12

sharidas force-pushed the encryption-task-26847 branch 6 times, most recently from 37d5e97 to 1558f08 Compare May 4, 2017 08:03

sharidas force-pushed the encryption-task-26847 branch 4 times, most recently from 1573616 to 6d3fed3 Compare May 4, 2017 15:59

sharidas commented May 5, 2017

View reviewed changes

sharidas force-pushed the encryption-task-26847 branch from 6d3fed3 to 17586ef Compare May 5, 2017 08:36

sharidas commented May 5, 2017

View reviewed changes

sharidas force-pushed the encryption-task-26847 branch from 17586ef to 183f15e Compare May 5, 2017 13:49

sharidas commented May 5, 2017

View reviewed changes

This change helps user to switch between master and user specific keys.

263adeb

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

sharidas force-pushed the encryption-task-26847 branch from 183f15e to 263adeb Compare May 5, 2017 16:05

PVince81 merged commit 4e5211b into master May 8, 2017

PVince81 deleted the encryption-task-26847 branch May 8, 2017 07:13

PVince81 mentioned this pull request May 8, 2017

Change default encryption behaviour #26847

Closed

sharidas mentioned this pull request Nov 20, 2018

Documentation required for switch between master and user specific keys owncloud/docs#352

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

This change helps user to switch between master keys #27512

This change helps user to switch between master keys #27512

sharidas commented Mar 27, 2017 •

edited

Loading

mention-bot commented Mar 27, 2017

sharidas commented Mar 27, 2017

sharidas commented Mar 27, 2017

felixheidecke commented Mar 27, 2017

PVince81 Mar 27, 2017

PVince81 Mar 27, 2017

PVince81 Mar 27, 2017

PVince81 Mar 27, 2017

PVince81 Mar 27, 2017

sharidas commented Mar 30, 2017

sharidas commented Mar 31, 2017

PVince81 Mar 31, 2017

PVince81 commented Mar 31, 2017

PVince81 commented Mar 31, 2017

sharidas commented Mar 31, 2017

PVince81 commented Apr 3, 2017 •

edited by sharidas

Loading

PVince81 commented Apr 3, 2017

PVince81 Apr 3, 2017

PVince81 Apr 3, 2017

PVince81 Apr 3, 2017 •

edited

Loading

sharidas commented Apr 4, 2017 •

edited

Loading

sharidas commented May 3, 2017 •

edited

Loading

PVince81 commented May 4, 2017

sharidas May 5, 2017

PVince81 May 5, 2017

sharidas May 5, 2017 •

edited

Loading

PVince81 May 5, 2017

sharidas May 5, 2017

PVince81 commented May 8, 2017

lock bot commented Aug 3, 2019


		encryptionTypeSelection($("#keyTypeId :selected").val(), "static");

		OC.AppConfig.getValue("encryption", "useMasterKey", function ($value) {

This change helps user to switch between master keys #27512

This change helps user to switch between master keys #27512

Conversation

sharidas commented Mar 27, 2017 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

mention-bot commented Mar 27, 2017

sharidas commented Mar 27, 2017

sharidas commented Mar 27, 2017

felixheidecke commented Mar 27, 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 Mar 30, 2017

sharidas commented Mar 31, 2017

Choose a reason for hiding this comment

PVince81 commented Mar 31, 2017

PVince81 commented Mar 31, 2017

sharidas commented Mar 31, 2017

PVince81 commented Apr 3, 2017 • edited by sharidas Loading

PVince81 commented Apr 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PVince81 Apr 3, 2017 • edited Loading

Choose a reason for hiding this comment

sharidas commented Apr 4, 2017 • edited Loading

sharidas commented May 3, 2017 • edited Loading

PVince81 commented May 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharidas May 5, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PVince81 commented May 8, 2017

lock bot commented Aug 3, 2019

sharidas commented Mar 27, 2017 •

edited

Loading

PVince81 commented Apr 3, 2017 •

edited by sharidas

Loading

PVince81 Apr 3, 2017 •

edited

Loading

sharidas commented Apr 4, 2017 •

edited

Loading

sharidas commented May 3, 2017 •

edited

Loading

sharidas May 5, 2017 •

edited

Loading