From 0383237511be674a466d5ce73d6257e96caed2d3 Mon Sep 17 00:00:00 2001 From: Manuel Ebert Date: Tue, 17 Apr 2012 00:07:19 +0200 Subject: [PATCH] Updated Readme from master --- README.md | 20 +++++++++++--------- index.html | 22 ++++++++++++---------- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3ef160aa..6afe2f45 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ jrnl *jrnl* is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncinc and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten. -Optionally, your journal can be encrypted using AES encryption. +Optionally, your journal can be encrypted using the [256-bit AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). ### Why keep a journal? @@ -111,7 +111,7 @@ It's just a regular `json` file: - `journal`: path to your journal file - `editor`: if set, executes this command to launch an external editor for writing your entries, e.g. `vim` or `subl -w` (note the `-w` flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal). - - `encrypt`: if true, encrypts your journal using AES encryption. + - `encrypt`: if true, encrypts your journal using AES. - `password`: you may store the password you used to encrypt your journal in plaintext here. This is useful if your journal file lives in an unsecure space (ie. your Dropbox), but the config file itself is more or less safe. - `tagsymbols`: Symbols to be interpreted as tags. (__See note below__) - `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time @@ -128,6 +128,14 @@ It's just a regular `json` file: > > Or use the built-in prompt or an external editor to compose your entries. +### JSON export + +Can do: + + jrnl -json + +Why not create a beautiful [timeline](http://timeline.verite.co/) of your journal? + ### Encryption Should you ever want to decrypt your journal manually, you can do so with any program that supports the AES algorithm. The key used for encryption is the SHA-256-hash of your password, and the IV (initialisation vector) is stored in the first 16 bytes of the encrypted file. So, to decrypt a journal file in python, run @@ -137,10 +145,4 @@ Should you ever want to decrypt your journal manually, you can do so with any pr with open("my_journal.txt") as f: cipher = f.read() crypto = AES.new(key, AES.MODE_CBC, iv = cipher[:16]) - plain = crypto.decrypt(cipher) - -### JSON export - -Can do: - - jrnl -json + plain = crypto.decrypt(cipher[16:]) diff --git a/index.html b/index.html index c95f90a6..6e23566b 100644 --- a/index.html +++ b/index.html @@ -65,7 +65,7 @@

jrnl is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncinc and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.

-

Optionally, your journal can be encrypted using AES encryption.

+

Optionally, your journal can be encrypted using the 256-bit AES.

Why keep a journal?

@@ -185,7 +185,7 @@ python setup.py install