update README
This commit is contained in:
parent
e694902f1a
commit
444e4095f0
26
README.md
26
README.md
@ -1,22 +1,27 @@
|
|||||||
# passgen
|
# passgen
|
||||||
passgen generate passphrases based on wordlists.
|
passgen generates passphrases based on wordlists.
|
||||||
Usage:
|
Usage:
|
||||||
```
|
```
|
||||||
Usage: passgen [options]
|
Usage: passgen [options]
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help Display this help message and exit
|
-h, --help Display this help message and exit
|
||||||
-s, --short Use the short EFF wordlist
|
-s, --short Use the short EFF wordlist (dfault)
|
||||||
-l, --large Use the large EFF wordlist (dfault)
|
-l, --large Use the large EFF wordlist
|
||||||
--camelcase, -cc Generate passphrase in CamelCase format
|
--camelcase, -cc Generate passphrase in CamelCase format
|
||||||
-p <path>, --path <path>
|
-wl <path>, --wordlist <path>
|
||||||
Use a custom wordlist file located at <path>
|
Use a custom wordlist file located at <path>
|
||||||
-wc <count>, --wordcount <count>
|
-n <count>, -wc <count>, --wordcount <count>
|
||||||
Amount of words to use for passphrase
|
Amount of words to use for passphrase, default = 5
|
||||||
--separator <seperator> Specify a character to use as a separator between words, default = `-`
|
--separator <seperator> Specify a character to use as a separator between words, default = `-`
|
||||||
|
|
||||||
Description:
|
Description:
|
||||||
Generate passphrases based on wordlists.
|
Generate passphrases based on wordlists.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
passgen -h
|
||||||
|
passgen --short 4
|
||||||
|
passgen -wl /path/to/custom_wordlist.txt --wordcount 4
|
||||||
```
|
```
|
||||||
|
|
||||||
example output:
|
example output:
|
||||||
@ -27,16 +32,21 @@ retrace-choice-litter-dreamt-zipping
|
|||||||
This project uses the [EFF's Wordlists for Random Passphrases](https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases) and [PCG random](https://www.pcg-random.org/) to pick random words
|
This project uses the [EFF's Wordlists for Random Passphrases](https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases) and [PCG random](https://www.pcg-random.org/) to pick random words
|
||||||
|
|
||||||
Compiling:
|
Compiling:
|
||||||
Compile to linux:
|
Compile for Linux:
|
||||||
```
|
```
|
||||||
mkdir build-linux && cd build-linux && cmake .. && make
|
mkdir build-linux && cd build-linux && cmake .. && make
|
||||||
```
|
```
|
||||||
|
|
||||||
Compile to Windows:
|
Compile for Windows:
|
||||||
```
|
```
|
||||||
mkdir build-windows && cd build-windows && cmake -DCMAKE_TOOLCHAIN_FILE=../mingw-toolchain.cmake .. && make
|
mkdir build-windows && cd build-windows && cmake -DCMAKE_TOOLCHAIN_FILE=../mingw-toolchain.cmake .. && make
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Wordlists are embedded using the following command:
|
||||||
|
```
|
||||||
|
xxd -i <path> > include/<path>.txt.hpp
|
||||||
|
```
|
||||||
|
|
||||||
Wordlists:
|
Wordlists:
|
||||||
- https://www.eff.org/files/2016/07/18/eff_large_wordlist.txt
|
- https://www.eff.org/files/2016/07/18/eff_large_wordlist.txt
|
||||||
- https://www.eff.org/files/2016/09/08/eff_short_wordlist_1.txt
|
- https://www.eff.org/files/2016/09/08/eff_short_wordlist_1.txt
|
||||||
|
Loading…
Reference in New Issue
Block a user