Merge pull request #81 from cryptomator/desktop/release/1.16.0

Desktop release 1.16.0

Author: infeo

source/desktop/accessing-vaults.rst

@@ -55,7 +55,7 @@ Click on ``Reveal Drive`` in the Cryptomator window to open the mount location u
 
      Even though your files are shown unencrypted in the virtual drive, they are not stored unencrypted on the hard drive but only in `volatile memory <https://en.wikipedia.org/wiki/Volatile_memory>`_
 
-.. image:: ../img/desktop/vault-detail-unlocked.png
+.. image:: ../img/desktop/vault-detail-unlocked-simple.png
     :alt: Cryptomator window showing an unlocked vault
 
 .. note::

source/desktop/encrypted-file-names.rst

@@ -0,0 +1,73 @@
+Encrypted File Names
+====================
+
+.. note::
+
+    Neither file name nor directory structure encryption can be disabled.
+
+Cryptomator protect your files by not only encrypting their content, but also their names and the overall directory structure of the vault.
+For example, if you have a directory structure inside your vault like this:
+
+.. code-block:: console
+
+    .
+    ├─ myProject.pptx
+    ├─ Images for Project
+    │  └─ ImageOfBees.jpg
+    └─ ...
+
+The actual directory structure of the vault on your hard drive/cloud will look like this:
+
+.. code-block:: console
+
+    .
+    ├─ d
+    │  ├─ BZ
+    │  │  └─ R4VZSS5PEF7TU3PMFIMON5GJRNBDWA
+    │  │     ├─ dirId.c9r  # internal vault file
+    │  │     ├─ 5TyvCyF255sRtfrIv**83ucADQ==.c9r  # myProject.pptx
+    │  │     └─ FHTa55bH*sUfVDbEb0gTL9hZ8nho.c9r  # Linking entry for directory "Images for Project"
+    │  │        └─ dir.c9r  # contains information for the link
+    │  └─ FC
+    │     └─ ZKZRLZUODUUYTYA4457CSBPZXB5A77  # content of the directory "Images for Project"
+    │        └─ 4lmrQYfE_5ETusEkVJlTJrcFzjwxNBymig==.c9r # ImageOfBees.jpg
+    ├─ masterkey.cryptomator
+    ├─ masterkey.cryptomator.DFD9B248.bkup
+    └─ vault.cryptomator
+
+
+While this increases security, it also makes it impossible to see the original file names and directory structure without decrypting them first.
+When you need to know the original name of a file (e.g. to restore an older version), you can use the ``Decrypt file name`` feature to decrypt the file name.
+
+
+.. _desktop/encrypted-file-names/decryption:
+
+Decrypting File Names
+---------------------
+
+.. note::
+
+    Due to technical reasons, given only an encrypted file Cryptomator can only decrypt its name.
+    It cannot compute its cleartext path.
+
+You can access this feature from the unlocked view of a vault in the Cryptomator main window.
+On the bottom of the unlocked view, drop files on the "Decrypt file name" zone or click on it.
+A modal window with the encrypted-decrypted-mapping opens.
+
+.. image:: ../img/desktop/vault-detail-unlocked.png
+    :alt: Vault detail view in the unlocked state
+
+The encrypted-decrypted-table has an action bar at the top with two buttons:
+* Clipboard button to copy the whole table as a CSV into the system clipboard
+* Trash button to clear the table
+
+.. image:: ../img/desktop/decrypt-file-names.png
+    :alt: Decrypt file names window
+    :scale: 63%
+    :align: center
+
+Encrypted file names and their corresponding decrypted, original name are shown inside a two column table, with the encrypted names on the right.
+If you have not dropped any files, the table is empty.
+You can click inside the empty table to select files with a file picker dialog.
+
+Once the table has content, you can select single cells and copy their content with the OS specific keyboard copy shortcut.

source/desktop/sync-conflicts.rst

@@ -1,20 +1,41 @@
 Synchronization Conflicts
 =========================
 
-Working on encrypted data from multiple locations works the same as working on unencrypted data from multiple locations. If there is a synchronization conflict, it is handled similarly to how most cloud storage services deal with conflicts.
+Working on encrypted data from multiple locations is the same as working on unencrypted data from multiple locations.
+If there is a synchronization conflict, it is handled similarly to how most cloud storage services deal with conflicts.
 
