summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSeppia <nonso@insicuri.net>2016-11-30 02:34:09 +0100
committerSeppia <nonso@insicuri.net>2016-11-30 02:34:09 +0100
commitee43c2ecf27514330ef13bb37fff95b3f76afbe6 (patch)
tree58b5c9a3eda5b1c8aee8931ccd43e44e8ab6cf42
parent3a5e86e17f54e6301b1e51bd930e2d22c351bdd6 (diff)
downloadonetimebluh-ee43c2ecf27514330ef13bb37fff95b3f76afbe6.tar.gz
onetimebluh-ee43c2ecf27514330ef13bb37fff95b3f76afbe6.tar.bz2
onetimebluh-ee43c2ecf27514330ef13bb37fff95b3f76afbe6.zip
updated README.md
-rw-r--r--README.md41
1 files changed, 23 insertions, 18 deletions
diff --git a/README.md b/README.md
index 49b6899..f597686 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Build
Still usign just gcc. Compile only for testing. Openssl libraries are needed and must be linked to gcc with the option `-lcrypto`. Here follows an example:
```
-gcc -Wall -Wpedantic -lcrypto onetimebluh.c -o onetimebluh -v
+gcc -Wall -Wpedantic -lcrypto onetimebluh.c -o otbluh -v
```
Usage
@@ -19,43 +19,48 @@ Usage
Example creates two keys of length 4096 bytes and use the first as a message and the second as the pad key (just for testing):
```
-onetimebluh --key-gen --nbytes 4096 --output message
-onetimebluh --key-gen --nbytes 4096 --output pad
-onetimebluh --encrypt message --key-file pad --output encrypted-message
-onetimebluh --decrypt encrypted-message --key-file pad --outptut decrypted-message
+otbluh --key-gen --nbytes 4096 --output message
+otbluh --key-gen --nbytes 4096 --output pad
+otbluh --encrypt message --key-file pad --output encrypted-message
+otbluh --decrypt encrypted-message --key-file pad --outptut decrypted-message
```
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:
```
-onetimebluh --encrypt message --key-file pad --output encrypted-message --tear-page
+otbluh --encrypt message --key-file pad --output encrypted-message --tear-page
```
Or using the short options:
```
-onetimebluh -te message -k pad -o encrypted-message
+otbluh -te 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
```
You can print the help by running `onetimebluh --help` or `onetimebluh -h`.
```
ONETIMEBLUH USAGE:
-onetimebluh [COMMAND] [OPTIONS] ...
+otbluh [COMMAND] [OPTIONS]
COMMANDS:
-
--d, --decrypt=FILE decrypt message (input) same as --encrypt, just for the feeling
--e, --encrypt=FILE encrypt message (input)
--h, --help print this help
--g, --key-gen create key file
+-b, --bluh bluhes your message or in other words performs a bynary dump
+-d, --decrypt=FILE decrypt message (input) same ad --encrypt, just for the feeling
+-e, --encrypt=FILE encrypt message (input)
+-g, --gen-key create key file
+-h, --help print this help
+-u, --unbluh unbluhes your message (gets the orginal message from the binary dump)
OPTIONS
-
--k, --key-file=FILE use key (input)
--b, --nbytes=NUM number of bytes
--o, --output=FILE output name
--t, --tear-page deletes from the pad file the bytes used to encrypt/decrypt
+-k, --key-file=KEY_FILE use key (input)
+-n, --nbytes=NUM number of bytes
+-o, --output=FILE output name
+-t, --tear-page deletes from the pad file the bytes used to encrypt/decrypt
Onetimebluh project repository at https://git.eigenlab.org/seppia/onetimebluh
```