Skip to content

Better bip39 error #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gabriel merged 3 commits into from
Jul 22, 2020
Merged

Better bip39 error #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f77635b
encoding: Better bip39 error
gabriel Jul 22, 2020
e27093d
Update encode_test.go
gabriel Jul 22, 2020
8cb853f
ErrInvalidBIP39Input
gabriel Jul 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion encoding/bip39.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ type ErrInvalidPhrase struct {
cause error
}

// ErrInvalidBIP39Input if invalid number of bytes for encoding.
var ErrInvalidBIP39Input = errors.New("bip39 only accepts 16, 20, 24, 28, 32 bytes")

func (e ErrInvalidPhrase) Error() string {
return "invalid phrase"
}
Expand All @@ -23,7 +26,14 @@ func (e ErrInvalidPhrase) Cause() error {

// BytesToPhrase returns a phrase for bytes
func BytesToPhrase(b []byte) (string, error) {
return bip39.NewMnemonic(b)
out, err := bip39.NewMnemonic(b)
if err != nil {
if err == bip39.ErrEntropyLengthInvalid {
return "", ErrInvalidBIP39Input
}
return "", err
}
return out, nil
}

// PhraseToBytes decodes a bip39 mnemonic into bytes
Expand Down
43 changes: 43 additions & 0 deletions encoding/encode_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,49 @@ func TestEncodeBase64(t *testing.T) {
require.EqualError(t, err, "invalid option: lowercase")
}

func TestEncodeBIP39(t *testing.T) {
var b []byte
var out string
var err error

b = bytes.Repeat([]byte{0x01}, 16)
out, err = encoding.Encode(b, encoding.BIP39)
require.NoError(t, err)
require.Equal(t, "absurd amount doctor acoustic avoid letter advice cage absurd amount doctor adjust", out)

b = bytes.Repeat([]byte{0x01}, 20)
out, err = encoding.Encode(b, encoding.BIP39)
require.NoError(t, err)
require.Equal(t, "absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter all", out)

b = bytes.Repeat([]byte{0x01}, 24)
out, err = encoding.Encode(b, encoding.BIP39)
require.NoError(t, err)
require.Equal(t, "absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd approve", out)

b = bytes.Repeat([]byte{0x01}, 28)
out, err = encoding.Encode(b, encoding.BIP39)
require.NoError(t, err)
require.Equal(t, "absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic banana", out)

b = bytes.Repeat([]byte{0x01}, 32)
out, err = encoding.Encode(b, encoding.BIP39)
require.NoError(t, err)
require.Equal(t, "absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice cage absurd amount doctor acoustic avoid letter advice comic", out)

b = bytes.Repeat([]byte{0x01}, 8)
_, err = encoding.Encode(b, encoding.BIP39)
require.Equal(t, err, encoding.ErrInvalidBIP39Input)

b = bytes.Repeat([]byte{0x01}, 40)
_, err = encoding.Encode(b, encoding.BIP39)
require.Equal(t, err, encoding.ErrInvalidBIP39Input)

b = bytes.Repeat([]byte{0x01}, 64)
_, err = encoding.Encode(b, encoding.BIP39)
require.Equal(t, err, encoding.ErrInvalidBIP39Input)
}

func TestMustEncodeDecode(t *testing.T) {
in := bytes.Repeat([]byte{0x01}, 32)
out, err := encoding.DecodeBase32(encoding.EncodeBase32(in))
Expand Down