xpg 0.8.1

xkcd-style password generator
Documentation

About

xkcd-style password generator

xkcd #936: Password Strength

Usage

$ xpg -h
xpg 0.8.1 <https://crates.io/crates/xpg>

xkcd-style password generator

Usage: xpg [OPTIONS] [PATTERN]

Arguments:
  [PATTERN]  Pattern (see note 1 below) [default: wwww]

Options:
  -c, --count <NUMBER>     Number of passwords (0:∞ ) [default: 1]
  -l, --length <NUMBER>    Length
  -m, --minimum <NUMBER>   Minimum length
  -M, --maximum <NUMBER>   Maximum length
  -a, --attempts <NUMBER>  Attempts [default: 10]
  -C, --config <PATH>      Configuration file
  -d, --default-config     Print default configuration
  -r, --readme             Print readme
  -h, --help               Print help
  -V, --version            Print version

---

Notes

1. Patterns
    * Words
        * `W`: WORD
        * `w`: word
        * `T`: Word
        * `k`: `shuffle(cccc(c|d)(C|c))`
        * `{sub}`: see `WordKind`s section in readme
    * Characters
        * `C`: A-Z
        * `c`: a-z
        * `d`: 0-9
        * `s`: `~!@#$%^&*-_=+;:,./?()[]{}<>`
        * `a`: `C` | `c` | `d` | `s`
    * Special
        * `keychain`
        * `codename`
        * `codename-series`

$ xpg -V
xpg 0.8.1

See also the Configuration section below.

Examples

$ xpg
dictionarysomeonegalaxyscale

Generate 10 passwords:

$ xpg -c 10
plantsicelandpartythin
husbandobjectneptunelisten
horsepassedbridgeshouted
figurestonesoldierchief
fractionindiaunderstandwhom
washthirteenfoodboard
wishdeepdemandtell
placecornermembersthat
fridayrushbegantokyo
doublelasttrainingbread

Generate passwords forever (or until Ctrl+C / SIGINT):

$ xpg -c 0
painttomorrowpeacerepresent
mayorhandbecausepoor
knewvirginiayellowknown
bothpeaceaprilindicate
theyofficemuchwednesday
marketfoolpicturewhose
shipgreenlaughdevice
propertygoldplainabout
loudfatherhangstatement
throughbrownideablood
^C

Generate a password with 8 words:

$ xpg wwwwwwww
stillstooduranusmoneyrealsectiongoodbyedivision

Generate 10 passwords with 8 words:

$ xpg wwwwwwww -c 10
doubtdailyfastrichtwentyskinbelgiumchild
letterpagesubjectunderstandhusbandcropshoweverfine
legsnailforestburningperiodnoticeableround
thuspagepartcreatecropschangecolombiaoctober
sightgentlechangeroadlossgavegoodhawaii
wheelleaderbottlethankguardhomebattlestreet
certainaftermaindownjulysentnaturepage
treeproduceapriltilllosebelongpusharms
gamegonecigarettehealthcropsglasspresscuba
rightpresentunitshoplordsincecomelisbon

Generate a password with 2 words followed by 3 digits:

$ xpg wwddd
frienddeal814

Generate a password with 2 words followed by 2 symbols:

$ xpg wwss
pricearrived;-

Generate a password with 2 words followed by a digit and a symbol:

$ xpg wwds
winteraunt7;

Generate a password with 4 words followed by 2 lowercase letters:

$ xpg wwwwcc
fastmercurycontinuemostml

Generate a password with 4 words followed by 2 uppercase letters:

$ xpg wwwwCC
visitforeverjumpeditselfZE

Generate a password with 4 title case words:

$ xpg TTTT
CarefullyMoneyKnownSelf

Generate a password with 4 uppercase words:

$ xpg WWWW
DOLLARWORESAFETYHEALTH

Generate a password with 4 words followed by 5 "any" characters (lowercase letter, uppercase letter, digit, or symbol)

$ xpg wwwwaaaaa
californiabottomgentlemaniceland<LVdD

Generate a password with 3 words and at least 15 characters:

$ xpg www -m 16
delightbelfastlaugh

Generate a password with 3 words and no more than 20 characters:

$ xpg www -M 20
blowcornbecome

Generate a password with 4 words and between 20 and 25 characters (increase attempts to help it succeed):

$ xpg www -m 20 -M 25 -a 1000
distancerhythmoctober

Generate a password with 2 words, 3 digits, 1 symbol, and exactly 16 characters (increase attempts to help it succeed):

$ xpg wwddds -l 16 -a 1000
detailsserve302#

Generate a password with a 1, 2 title case words, and !:

$ xpg '1TT!'
1GaveMuch!

Generate a password with 1 symbol, 2 adjectives, 1 noun, and 2 digits:

