Skip to content

Commit bd2e4c0

Browse files
committed
add section about storing passwords
1 parent b15e549 commit bd2e4c0

1 file changed

Lines changed: 78 additions & 0 deletions

File tree

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

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,84 @@ 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. Ensure that your device is secure and that you trust the keychain you are using.
61+
:::
62+
63+
By default Cryptomator does not store your vault's password on your hard drive.
64+
It is only used to unlock the vault and destroyed afterwards.
65+
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+
2. 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+
2. Tick the box `Remember Password` in the unlock dialog.
80+
3. Enter the vault's password and click on `Unlock`.
81+
82+
This will store the password 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 accessing 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 created.
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 created.
132+
</details>
133+
134+
57135
## Show Recovery Key {#show-recovery-key}
58136

59137
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)