Linkify docs and reorder a bit - pee - Pee a password manager;Pee - because you have to...
(HTM) git clone git://vernunftzentrum.de/pee.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) LICENSE
---
(DIR) commit 17a1288a736cdf7cbedb59fcfddb462769398dd5
(DIR) parent d81668d38fa2e3d5fb6d2c0878bd614b33a7b929
(HTM) Author: Christian Kellermann <ckeen@pestilenz.org>
Date: Sat, 9 Jan 2016 12:45:30 +0100
Linkify docs and reorder a bit
Diffstat:
README.rst | 30 ++++++++++++++++--------------
1 file changed, 16 insertions(+), 14 deletions(-)
---
(DIR) diff --git a/README.rst b/README.rst
@@ -16,10 +16,20 @@ Pee will output the password on the console by default.
If you want to have it available for copy and paste, you should use an external program like xsel.
+Dependencies
+------------
+
+Pee is written in `CHICKEN Scheme`__, the cryptography parts are provided by the tweetnacl egg.
+The BLAKE2s_ code has been taken verbatim from the reference implementations and is included in the pee source code.
+Other eggs pee depends on are: srfi-1, srfi-4, getopt-long, matchable and stty.
+
+.. _BLAKE2s: https://github.com/BLAKE2/BLAKE2.git
+__ https://www.call-cc.org
+
Installing
----------
-After unpacking the source build it using the CHICKEN Scheme compiler.
+After unpacking the source build it using the CHICKEN Scheme compiler::
$ chicken-install blob-utils getopt-long matchable stty tweetnacl
$ csc -s -Jc crypto-helper.scm blake2s-ref.c -C -std=c99
@@ -36,25 +46,17 @@ If all goes well it will clean up afterwards.
If not you will have to manually do the clean up.
If you have cloned from the git repo, a git clean -f will do that for you.
-Dependencies
-------------
-
-Pee is written in CHICKEN Scheme, the cryptography parts are provided by the tweetnacl egg.
-The BLAKE2s code has been taken verbatim from the reference implementations and is included in the pee source code.
-Other eggs pee depends on are: srfi-1, srfi-4, getopt-long, matchable and stty.
-
-https://github.com/BLAKE2/BLAKE2.git
-
Cryptography
------------
-The key is derived using the BLAKE2s key derivation function.
+The key is derived using the BLAKE2s_ key derivation function.
For symmertric encryption the tweetnacl library is used.
-Passwords are generated using OpenBSD's arc4random() RNG.
+If running on OpenBSD, passwords are generated using OpenBSD's `arc4random()`__ RNG.
+If running on any other OS /dev/random will be used as a source for random bytes.
Passwords are choosen from this set of characters "abcdefhijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!@#$%^&*()-=~?/\|+,:.<>{}[]".
-
+__ http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man3/arc4random.3
License
-------
@@ -63,7 +65,7 @@ The blake2s Hash function has been licensed under a Creative Commons CC0 1.0 Uni
The tweetnacl code is in the public domain.
The tweetnacl egg is BSD licensed.
-The rest of the pee code comes with a ISC license.
+The rest of the pee code comes with a OpenBSD (ISC like) license.
Copyright (c) 2016 Christian Kellermann <ckeen@pestilenz.org>