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

added note that pycrypto is required

Browse source 
made other small changes for grammar and clarity
This commit is contained in:
Guy B. deBros 2020-06-08 07:53:35 -04:00
parent 7b09ff28b4
commit 35c7438ec4
1 changed files with 45 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
docs/encryption.md
View file

@ -1,60 +1,68 @@
# Encryption
## Encrypting and decrypting
## `pycrypto`
If you don’t choose to encrypt your file when you run
`jrnl` for the first time, you can encrypt
your existing journal file or change its password using this:
Please note that _all_ of `jrnl`'s encryption functions require `pycrypto`,
which can be installed using `pip`:
```sh
pip3 install pycrypto
```
## Encrypting and Decrypting
If you chose not to encrypt your file when you ran `jrnl` for the first time,
you can still encrypt your existing journal file or change its password using
the following command:
``` sh
jrnl --encrypt
```
If it is already encrypted, you will first be asked for the current
password. You can then enter a new password and your plain journal will
replaced by the encrypted file. Conversely,
If your file is already encrypted, you will first be asked for the current
password. You can then enter a new password, and your unencrypted file will
replaced with the new encrypted file. Conversely,
``` sh
jrnl --decrypt
```
will replace your encrypted journal file with a journal in plain text. You
can also specify a filename, i.e. `jrnl --decrypt plain_text_copy.txt`,
to leave your original file untouched.
replaces your encrypted journal file with a journal in plain text. You can also
specify a filename, e.g., `jrnl --decrypt plain_text_copy.txt`, to leave the
original encrypted file untouched and create a new plain text file next to it.
## Storing passwords in your keychain
## Storing Passwords in Your Keychain
Whenever you encrypt your journal, you are asked whether you want to
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
your journal.
When you encrypt your journal, you will be asked whether you want to store the
encryption password in your keychain. This saves you the trouble of having to
enter your password every time you want to write in or read your journal.
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
not on another – you can run `jrnl --encrypt` on an encrypted
journal and use the same password again.
If you don't initially store the password in the keychain but decide to do so at
a later point---or if you want to store it in one computer's keychain but not
in another computer's---you can run `jrnl --encrypt` on an encrypted journal
and use the same password again. This will trigger the keychain storage prompt.
## A note on security
## A Note on Security
While `jrnl` follows best practices, total security is an illusion.
There are a number of ways that people can at least partially
While `jrnl` follows best practices, total security is never possible in the
real world. There are a number of ways that people can at least partially
compromise your `jrnl` data. See the [Privacy and Security](./security.md)
documentation for more information.
page for more information.
## No password recovery
## Password Recovery
There is no method to recover or reset your `jrnl` password. If you lose it,
your data is inaccessible.
your data is inaccessible forever.
## Manual decryption
## Manual Decryption
Should you ever want to decrypt your journal manually, you can do so
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
(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
before being encrypted. Here’s a Python script that you can use to
decrypt your journal:
Should you ever want to decrypt your journal manually, you can do so 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 (initialization 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 before being encrypted.
Here is a Python script that you can use to decrypt your journal:
``` python
#!/usr/bin/env python3
@ -66,18 +74,18 @@ import hashlib
import sys
parser = argparse.ArgumentParser()
parser.add_argument("filepath", help="journal file to decrypt")
parser.add_argument(“filepath”, help=”journal file to decrypt”)
args = parser.parse_args()
pwd = getpass.getpass()
key = hashlib.sha256(pwd.encode('utf-8')).digest()
key = hashlib.sha256(pwd.encode(‘utf-8’)).digest()
with open(args.filepath, 'rb') as f:
with open(args.filepath, ‘rb’) as f:
ciphertext = f.read()
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
plain = crypto.decrypt(ciphertext[16:])
plain = plain.strip(plain[-1:])
plain = plain.decode("utf-8")
plain = plain.decode(“utf-8”)
print(plain)
```