Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add documentation about e2ee #12821

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

artonge
Copy link
Contributor

@artonge artonge commented Mar 4, 2025

@marinofaggiana @mgallien @alperozturk96 can you add screenshots for your respective platform?

Note: the android screenshots are in French, so they need to be replaced.

Screenshot 2025-03-05 at 11-04-41 Using end-to-end encryption — Nextcloud latest User Manual latest documentation

Fix nextcloud/end_to_end_encryption#936

@alexanderdd
Copy link
Contributor

alexanderdd commented Mar 4, 2025

Hello, some suggestions:

  • from one of your device -> from one of your devices
  • "On the browser, you'll first have to enable e2ee in the browser" -> "In the browser, you'll first have to allow end to end encryption in the personal settings."
  • I would put the section "encrypting a folder" right after "enabling e2ee", and put the section "adding an e2ee device" after that. IMO this better represents the most common workflow.
  • in "encrypting a folder", maybe first show how to create a new folder in the client, which can then be encrypted (probably the most common use case, and users might not know that you can create folders via the ...-menu)
  • in "adding an e2ee device > web" maybe add that it is currently read-only, and that these folders cannot be shared with users/groups

Thank you for this documentation!

@artonge artonge force-pushed the artonge/feat/add_deleting_metadata branch 2 times, most recently from d5c9540 to 7a92483 Compare March 5, 2025 10:04
@alperozturk96
Copy link

alperozturk96 commented Mar 5, 2025

@artonge If these are okay I can update the PR.

e2ee-android-adde2ee-android-add e2ee-android-mnemonice2ee-android-mnemonic e2ee-android-setupe2ee-android-setup

@artonge
Copy link
Contributor Author

artonge commented Mar 5, 2025

@artonge If these are okay I can update the PR.

I would invert add and mnemonic, no?

@alperozturk96
Copy link

alperozturk96 commented Mar 5, 2025

@artonge If these are okay I can update the PR.

I would invert add and mnemonic, no?

Ahh, yes that's right. I fixed the titles

@artonge
Copy link
Contributor Author

artonge commented Mar 17, 2025

Ping @mgallien @marinofaggiana

@marinofaggiana
Copy link
Member

marinofaggiana commented Mar 17, 2025

X A B C
Not configured Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 13 55 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 14 15 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 15 40
Configured Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 11 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 22 Simulator Screenshot - iPhone 16 Pro - 2025-03-17 at 16 17 30

@marinofaggiana

This comment was marked as duplicate.

@alexanderdd
Copy link
Contributor

ideally also include documentation on how to share an e2ee folder with groups and how to create a file drop link, according to https://nextcloud.com/blog/desktop-3-8-end-to-end-encryption-levels-up-with-sharing-and-file-drop/ this is already possible

Copy link

@gerbrent gerbrent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work here!! Really nice to see this progressing. 🎉

I would love to see added:

  • Description about the mnemonic, such as what it is (i.e. like a password), that it must be kept secret.
  • Description of what happens to the folder of encrypted files if all devices are disconnected from the folder, i.e. all clients are deleted/logged out. I believe the files remain in the folder, but inaccessible unless the mnemonic is known by the user. If the mnemonic is not known in this case, the files are lost forever and can not be recovered! Not even/especially by the administrator.
  • Limitations of typical Files operations when E2EE is enabled (sharing, copying, etc)

<details>
<summary>Android</summary>

.. image:: ../images/e2ee-android-add.png

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • replace re French Android UI (known already)

<details>
<summary>iOS</summary>

.. image:: ../images/e2ee-ios-add.png

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add iOS screenshot (missing? 404..)

<details>
<summary>iOS</summary>

.. image:: ../images/e2ee-ios-mnemonic.png

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Add iOS screenshot (missing? 404..)

@artonge
Copy link
Contributor Author

artonge commented Apr 1, 2025

@alperozturk96 still some missing screenshots:

  • images/e2ee-android-encrypt.png - View showing how to set up encryption for a folder
  • images/e2ee-android-add.png - View showing how to set up encryption when it was already set on another device

@marinofaggiana still some missing screenshots:

  • images/e2ee-ios-encrypt.png - View showing how to set up encryption for a folder
  • images/e2ee-ios-add.png - View showing how to set up encryption when it was already set on another device

@alperozturk96 @marinofaggiana @mgallien can all of you also add screenshots for the sharing flow?

Signed-off-by: Louis Chemineau <[email protected]>
@artonge artonge force-pushed the artonge/feat/add_deleting_metadata branch from 7a92483 to fcaa99a Compare April 1, 2025 11:26
Signed-off-by: alperozturk <[email protected]>
@alperozturk96
Copy link

@artonge I added the missing screenshots. What do you mean by sharing flow?

@artonge
Copy link
Contributor Author

artonge commented Apr 3, 2025

What do you mean by sharing flow?

Sharing an E2EE folder with someone else. But thinking about it, it is probably the exact same as for non E2EE folders. Feel free to ignore if this is the case.

@alperozturk96
Copy link

What do you mean by sharing flow?

Sharing an E2EE folder with someone else. But thinking about it, it is probably the exact same as for non E2EE folders. Feel free to ignore if this is the case.

There is no "Share" option in the three-dot menu when I checked it on the Web. On Android, I also noticed empty tabs. We should add these.

Could you check it for iOS @marinofaggiana ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add E2EE to official Nextcloud documentation
5 participants