Skip to content

Commit 9b495fa

Browse files
infeoinfeo
committed
Merge branch 'develop'
2 parents 92a16b3 + 85c6bda commit 9b495fa

File tree

2 files changed

+94
-14
lines changed

2 files changed

+94
-14
lines changed

‎docs/desktop/accessing-vaults.md‎

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,26 @@ You can only access decrypted files of a vault if you can unlock it. Unlocking a
1212

1313
## Unlocking a Vault {#unlocking-a-vault}
1414

15-
1. Select the vault you wish to unlock.
16-
2. Click on the large `Unlock` button located at the center of the Cryptomator window.
15+
1. Select the vault you wish to unlock in the vault list.
16+
2. Click on the large `Unlock` button in the vault detail view of the Cryptomator window.
1717
3. Enter your vault's password.
18-
19-
A confirmation will be displayed if your password is correct.
20-
You can either close the confirmation window by clicking `Done` or click on `Reveal Vault` to show your unlocked vault in your file manager.
18+
4. Click the `Unlock` button.
2119

2220
<Image src="/img/desktop/unlock-prompt.png" alt="Vault unlock dialog" width="512" height="285" />
2321

2422
:::note
25-
You can store the password in your operating system's keychain by checking the "Save Password" checkbox. There are also plug-ins available for Cryptomator, that allow you to store Cryptomator's vault passwords in third party password managers:
26-
27-
- [KeePassXC plug-in](https://plugin.purejava.org) stores Cryptomator's vault passwords in a KeePassXC database
28-
- [Bitwarden plug-in](https://github.com/purejava/cryptomator-bitwarden/wiki) stores the vault passwords in Bitwarden's Secrets Manager
29-
30-
With a saved password, you can unlock your vaults without typing a password on every unlock. It's faster.
31-
:::
23+
You can store the password in your operating system's keychain by checking the "Remember password" checkbox.
24+
With a saved password, you can unlock your vaults without typing a password on every unlock.
25+
For more information, see the [Storing Passwords](/docs/desktop/password-and-recovery-key.md#storing-passwords) section.
3226

3327
:::warning
34-
Only store your password in the system's keychain on trusted devices.
35-
Anyone with access to the computer with stored passwords will be able to unlock your vault, and in some cases, even find your password.
28+
Only store your password in the system's keychain on trusted devices.
29+
Anyone with access to these devices will be able to unlock your vault, and in some cases, even read your stored password.
3630
:::
3731

32+
If your password is correct, a success message will be displayed, and the vault will be unlocked.
33+
You can close the success window by clicking `Done`, or click `Reveal Vault` to show the unlocked vault in your file manager.
34+
3835
<Image src="/img/desktop/unlock-success.png" alt="Vault unlock success dialog" width="512" height="314" />
3936

4037
## Locking a Vault {#locking-a-vault}

‎docs/desktop/password-and-recovery-key.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,89 @@ The password is used to derive a [KEK](https://en.wikipedia.org/wiki/Glossary_of
5454
If you like to encrypt your vault files with a new, stronger password, you need to create a new vault and drag the data from the old to the new one. Make sure to wipe all backups of the old vault afterwards.
5555
:::
5656

57+
## Storing Passwords {#storing-passwords}
58+
59+
:::info
60+
Storing passwords in a keychain can be convenient, but it also poses a security risk if your device is compromised.
61+
Ensure that your device is secure and that you trust the used keychain.
62+
:::
63+
64+
By default, Cryptomator does not store your vault's password on your hard drive.
65+
It is only used to unlock the vault and is destroyed afterward.
66+
However, you can enable the option to store the password in the system keychain.
67+
This is useful if you want to avoid entering the password every time you unlock the vault.
68+
69+
To enable this option:
70+
1. Navigate to the `General` tab in the preferences.
71+
1. Check the box `Store passwords with …` and select your preferred keychain (e.g., macOS Keychain, Windows Hello, or GNOME Keyring).
72+
73+
:::note
74+
Not all keychains are supported on all platforms. For example, macOS Keychain is only available on macOS, and Windows Hello is only available on Windows.
75+
:::
76+
77+
To store a password for a vault:
78+
1. Start the unlocking process by selecting the vault and clicking on `Unlock` in the main window.
79+
1. Tick the box `Remember password` in the unlock dialog.
80+
1. Enter the vault's password and click on `Unlock`.
81+
82+
The password will be stored in the selected keychain, allowing you to unlock the vault without entering the password again.
83+
Some keychains may require you to authenticate (e.g., using your system password or biometric authentication) before storing/accessing the password.
84+
85+
The stored password can be removed at any time by opening the `Vault Options` → `Password` tab and clicking on `Remove saved password`.
86+
87+
Available keychains are:
88+
89+
<details>
90+
<summary>macOS Keychain (macOS)</summary>
91+
92+
Uses the built-in macOS keychain to store your password.
93+
The password is only stored locally on your Mac and is encrypted using the system's security features.
94+
</details>
95+
<details>
96+
<summary>Touch ID (macOS)</summary>
97+
98+
Uses the built-in macOS keychain, but requires authentication with Touch ID before you can access the password.
99+
The password is only stored locally on your Mac and is encrypted using the system's security features.
100+
101+
Requires a compatible Mac with Touch ID enabled.
102+
</details>
103+
<details>
104+
<summary>Windows Hello (Windows)</summary>
105+
106+
Uses the Windows Hello feature to encrypt your password.
107+
The password is only stored locally on your Windows device and is encrypted using a key derived from your Windows user account.
108+
109+
Requires a compatible Windows device with Windows Hello enabled.
110+
</details>
111+
<details>
112+
<summary>Windows Data Protection API (Windows)</summary>
113+
114+
Uses the Windows Data Protection API to encrypt your password.
115+
The password is only stored locally on your Windows device and is encrypted using a key derived from your Windows user account.
116+
</details>
117+
<details>
118+
<summary>GNOME Keyring (Linux)</summary>
119+
120+
Uses the GNOME keyring to store your password.
121+
The password is only stored locally in the default GNOME keyring.
122+
123+
Requires GNOME keyring to be installed and running on your Linux system, with the default keyring present.
124+
</details>
125+
<details>
126+
<summary>KDE Wallet (Linux)</summary>
127+
128+
Uses the KDE Wallet to store your password.
129+
The password is only stored locally in the default KDE Wallet.
130+
131+
Requires KDE Wallet to be installed and running on your Linux system, with the default wallet present.
132+
</details>
133+
134+
There are also third-party plug-ins for Cryptomator that allow you to store vault passwords in external password managers:
135+
136+
- [KeePassXC plug-in](https://plugin.purejava.org) stores Cryptomator's vault passwords in a KeePassXC database.
137+
- [Bitwarden plug-in](https://github.com/purejava/cryptomator-bitwarden/wiki) stores the vault passwords in Bitwarden's Secrets Manager.
138+
139+
57140
## Show Recovery Key {#show-recovery-key}
58141

59142
You can derive a recovery key during vault creation or even later as long as you know your vault's password.

0 commit comments

Comments
 (0)