Skip to content

Commit 8fb8e9b

Browse files
authored
Merge pull request #87 from cryptomator/feature/15-character-conversion
Add info about keyboard layouts and special characters in passwords
2 parents 54a5258 + 48474cc commit 8fb8e9b

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

docs/desktop/adding-vaults.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ This is especially important if you plan to share a vault with someone.
7979
Additionally, we recommend sharing passwords only over a secure channel, like PGP encypted emails, or end-to-end encrypted chat apps.
8080
:::
8181

82+
:::info
83+
Be mindful of your keyboard layout when creating passwords. Special characters and dead keys can behave differently across keyboard layouts (e.g., Dutch vs. English). This may cause password entry issues if you switch keyboard layouts later. For more information, see [Keyboard Layouts and Special Characters](/docs/security/best-practices.md#keyboard-layouts-and-special-characters).
84+
:::
85+
8286
<Image src="/img/desktop/add-vault-4.png" alt="Choose a strong password for your Cryptomator vault" width="718" height="590" />
8387

8488
:::warning

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ In the opened window, you will be asked for:
3434
2. A new password. We suggest following our guide on choosing a [strong password](/docs/security/best-practices.md#good-passwords).
3535
3. Enter the new password again.
3636

37+
:::info
38+
Be mindful of your keyboard layout when changing passwords. Special characters and dead keys can behave differently across keyboard layouts (e.g., Dutch vs. English). This may cause password entry issues if you switch keyboard layouts later. For more information, see [Keyboard Layouts and Special Characters](/docs/security/best-practices.md#keyboard-layouts-and-special-characters).
39+
:::
40+
3741
In order to proceed, you must confirm that you understand your action by selecting a checkbox.
3842

3943
Finally, click on the `Change` button to change the password.

docs/security/best-practices.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,21 @@ Thus, we recommend using a password manager to generate and store the passwords.
3838
By doing so, you only have to remember a few or a single secure password.
3939
Otherwise, we recommend using at least 10 characters, ideally [use sentences instead of words](https://xkcd.com/936/).
4040

41+
### Keyboard Layouts and Special Characters {#keyboard-layouts-and-special-characters}
42+
43+
Be aware that keyboard layout differences can affect password entry. When creating a password, consider these important points:
44+
45+
* Use the same keyboard layout when entering your password. Characters may produce different results depending on your keyboard language setting.
46+
* Some keyboard layouts use "dead keys" for accented characters. For example, pressing `'` followed by `e` might produce `é` instead of `'e`. This can cause unexpected character conversion in passwords.
47+
* Characters like `'`, `"`, `` ` ``, `^`, and `~` may behave differently across keyboard layouts and can be particularly problematic.
48+
49+
To avoid issues:
50+
51+
* Test your password immediately after setting it by locking and unlocking your vault.
52+
* Avoid special characters that may be affected by dead keys if you frequently switch between keyboard layouts.
53+
* If you must use different keyboard layouts, document which layout was used when creating the password.
54+
* Consider using alphanumeric characters and basic symbols that remain consistent across keyboard layouts.
55+
4156
## Backup Strategy {#backup-strategy}
4257

4358
Cryptomator is not a backup solution.

0 commit comments

Comments
 (0)