atmos/codecrypt
1
0
Fork 0
mirror of https://github.com/biergaizi/codecrypt synced 2024-06-16 11:58:16 +00:00
Code Issues Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Mirek Kratochvil 2017-10-23 14:54:18 +02:00
parent 76fb3b059d
commit 798de9f70a
3 changed files with 33 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -135,6 +135,15 @@ margin. Let's play with random data!
#decrypt a large file
ccr -daS symkey.asc <big_data_encrypted.iso >big_data.iso
#password-protect all your private keys
ccr -L
#protect a symmetric key using another symmetric key
ccr -L -S symkey1 -w symkey2
#password-protect symkey2 with a custom cipher
ccr -L -S symkey2 -w @xsynd,cube512
## Option reference
For completeness I add listing of all options here (also available from
@ -148,8 +157,8 @@ For completeness I add listing of all options here (also available from
-T, --test perform (probably nonexistent) testing/debugging stuff
Global options:
-R, --in input file, default is stdin
-o, --out output file, default is stdout
-R, --in set input file, default is stdin
-o, --out set output file, default is stdout
-E, --err the same for stderr
-a, --armor use ascii-armored I/O
-y, --yes assume that answer is `yes' everytime
@ -166,13 +175,13 @@ For completeness I add listing of all options here (also available from
-C, --clearsign work with cleartext signatures
-b, --detach-sign specify file with detached signature
-S, --symmetric enable symmetric mode of operation where encryption
is done using symmetric cipher and signatures are
hashes, and specify a filename of symmetric key or hashes
is done using symmetric cipher and signatures are
hashes, and specify a filename of symmetric key or hashes
Key management:
-g, --gen-key generate keys for specified algorithm
-g help list available cryptographic algorithms
-k, --list list contents of keyring
-k, --list list the contents of keyring
-K, --list-secret
-i, --import import keys
-I, --import-secret
@ -182,12 +191,17 @@ For completeness I add listing of all options here (also available from
-X, --delete-secret
-m, --rename rename matching keys
-M, --rename-secret
-L, --lock lock secrets
-U, --unlock unlock secrets
Key management options:
-n, --no-action on import, only show what would be imported
-N, --name specify a new name for renaming or importing
-F, --filter only work with keys with matching names
-f, --fingerprint format full key IDs nicely for human eyes
-N, --name specify a new name for renaming or importing
-n, --no-action on import, only show what would be imported
-w, --with-lock specify the symmetric key for (un)locking the secrets,
-w @SPEC ask for password and expand it to a symmetric key
of type SPEC for (un)locking the secret
## Disclaimer

11
man/ccr.1
View File

@ -1,4 +1,4 @@
.TH CCR 1 2017-10-22 "ccr" "Codecrypt"
.TH CCR 1 2017-10-23 "ccr" "Codecrypt"
.SH NAME
.B ccr
\- The post-quantum cryptography encryption and signing tool
@ -498,6 +498,15 @@ ccr -eaS symkey.asc -R big_data.iso -o big_data_encrypted.iso
#decrypt a large file
ccr -daS symkey.asc <big_data_encrypted.iso >big_data.iso
#password-protect all your private keys
ccr -L
#protect a symmetric key using another symmetric key
ccr -L -S symkey1 -w symkey2
#password-protect symkey2 with a custom cipher
ccr -L -S symkey2 -w @xsynd,cube512
.fi
.SH DISCLAIMER

2
src/main.cpp
View File

@ -85,6 +85,8 @@ void print_help (char*pname)
out (" -N, --name specify a new name for renaming or importing");
out (" -n, --no-action on import, only show what would be imported");
out (" -w, --with-lock specify the symmetric key for (un)locking the secrets");
out (" -w @SPEC ask for password and expand it to a symmetric key");
out(" of type SPEC for (un)locking the secret");
outeol;
out (" With -S and -w, using `@' as the key file name will cause the program to");
out (" interactively ask for a password and derive the symmetric key from it.");