$ xpg 's{adj}{adj}{n}dd'
(pleasantmadepublic03

Generate a keychain-style password:

$ xpg keychain
bfraPq-titxcw-cqyy4x

Generate a code name:

$ xpg codename
GOLD CIGARETTE

Generate a code name series:

$ xpg codename-series
JUSTTHERE WHICHMOON
JUSTTHERE SHARPSTAND
JUSTTHERE TINYCOUNT
JUSTTHERE DESERTRIVER
JUSTTHERE BROKENSURFACE
JUSTTHERE EIGHTWITHOUT
JUSTTHERE GROWNPLAIN
JUSTTHERE DIRECTPRESIDENTS
JUSTTHERE DIRECTTEST
JUSTTHERE NEXTNERVE

Generate a code name series with 20 code names:

$ xpg codename-series -c 20
GONEMERCURY LONGLADY
GONEMERCURY SEPARATEEUROPE
GONEMERCURY THEIROTHER
GONEMERCURY LATERPERIOD
GONEMERCURY ABLESEED
GONEMERCURY PLURALCOTTON
GONEMERCURY SAFEMOUTH
GONEMERCURY FREELAST
GONEMERCURY EXPRESSSEAT
GONEMERCURY GLASSGRAIN
GONEMERCURY MADEROCK
GONEMERCURY FIFTYOPINION
GONEMERCURY AFTERSAFE
GONEMERCURY OUTSIDEFINE
GONEMERCURY DISTANTSLEEP
GONEMERCURY CHIEFWHOLE
GONEMERCURY WILDFORCE
GONEMERCURY JAPANESEWEATHER
GONEMERCURY BEARRUSH
GONEMERCURY DOUBLEMARK

Generate a password with 20 "any" characters:

$ xpg aaaaaaaaaaaaaaaaaaaa
$OHj;I6c1B~]Lq4y@?~I

Same as the previous example, but shorter:

$ xpg a -m 20
wR)dIbaV!C;xV=^Eb+=]

Configuration

See config.json or use -d for the default configuration compiled into the binary executable.

If another file is placed at any of the following locations or the path provided via the -C option at runtime, it will be used instead.

  • Linux: /home/username/.config/xpg/config.json
  • Windows: C:\Users\username\AppData\Roaming\qtfkwk\xpg\config\config.json
  • macOS: /Users/username/Library/Application Support/com.qtfkwk.xpg/config.json

WordKinds

  • Adjective / {adj}
    • Color* / {color}
    • Nationality / {nat}
  • Adverb / {adv}
  • Conjunction / {conj}
  • Interjection / {i}
  • Noun / {n}
    • PluralNoun / {n.pl}
    • Pronoun / {n.pro}
    • SingularNoun / {n.s}
      • Astronomy / {ast}
        • Moon / {moon}
        • Planet / {planet}
      • Color* / {color}
      • Day / {day}
      • Month / {mon}
      • ProperNoun / {n.prop}
        • Element / {el}
        • Name / {name}
          • FemaleName / {fname}
          • MaleName / {mname}
        • Place / {place}
          • City / {city}
          • Continent / {cont}
          • Country / {country}
          • UsState / {us-state}
        • Mythology / {myth}
          • GreekDeity / {greekdeity}
          • RomanDeity / {romandeity}
  • Preposition / {prep}
  • Verb / {v}
    • AuxiliaryVerb / {v.aux}
    • IntransitiveVerb / {v.int}
    • TransitiveVerb / {v.tr}
    • VerbPast / {v.past}

Notes

  1. WordKind / {sub}

  2. It is only necessary to set the most descriptive WordKind(s) since they are automatically included in the larger word kinds.

  3. The characters object value must contain the C, c, and d keys with non-empty values. Additional keys/values can be added and used.

Changelog

  • 0.1.0 (2019-09-08): store wordlist as constant and operate on it without copying; select N words without repetition via choose_multiple; tests; benchmark various implementations; xpg function; xpg! macro to enable optional word count argument; command line interface via clap
  • 0.1.1 (2019-09-08): minor fixes
  • 0.1.2 (2019-09-08): minor fixes
  • 0.2.0 (2019-09-09): expose xpg! macro; improve documentation
  • 0.3.0 (2022-10-01): update dependencies; add digits and symbols options
  • 0.3.1 (2022-10-01): fix readme
  • 0.4.0 (2022-10-02): add --lowercase, --uppercase, and --any options; enable --words option to be zero if --any option is greater than zero; enable infinite passwords via -c 0
  • 0.5.0 (2022-10-13): add --keychain and --code-name options
  • 0.6.0 (2023-11-22): remove num and factorial crate dependencies; improve permutations function; update dependencies; apply clippy fixes and cargo fmt; reorganize
  • 0.6.1 (2023-11-22): fix readme
  • 0.7.0 (2023-11-24): complete redesign
  • 0.8.0 (2023-11-25): remove benchmark; simplify cli options; add -r and -C options; restore -c 0 functionality; add codename-series special pattern; add word kind subpatterns; enable external runtime configuration via new Config struct
  • 0.8.1 (2023-11-25): fix -C option

References