passit: add Orchard Street Wordlists

Updates #1

Author: tmthrgd

embedded.go

@@ -27,10 +27,47 @@ func (eg *embeddedGenerator) Password(r io.Reader) (string, error) {
 	return readSliceN(r, eg.list)
 }
 
+// OrchardStreetMedium is a Generator that returns a random word from
+// Sam Schlinkert's Orchard Street Medium List.
+//
+// It contains 8,192 words and has 13.000 bits of entropy per word. This list is
+// uniquely decodable and can be used with or without separators.
+//
+// This wordlist is licensed by Sam Schlinkert under a CC BY-SA 4.0 license.
+var OrchardStreetMedium Generator = &embeddedGenerator{raw: &wordlist.OrchardStreetMedium}
+
+// OrchardStreetLong is a Generator that returns a random word from
+// Sam Schlinkert's Orchard Street Long List.
+//
+// It contains 17,576 words and has 14.101 bits of entropy per word. This list is
+// uniquely decodable and can be used with or without separators.
+//
+// This wordlist is licensed by Sam Schlinkert under a CC BY-SA 4.0 license.
+var OrchardStreetLong Generator = &embeddedGenerator{raw: &wordlist.OrchardStreetLong}
+
+// OrchardStreetAlpha is a Generator that returns a random word from
+// Sam Schlinkert's Orchard Street Alpha List.
+//
+// It contains 1,296 words and has 10.340 bits of entropy per word. This list is
+// uniquely decodable and can be used with or without separators.
+//
+// This wordlist is licensed by Sam Schlinkert under a CC BY-SA 4.0 license.
+var OrchardStreetAlpha Generator = &embeddedGenerator{raw: &wordlist.OrchardStreetAlpha}
+
+// OrchardStreetQWERTY is a Generator that returns a random word from
+// Sam Schlinkert's Orchard Street QWERTY List.
+//
+// It contains 1,296 words and has 10.340 bits of entropy per word. This list is
+// uniquely decodable and can be used with or without separators.
+//
+// This wordlist is licensed by Sam Schlinkert under a CC BY-SA 4.0 license.
+var OrchardStreetQWERTY Generator = &embeddedGenerator{raw: &wordlist.OrchardStreetQWERTY}
+
 // STS10Wordlist is a Generator that returns a random word from Sam Schlinkert's
 // '1Password Replacement List'.
 //
-// It contains 18,208 words and has 14.152 bits of entropy per word.
+// It contains 18,208 words and has 14.152 bits of entropy per word. This list is
+// not uniquely decodable and should only be used with separators.
 //
 // This wordlist is licensed by Sam Schlinkert under a CC BY 3.0 license.
 var STS10Wordlist Generator = &embeddedGenerator{raw: &wordlist.STS10Wordlist}

embedded_test.go

