19 releases (breaking)
0.14.0 | Dec 11, 2023 |
---|---|
0.12.0 | Nov 29, 2023 |
0.5.0 | Oct 13, 2022 |
0.2.0 | Sep 9, 2019 |
#210 in Command line utilities
130KB
907 lines
About
xkcd-style password generator
Usage
$ xpg -h
xpg 0.14.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)
-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.14.0
See also the Configuration section below.
Examples
$ xpg
indicatethreehonorsimilar
Generate 10 passwords
$ xpg -c 10
februaryorderthankparis
whilesentseveralrest
chargelookenoughpaper
flowtimecheckline
cropsdelighttasteexpect
delawaretherecheckchina
rightheavysisterfamous
betweengroupbecausealone
afterdownshinemade
shoutgoodfactjordan
Generate passwords forever
or until Ctrl+C / SIGINT
$ xpg -c 0
lowertillsuchactually
moonconditionphrasedesire
foollatersafetyshort
laughproudforestthick
longlessstaplesupply
orderlytablethosebusy
mailtravelsubstancesqueen
tiedfightglasssaturn
considerableplantincheskorea
shirtdesertcornbelong
^C
Generate a password with 8 words
$ xpg wwwwwwww
twentyyourselfsomewingjointruckmonthsoften
Generate 10 passwords with 8 words
$ xpg wwwwwwww -c 10
behindsailpossiblemiddleuranusauntuponevening
whitemilesomesaysmannerunderlinekilledbotswana
pleaserecordsugarpracticedenmarkwelcomewhatsmall
metalsignremainequalablefavorshownscotland
camenailanotherplayeasybesidewhichmeeting
matchcirclefoolparticularfindpluralseedsave
neversmallratherpressdifferentspeedsandmost
fishplainslosecarefullypluralloveshirtmoment
locatedmeasureboardegyptsailfeltbrokearms
oxygenfifteendamascusdanceweatherfactorsparkbulgaria
Generate a password with 2 words followed by 3 digits
$ xpg wwddd
filldone264
Generate a password with 2 words followed by 2 symbols
$ xpg wwss
southerneveryone}*
Generate a password with 2 words followed by a digit and a symbol
$ xpg wwds
nonerush5<
Generate a password with 4 words followed by 2 lowercase letters
$ xpg wwwwcc
tiedbroadsubstancestowardsp
Generate a password with 4 words followed by 2 uppercase letters
$ xpg wwwwCC
branchesstudentsconsiderriddenKG
Generate a password with 4 title case words
$ xpg TTTT
WoodStreetSpreadSmall
Generate a password with 4 uppercase words
$ xpg WWWW
CONSIDERTILLFOUNDESCAPE
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
gentlemanpresidentthirteenshownog%Dw
Generate a password with 3 words and at least 15 characters
$ xpg www -m 15
providesoldsort
Generate a password with 3 words and no more than 20 characters
$ xpg www -M 20
kenyapeacegrave
Generate a password with 4 words and between 20 and 25 characters
$ xpg www -m 20 -M 25 -a 1000
requiregroundbranches
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
aftermembers770~
See also Usage note 2.
Generate a password with a 1
, 2 title case words, and !
$ xpg '1TT!'
1OnlyAcross!
Generate a password with 1 symbol, 2 adjectives, 1 noun, and 2 digits
$ xpg 's{adj}{adj}{n}dd'
~certaingravebetter73
Generate a password with 2 words and 1 extended word
$ xpg 'ww{ext}'
romerisethebe
Generate a password with 2 words and 1 title case extended word
$ xpg 'ww{T:ext}'
growratherEnceladus
Generate a password with 2 words and 1 uppercase extended word
$ xpg 'ww{W:ext}'
leadertheyTETHYS
Generate 10 passwords with 4 title case words and extended words merged
$ xpg -ec 10 TTTT
RideAllowHaveCase
ReportProvideTritonSuit
LostAboutWarmGreece
AgainPlanetWithinNevada
HomeDeepToldThus
WorkSlowOceanDuring
FinlandCommonIsonoeSlept
AmaltheaStrangerStormTaken
VowelCylleneSongTrain
LanguageDeimosTrainPhilophrosyne
Generate a keychain-style password
$ xpg keychain
cy5fzp-mxPhcq-ohgfgc
Generate a code name
$ xpg codename
COOL ROPE
Generate a code name series
$ xpg codename-series
LATERGENTLEMAN KINDDARE
LATERGENTLEMAN NOTHINGFOOT
LATERGENTLEMAN SUDDENMOON
LATERGENTLEMAN THERECENTER
LATERGENTLEMAN HUNDREDLINE
LATERGENTLEMAN EXCITINGDAILY
LATERGENTLEMAN IMPORTANTSUBJECT
LATERGENTLEMAN FRONTHEAT
LATERGENTLEMAN SIMILARSOIL
LATERGENTLEMAN DARKSHIP
Generate a code name series with 20 code names
$ xpg codename-series -c 20
HUNDREDDETAILS YOUNGTHROW
HUNDREDDETAILS WORNCAPTAIN
HUNDREDDETAILS DAUGHTERCASE
HUNDREDDETAILS TINYFIFTH
HUNDREDDETAILS HUGESHOP
HUNDREDDETAILS GOLDBABY
HUNDREDDETAILS DOUBLERECORD
HUNDREDDETAILS MANYREPORT
HUNDREDDETAILS HARDTOMORROW
HUNDREDDETAILS MODERNFINISH
HUNDREDDETAILS FIFTHVIEW
HUNDREDDETAILS ELSEGIRL
HUNDREDDETAILS LEADAPRIL
HUNDREDDETAILS LIVENIECE
HUNDREDDETAILS SILENTBEYOND
HUNDREDDETAILS COOLWING
HUNDREDDETAILS HAPPYSUNDAY
HUNDREDDETAILS COMMONDOCTOR
HUNDREDDETAILS MADESQUARE
HUNDREDDETAILS COLDSTONE
Generate a haiku
$ xpg haiku
Electricity / Considerable nature / Village five sharp fine
Generate a haiku with syllable pattern
$ xpg haiku+
Held beauty evening (1,2,2) / Copenhagen Europe shore (4,2,1) / Water Mercury (2,3)
Generate a condensed haiku with syllable pattern
$ xpg haiku-
Mayor-test-give-weak(2,1,1,1)/Considerable-there-skin(5,1,1)/Electricity(5)
Generate a condensed haiku
$ xpg haiku--
Opinion-strange-cook/Electricity-bone-grow/Copenhagen-main
Generate a haiku with newlines
$ xpg haiku++
Probable teach pure
Temperature length distant
Especially tree
Generate a haiku with syllable pattern and newlines
$ xpg haiku+++
Information soon (4,1)
Settled self Arizona (2,1,4)
Ireland science (3,2)
Generate a haiku with extended words
$ xpg -e haiku
South Carolina / Move South America life / Left Amalthea hurt
Generate a password with 20 any characters
$ xpg aaaaaaaaaaaaaaaaaaaa
%GRA>R%EF>H7v(/lQIFZ
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
plMad$O&q+l1ovdzM~z~
Generate 3 passwords each from a different pattern
$ xpg wwww WWWW TTTT
shadebankercoveredpaid
JUMPEDCLASSTHOUSANDISLAND
LoudSnowSquareCarefully
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}'
write-PERSON-Montana-dionysus-Louisiana
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
WordKind
s
- AllExtended /
{a.ext}
- All /
{a}
- Adjective /
{adj}
- Color* /
{color}
- Nationality /
{nat}
- Color* /
- Adverb /
{adv}
- Conjunction /
{conj}
- Interjection /
{i}
- Noun /
{n}
- PluralNoun /
{n.pl}
- Pronoun /
{n.pro}
- SingularNoun /
{n.s}
- Astronomy /
{ast}
- Moon /
{moon}
- Planet /
{planet}
- Moon /
- Color* /
{color}
- Day /
{day}
- Month /
{mon}
- ProperNoun /
{n.prop}
- Element /
{el}
- Name /
{name}
- FemaleName /
{fname}
- MaleName /
{mname}
- FemaleName /
- Place /
{place}
- City /
{city}
- Continent /
{cont}
- Country /
{country}
- UsState /
{us-state}
- City /
- Mythology /
{myth}
- GreekMyth /
{greekmyth}
- Olympian /
{olympian}
- Chthonic /
{chthonic}
- Olympian /
- RomanMyth /
{romanmyth}
- GreekMyth /
- Element /
- Astronomy /
- PluralNoun /
- Preposition /
{prep}
- Verb /
{v}
- AuxiliaryVerb /
{v.aux}
- IntransitiveVerb /
{v.int}
- TransitiveVerb /
{v.tr}
- VerbPast /
{v.past}
- AuxiliaryVerb /
- Adjective /
- Extended /
{ext}
- Noun /
{n}
- SingularNoun /
{n.s}
- Astronomy /
{ast}
- Moon /
{moon}
- MarsMoon /
{marsmoon}
- JupiterMoon /
{jupitermoon}
- SaturnMoon /
{saturnmoon}
- UranusMoon /
{uranusmoon}
- NeptuneMoon /
{neptunemoon}
- MarsMoon /
- Moon /
- Astronomy /
- SingularNoun /
- Noun /
- All /
Notes
-
WordKind /
{sub}
-
It is only necessary to set the most descriptive
WordKind
(s) since they are automatically included in the larger word kinds. -
The
characters
object value must contain theC
,c
, andd
keys with non-empty values. Additional keys/values can be added and used. -
{sub}
s produce lowercase words by default, but if prefixed withW:
orT:
words will be uppercase or title case, respectively: i.e.{W:sub}
or{T:sub}
(replacesub
with an actual{sub}
name above). -
{sub}
s include all words by default, but if suffixed with:N
whereN
is a number, it will only include words with that number of syllables: i.e.{sub:N}
(replacesub
with an actual{sub}
name above andN
with the desired number of syllables ~1-5).
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; addcodename-series
special pattern; add word kind subpatterns; enable external runtime configuration via newConfig
struct - 0.8.1 (2023-11-25): fix
-C
option - 0.9.0 (2023-11-26): add extended words; enable multiple patterns; add
-e
and-L
options; make-d
dump the loaded not default configuration - 0.10.0 (2023-11-27): add syllables and
haiku*
special patterns; fix the codename series algorithm; make olympian/chthonic kinds extended; update dependencies - 0.11.0 (2023-11-28): add bat pager on *nix
- 0.12.0 (2023-11-29): fix haiku algorithm; updated dependencies
- 0.13.0 (2023-12-01): add/fix months; fix dump; update dependencies
- 0.14.0 (2023-12-11): impl Default for Config; updated dependencies
References
- Word list originated from Bart Busschots' HSXKPasswd Perl module (GitHub, CPAN: Crypt::HSXKPasswd), specifically lib/Crypt/HSXKPasswd/Dictionary/EN.pm@1d88564:38
Dependencies
~4–15MB
~182K SLoC