Skip to content
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.

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

Validate mnemonic whitespace #59

Merged
merged 3 commits into from
Jul 11, 2023
Merged

Validate mnemonic whitespace #59

merged 3 commits into from
Jul 11, 2023

Conversation

lrettig
Copy link
Member

@lrettig lrettig commented Jul 11, 2023

Closes #58

Print an error and refuse to generate keys if a whitespace violation is detected in an input mnemonic


// bip39 lib doesn't properly validate whitespace so we have to do that manually.
if expected := strings.Join(strings.Fields(m), " "); m != expected {
return nil, errWhitespace

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not simply normalize the input instead? returning the error would be confusing for user
they then have to visually find where the extra white space is?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is less error-prone. if there's extra whitespace, then the user did something wrong, likely a copy and paste error. i think proceeding to generate a key in spite of this is a bad idea. the user should be aware of the error and should correct it. the BIP39 spec, such as it is, does not allow extra whitespace.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but then if there are sure of it (extra whitespace in btwn phrases), they will never be able to use this phrase.

should print the exact diff to user and prompt them to confirm then.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the interest of time, instead of creating more code, maybe just ask user to use the phrase smcli created

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@countvonzero I think this code should be as simple as possible. I don't think it's the responsibility of the wallet app to correct the user's mistake. At most we could link them to a doc that explains the issue and how to correct it, something along those lines.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then the phrase is wrong and they should use one that's valid. and they should be made aware that it's wrong.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in any case. otherwise code lg

Copy link
Member

@fasmat fasmat Jul 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a related but different question. Whitespace is more than just spaces, does bip39 handle things like \r, \n and \t correctly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fasmat all whitespace is treated the same way. this change will complain about \r, \n, and \t as well, see https://pkg.go.dev/strings#Fields. the regression test checks things other than spaces. the only thing that's permitted is a single space between words.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, didn't see the other whitespace characters in the test. Then LGTM

@lrettig lrettig merged commit aa072f8 into develop Jul 11, 2023
@lrettig lrettig deleted the validate-mnemonic branch July 11, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Whitespace in input mnemonic produces different seed
3 participants