hardcoresushi
/
doby
1
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Update help & examples in README

This commit is contained in:
Matéo Duparc 2021-11-13 21:59:02 +01:00
parent 311677d195
commit 1f50973381
Signed by: hardcoresushi
GPG Key ID: 007F84120107191E
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -42,17 +42,17 @@ cat my-super-secret-logs-file.log | doby - logs.doby
Speicfy password from the command line: Speicfy password from the command line:
```bash ```bash
doby -p "A super very ultra strong passphrase" my-super-secret-document.pdf document.doby doby --password "A super very ultra strong passphrase" my-super-secret-document.pdf document.doby
``` ```
Double encryption: Double encryption:
```bash ```bash
doby -p "first password" my-super-secret-database.db | doby -f - double-encrypted.doby doby --password "first password" my-super-secret-database.db | doby -f - double-encrypted.doby
``` ```
Increase password brute-force resistance: Increase password brute-force resistance:
```bash ```bash
echo "you-will-never-break-this" | doby --memory-cost 524288 --threads 16 --iterations 40 > my-super-secret-password.doby echo "you-will-never-break-this" | doby --memory-cost 524288 --parallelism 16 --time-cost 40 > my-super-secret-password.doby
``` ```
## Full Options ## Full Options
@ -63,14 +63,15 @@ USAGE:
FLAGS: FLAGS:
-f, --force-encrypt Encrypt even if doby format is recognized -f, --force-encrypt Encrypt even if doby format is recognized
-i, --interactive Prompt before overwriting files
-h, --help Prints help information -h, --help Prints help information
-V, --version Prints version information -V, --version Prints version information
OPTIONS: OPTIONS:
-p, --password <password> Password used to derive encryption keys --password <password> Password used to derive encryption keys
-i, --iterations <iterations> Argon2 time cost [default: 10] -t, --time-cost <iterations> Argon2 time cost [default: 10]
-m, --memory-cost <memory cost> Argon2 memory cost (in kilobytes) [default: 4096] -m, --memory-cost <memory size> Argon2 memory cost (in kilobytes) [default: 4096]
-t, --threads <threads> Argon2 parallelism (between 1 and 255) [default: 4] -p, --parallelism <threads> Argon2 parallelism cost [default: 4]
-b, --block-size <blocksize> Size of the I/O buffer (in bytes) [default: 65536] -b, --block-size <blocksize> Size of the I/O buffer (in bytes) [default: 65536]
-c, --cipher <cipher> Encryption cipher to use [possible values: aes, xchacha20] -c, --cipher <cipher> Encryption cipher to use [possible values: aes, xchacha20]