About

xkcd-style password generator

xkcd #936: Password Strength

Usage

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

xkcd-style password generator

Usage: xpg [OPTIONS] [PATTERNS]...

Arguments:
  [PATTERNS]...  Pattern(s) (see note 1) [default: `wwww`, `-L`: `{a}`]

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 (see note 2) [default: 10]
  -C, --config <PATH>       Configuration file
  -e, --extended            Merge extended words (see note 3)
  -A, --apply-case <STYLE>  Apply case style [possible values: upper, lower,
                            title, toggle, camel, pascal, upper-camel, snake,
                            upper-snake, screaming-snake, kebab, cobol,
                            upper-kebab, train, flat, upper-flat, alternating,
                            random, pseudo-random]
  -L, --list                List words in `{sub}`(s)
  -d, --dump-config         Print 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`
        * `haiku--` | `haiku-condensed`
        * `haiku-` | `haiku-with-syllables-condensed`
        * `haiku`
        * `haiku+` | `haiku-with-syllables`
        * `haiku++` | `haiku-full`
        * `haiku+++` | `haiku-full-with-syllables`

2. Ten attempts are made to satisfy the given length requirements by default;
   use `-a N` and set `N` to the number of attempts to increase chances.
   It will exit with an error if unable to satisfy requirements; some
   configurations will always produce an error.

3. Extended words are only available in exclusively extended word kinds by
   default; however, with `-e`, they are merged with regular word kinds; use
   with the `-L` option to see its effect.

$ xpg -V
xpg 0.17.2

See also the Configuration section below.

Examples

$ xpg
woodproudmouthnine

Generate 10 passwords

$ xpg -c 10
matterablemorningmusic
seatdetailsspentcurrent
feelingstreamcauseetching
fruitsystemschoolstay
branchespeaceriddenneed
moneymetalwashworkers
pressitselflonesurprise
arizonawhencompletesince
darecompoundperfectcrowd
sickdiscoveredquestionssmoke

Generate passwords forever

or until Ctrl+C / SIGINT

$ xpg -c 0
walkgalaxypatternwife
stationshinealabamafifth
milefoodbattlefeel
wondermeatplanecommon
virginiagainsharpnear
risepulledwishlate
providemoleculesintoover
scienceangerfrenchstudy
peruminedifferentcrowd
suddenleavehurtsmiled
^C

Generate a password with 8 words

$ xpg wwwwwwww
riddenfactobservestockitselffridayexpresspublic

Generate 10 passwords with 8 words

$ xpg wwwwwwww -c 10
noonfarmersfollowseembirdnounroomseed
galaxyusuallyshinegavechoosetookconditionprobably
francewaleswallequationmorefeedpleasevoice
arizonacompanyarticleglossaryirelandscoreincreaseshop
soldierschanceobservehealthparagraphworkersstrangecovered
joinedhearlordplainfaceresultwoodlondon
resenttellmattersecondbonesshotdonegain
monthsbritainpersonwenteversinglekitchenanother
stringdifferencearmsjoinedeachjumpedhousecotton
famousdecideelectricitycoveredwallbelongbecausesteel

Generate a password with 2 words followed by 3 digits

$ xpg wwddd
farmerstown603

Generate a password with 2 words followed by 2 symbols

$ xpg wwss
farmersmoscow~*

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

$ xpg wwds
freenight1&

Generate a password with 4 words followed by 2 lowercase letters

$ xpg wwwwcc
besidetheirchairquarterbc

Generate a password with 4 words followed by 2 uppercase letters

$ xpg wwwwCC
frenchwhiledelightfireAD

Generate a password with 4 title case words

$ xpg TTTT
StreetWavesNoteButter

Generate a password with 4 uppercase words

$ xpg WWWW
PANAMAMEASURELIVEGREEK

Generate a password with 4 words followed by 5 any characters

An "any" character can be a lowercase letter, uppercase letter, digit, or symbol.

$ xpg wwwwaaaaa
questionsjustropepassK/cZd

Generate a password with 3 words and at least 15 characters

$ xpg www -m 15
germanytwentyoutside

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

$ xpg www -M 20
flowbecauselevel

Generate a password with 4 words and between 20 and 25 characters

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

See also Usage note 2.

Generate a password with 2 words, 3 digits, 1 symbol, and exactly 16 characters

$ xpg wwddds -l 16 -a 1000
besideafrica579&

See also Usage note 2.

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

$ xpg '1TT!'
1BarbadosBill!

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

$ xpg 's{adj}{adj}{n}dd'
$madesweetquestion26

Generate a password with 2 words and 1 extended word

$ xpg 'ww{ext}'
britainrollrhodeisland

Generate a password with 2 words and 1 title case extended word

$ xpg 'ww{T:ext}'
centleadEuropa

Generate a password with 2 words and 1 uppercase extended word

$ xpg 'ww{W:ext}'
countdeathLYSITHEA

Generate 10 passwords with 4 title case words and extended words merged

$ xpg -ec 10 TTTT
SightLikelyAlwaysBring
MaterialFactoriesAfraidLead
InchBulgariaMoneyPick
NorthernWentChildhoodMember
WiseCaliforniaDevelopedWave
SevenLiftedWaitFiji
LossChileFreshTennessee
CarryNoticePickLoud
PrintedWarsawSisterTomorrow
SpreadDropAlabamaStood

Generate a keychain-style password

$ xpg keychain
jtdvEn-lgcssu-lrs4ya

Generate a code name

$ xpg codename
SICK SWIM

Generate a code name series

$ xpg codename-series
MORENOISE NEITHERACROSS
MORENOISE FREEVALLEY
MORENOISE THREELETTER
MORENOISE FRENCHSTUDENT
MORENOISE JAPANESEBONES
MORENOISE FANCYCLOTH
MORENOISE RIDDENNEED
MORENOISE SMALLWEEK
MORENOISE STRANGESEASON
MORENOISE LITTLEGUIDE

Generate a code name series with 20 code names

$ xpg codename-series -c 20
DISTANTBUILD UNDERPRESIDENTS
DISTANTBUILD MANYCOLOR
DISTANTBUILD REALREPORT
DISTANTBUILD THICKSPEED
DISTANTBUILD FAMOUSWINGS
DISTANTBUILD AROUNDHEIGHT
DISTANTBUILD MINUTEGRAY
DISTANTBUILD DOUBLELAUGHTER
DISTANTBUILD MAINTYPE
DISTANTBUILD PLAINSQUARE
DISTANTBUILD ABLEGLOSSARY
DISTANTBUILD LEFTMASTER
DISTANTBUILD NICEBRANCHES
DISTANTBUILD LONGOUTSIDE
DISTANTBUILD SMALLCAUSE
DISTANTBUILD PLEASANTWESTERN
DISTANTBUILD CONSONANTBANK
DISTANTBUILD SIMILARFARMERS
DISTANTBUILD THISSTOCK
DISTANTBUILD RAISEDMOUTH

Generate a haiku

$ xpg haiku
Experiment hurt / Considerable after / Electricity

Generate a haiku with syllable pattern

$ xpg haiku+
Enough fancy skin (2,2,1) / Electricity bean strike (5,1,1) / Flower finally (2,3)

Generate a condensed haiku with syllable pattern

$ xpg haiku-
From-likely-amount(1,2,2)/Instruments-temperature(3,4)/Alaska-prove-smoke(3,1,1)

Generate a condensed haiku

$ xpg haiku--
Considerable/Member-necessary-rose/Electricity

Generate a haiku with newlines

$ xpg haiku++
Cloth particular
Wednesday Copenhagen terms
Join fast school ladder

Generate a haiku with syllable pattern and newlines

$ xpg haiku+++
Build history root (1,3,1)
Dictionary December (4,3)
Branch Jupiter queen (1,3,1)

Generate a haiku with extended words

$ xpg -e haiku
Kenya cloud even / Enemy Michigan hunt / South America

Generate a password with 20 any characters

$ xpg aaaaaaaaaaaaaaaaaaaa
>g6sh:}*N6R0T1or^>_U

Same as the previous example, but shorter

This works because a character-only pattern is padded to the minimum length with the last character.

$ xpg a -m 20
cpz-V[A8GjE^2mh@>yHY

Generate 3 passwords each from a different pattern

$ xpg wwww WWWW TTTT
generalgreekbranchescows
PATTERNREASONHOURSTOUCH
ArmsCurrentTwelveHeavy

Apply upper casing

$ xpg -A upper 'T T T T'
SWEDEN BEING UNTIL ESPECIALLY

Apply lower casing

$ xpg -A lower 'T T T T'
rock among blue cent

Apply title casing

$ xpg -A title 'T T T T'
Instruments Change Kept Gave

Apply toggle casing

$ xpg -A toggle 'T T T T'
wITH fELLOW hISTORY fORM

Apply camel casing

$ xpg -A camel 'T T T T'
builtEffortJustGreat

Apply pascal casing

$ xpg -A pascal 'T T T T'
IronStillFreeBranches

Apply upper-camel casing

$ xpg -A upper-camel 'T T T T'
ShoesLargeLikeGentle

Apply snake casing

$ xpg -A snake 'T T T T'
same_block_later_each

Apply upper-snake casing

$ xpg -A upper-snake 'T T T T'
UPON_BUTTER_CLEAR_INDUSTRY

Apply screaming-snake casing

$ xpg -A screaming-snake 'T T T T'
SINGLE_OXYGEN_CONSONANT_SUDDENLY

Apply kebab casing

$ xpg -A kebab 'T T T T'
yesterday-those-either-government

Apply cobol casing

$ xpg -A cobol 'T T T T'
MEET-VALLEY-JORDAN-ADVANCE

Apply upper-kebab casing

$ xpg -A upper-kebab 'T T T T'
SAFE-ELEMENTS-FINE-ICELAND

Apply train casing

$ xpg -A train 'T T T T'
Copy-Decide-Farmers-Nail

Apply flat casing

$ xpg -A flat 'T T T T'
cakedecidedjoinedflat

Apply upper-flat casing

$ xpg -A upper-flat 'T T T T'
LITTLEGAINESCAPENECK

Apply alternating casing

$ xpg -A alternating 'T T T T'
sEaSoN cErTaIn AcRoSs EiGhT

Apply random casing

$ xpg -A random 'T T T T'
Much twenTY bEen opiNIOn

Apply pseudo-random casing

$ xpg -A pseudo-random 'T T T T'
HuNgeR ThOusANds FeEt HuMAn

Generate a password with words with 1, 2, 3, 4, and 5 syllables

$ xpg '{a:1}-{W:a:2}-{T:a:3}-{olympian:4}-{T:ext:5}'
cloud-STAPLE-Decimal-dionysus-Southamerica

List the words in Color / {color}

$ xpg -L '{color}'
black
blue
brown
gray
green
white
yellow

List the words in Color / {color} in uppercase

$ xpg -L '{W:color}'
BLACK
BLUE
BROWN
GRAY
GREEN
WHITE
YELLOW

List the words in Color / {color} in title case

$ xpg -L '{T:color}'
Black
Blue
Brown
Gray
Green
White
Yellow

Count the words in Color / {color}

$ xpg -L '{color}' |wc -l
7

List the words in Color / {color} and Element / {W:el}

$ xpg -L '{color}' '{W:el}'
black
blue
brown
gray
green
white
yellow
GOLD
IRON
LEAD
MERCURY
OXYGEN
SILVER

Count words

$ xpg -L |wc -l
1257

Count words with extended

$ xpg -Le |wc -l
1403

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

• AllExtended / {a.ext}
  • All / {a}
    • 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}
            • GreekMyth / {greekmyth}
              • Olympian / {olympian}
              • Chthonic / {chthonic}
            • RomanMyth / {romanmyth}
    • Preposition / {prep}
    • Verb / {v}
      • AuxiliaryVerb / {v.aux}
      • IntransitiveVerb / {v.int}
      • TransitiveVerb / {v.tr}
      • VerbPast / {v.past}
  • Extended / {ext}
    • Noun / {n}
      • SingularNoun / {n.s}
        • Astronomy / {ast}
          • Moon / {moon}
            • MarsMoon / {marsmoon}
            • JupiterMoon / {jupitermoon}
            • SaturnMoon / {saturnmoon}
            • UranusMoon / {uranusmoon}
            • NeptuneMoon / {neptunemoon}

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.

4. {sub}s produce lowercase words by default, but if prefixed with W: or T: words will be uppercase or title case, respectively: i.e. {W:sub} or {T:sub} (replace sub with an actual {sub} name above).

5. {sub}s include all words by default, but if suffixed with :N where N is a number, it will only include words with that number of syllables: i.e. {sub:N} (replace sub with an actual {sub} name above and N with the desired number of syllables ~1-5).

Changelog

Please find the CHANGELOG.md in the repository.

References

• Word list originated from Bart Busschots' HSXKPasswd Perl module (GitHub, CPAN: Crypt::HSXKPasswd), specifically lib/Crypt/HSXKPasswd/Dictionary/EN.pm@1d88564:38