Skip to content

Commit 2a82c9c

Browse files
committed
Restructure encrypted-file-names
make it more accessible for non-techy users
1 parent 25c1932 commit 2a82c9c

File tree

1 file changed

+50
-43
lines changed

1 file changed

+50
-43
lines changed

docs/desktop/encrypted-file-names.md

Lines changed: 50 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -7,72 +7,41 @@ sidebar_position: 7
77
# Encrypted File Names
88

99
:::info
10-
Neither file name nor directory structure encryption can be disabled.
10+
File name and directory structure encryption **cannot** be disabled.
1111
:::
1212

13-
Cryptomator protects your files by not only encrypting their content, but also their names and the overall directory structure of the vault.
14-
For example, if you have a directory structure inside your vault like this:
13+
Cryptomator protects your files by not only encrypting their content, but also their names and the overall directory structure of the vault. As a result, encrypted files and folders inside the vault storage location do not reveal the original names or layout (for an example see [below](#technical-example)).
1514

16-
```
17-
.
18-
├─ myProject.pptx
19-
├─ Images for Project
20-
│ └─ ImageOfBees.jpg
21-
└─ ...
22-
```
23-
24-
The actual directory structure of the vault on your hard drive/cloud will look like this:
15+
This matters whenever you need to match a cleartext file in your unlocked vault with its encrypted counterpart in the vault storage location, for example when restoring an older version from a cloud provider or backup tool.
2516

26-
```
27-
.
28-
├─ d
29-
│ ├─ BZ
30-
│ │ └─ R4VZSS5PEF7TU3PMFIMON5GJRNBDWA
31-
│ │ ├─ dirId.c9r # internal vault file
32-
│ │ ├─ 5TyvCyF255sRtfrIv**83ucADQ==.c9r # myProject.pptx
33-
│ │ └─ FHTa55bH*sUfVDbEb0gTL9hZ8nho.c9r # Linking entry for directory "Images for Project"
34-
│ │ └─ dir.c9r # contains information for the link
35-
│ └─ FC
36-
│ └─ ZKZRLZUODUUYTYA4457CSBPZXB5A77 # content of the directory "Images for Project"
37-
│ └─ 4lmrQYfE_5ETusEkVJlTJrcFzjwxNBymig==.c9r # ImageOfBees.jpg
38-
├─ masterkey.cryptomator
39-
├─ masterkey.cryptomator.DFD9B248.bkup
40-
└─ vault.cryptomator
41-
```
17+
The app offers two features to reveal the mapping between the cleartext and the encrypted files:
18+
* `Locate Encrypted File`: You have the cleartext file in the unlocked vault and want to find its encrypted counterpart in the vault storage location.
19+
* `Decrypt File Name`: You have an encrypted vault file and want to know its original cleartext name.
4220

43-
While this increases security, it also makes it impossible to see the original file names and directory structure without decrypting them first.
44-
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.
45-
Conversely, if you need to find the encrypted counterpart of a file inside the vault, use the `Locate Encrypted File` feature.
21+
<Image src="/img/desktop/vault-detail-unlocked.png" alt="Vault detail view in the unlocked state" width="495" height="381" />
4622

4723
## Locate Encrypted File {#locate-encrypted-file}
4824

49-
The Locate Encrypted File feature helps you find the encrypted version of a specific file from inside the vault. This comes in handy when vault files are versioned and you want to restore an older version of a file. As Cryptomator encrypts file names and obfuscates directory structures, first locate the encrypted file and then restore an older version of the encrypted file with a third-party app.
25+
The Locate Encrypted File feature helps you find the encrypted counterpart of a file from inside the vault. This comes in handy when you want to restore an older version of a file. As Cryptomator encrypts file names and obfuscates directory structures, first locate the encrypted file and then restore an older version of the encrypted file with your third-party app.
5026

5127
1. Unlock the desired vault.
5228
2. Click on the `Locate Encrypted File` button.
5329
3. Select the file within the vault.
5430

5531
As an alternative for clicking the button, you can directly drag & drop a file onto the button.
5632

57-
A file manager window opens showing the encrypted folder and marking the encrypted file.
33+
A file manager window opens showing the encrypted folder and marking the encrypted file inside the vault storage location.
5834

59-
## Decrypt File Names {#decrypting-file-names}
60-
61-
:::note
62-
Due to technical reasons, Cryptomator can only decrypt the name of an encrypted file if that file is provided by itself.
63-
It cannot determine the file's cleartext path.
64-
:::
35+
## Decrypt File Name {#decrypt-file-name}
6536

66-
The Decrypt File Name feature helps you resolve encrypted file names back to their original cleartext names. To map encrypted files back to their cleartext names, just drag and drop the files onto the button in the unlocked vault section of the main app.
37+
The Decrypt File Name feature helps you resolve encrypted file names back to their original cleartext names.
6738

6839
1. Unlock the desired vault.
6940
2. Click on the `Decrypt File Name` zone at the bottom of the unlocked view.
7041
3. Select the encrypted file.
7142

7243
As an alternative for clicking the zone, you can directly drag & drop files onto it.
7344

74-
<Image src="/img/desktop/vault-detail-unlocked.png" alt="Vault detail view in the unlocked state" width="495" height="381" />
75-
7645
A modal window opens showing a two-column table with the encrypted names on the left and their decrypted, cleartext names on the right.
7746

7847
<Image src="/img/desktop/decrypt-file-names.png" alt="Decrypt file names window" width="311" height="385" />
@@ -81,7 +50,45 @@ The action bar at the top of the table provides two buttons:
8150
* Clipboard button to copy the whole table as CSV into the system clipboard
8251
* Trash button to clear the table
8352

84-
Select single cells and copy their content with the OS-specific keyboard shortcut.
53+
You can select single cells and copy their content with the OS-specific keyboard shortcut.
54+
55+
:::note
56+
For technical reasons, Cryptomator can only decrypt the *file name* of a given encrypted file.
57+
It cannot tell where that file is located in the unlocked vault.
58+
:::
59+
60+
## Technical Example
61+
62+
If you have a directory structure inside your vault like this:
63+
64+
```
65+
.
66+
├─ myProject.pptx
67+
├─ Images for Project
68+
│ └─ ImageOfBees.jpg
69+
└─ ...
70+
```
71+
72+
The actual directory structure of the vault on your hard drive/cloud will look like this:
73+
74+
```
75+
.
76+
├─ d
77+
│ ├─ BZ
78+
│ │ └─ R4VZSS5PEF7TU3PMFIMON5GJRNBDWA
79+
│ │ ├─ dirId.c9r # internal vault file
80+
│ │ ├─ 5TyvCyF255sRtfrIv**83ucADQ==.c9r # myProject.pptx
81+
│ │ └─ FHTa55bH*sUfVDbEb0gTL9hZ8nho.c9r # Linking entry for directory "Images for Project"
82+
│ │ └─ dir.c9r # contains information for the link
83+
│ └─ FC
84+
│ └─ ZKZRLZUODUUYTYA4457CSBPZXB5A77 # content of the directory "Images for Project"
85+
│ └─ 4lmrQYfE_5ETusEkVJlTJrcFzjwxNBymig==.c9r # ImageOfBees.jpg
86+
├─ masterkey.cryptomator
87+
├─ masterkey.cryptomator.DFD9B248.bkup
88+
└─ vault.cryptomator
89+
```
90+
91+
This is why you cannot identify files in the vault storage location by name alone without decrypting them first. For more information about the vault encryption scheme read [the specification](/docs/security/vault.md).
8592

8693
## Video Walkthrough
8794

0 commit comments

Comments
 (0)