diff options
| author | Simeon Simeonov | 2018-04-11 13:45:27 +0200 |
|---|---|---|
| committer | Simeon Simeonov | 2018-04-11 13:45:27 +0200 |
| commit | 81693819d6cf81766e6a9ef4bbeae9e556a21b75 (patch) | |
| tree | 02676c0e67fe2ea7bc4256e786eda5d3ee925484 | |
| parent | 97419f99819dc4dfb3b51a57485cb404c9ba299a (diff) | |
Fix some documentation typos
| -rw-r--r-- | README.md | 29 |
1 files changed, 14 insertions, 15 deletions
| @@ -11,7 +11,7 @@ Implemented features and fixes not present in the official Sylpheed release | |||
| 11 | 11 | ||
| 12 | - (feature) | 12 | - (feature) |
| 13 | Support for encrypting and storing encrypted passwords using a master password. | 13 | Support for encrypting and storing encrypted passwords using a master password. |
| 14 | See README for more details. | 14 | Read bellow for more details! |
| 15 | 15 | ||
| 16 | 16 | ||
| 17 | Master password | 17 | Master password |
| @@ -24,7 +24,7 @@ and is currently in an experimental state. | |||
| 24 | Motivation | 24 | Motivation |
| 25 | ---------- | 25 | ---------- |
| 26 | 26 | ||
| 27 | Currently Sylpheed is storing passwords in palin-text. One can always refrain | 27 | Currently Sylpheed is storing passwords in plain-text. One can always refrain |
| 28 | from storing passwords and let Sylpheed prompt for them, but the more accounts | 28 | from storing passwords and let Sylpheed prompt for them, but the more accounts |
| 29 | one has, the more annoying this becomes. | 29 | one has, the more annoying this becomes. |
| 30 | 30 | ||
| @@ -35,19 +35,19 @@ prompt for the master password. | |||
| 35 | Security goals | 35 | Security goals |
| 36 | -------------- | 36 | -------------- |
| 37 | 37 | ||
| 38 | - attacker (A) should not be able to derive the password from the digest | 38 | - attacker (A) should not be able to derive the password from the digest. |
| 39 | 39 | ||
| 40 | - A should not be able to derive the master password even if she has | 40 | - A should not be able to derive the master password even if she has |
| 41 | read and write access to the storage | 41 | read and write access to the storage. |
| 42 | 42 | ||
| 43 | - A should not be able to determine the length of the encrypted password | 43 | - A should not be able to determine the length of the encrypted password |
| 44 | even if she has read and write access to the storage | 44 | even if she has read and write access to the storage. |
| 45 | 45 | ||
| 46 | - A should not be able to craft an edited password without obtaining the | 46 | - A should not be able to craft an edited password without obtaining the |
| 47 | master password | 47 | master password. |
| 48 | 48 | ||
| 49 | - a warning / prompt should be given if a user accidently types in a "wrong" | 49 | - a warning / prompt should be given if a user accidentally types in a "wrong" |
| 50 | master password before decryption is initiated | 50 | master password before decryption is initiated. |
| 51 | 51 | ||
| 52 | 52 | ||
| 53 | Usage in Sylpheed | 53 | Usage in Sylpheed |
| @@ -55,7 +55,7 @@ Usage in Sylpheed | |||
| 55 | 55 | ||
| 56 | - backup your Sylpheed profile (often $HOME/.sylpheed-2.0)! | 56 | - backup your Sylpheed profile (often $HOME/.sylpheed-2.0)! |
| 57 | 57 | ||
| 58 | - start Sylpheed and open Configuration -> Common preferences...! | 58 | - start Sylpheed and open "Configuration" -> "Common preferences..."! |
| 59 | 59 | ||
| 60 | - select the "Master password" tab, enable "Use master password" and | 60 | - select the "Master password" tab, enable "Use master password" and |
| 61 | apply the changes! | 61 | apply the changes! |
| @@ -64,6 +64,8 @@ Usage in Sylpheed | |||
| 64 | 64 | ||
| 65 | - you will be asked to type and verify a new master password. | 65 | - you will be asked to type and verify a new master password. |
| 66 | 66 | ||
| 67 | - set your new passwords from the "Configuration" -> "Edit accounts..."! | ||
| 68 | |||
| 67 | Note: | 69 | Note: |
| 68 | Sylpheed will automatically convert existing stored passwords, but it will not | 70 | Sylpheed will automatically convert existing stored passwords, but it will not |
| 69 | touch your backups. You will have to remove all remnants of plain-text | 71 | touch your backups. You will have to remove all remnants of plain-text |
| @@ -138,7 +140,7 @@ Encryption | |||
| 138 | 140 | ||
| 139 | Input: | 141 | Input: |
| 140 | 142 | ||
| 141 | - palin-text password to be encrypted (P) | 143 | - plain-text password to be encrypted (P) |
| 142 | 144 | ||
| 143 | - plain-text master-password used for key derivation (M) | 145 | - plain-text master-password used for key derivation (M) |
| 144 | 146 | ||
| @@ -183,7 +185,7 @@ Input: | |||
| 183 | 185 | ||
| 184 | Output: | 186 | Output: |
| 185 | 187 | ||
| 186 | - palin-text password (P) | 188 | - plain-text password (P) |
| 187 | 189 | ||
| 188 | 190 | ||
| 189 | Operation: | 191 | Operation: |
| @@ -218,7 +220,7 @@ Limitations | |||
| 218 | 220 | ||
| 219 | - currently only the 'password' and 'smtp_password' keys in accountrc | 221 | - currently only the 'password' and 'smtp_password' keys in accountrc |
| 220 | are encrypted. | 222 | are encrypted. |
| 221 | A machanism that allows for any key and even folders to be encrypted | 223 | A mechanism that allows for any key and even folders to be encrypted |
| 222 | should be considered in the future. | 224 | should be considered in the future. |
| 223 | 225 | ||
| 224 | - currently it is not possible to select alternative ciphers, hash-functions | 226 | - currently it is not possible to select alternative ciphers, hash-functions |
| @@ -226,6 +228,3 @@ Limitations | |||
| 226 | 228 | ||
| 227 | - currently it is not possible to change your master password without having to | 229 | - currently it is not possible to change your master password without having to |
| 228 | set your passwords manually. | 230 | set your passwords manually. |
| 229 | |||
| 230 | -- | ||
| 231 | Simeon Simeonov <sgs [ATTT] pichove (DOTTT) org> | ||