-When a sync conflict occurs, cloud storage services typically create a conflict file by appending a suffix (e.g., ``(1)``) to indicate that there was a conflict. You then need to determine which file to keep.
+When a sync conflict occurs, cloud storage services typically resolve the conflict by leaving the local file as it is and create an additional, conflicting file with the content from the cloud.
+The file name is the same as the original one, suffixed with a short string (e.g., ``(Created by Alice)``) to indicate it's a different version.
+
+Cryptomator handles encrypted files in the same way.
+It detects sync conflicts and appends the suffix from your cloud provider to the decrypted filename.
+If the filename with the conflict suffix is too long, Cryptomator shortens the overall filename.
+If the (decrypted) filename with the conflict suffix already exists, the conflicted file has a simple ``(X)`` suffix, where X is an integer.
+
+
++---------------------------------------------+----------------------------------+-----------------------------------------------+----------------------------------------------------------------+
+| Situation                                   | Cloud Provider Suffix            | Original Decrypted Name                       | New Decrypted Name                                             |
++=============================================+==================================+===============================================+================================================================+
+| Regular                                     | (Created by Alice)               | businessPitch.odp                             | businessPitch (Created by Alice).odp                           |
++---------------------------------------------+----------------------------------+-----------------------------------------------+----------------------------------------------------------------+
+| Preferred name already taken                | (Created by Alice)               | businessPitch.odp                             | businessPitch (1).odp                                          |
++---------------------------------------------+----------------------------------+-----------------------------------------------+----------------------------------------------------------------+
+| Maximum cleartext of the vault is set to 62 | (Created by Alice on 2024-01-31) | businessPitchForTheGreatIdeaIHadLastNight.odp | businessPitchForTheGreatIdeaI (Created by Alice on 2024-01.odp |
++---------------------------------------------+----------------------------------+-----------------------------------------------+----------------------------------------------------------------+
 
-Cryptomator handles encrypted files in the same way. It detects synchronization conflicts and displays the conflicted file with a ``(X)`` suffix, where X is an integer.
 
 .. note::
 
-    Sync conflicts can happen in cloud storages for several reasons. In such cases, it is up to you to decide what to do with the conflicted files. It is recommended to manually check both files and determine which one to keep. If you conclude that both files are identical, you can delete one copy. The organization of your files is entirely in your hands.
+    Sync conflicts can happen in cloud storages for several reasons.
+    In such cases, it is up to you to decide what to do with the conflicted files.
+    It is recommended to manually check both files and determine which one to keep.
+    If you conclude that both files are identical, you can delete one copy.
+    The organization of your files is entirely in your hands.
 
 Handling Sync Conflicts
 -----------------------
 
-1. When a sync conflict is detected, Cryptomator will display the conflicted file with a ``(X)`` suffix, where X is an increasing integer.
+1. When a sync conflict is detected, Cryptomator will display the conflicted file with a suffix, as shown in the table above.
 2. Manually review both the original and conflicted files.
 3. Decide which file to keep based on your review.
 4. If both files are identical, you can delete one of the copies to resolve the conflict.
@@ -24,8 +45,11 @@ By following these steps, you can effectively manage synchronization conflicts a
 Example
 -------
 
-Suppose you have a file named ``document.txt`` in your vault. In the encrypted vault, this file might be represented with an encrypted name such as ``5TyvCyF255sRtfrIv...83ucADQ==.c9r``.
+Suppose you have a file named ``projectPlan.doc`` in your vault.
+In the encrypted vault, this file might be represented with an encrypted name such as ``5TyvCyF255sRtfrIv...83ucADQ==.c9r``.
 
-If a synchronization conflict occurs, it will happen on the encrypted filename. Cryptomator detects unexpected patterns in the encrypted filename and handles the conflict accordingly.
+If a synchronization conflict occurs, it will happen on the encrypted filename.
+Cryptomator detects unexpected patterns in the encrypted filename and handles the conflict accordingly.
 
-For example, if there is a conflict with ``5TyvCyF255sRtfrIv...83ucADQ== (1).c9r``, Cryptomator will decrypt the decryptable part of the filename and rename the file to include a conflict suffix. The conflicted file might be renamed to something like ``FHTa55bH...sUfVDbEb0gTL9hZ8nho.c9r``, which corresponds to ``document (1).txt``.
+For example, if there is a conflict with ``5TyvCyF255sRtfrIv...83ucADQ== (Created by Alice).c9r``, Cryptomator will decrypt the encrypted part of the filename and rename the file to include a conflict suffix.
+The conflicted file might be renamed to something like ``FHTa55bH...sUfVDbEb0gTL9hZ8nho.c9r``, which corresponds to ``projectPlan (Created by Alice).doc``.

source/desktop/vault-events.rst

@@ -0,0 +1,44 @@
+Events and Event View
+=====================
+
+Vault events give information about the vault's status and certain activities.
+There are several types of events, including conflict detection or corrupted files.
+All vault events are logged in the event view, which can be opened from the main window.
+
+.. note::
+
+    Vault events are not persisted on the hard disk.
+    They are only stored in memory and are lost when the application is closed.
+
+
+.. _desktop/vault-events/event-viewer:
+
+Event View
+------------
+
+The event view shows the events of all vaults.
+To open the event view, click on the Bell icon in the lower left corner of the main window.
+If new, unread events are present, the icon has a small red dot.
+
+.. image:: ../img/desktop/event-view.png
+    :scale: 63%
+    :alt: Event view
+
+
+The event view has an action bar at the top followed by the actual event list.
+Events are displayed from newest (top) to oldest (bottom).
+You can filter the events by the vault they belong to.
+Also, you can clear the event log by clicking on the trash can icon.
+
+
+.. _desktop/vault-events/vault-event:
+
+Vault Event
+-----------
+
+A vault event consists of a title, its number of appearances in brackets, an affected file, and a timestamp.
+If you hover over the event, a button to open a context menu appears.
+The context menu contains event-specific actions, mostly to reveal affected files in the file manager.
+
+If the vault of the event is locked, the event is anonymized.
+To view the event details, you need to unlock the corresponding vault first.

source/img/desktop/decrypt-file-names.png

@@ -25,7 +25,9 @@ If you are interested in the security of Cryptomator, have a look at our :ref:`s
    desktop/accessing-vaults.rst
    desktop/password-and-recovery-key.rst
    desktop/vault-management.rst
+   desktop/encrypted-file-names.rst
    desktop/volume-type.rst
+   desktop/vault-events.rst
    desktop/error-handling.rst
    desktop/sync-conflicts.rst
    desktop/advanced-settings.rst