Passphrase & Password generation library for GoLang.
Passphrases are made up of 2 or more words connected by a separator and may have capitalized words, and numbers. These are easier for humans to remember compared to passwords.
The passphrase
package helps generate these and supports the following rules
that be used during generation:
- Capitalize words used in the passphrase (foo -> Foo)
- Use a custom dictionary of words instead of built-in English dictionary
- Use X number of Words
- Insert a random number behind one of the words
- Use a custom separator
- Use words with a specific length-range
g, err := passphrase.NewGenerator(
passphrase.WithCapitalizedWords(true),
passphrase.WithDictionary(dictionaries.English()),
passphrase.WithNumWords(3),
passphrase.WithNumber(true),
passphrase.WithSeparator("-"),
passphrase.WithWordLength(4, 6),
)
if err != nil {
panic(err.Error())
}
for idx := 1; idx <= 10; idx++ {
fmt.Printf("Passphrase #%3d: %#v\n", idx, g.Generate())
}
Output...
Passphrase # 1: "Peage6-Blousy-Whaup" Passphrase # 2: "Crape0-Natter-Pecs" Passphrase # 3: "Facers-Razzed-Jupes6" Passphrase # 4: "Jingko1-Shell-Stupor" Passphrase # 5: "Nailer-Turgid-Sancta4" Passphrase # 6: "Rodeo5-Cysts-Pinons" Passphrase # 7: "Mind-Regina-Swinks9" Passphrase # 8: "Babas5-Lupous-Xylems" Passphrase # 9: "Ocreae-Fusel0-Jujube" Passphrase # 10: "Mirks6-Woofer-Lase"
Passwords are a random amalgamation of characters.
The password
package helps generate these and supports the following rules
that be used during generation:
- Use a specific character-set
- Restrict the length of the password
- Use at least X lower-case characters
- Use at least X upper-case characters
- Use at least X and at most Y symbols
g, err := password.NewGenerator(
password.WithCharset(charset.AllChars.WithoutAmbiguity().WithoutDuplicates()),
password.WithLength(12),
password.WithMinLowerCase(5),
password.WithMinUpperCase(2),
password.WithNumSymbols(1, 1),
)
if err != nil {
panic(err.Error())
}
for idx := 1; idx <= 10; idx++ {
fmt.Printf("Password #%3d: %#v\n", idx, g.Generate())
}
Output...
Password # 1: "jQwRvL#oye7q" Password # 2: "T2WRwSbwghc^" Password # 3: "S@DxkUwkunhy" Password # 4: "NJ4wxhSygLm&" Password # 5: "phHfuqw*uAPq" Password # 6: "$3XDCoLXdeqq" Password # 7: "enzB*ENGhsQm" Password # 8: "ioCfs&cLJgyd" Password # 9: "obwEEEthM$MC" Password # 10: "kmQVb&fPqexj"
Odometer helps generate all possible string combinations of characters given a list of characters and the expected length of the string.
The odometer
package provides optimal interfaces to move through the list:
- Decrement()
- DecrementN(n)
- GoTo(n)
- Increment()
- IncrementN(n)
- etc.
o := odometer.New(charset.AlphabetsUpper, 8)
for idx := 1; idx <= 10; idx++ {
fmt.Printf("Password #%3d: %#v\n", idx, o.String())
if o.AtEnd() {
break
}
o.Increment()
}
Output...
Password # 1: "AAAAAAAA" Password # 2: "AAAAAAAB" Password # 3: "AAAAAAAC" Password # 4: "AAAAAAAD" Password # 5: "AAAAAAAE" Password # 6: "AAAAAAAF" Password # 7: "AAAAAAAG" Password # 8: "AAAAAAAH" Password # 9: "AAAAAAAI" Password # 10: "AAAAAAAJ"
goos: linux
goarch: amd64
pkg: github.com/jedib0t/go-passwords/passphrase
cpu: AMD Ryzen 9 5900X 12-Core Processor
BenchmarkGenerator_Generate-12 3979081 294.8 ns/op 144 B/op 5 allocs/op
PASS
ok github.com/jedib0t/go-passwords/passphrase 1.503s
goos: linux
goarch: amd64
pkg: github.com/jedib0t/go-passwords/password
cpu: AMD Ryzen 9 5900X 12-Core Processor
BenchmarkGenerator_Generate-12 5977402 199.4 ns/op 40 B/op 2 allocs/op
PASS
ok github.com/jedib0t/go-passwords/password 1.414s
goos: linux
goarch: amd64
pkg: github.com/jedib0t/go-passwords/odometer
cpu: AMD Ryzen 9 5900X 12-Core Processor
BenchmarkOdometer_Decrement-12 56414820 21.25 ns/op 0 B/op 0 allocs/op
BenchmarkOdometer_Decrement_Big-12 44742920 27.37 ns/op 0 B/op 0 allocs/op
BenchmarkOdometer_DecrementN-12 6536234 177.3 ns/op 16 B/op 2 allocs/op
BenchmarkOdometer_GotoLocation-12 5184144 220.7 ns/op 56 B/op 4 allocs/op
BenchmarkOdometer_Increment-12 61866901 19.37 ns/op 0 B/op 0 allocs/op
BenchmarkOdometer_Increment_Big-12 67560506 17.68 ns/op 0 B/op 0 allocs/op
BenchmarkOdometer_IncrementN-12 7371675 172.7 ns/op 16 B/op 2 allocs/op
BenchmarkOdometer_String-12 14852208 75.40 ns/op 16 B/op 1 allocs/op
PASS
ok github.com/jedib0t/go-passwords/odometer 10.282s