@@ -20,124 +20,66 @@ func allWordsValid(t *testing.T, list []string) {
 // These tests are currently the same, but keep them separate in case that changes.
 var allEmojiValid = allWordsValid
 
-func TestSTS10Wordlist(t *testing.T) {
-	const size = 8
-
-	tr := newTestRand()
-
-	pass, err := Repeat(STS10Wordlist, " ", size).Password(tr)
-	require.NoError(t, err)
-
-	assert.Equal(t, "winner vertigo spurs believed dude runaways poorest tourists", pass)
-	assert.Equal(t, size-1, strings.Count(pass, " "),
-		`strings.Count(%q, " ")`, pass)
-	assert.Truef(t, utf8.ValidString(pass),
-		"utf8.ValidString(%q)", pass)
-
-	allWordsValid(t, STS10Wordlist.(*embeddedGenerator).list)
-}
-
-func TestEFFLargeWordlist(t *testing.T) {
-	const size = 8
-
-	tr := newTestRand()
-
-	pass, err := Repeat(EFFLargeWordlist, " ", size).Password(tr)
-	require.NoError(t, err)
-
-	assert.Equal(t, "reprint wool pantry unworried mummify veneering securely munchkin", pass)
-	assert.Equal(t, size-1, strings.Count(pass, " "),
-		`strings.Count(%q, " ")`, pass)
-	assert.Truef(t, utf8.ValidString(pass),
-		"utf8.ValidString(%q)", pass)
-
-	allWordsValid(t, EFFLargeWordlist.(*embeddedGenerator).list)
-}
-
-func TestEFFShortWordlist1(t *testing.T) {
-	const size = 8
-
-	tr := newTestRand()
-
-	pass, err := Repeat(EFFShortWordlist1, " ", size).Password(tr)
-	require.NoError(t, err)
-
-	assert.Equal(t, "bush vapor issue ruby carol sleep hula case", pass)
-	assert.Equal(t, size-1, strings.Count(pass, " "),
-		`strings.Count(%q, " ")`, pass)
-	assert.Truef(t, utf8.ValidString(pass),
-		"utf8.ValidString(%q)", pass)
-
-	allWordsValid(t, EFFShortWordlist1.(*embeddedGenerator).list)
-}
-
-func TestEFFShortWordlist2(t *testing.T) {
-	const size = 8
-
-	tr := newTestRand()
-
-	pass, err := Repeat(EFFShortWordlist2, " ", size).Password(tr)
-	require.NoError(t, err)
-
-	assert.Equal(t, "barracuda vegetable idly podiatrist bossiness satchel hexagon boxlike", pass)
-	assert.Equal(t, size-1, strings.Count(pass, " "),
-		`strings.Count(%q, " ")`, pass)
-	assert.Truef(t, utf8.ValidString(pass),
-		"utf8.ValidString(%q)", pass)
-
-	allWordsValid(t, EFFShortWordlist2.(*embeddedGenerator).list)
-}
-
-func TestEmoji13(t *testing.T) {
-	const size = 25
-
-	tr := newTestRand()
-
-	for _, expect := range []string{
-		"💙🏂🏽🧑🏽\u200d🦱🤙🏾🧗🏿\u200d♀️🧑🏻\u200d🤝\u200d🧑🏻🐭🚵🏿🚴🏿🏠💇🏾\u200d♂️💁🏻🙍🏾\u200d♂️👩🏾\u200d🦲🧑🏿\u200d🤝\u200d🧑🏼✨🖐🏿🎮🔑🏔️🔹🇩🇲💇🏼\u200d♀️🕶️🧙🏼",
-		"🫕👳🏽\u200d♀️👩🏻\u200d💻👰🏿\u200d♀️🇲🇻🔃🖖🏻🧛🏿\u200d♂️👩🏼\u200d🤝\u200d👩🏻🧚🏿🇧🇦🇹🇻🇱🇹🍆🧑🏻\u200d🤝\u200d🧑🏾🌲👨🏼\u200d🦼🏌🏻\u200d♂️👨\u200d🚀😸👰🏽\u200d♀️🦖#️⃣👴🏼💂🏻",
-		"🏌️\u200d♂️💲🐗🥇↘️👰🇨🇷👈🏽🦸🏿\u200d♂️🗺️🇭🇺🇯🇴🚣🏻👷🏽\u200d♂️🧖🏿🇬🇭🤙🏿🥾🤪⛹🏻👩🏻\u200d🌾☸️🧨▶️🐎",
-		"🧑🏻\u200d🤝\u200d🧑🏾👨🏼\u200d🤝\u200d👨🏿🏆🕙🏆🏃🏻\u200d♂️🤿👨🏿\u200d⚕️🧑🏾🤛🏼🏋🏿🧑🏽\u200d🏭👮🏼\u200d♀️🙅🏾\u200d♂️Ⓜ️🧘🏾☑️⛴️🎙️🚭🦸🏻\u200d♂️🥷🏻📙👨🏾\u200d⚖️🍤",
+func TestEmbeddedWordlist(t *testing.T) {
+	for _, tc := range []struct {
+		name   string
+		gen    Generator
+		expect string
+	}{
+		{"OrchardStreetMedium", OrchardStreetMedium, "pavilion extinct stadium furnace shores pirates hospital influenced"},
+		{"OrchardStreetLong", OrchardStreetLong, "agreed stopping brilliant elongated richness populous sprung grassland"},
+		{"OrchardStreetAlpha", OrchardStreetAlpha, "bees told hymn pride boy scout hum bus"},
+		{"OrchardStreetQWERTY", OrchardStreetQWERTY, "bids trio hurry queer buyer sect hull cadres"},
+		{"STS10Wordlist", STS10Wordlist, "winner vertigo spurs believed dude runaways poorest tourists"},
+		{"EFFLargeWordlist", EFFLargeWordlist, "reprint wool pantry unworried mummify veneering securely munchkin"},
+		{"EFFShortWordlist1", EFFShortWordlist1, "bush vapor issue ruby carol sleep hula case"},
+		{"EFFShortWordlist2", EFFShortWordlist2, "barracuda vegetable idly podiatrist bossiness satchel hexagon boxlike"},
 	} {
-		pass, err := Repeat(Emoji13, "", size).Password(tr)
-		if !assert.NoError(t, err) {
-			continue
-		}
-
-		assert.Equal(t, expect, pass)
-		assert.Equal(t, size, countEmojiInString(Emoji13.(*embeddedGenerator).list, pass),
-			"countEmojiInString(%q)", pass)
-		assert.Truef(t, utf8.ValidString(pass),
-			"utf8.ValidString(%q)", pass)
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			const size = 8
+
+			tr := newTestRand()
+			pass, err := Repeat(tc.gen, " ", size).Password(tr)
+			require.NoError(t, err)
+
+			assert.Equal(t, tc.expect, pass)
+			assert.Equal(t, size-1, strings.Count(pass, " "),
+				`strings.Count(%q, " ")`, pass)
+			assert.Truef(t, utf8.ValidString(pass),
+				"utf8.ValidString(%q)", pass)
+
+			allWordsValid(t, tc.gen.(*embeddedGenerator).list)
+		})
 	}
-
-	allEmojiValid(t, Emoji13.(*embeddedGenerator).list)
 }
 
-func TestEmoji15(t *testing.T) {
-	const size = 25
-
-	tr := newTestRand()
-
-	for _, expect := range []string{
-		"➡️🦸🏼\u200d♂️👩🏾\u200d🦳📱✍🏻🪣👨🏾\u200d🌾🤩🤵🏽\u200d♂️👮🏼🧗🏾\u200d♂️👷🏾\u200d♀️🧝🏾\u200d♂️👔🟨↗️🕵🏽👦🏽🏃🏽\u200d♂️🦶🤾🏿\u200d♂️⛺👮🏿👇🏽👳🏿",
-		"🌀🦿👈🏽🏄🏽\u200d♀️🧑🏻\u200d🦰🔃🫣🏪🪿🧗🏽👃8️⃣👩🏿\u200d🦰🇹🇦👮🏼\u200d♂️👨🏼\u200d❤️\u200d👨🏿🧑🏿\u200d🦱🤸🏽\u200d♂️🛫👩🏻\u200d🦰👩🏽\u200d❤️\u200d💋\u200d👨🏾🦶🏾㊗️👩🏼\u200d🎤💁🏻\u200d♂️",
-		"🧑🏿\u200d🤝\u200d🧑🏻🚶🏻\u200d♂️👨🏿\u200d⚖️🔟👨🏿\u200d🤝\u200d👨🏾👨\u200d👩\u200d👦🧝🏽\u200d♀️🔽🙋🏿\u200d♂️🧑🏼👩🏾\u200d🍼💆🏻\u200d♂️👩🏿\u200d🦽🐀💂🏻\u200d♀️🆑🍠🥸🤚🏾🚶🏻\u200d♂️🇦🇲💙👐💪🏾🫁",
-		"👱🏻🧒🏿🧢🐖👨🏿\u200d✈️🦀🎅👨🏾\u200d❤️\u200d💋\u200d👨🏼👨🏼\u200d🦱🎫🥻🙆🏿\u200d♂️👩🏼\u200d❤️\u200d💋\u200d👨🏼👴🏿💪🏻💂🏿\u200d♂️🛌🌚🏈👩🏻\u200d🤝\u200d👨🏽🛀🏾👋🏾🧑🏼\u200d🤝\u200d🧑🏻🏫✋🏼",
+func TestEmoji(t *testing.T) {
+	for _, tc := range []struct {
+		name   string
+		gen    Generator
+		expect string
+	}{
+		{"Emoji13", Emoji13, "💙🏂🏽🧑🏽\u200d🦱🤙🏾🧗🏿\u200d♀️🧑🏻\u200d🤝\u200d🧑🏻🐭🚵🏿🚴🏿🏠💇🏾\u200d♂️💁🏻🙍🏾\u200d♂️👩🏾\u200d🦲🧑🏿\u200d🤝\u200d🧑🏼✨🖐🏿🎮🔑🏔️🔹🇩🇲💇🏼\u200d♀️🕶️🧙🏼🫕👳🏽\u200d♀️👩🏻\u200d💻👰🏿\u200d♀️🇲🇻🔃🖖🏻🧛🏿\u200d♂️👩🏼\u200d🤝\u200d👩🏻🧚🏿🇧🇦🇹🇻🇱🇹🍆🧑🏻\u200d🤝\u200d🧑🏾🌲👨🏼\u200d🦼🏌🏻\u200d♂️👨\u200d🚀😸👰🏽\u200d♀️🦖#️⃣👴🏼💂🏻🏌️\u200d♂️💲🐗🥇↘️👰🇨🇷👈🏽🦸🏿\u200d♂️🗺️🇭🇺🇯🇴🚣🏻👷🏽\u200d♂️🧖🏿🇬🇭🤙🏿🥾🤪⛹🏻👩🏻\u200d🌾☸️🧨▶️🐎🧑🏻\u200d🤝\u200d🧑🏾👨🏼\u200d🤝\u200d👨🏿🏆🕙🏆🏃🏻\u200d♂️🤿👨🏿\u200d⚕️🧑🏾🤛🏼🏋🏿🧑🏽\u200d🏭👮🏼\u200d♀️🙅🏾\u200d♂️Ⓜ️🧘🏾☑️⛴️🎙️🚭🦸🏻\u200d♂️🥷🏻📙👨🏾\u200d⚖️🍤"},
+		{"Emoji15", Emoji15, "➡️🦸🏼\u200d♂️👩🏾\u200d🦳📱✍🏻🪣👨🏾\u200d🌾🤩🤵🏽\u200d♂️👮🏼🧗🏾\u200d♂️👷🏾\u200d♀️🧝🏾\u200d♂️👔🟨↗️🕵🏽👦🏽🏃🏽\u200d♂️🦶🤾🏿\u200d♂️⛺👮🏿👇🏽👳🏿🌀🦿👈🏽🏄🏽\u200d♀️🧑🏻\u200d🦰🔃🫣🏪🪿🧗🏽👃8️⃣👩🏿\u200d🦰🇹🇦👮🏼\u200d♂️👨🏼\u200d❤️\u200d👨🏿🧑🏿\u200d🦱🤸🏽\u200d♂️🛫👩🏻\u200d🦰👩🏽\u200d❤️\u200d💋\u200d👨🏾🦶🏾㊗️👩🏼\u200d🎤💁🏻\u200d♂️🧑🏿\u200d🤝\u200d🧑🏻🚶🏻\u200d♂️👨🏿\u200d⚖️🔟👨🏿\u200d🤝\u200d👨🏾👨\u200d👩\u200d👦🧝🏽\u200d♀️🔽🙋🏿\u200d♂️🧑🏼👩🏾\u200d🍼💆🏻\u200d♂️👩🏿\u200d🦽🐀💂🏻\u200d♀️🆑🍠🥸🤚🏾🚶🏻\u200d♂️🇦🇲💙👐💪🏾🫁👱🏻🧒🏿🧢🐖👨🏿\u200d✈️🦀🎅👨🏾\u200d❤️\u200d💋\u200d👨🏼👨🏼\u200d🦱🎫🥻🙆🏿\u200d♂️👩🏼\u200d❤️\u200d💋\u200d👨🏼👴🏿💪🏻💂🏿\u200d♂️🛌🌚🏈👩🏻\u200d🤝\u200d👨🏽🛀🏾👋🏾🧑🏼\u200d🤝\u200d🧑🏻🏫✋🏼"},
 	} {
-		pass, err := Repeat(Emoji15, "", size).Password(tr)
-		if !assert.NoError(t, err) {
-			continue
-		}
-
-		assert.Equal(t, expect, pass)
-		assert.Equal(t, size, countEmojiInString(Emoji15.(*embeddedGenerator).list, pass),
-			"countEmojiInString(%q)", pass)
-		assert.Truef(t, utf8.ValidString(pass),
-			"utf8.ValidString(%q)", pass)
+		tc := tc
+		t.Run(tc.name, func(t *testing.T) {
+			const size = 100
+
+			tr := newTestRand()
+			pass, err := Repeat(tc.gen, "", size).Password(tr)
+			require.NoError(t, err)
+
+			assert.Equal(t, tc.expect, pass)
+			assert.Equal(t, size, countEmojiInString(tc.gen.(*embeddedGenerator).list, pass),
+				"countEmojiInString(%q)", pass)
+			assert.Truef(t, utf8.ValidString(pass),
+				"utf8.ValidString(%q)", pass)
+
+			allEmojiValid(t, tc.gen.(*embeddedGenerator).list)
+		})
 	}
-
-	allEmojiValid(t, Emoji15.(*embeddedGenerator).list)
 }
 
 func countEmojiInString(list []string, s string) int {

internal/wordlist/embed.go

@@ -3,6 +3,42 @@ package wordlist
 import _ "embed" // for go:embed
 
 var (
+	// OrchardStreetMedium is a wordlist that was taken from:
+	// https://github.com/sts10/orchard-street-wordlists/blob/016e8d6634c03dd08afd5b14753784aff325ebd1/lists/orchard-street-medium.txt.
+	//
+	// orchard-street-medium.txt is licensed by Sam Schlinkert under a
+	// CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/).
+	//
+	//go:embed orchard-street-medium.txt
+	OrchardStreetMedium string
+
+	// OrchardStreetLong is a wordlist that was taken from:
+	// https://github.com/sts10/orchard-street-wordlists/blob/016e8d6634c03dd08afd5b14753784aff325ebd1/lists/orchard-street-long.txt.
+	//
+	// orchard-street-long.txt is licensed by Sam Schlinkert under a
+	// CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/).
+	//
+	//go:embed orchard-street-long.txt
+	OrchardStreetLong string
+
+	// OrchardStreetMedium is a wordlist that was taken from:
+	// https://github.com/sts10/orchard-street-wordlists/blob/016e8d6634c03dd08afd5b14753784aff325ebd1/lists/orchard-street-alpha.txt.
+	//
+	// orchard-street-alpha.txt is licensed by Sam Schlinkert under a
+	// CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/).
+	//
+	//go:embed orchard-street-alpha.txt
+	OrchardStreetAlpha string
+
+	// OrchardStreetLong is a wordlist that was taken from:
+	// https://github.com/sts10/orchard-street-wordlists/blob/016e8d6634c03dd08afd5b14753784aff325ebd1/lists/orchard-street-qwerty.txt.
+	//
+	// orchard-street-qwerty.txt is licensed by Sam Schlinkert under a
+	// CC BY-SA 4.0 license (https://creativecommons.org/licenses/by-sa/4.0/).
+	//
+	//go:embed orchard-street-qwerty.txt
+	OrchardStreetQWERTY string
+
 	// STS10Wordlist is a wordlist that was taken from:
 	// https://github.com/sts10/generated-wordlists/tree/e0daeebbffbb/lists/1password-replacement
 	// where it was called 1password-replacement.txt.