diff --git a/README.md b/README.md index 093cf09..d0bab37 100644 --- a/README.md +++ b/README.md @@ -3,150 +3,159 @@ This is a Nodejs implementation of https://github.com/atoponce/webpassgen. As such, enough changes are made to make it its own separate project. -**NOTE:** When generating emoji passwords, a font supporting emoji may be needed -to view the emoji characters correctly. +**NOTE:** When generating non-ASCII passwords, a font supporting Unicode may be +needed to view the characters correctly. Options are: Usage: node main.js [OPTION [ARG]]... - + NOTE: A Unicode font may be needed to view some of the passwords correctly. - + -h --help - Print this help and exit. - + Print this help and exit. + -d --diceware - Choose a Diceware language. Default is English. - must be one of: - Basque, Beale, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, - Dutch-Alt, English, Esperanto, Estonian, Finnish, French, German, - Hungarian, Italian, Japanese, Latin, Maori, Norwegian, Polish, - Portuguese, Russian, Slovak, Slovenian, Spanish, Swedish, Turkish. - + Choose a Diceware language. Default is English. + must be one of: + Basque, Beale, Bulgarian, Catalan, Chinese, Czech, Danish, Dutch, + Dutch-Alt, English, Esperanto, Estonian, Finnish, French, German, + Hungarian, Italian, Japanese, Latin, Maori, Norwegian, Polish, + Portuguese, Russian, Slovak, Slovenian, Spanish, Swedish, Turkish. + -e --eff - Choose an EFF wordlist. Default is Short. - must be one of: - Distant, Long, Short. - + Choose an EFF wordlist. Default is Short. + must be one of: + Distant, Long, Short. + -a --alternate - Choose an alternate wordlist. Default is Trump. - must be one of: - Colors, Elvish, Klingon, PGP, Rockyou, Simpsons, Trump - + Choose an alternate wordlist. Default is Trump. + must be one of: + Colors, Elvish, Klingon, PGP, Rockyou, Simpsons, Trump + -b --bitcoin - Choose a Bitcoin language. Default is English. - must be one of: - Chinese, English, French, Italian, Japanese, Korean - NOTE: - Simplified Chinese is the default Chinese character set. - If you want to use Traditional Chinese, use --traditional. - + Choose a Bitcoin language. Default is English. + must be one of: + Chinese, English, French, Italian, Japanese, Korean + NOTE: + Simplified Chinese is the default Chinese character set. + If you want to use Traditional Chinese, use --traditional. + -t --traditional - Use the Traditional Chinese character set with Bitcoin. - + Use the Traditional Chinese character set with Bitcoin. + -s --system - Use /usr/share/dict/words for building your passphrase. - Obviously, the more words in that file, the more entropy per word. - NOTE: larger system word lists will contain more obscure words. - + Use /usr/share/dict/words for building your passphrase. + Obviously, the more words in that file, the more entropy per word. + NOTE: larger system word lists will contain more obscure words. + + -B + --bubble + Choose Bubble Babble encoding. + -n --ninja - Choose Secret Ninja encoding. - + Choose Secret Ninja encoding. + -k --kpop - Choose Korean K-pop words. - + Choose Korean K-pop words. + -r --random - Choose from a string set. Default is Base94 - must be one of: - Base94, Base85, Base64, Base62, Base58, Base52, Base36, Base32 - Base26, Base16, Base10, Base8, Base2, Coins, DNA, Emoji - NOTE: If you want URL-safe Base64, use -u/--urlsafe. - + Choose from a string set. Default is Base94 + must be one of: + Base256, Base188, Base94, Base85, Base64, Base62, Base58, Base52 + Base36, Base32, Base26, Base16, Base10, Base8, Base2, Coins, DNA, Emoji + NOTE: If you want URL-safe Base64, use -u/--urlsafe. + NOTE: If you want Braile Base256, use -B/--braille. + + -B + --braille + Use Braille patterns for Base256. Ignored with any other option. + -u --url-safe - Use URL-safe characters for Base64. Ignored with any other option. - + Use URL-safe characters for Base64. Ignored with any other option. + -o --only - Choose a generator instead of printing all six (default). - must be one of: - Alternate, Bitcoin, Diceware, EFF, Pseudowords - Random, System - + Choose a generator instead of printing all six (default). + must be one of: + Alternate, Bitcoin, Diceware, EFF, Pseudowords + Random, System + -m --min-entropy - Set a minimum entropy requirement in bits. Default is 70. - + Set a minimum entropy requirement in bits. Default is 70. + -j --json - Output the passwords and meta in JSON format. - + Output the passwords and meta in JSON format. + -H --hyphenate - Add hyphens to the Diceware, EFF, and Alternate passphrases. + Add hyphens to the Diceware, EFF, and Alternate passphrases. Output can be valid JSON, meant to be both human and machine parseable. Default is unformatted plaintext: $ nodepassgen - Alternate(Trump): deplorable stuns 1988 Broaddrick 44 Russians - Bitcoin(English): dirt globe expire victory oak okay fragile - Diceware(English): spew vw night grain 89 won - EFF(Short): lair shush royal jam snack visor busy - Pseudowords(Bubble Babble): xekyp-binah-gofop-febun-kemax - Random(Base94): Gf&qfko + Alternate(Trump): playing six maker #SC appointed community + 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 + Random(Base94): XuLk?26Y!DS $ nodepassgen --json [ { "Generator": "Alternate", "Wordlist": "Trump", - "Password": "#newyear thoughts nuclear fools damage steel", - "Characters": 39, - "Entropy": 77 + "Password": "#debate witch dear lame Mariano called", + "Characters": 33, + "Entropy": 78 }, { "Generator": "Bitcoin", "Wordlist": "English", - "Password": "leader naive way subway board citizen beach", - "Characters": 37, + "Password": "lock globe crazy afraid avoid inform cruel", + "Characters": 36, "Entropy": 77 }, { "Generator": "Diceware", "Wordlist": "English", - "Password": "55 parse club kudo bread reagan", - "Characters": 26, + "Password": "pasha 34 tensor aaron away flick", + "Characters": 27, "Entropy": 77 }, { "Generator": "EFF", "Wordlist": "Short", - "Password": "omen robin mud jot savor reach ivy", - "Characters": 28, + "Password": "chuck mull mardi brink error tag dig", + "Characters": 30, "Entropy": 72 }, { "Generator": "Pseudowords", - "Wordlist": "Bubble Babble", - "Password": "xakyf-difiv-xuvil-tamal-mivax", - "Characters": 25, - "Entropy": 78 + "Wordlist": "Apple_Inc", + "Password": "fovMyp-vejpeg-5orfyp", + "Characters": 20, + "Entropy": 72 }, { "Generator": "Random", "Wordlist": "Base94", - "Password": "2_c+#]ky6B1", + "Password": "TI-$yR!fx\\|", "Characters": 11, "Entropy": 72 }