fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-10 08:38:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

In Encryption docs, improve grammar and typography

Browse source
This commit is contained in:
Rory O’Kane 2019-08-19 04:01:33 -04:00
parent 05234590eb
commit 374cae687a
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/encryption.md
View file

@ -2,9 +2,9 @@
## Encrypting and decrypting ## Encrypting and decrypting
If you don't choose to encrypt your file when you run If you don’t choose to encrypt your file when you run
`jrnl` for the first time, you can encrypt `jrnl` for the first time, you can encrypt
your existing journal file or change its password using your existing journal file or change its password using this:
``` sh ``` sh
jrnl --encrypt jrnl --encrypt
@ -18,38 +18,38 @@ replaced by the encrypted file. Conversely,
jrnl --decrypt jrnl --decrypt
``` ```
will replace your encrypted journal file by a Journal in plain text. You will replace your encrypted journal file with a journal in plain text. You
can also specify a filename, ie. `jrnl --decrypt plain_text_copy.txt`, can also specify a filename, i.e. `jrnl --decrypt plain_text_copy.txt`,
to leave your original file untouched. to leave your original file untouched.
## Storing passwords in your keychain ## Storing passwords in your keychain
Whenever you encrypt your journal, you are asked whether you want to Whenever you encrypt your journal, you are asked whether you want to
store the encryption password in your keychain. If you do this, you store the encryption password in your keychain. If you do this, you
won't have to enter your password every time you want to write or read won’t have to enter your password every time you want to write or read
your journal. your journal.
If you don't initially store the password in the keychain but decide to If you don’t initially store the password in the keychain but decide to
do so at a later point -- or maybe want to store it on one computer but do so at a later point – or maybe want to store it on one computer but
not on another -- you can simply run `jrnl --encrypt` on an encrypted not on another – you can simply run `jrnl --encrypt` on an encrypted
journal and use the same password again. journal and use the same password again.
## A note on security ## A note on security
While jrnl follows best practises, true security is an illusion. While jrnl follows best practises, true security is an illusion.
Specifically, jrnl will leave traces in your memory and your shell Specifically, jrnl will leave traces in your memory and your shell
history -- it's meant to keep journals secure in transit, for example history – it’s meant to keep journals secure in transit, for example
when storing it on an when storing it on an
[untrusted](http://techcrunch.com/2014/04/09/condoleezza-rice-joins-dropboxs-board/) [untrusted](http://techcrunch.com/2014/04/09/condoleezza-rice-joins-dropboxs-board/)
services such as Dropbox. If you're concerned about security, disable services such as Dropbox. If you’re concerned about security, disable
history logging for journal in your `.bashrc` history logging for journal in your `.bashrc`:
``` sh ``` sh
HISTIGNORE="$HISTIGNORE:jrnl *" HISTIGNORE="$HISTIGNORE:jrnl *"
``` ```
If you are using zsh instead of bash, you can get the same behaviour If you are using zsh instead of bash, you can get the same behaviour by
adding this to your `zshrc` adding this to your `zshrc`:
``` sh ``` sh
setopt HIST_IGNORE_SPACE setopt HIST_IGNORE_SPACE
@ -69,8 +69,8 @@ with any program that supports the AES algorithm in CBC. The key used
for encryption is the SHA-256-hash of your password, the IV for encryption is the SHA-256-hash of your password, the IV
(initialisation vector) is stored in the first 16 bytes of the encrypted (initialisation vector) is stored in the first 16 bytes of the encrypted
file. The plain text is encoded in UTF-8 and padded according to PKCS\#7 file. The plain text is encoded in UTF-8 and padded according to PKCS\#7
before being encrypted. Here's a Python script that you can use to before being encrypted. Here’s a Python script that you can use to
decrypt your journal decrypt your journal:
``` python ``` python
#!/usr/bin/env python3 #!/usr/bin/env python3