summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSeppia <seppia@seppio.fish>2018-07-05 13:12:21 +0200
committerSeppia <seppia@seppio.fish>2018-07-05 13:12:21 +0200
commit4a0d6286e52b1252782c2943c0b4cd71f1b746fa (patch)
treecbc22480f746f83c00cf7d16f280f4a9e4f0697a
parentd4da9daf5a596399c44a01548b784b35346df840 (diff)
downloadonetimebluh-0.2.tar.gz
onetimebluh-0.2.tar.bz2
onetimebluh-0.2.zip
Updated readmev0.2
Updated README.md to match the new options and syntax.
-rw-r--r--README.md30
1 files changed, 17 insertions, 13 deletions
diff --git a/README.md b/README.md
index e86b1ac..c95da09 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ To build onetimebluh just run `make` and you will find the executable binary in
## Install
If you want to install onetimebluh, just run `make install`.
-If you are using Archlinux onetimebluh is available in the [AUR](https://aur.archlinux.org/packages/otbluh-git/) and in my unofficial Archlinux repository [seppianet](https://archlinux.seppia.net/).
+If you are using Archlinux onetimebluh is available in the [AUR](https://aur.archlinux.org/packages/otbluh/) and in my unofficial Archlinux repository [seppianet](https://archlinux.seppia.net/).
To use the repo simply add the following to you `pacman.conf` (currently the repo has only `x86_64` packages):
@@ -20,32 +20,34 @@ SigLevel = Optional
Server = https://archlinux.seppia.net/$arch
```
+If you want to ahve alvways the latest version there is also the git package in the [AUR](https://aur.archlinux.org/packages/otbluh-git/)
+
## Usage
This example creates a `message` file of 4 KiB and a key of the same length (we are encrypting a pseudo random bytes file):
```
dd bs=512 count=8 if=/dev/urandom of=message
-otbluh --key-gen --nbytes 4K --output pad
-otbluh --encrypt message --key-file pad --output encrypted-message
-otbluh --decrypt encrypted-message --key-file pad --outptut decrypted-message
+otbluh --gen-key --nbytes 4K --output pad
+otbluh --encrypt --input message --key-file pad --output encrypted-message
+otbluh --decrypt --input encrypted-message --key-file pad --outptut decrypted-message
```
It is recommended to use the `-t` option in order to be sure not to use more than once the same pieces of the pad to encrypt your data. Here follows an other example:
```
-otbluh --encrypt message --key-file pad --output encrypted-message --tear-page
+otbluh --encrypt --input message --key-file pad --output encrypted-message --tear-page
```
Or using the short options:
```
-otbluh -te message -k pad -o encrypted-message
+otbluh -tei message -k pad -o encrypted-message
```
If you want you can use the `--bluh` function to get the binary dump of yuor encrypted message:
```
-otbluh --bluh message --output bluhed-message
+otbluh --bluh --input message --output bluhed-message
```
You can print the help by running `otbluh --help`.
@@ -56,19 +58,21 @@ otbluh [COMMAND] [OPTIONS]
Commands:
- -b, --bluh=FILE bluhes your message or in other words performs a binary dump
- -d, --decrypt=FILE decrypt message (input) same ad --encrypt, just for the feeling
- -e, --encrypt=FILE encrypt message (input)
+ -b, --bluh bluhes your message or in other words performs a binary dump
+ -d, --decrypt decrypt message (input) same ad --encrypt, just for the feeling
+ -e, --encrypt encrypt message (input)
-g, --gen-key create key file
-h, --help print this help
- -u, --unbluh=FILE unbluhes your message (gets the orginal message from the binary dump)
+ -u, --unbluh unbluhes your message (gets the orginal message from the binary dump)
Options:
-c, --char=CAHRS reads two cahracters as argument and uses them to bluh your message
-k, --key-file=KEY_FILE use key (input)
- -n, --nbytes=NUM{K,M,G,T} number of bytes, you can specify K for KiB, M for MiB, etc...
- -o, --output=FILE output name
+ -i, --input=FILE input file
+ -n, --nbytes=NUM{K,M,G,T} number of bytes, you can specify K for KiB, M for MiB, etc...
+ -o, --output=FILE output file
+ -q, --quiet suppresses all messages, except from error releated ones
-t, --tear-page deletes from the pad file the bytes used to encrypt/decrypt
Onetimebluh project repository at https://git.eigenlab.org/seppia/onetimebluh