About

xkcd-style password generator

xkcd #936: Password Strength

Usage

$ xpg -h
xpg 0.16.0 <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+`
        * `haiku-`
        * `haiku--`
        * `haiku++`
        * `haiku+++`

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.16.0

See also the Configuration section below.

Examples

$ xpg
feelborrowhimselfexpress

Generate 10 passwords

$ xpg -c 10
positionhuntingearsarrived
colorthingdriveconsonant
clouddoeschinaflier
flowersbecomerealizespace
rightkindsectiongroup
levelconditionthousandtone
hellogatefullagainst
sandchargesortgrow
dancenotewomenfair
churchbutterphraseeach

Generate passwords forever

or until Ctrl+C / SIGINT

$ xpg -c 0
raiseduntildenmarkwish
damascustrainwildbasket
choosechairhopespace
toolsseemdestroypounds
miletruestatementperhaps
centermadridbusinessrhythm
montanakeptminutesschool
dividelandgatehavana
continuepolandsharpcarefully
applesouthernwesternworth
^C

Generate a password with 8 words

$ xpg wwwwwwww
niecetruststaythroughrollplantshourbread

Generate 10 passwords with 8 words

$ xpg wwwwwwww -c 10
scenenineplantdividednicevisitexerciseheight
nosewestmoleculesdevicesamebroadnationmembers
parkgirlcountjuneflierbotswanaresultspend
wifeusuallyfriendsclimbedsuchmayorlegsindicate
excitingsuchbelieveaustriasometimesnoisepleasantexpect
governdrawdelawarehimselfteachservicehurtegypt
soldiersasiamarketeverinsideteachersoftouter
tailuntildenmarkmercurybridgegateproducegentleman
naturalfeedwaterlineloudearthplantshort
fijilooktinydifferentmeetingwelcomehistorygarden

Generate a password with 2 words followed by 3 digits

$ xpg wwddd
realpure316

Generate a password with 2 words followed by 2 symbols

$ xpg wwss
stillsubject=]

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

$ xpg wwds
agreedtrip7?

Generate a password with 4 words followed by 2 lowercase letters

$ xpg wwwwcc
fishviewproudfootaq

Generate a password with 4 words followed by 2 uppercase letters

$ xpg wwwwCC
mainmusiclastwhileHK

Generate a password with 4 title case words

$ xpg TTTT
MoveStickBelfastNecessary

Generate a password with 4 uppercase words

$ xpg WWWW
BUILDINGTHANKHUGEDINNER

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
ironobservebridgesureR)~@U

Generate a password with 3 words and at least 15 characters

$ xpg www -m 15
proudchoosebanker

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

$ xpg www -M 20
colorsurebeyond

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

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

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
guardperhaps822&

See also Usage note 2.

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

$ xpg '1TT!'
1FlatFurther!

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

$ xpg 's{adj}{adj}{n}dd'
&enoughdecimallevel24

Generate a password with 2 words and 1 extended word

$ xpg 'ww{ext}'
damascusfathernewhampshire

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

$ xpg 'ww{T:ext}'
closecreateMetis

Generate a password with 2 words and 1 uppercase extended word

$ xpg 'ww{W:ext}'
saidkentuckyRHEA

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

$ xpg -ec 10 TTTT
RegionCongoWomanRose
SideWedgeNesoAnger
CentsBeautifulLightAllow
PlayHurtStandCharacter
FranceSafeAfraidEqual
IndianRuleSceneHole
SisterYellowSaturnDifferent
NailPowerDecidedFace
MethodPropertyEnceladusSugar
TethysColoradoGlossarySponde

Generate a keychain-style password

$ xpg keychain
xufQal-hdkpuq-qsox1l

Generate a code name

$ xpg codename
THROUGH HAIR

Generate a code name series

$ xpg codename-series
EXPRESSDREAM SEVERALAMOUNT
EXPRESSDREAM FALLLABOR
EXPRESSDREAM BRIGHTCOPY
EXPRESSDREAM WESTHUNGER
EXPRESSDREAM NICELIGHT
EXPRESSDREAM NORTHWELCOME
EXPRESSDREAM DECIDEDVALUE
EXPRESSDREAM JUSTEXERCISE
EXPRESSDREAM COMMONSILVER
EXPRESSDREAM ACTIONURANUS

Generate a code name series with 20 code names

$ xpg codename-series -c 20
FULLSMOKE STRANGEWISE
FULLSMOKE DEEPSTAY
FULLSMOKE FINALLYCHILD
FULLSMOKE SHOULDBEAT
FULLSMOKE FUTUREWEDNESDAY
FULLSMOKE GONEMONEY
FULLSMOKE EXPRESSCROSS
FULLSMOKE ENOUGHKING
FULLSMOKE GOLDTEACHER
FULLSMOKE DESERTFAMILY
FULLSMOKE NINEDREAM
FULLSMOKE DOUBLEDOUBLE
FULLSMOKE BOTTOMCHECK
FULLSMOKE SHARPYESTERDAY
FULLSMOKE COOLSTRING
FULLSMOKE FEELINGMARCH
FULLSMOKE MADESCALE
FULLSMOKE FINISHEDBIRDS
FULLSMOKE BROADHOLE
FULLSMOKE FREEARMY

Generate a haiku

$ xpg haiku
Dictionary stock / Opposite dollars bone fool / Result suggested

Generate a haiku with syllable pattern

$ xpg haiku+
Elements neck soon (3,1,1) / Anger change heaven course long (2,1,2,1,1) / Language snow Norway (2,1,2)

Generate a condensed haiku with syllable pattern

$ xpg haiku-
Considerable(5)/Deep-battery-Alaska(1,3,3)/America-which(4,1)

Generate a condensed haiku

$ xpg haiku--
Have-especially/Particular-etching-born/Minute-liar-bread

Generate a haiku with newlines

$ xpg haiku++
Center safety shirt
Burning desert July learn
Electricity

Generate a haiku with syllable pattern and newlines

$ xpg haiku+++
Indicate needle (3,2)
Considerable walk size (5,1,1)
Experience reached (4,1)

Generate a haiku with extended words

$ xpg -e haiku
Consonant share since / Pennsylvania delight nice / Arche dear than free

Generate a password with 20 any characters

$ xpg aaaaaaaaaaaaaaaaaaaa
si&lu~6/lI1U@V=Cje*J

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
DgG?S{l1=F3A#%._dixf

Generate 3 passwords each from a different pattern

$ xpg wwww WWWW TTTT
chilelatersomechildren
SHOPNOTEMATERIALSAIL
BothCleanKeepTurn

Apply upper casing

$ xpg -A upper 'T T T T'
FORTY WEDGE EXAMPLE THEREFORE

Apply lower casing

$ xpg -A lower 'T T T T'
build yesterday guide study

Apply title casing

$ xpg -A title 'T T T T'
Ought Again Along Bird

Apply toggle casing

$ xpg -A toggle 'T T T T'
pRESENT tOMORROW pAIN oCEAN

Apply camel casing

$ xpg -A camel 'T T T T'
modernValleySongCorn

Apply pascal casing

$ xpg -A pascal 'T T T T'
WoodSouthernDecemberWaves

Apply upper-camel casing

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

Apply snake casing

$ xpg -A snake 'T T T T'
except_height_greek_grave

Apply upper-snake casing

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

Apply screaming-snake casing

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

Apply kebab casing

$ xpg -A kebab 'T T T T'
write-neptune-pain-capital

Apply cobol casing

$ xpg -A cobol 'T T T T'
EASY-SWIM-CAUGHT-URANUS

Apply upper-kebab casing

$ xpg -A upper-kebab 'T T T T'
GARDEN-SOUTH-PART-JOINED

Apply train casing

$ xpg -A train 'T T T T'
Together-Indian-Africa-Total

Apply flat casing

$ xpg -A flat 'T T T T'
bulgariawentwaithundred

Apply upper-flat casing

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

Apply alternating casing

$ xpg -A alternating 'T T T T'
wOuLd SuIt WiNd MaRk

Apply random casing

$ xpg -A random 'T T T T'
wING dead BlAck sUNDAY

Apply pseudo-random casing

$ xpg -A pseudo-random 'T T T T'
rUSsiA wIThiN InsTRumEnTs BlOcK

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}'
plane-FOLLOW-Uranus-dionysus-Northcarolina

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