From 759e7d8127cb7aa93e7e4735d31a0cc48ffdfeeb Mon Sep 17 00:00:00 2001 From: Aaron Toponce Date: Wed, 31 Mar 2021 19:12:03 -0600 Subject: [PATCH] update readme to match output --- README.md | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index e4ee416..b870bac 100644 --- a/README.md +++ b/README.md @@ -8,59 +8,65 @@ needed to view the characters correctly. Options are: - Usage: node main.js [OPTION [ARG]]... + Usage: nodepassgen [OPTION [ARG]]... NOTE: A Unicode font may be needed to view some of the passwords correctly. -h, --help Print this help and exit. -a, --alternate WORDLIST Choose an alternate wordlist. Default is Trump. WORDLIST must be one of: - Deseret, Colors, Elvish, Klingon, PGP, - Rockyou, Shavian, Simpsons, Trump + Deseret, Colors, Elvish, English, Klingon, + PGP, Pokerware, Rockyou, Shavian, Simpsons, + S/KEY, Trump. + NOTE: "English" combines every English word list. -b, --bitcoin LANGUAGE Choose a Bitcoin language. Default is English. LANGUAGE must be one of: Chinese, Czech, English, French, Italian, - Japanese, Korean, Portuguese + Japanese, Korean, Portuguese. NOTE: Simplified Chinese is the default Chinese character set. If you want to use Traditional Chinese, use --traditional. - -B, --bubble Choose Bubble Babble encoding. -d, --diceware LANGUAGE Choose a Diceware language. Default is English. LANGUAGE must be one of: Basque, Beale, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, English, Esperanto, Estonian, Finnish, French, German, Greek, Hebrew, Hungarian, Italian, Japanese, Latin, - Maori, Norwegian, Polish, Portuguese, + Maori, NLP, Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovenian, Spanish - Swedish, Turkish + Swedish, Turkish. + NOTE: NLP is "Natural Language Passwords". -D, --dicekey Generate a hard-coded 198-bit entropy text-based DiceKeys key. Format of the key is: where: : Shuffled A-Z without Q : Random side 1-6 of the die - : Random N,E,S,W cardinal direction + : Random t,r,b,l direction -e, --eff WORDLIST Choose an EFF wordlist. Default is Short. WORDLIST must be one of: - Distant, Long, Potter, Short, Trek, Wars. - -H, --hyphenate Hyphenate Diceware, EFF, & Alternate passphrases. + Distant, Long, Potter, Short, Thrones, Trek, + Wars. + -H, --hyphenate Hyphenate Alternate, Bitcoin, Diceware, EFF, and + system passphrases. -j, --json Output the passwords and meta in JSON format. - -k, --kpop Choose Korean K-pop words. -m, --min-entropy NUMBER Set a minimum entropy in bits. Default is 70. - -n, --ninja Choose Secret Ninja encoding. -o, --only GENERATOR Choose a generator instead of printing all six. GENERATOR must be one of: Alternate, Bitcoin, Diceware, EFF, - Pseudowords, Random, System - -r, --random SET Choose from a string set. Default is Base94 + Pseudowords, Random, System. + -p, --pseudowords OPTION Choose a Pseudowords option. Default is Apple. + OPTION must be one of: + Apple, Babble, K-pop, Ninja. + -r, --random SET Choose from a string set. Default is Base94. SET must be one of: Base256, Base188, Base94, Base85, Base64, Base62, Base58, Base52, Base36, Base32, Base26, Base16, Base10, Base8, Base2, Coins, - DNA, Emoji + DNA, Emoji. NOTE: Braile Base256, use -R, --braille. -R, --braille Use Braille patterns for Base256. -s, --system Use /usr/share/dict/words for the passphrase. NOTE: larger word lists have more obscure words. -t, --traditional Use Traditional Chinese with Bitcoin. + Output can be valid JSON, meant to be both human and machine parseable. Default is unformatted plaintext: @@ -70,7 +76,7 @@ is unformatted plaintext: Bitcoin(English): marine zone system type middle tilt margin Diceware(English): boone ani nuclei cuba bhoy shied EFF(Short): hush blot agent ounce trash chess hub - Pseudowords(Apple_Inc): Qihxes-rebvir-3arrid + Pseudowords(Apple): Qihxes-rebvir-3arrid Random(Base94): XuLk?26Y!DS $ nodepassgen -j | jq @@ -105,7 +111,7 @@ is unformatted plaintext: }, { "Generator": "Pseudowords", - "Wordlist": "Apple_Inc", + "Wordlist": "Apple", "Password": "9imken-tipnub-zezvaB", "Characters": 20, "Entropy": 72