diff --git a/user_manual/files/index.rst b/user_manual/files/index.rst index d4bfb2de84b..a5ab29d1d09 100644 --- a/user_manual/files/index.rst +++ b/user_manual/files/index.rst @@ -10,6 +10,7 @@ Files & synchronization deleted_file_management desktop_mobile_sync encrypting_files + using_e2ee sharing file_drop large_file_upload @@ -17,4 +18,4 @@ Files & synchronization version_control projects transfer_ownership - federated_cloud_sharing + federated_cloud_sharing diff --git a/user_manual/files/using_e2ee.rst b/user_manual/files/using_e2ee.rst new file mode 100644 index 00000000000..abca68ecfe8 --- /dev/null +++ b/user_manual/files/using_e2ee.rst @@ -0,0 +1,295 @@ +============================================= +Using end-to-end encryption +============================================= + +If enabled server side, Nextcloud provides the possibility to encrypt your files on your devices. +This is called end-to-end encryption, or E2EE, because the files are encrypted on your device and only decrypted on your device. +The server never sees the unencrypted files, further protecting user privacy and data security. + +Enabling E2EE +------------- + +If your administrator enabled the [End-to-End Encryption app](https://apps.nextcloud.com/apps/end_to_end_encryption), you can start using it from one of your devices. +Open the settings of the Nextcloud client and look for the EE2E encryption settings. + +.. raw:: html + +
+ Desktop + +.. image:: ../images/e2ee-desktop-setup.png + :width: 750px + :alt: Setup E2EE on the desktop client + +.. raw:: html + +
+ + +.. raw:: html + +
+ Android + +.. image:: ../images/e2ee-android-setup.png + :width: 400px + :alt: Setup E2EE on Android + +.. raw:: html + +
+ + +.. raw:: html + +
+ iOS + +.. image:: ../images/e2ee-ios-setup-1.png + :width: 400px + :alt: Setup E2EE on iOS step 1 + +.. image:: ../images/e2ee-ios-setup-2.png + :width: 400px + :alt: Setup E2EE on iOS step 2 + +.. image:: ../images/e2ee-ios-setup-3.png + :width: 400px + :alt: Setup E2EE on iOS step 3 + +.. raw:: html + +
+ + +.. raw:: html + +
+ Web + +.. warning:: + It is not possible to enable encryption on a folder in the browser. This must be done on a client app, either a desktop or mobile client. + +.. raw:: html + +
+ + +.. raw:: html + +
+ +Encrypting a folder +----------------------- + +.. warning:: + + You can only enable encryption on empty folders. + + +.. raw:: html + +
+ Desktop + +.. image:: ../images/e2ee-desktop-encrypt-1.png + :width: 750px + :alt: Encrypting a folder on the desktop client step 1 + +.. image:: ../images/e2ee-desktop-encrypt-2.png + :width: 750px + :alt: Encrypting a folder on the desktop client step 2 + +.. image:: ../images/e2ee-desktop-encrypt-3.png + :width: 750px + :alt: Encrypting a folder on the desktop client step 3 + +.. raw:: html + +
+ + +.. raw:: html + +
+ Android + +.. image:: ../images/e2ee-android-encrypt.png + :width: 400px + :alt: Encrypting a folder on an Android device + +.. raw:: html + +
+ + +.. raw:: html + +
+ iOS + +.. image:: ../images/e2ee-ios-encrypt.png + :width: 400px + :alt: Encrypting a folder on an iOS device + +.. raw:: html + +
+ + +.. raw:: html + +
+ Web + +.. warning:: + + It is not possible to enable encryption on a folder in the browser. This must be done on a client app, either a desktop or mobile client. + +.. raw:: html + +
+ + +.. raw:: html + +
+ +Adding an E2EE device +--------------------- + +.. raw:: html + +
+ Desktop + +.. image:: ../images/e2ee-desktop-add.png + :width: 750px + :alt: Setup a new desktop client + +.. raw:: html + +
+ + +.. raw:: html + +
+ Android + +.. image:: ../images/e2ee-android-add.png + :width: 400px + :alt: Setup a new Android device + +.. raw:: html + +
+ + +.. raw:: html + +
+ iOS + +.. image:: ../images/e2ee-ios-add.png + :width: 400px + :alt: Setup a new iOS device + +.. raw:: html + +
+ + +.. raw:: html + +
+ Web + +In the browser, first enable E2EE in the personal settings. This is needed, as E2EE is less secure in the browser, requiring you to fully trust the administrator to not alter the source code the browser will execute. +E2EE folders are currently read-only. Therefore, it is not possible to add, remove, edit, or share an E2EE file from the browser. + +.. image:: ../images/e2ee-web-add-1.png + :width: 750px + :alt: Setup a new browser session step 1 + +.. image:: ../images/e2ee-web-add-2.png + :width: 750px + :alt: Setup a new browser session step 2 + +.. image:: ../images/e2ee-web-add-3.png + :width: 750px + :alt: Setup a new browser session step 3 + +.. raw:: html + +
+ + +.. raw:: html + +
+ + +Displaying the mnemonic +----------------------- + +The mnemonic is a list of words that is used to encrypt and decrypt your files. It is important to keep this mnemonic safe, as it is the only way to access your files if you lose access to your device. If you lose access to your mnemonic, you will lose access to your files. + +.. raw:: html + +
+ Desktop + +.. image:: ../images/e2ee-desktop-mnemonic.png + :width: 750px + :alt: Displaying the mnemonic on the desktop client + +.. raw:: html + +
+ + +.. raw:: html + +
+ Android + +.. image:: ../images/e2ee-android-mnemonic.png + :width: 400px + :alt: Displaying the mnemonic on an Android device + +.. raw:: html + +
+ + +.. raw:: html + +
+ iOS + +.. image:: ../images/e2ee-ios-mnemonic.png + :width: 400px + :alt: Displaying the mnemonic on an iOS device + +.. raw:: html + +
+ + +.. raw:: html + +
+ Web + +.. warning:: + + It is not possible to display the mnemonic in the browser. + +.. raw:: html + +
+ +.. raw:: html + +
diff --git a/user_manual/images/e2ee-android-add.png b/user_manual/images/e2ee-android-add.png new file mode 100644 index 00000000000..f8cfcb070f2 Binary files /dev/null and b/user_manual/images/e2ee-android-add.png differ diff --git a/user_manual/images/e2ee-android-encrypt.png b/user_manual/images/e2ee-android-encrypt.png new file mode 100644 index 00000000000..a73d16ff1a8 Binary files /dev/null and b/user_manual/images/e2ee-android-encrypt.png differ diff --git a/user_manual/images/e2ee-android-mnemonic.png b/user_manual/images/e2ee-android-mnemonic.png new file mode 100644 index 00000000000..f4cea033a74 Binary files /dev/null and b/user_manual/images/e2ee-android-mnemonic.png differ diff --git a/user_manual/images/e2ee-android-setup.png b/user_manual/images/e2ee-android-setup.png new file mode 100644 index 00000000000..b53a65583f1 Binary files /dev/null and b/user_manual/images/e2ee-android-setup.png differ diff --git a/user_manual/images/e2ee-desktop-add.png b/user_manual/images/e2ee-desktop-add.png new file mode 100644 index 00000000000..2f4d3cc8114 Binary files /dev/null and b/user_manual/images/e2ee-desktop-add.png differ diff --git a/user_manual/images/e2ee-desktop-done.png b/user_manual/images/e2ee-desktop-done.png new file mode 100644 index 00000000000..d77b318e325 Binary files /dev/null and b/user_manual/images/e2ee-desktop-done.png differ diff --git a/user_manual/images/e2ee-desktop-encrypt-1.png b/user_manual/images/e2ee-desktop-encrypt-1.png new file mode 100644 index 00000000000..e8092837884 Binary files /dev/null and b/user_manual/images/e2ee-desktop-encrypt-1.png differ diff --git a/user_manual/images/e2ee-desktop-encrypt-2.png b/user_manual/images/e2ee-desktop-encrypt-2.png new file mode 100644 index 00000000000..5c69bb3ae30 Binary files /dev/null and b/user_manual/images/e2ee-desktop-encrypt-2.png differ diff --git a/user_manual/images/e2ee-desktop-encrypt-3.png b/user_manual/images/e2ee-desktop-encrypt-3.png new file mode 100644 index 00000000000..9c9b72b2de8 Binary files /dev/null and b/user_manual/images/e2ee-desktop-encrypt-3.png differ diff --git a/user_manual/images/e2ee-desktop-mnemonic.png b/user_manual/images/e2ee-desktop-mnemonic.png new file mode 100644 index 00000000000..7bc6afdbf9a Binary files /dev/null and b/user_manual/images/e2ee-desktop-mnemonic.png differ diff --git a/user_manual/images/e2ee-desktop-setup.png b/user_manual/images/e2ee-desktop-setup.png new file mode 100644 index 00000000000..c5034d147db Binary files /dev/null and b/user_manual/images/e2ee-desktop-setup.png differ diff --git a/user_manual/images/e2ee-ios-mnemonic.png b/user_manual/images/e2ee-ios-mnemonic.png new file mode 100644 index 00000000000..bde4e32d01a Binary files /dev/null and b/user_manual/images/e2ee-ios-mnemonic.png differ diff --git a/user_manual/images/e2ee-ios-setup-1.png b/user_manual/images/e2ee-ios-setup-1.png new file mode 100644 index 00000000000..209537f69ad Binary files /dev/null and b/user_manual/images/e2ee-ios-setup-1.png differ diff --git a/user_manual/images/e2ee-ios-setup-2.png b/user_manual/images/e2ee-ios-setup-2.png new file mode 100644 index 00000000000..213d6157541 Binary files /dev/null and b/user_manual/images/e2ee-ios-setup-2.png differ diff --git a/user_manual/images/e2ee-ios-setup-3.png b/user_manual/images/e2ee-ios-setup-3.png new file mode 100644 index 00000000000..8bb59f3c73b Binary files /dev/null and b/user_manual/images/e2ee-ios-setup-3.png differ diff --git a/user_manual/images/e2ee-web-add-1.png b/user_manual/images/e2ee-web-add-1.png new file mode 100644 index 00000000000..7c64cd2c79e Binary files /dev/null and b/user_manual/images/e2ee-web-add-1.png differ diff --git a/user_manual/images/e2ee-web-add-2.png b/user_manual/images/e2ee-web-add-2.png new file mode 100644 index 00000000000..1abae1df11f Binary files /dev/null and b/user_manual/images/e2ee-web-add-2.png differ diff --git a/user_manual/images/e2ee-web-add-3.png b/user_manual/images/e2ee-web-add-3.png new file mode 100644 index 00000000000..85107cd7729 Binary files /dev/null and b/user_manual/images/e2ee-web-add-3.png differ