From 2f92e6b2b20e3174e38565700a2da1adc7cf2c53 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:31:53 +0200 Subject: [PATCH] cli/docs/README.md.in: Update to reflect new cli syntax and security notice. --- cli/docs/README.md.in | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/cli/docs/README.md.in b/cli/docs/README.md.in index b3e0b98..aaa281a 100644 --- a/cli/docs/README.md.in +++ b/cli/docs/README.md.in @@ -12,7 +12,7 @@ Source code is available at [github.com](https://github.com/eosswedenorg/antelop @PROJECT_NAME@ [-v] -@PROJECT_NAME@ search [-m] [--l33t] [--threads=] [--dict= ...] [--lang= ...] word_list [count] +@PROJECT_NAME@ search [-m] [--l33t] [--threads ] [--dict ...] [--lang ...] word_list [count] @PROJECT_NAME@ benchmark [num_keys] ``` @@ -32,7 +32,7 @@ Options and subcommands are as follows: ### search command -`eosio-keygen search [-m] [--l33t] [--threads=] [--dict= ...] [--lang= ...] word_list [count]` +`eosio-keygen search [-m] [--l33t] [--threads ] [--dict ...] [--lang ...] word_list [count]` performs a search, finding `count` public keys containing one or more words from `word_list` (separated with ','). @@ -48,17 +48,17 @@ Monochrome, disables all color output. Takes each word in `word_list` and find all l33tspeak combinations of that word and uses the new list for the search. -#### --threads=num +#### --threads num Use `num` of parallel threads for searching. Default is what the operating system recommends. -#### --dict=file +#### --dict file Use words found in `file` (separated by newline) to highlight words in the keys found (note that the words in this file are not used for search. only for highlight output). There can be more then one `--dict` flag. In that case contents of all files are merged into one dictionary. -#### --lang=value +#### --lang value Same as `--dict` but will use `value` to find a file in `@CMAKE_INSTALL_FULL_DATADIR@/@CMAKE_PROJECT_NAME@/dict`. There can be more then one `--lang` flag. In that case contents of all files are merged into one dictionary. @@ -83,13 +83,12 @@ Number of keys to search for (default is 10) ## Security notice -Keys are generated by `OpenSSL`'s `EC_KEY_generate_key` function. The program will -never expose your keys to anything but the computers memory and output of the -program. You are free to inspect the source code and compile yourself to verify. +Keys are generated using [libantelope](https://github.com/eosswedenorg/libantelope) +while the library does not claim to guarantee cryptographically secure keys. it +relies on widly used open source cryptographic libraries (OpenSSL, libsecp256k1). -However, use this at your own risk. we cannot guarantee that the keys are -cryptographically secure as this depends on OpenSSL's implementation (alto it is -widely used and should be safe) +Use at your own risk. The author and [Sw/eden](https://eossweden.org/) does not take responsability +for any damage caused by keys generated by the program. Please read the `LICENSE.cli` file.