eosswedenorg/antelope-keygen
1
0
Fork 0
mirror of https://github.com/eosswedenorg/antelope-keygen synced 2026-07-03 11:53:41 +02:00
Code Issues Releases Activity

cli/docs/README.md.in: Update to reflect new cli syntax and security notice.

Browse source
This commit is contained in:
Henrik Hautakoski 2023-04-10 16:31:53 +02:00
parent 25025c21b4
commit 2f92e6b2b2
1 changed files with 10 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

21
cli/docs/README.md.in
View file

@ -12,7 +12,7 @@ Source code is available at [github.com](https://github.com/eosswedenorg/antelop
@PROJECT_NAME@ [-v] @PROJECT_NAME@ [-v]
@PROJECT_NAME@ search [-m] [--l33t] [--threads=<num>] [--dict=<file1> ...] [--lang=<value> ...] word_list [count] @PROJECT_NAME@ search [-m] [--l33t] [--threads <num>] [--dict <file1> ...] [--lang <value> ...] word_list [count]
@PROJECT_NAME@ benchmark [num_keys] @PROJECT_NAME@ benchmark [num_keys]
``` ```
@ -32,7 +32,7 @@ Options and subcommands are as follows:
### search command ### search command
`eosio-keygen search [-m] [--l33t] [--threads=<num>] [--dict=<file1> ...] [--lang=<value> ...] word_list [count]` `eosio-keygen search [-m] [--l33t] [--threads <num>] [--dict <file1> ...] [--lang <value> ...] word_list [count]`
performs a search, finding `count` public keys containing one or more words from `word_list` (separated with ','). 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. 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. 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 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). 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. 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`. 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. 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 ## Security notice
Keys are generated by `OpenSSL`'s `EC_KEY_generate_key` function. The program will Keys are generated using [libantelope](https://github.com/eosswedenorg/libantelope)
never expose your keys to anything but the computers memory and output of the while the library does not claim to guarantee cryptographically secure keys. it
program. You are free to inspect the source code and compile yourself to verify. relies on widly used open source cryptographic libraries (OpenSSL, libsecp256k1).
However, use this at your own risk. we cannot guarantee that the keys are Use at your own risk. The author and [Sw/eden](https://eossweden.org/) does not take responsability
cryptographically secure as this depends on OpenSSL's implementation (alto it is for any damage caused by keys generated by the program.
widely used and should be safe)
Please read the `LICENSE.cli` file. Please read the `LICENSE.cli` file.