akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

aezeed: publicly export the word field in ErrUnknownMnenomicWord

Browse Source 
In this commit, we publicly export the `word` field as it makes it
easier to programmatically interact with the package when attempting to
re-derive proper `cipherseed` instances. We also add a new `Index` field
as well to provide additional context for programmatic manipulating of
seeds.
This commit is contained in:
Olaoluwa Osuntokun 2019-07-12 17:12:14 -07:00
parent 3faece15be
commit d5122b7f04
No known key found for this signature in database
GPG Key ID: CE58F7F8E20FD9A2
3 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
aezeed/cipherseed.go
View File

@ -510,10 +510,13 @@ func (m *Mnemonic) Decipher(pass []byte) ([DecipheredCipherSeedSize]byte, error)
// Before we attempt to map the mnemonic back to the original // Before we attempt to map the mnemonic back to the original
// ciphertext, we'll ensure that all the word are actually a part of // ciphertext, we'll ensure that all the word are actually a part of
// the current default word list. // the current default word list.
for _, word := range m { for i, word := range m {
if !strings.Contains(englishWordList, word) { if !strings.Contains(englishWordList, word) {
emptySeed := [DecipheredCipherSeedSize]byte{} emptySeed := [DecipheredCipherSeedSize]byte{}
return emptySeed, ErrUnknownMnenomicWord{word} return emptySeed, ErrUnknownMnenomicWord{
Word: word,
Index: uint8(i),
}
} }
} }

8
aezeed/cipherseed_test.go
View File

@ -543,8 +543,12 @@ func TestDecipherUnknownMnenomicWord(t *testing.T) {
t.Fatalf("expected ErrUnknownMnenomicWord instead got %T", err) t.Fatalf("expected ErrUnknownMnenomicWord instead got %T", err)
} }
if wordErr.word != "kek" { if wordErr.Word != "kek" {
t.Fatalf("word mismatch: expected %v, got %v", "kek", wordErr.word) t.Fatalf("word mismatch: expected %v, got %v", "kek", wordErr.Word)
}
if int32(wordErr.Index) != randIndex {
t.Fatalf("wrong index detected: expected %v, got %v",
randIndex, wordErr.Index)
} }
} }

10
aezeed/errors.go
View File

@ -21,10 +21,16 @@ var (
// ErrUnknownMnenomicWord is returned when attempting to decipher and // ErrUnknownMnenomicWord is returned when attempting to decipher and
// enciphered mnemonic, but a word encountered isn't a member of our word list. // enciphered mnemonic, but a word encountered isn't a member of our word list.
type ErrUnknownMnenomicWord struct { type ErrUnknownMnenomicWord struct {
word string // Word is the unknown word in the mnemonic phrase.
Word string
// Index is the index (starting from zero) within the slice of strings
// that makes up the mnemonic that points to the incorrect word.
Index uint8
} }
// Error returns a human readable string describing the error. // Error returns a human readable string describing the error.
func (e ErrUnknownMnenomicWord) Error() string { func (e ErrUnknownMnenomicWord) Error() string {
return fmt.Sprintf("word %v isn't a part of default word list", e.word) return fmt.Sprintf("word %v isn't a part of default word list "+
"(index=%v)", e.Word, e.Index)
} }