Add input validation, minor refactor #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rekmarks
commented
Feb 23, 2021
Comment on lines
+43
to
+69
| function validateDeriveKeyParams(pathSegment, parentKey) { | ||
| // The path segment must be one of the following: | ||
| // - A lone BIP-32 path segment | ||
| // - A lone BIP-39 path segment | ||
| // - A multipath | ||
| if (!( | ||
| BIP_32_PATH_REGEX.test(pathSegment) || | ||
| BIP_39_PATH_REGEX.test(pathSegment) || | ||
| MULTI_PATH_REGEX.test(pathSegment) | ||
| )) { | ||
| throw new Error('Invalid HD path segment. Ensure that the HD path segment is correctly formatted.') | ||
| } | ||
|
|
||
| // BIP-39 segments can only initiate HD paths | ||
| if (BIP_39_PATH_REGEX.test(pathSegment) && parentKey) { | ||
| throw new Error('May not specify parent key and BIP-39 path segment.') | ||
| } | ||
|
|
||
| // BIP-32 segments cannot initiate HD paths | ||
| if (!pathSegment.startsWith('bip39') && !parentKey) { | ||
| throw new Error('Must specify parent key if the first path of the path segment is not BIP-39.') | ||
| } | ||
|
|
||
| // The parent key must be a Buffer | ||
| if (parentKey && !Buffer.isBuffer(parentKey)) { | ||
| throw new Error('Parent key must be a Buffer if specified.') | ||
| } |
There was a problem hiding this comment.
This here is the crux of this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds input validation to ensure that only properly formatted paths are processed by
deriveKeyFromPath. Aside from internal import/export refactoring, the only functional change is the added input validation, and the tests, which are functionally unchanged, pass.This PR is intended as the first entry before a major version bump, due to this package's anticipated production use. Therefore, the following breaking, but not cryptographically relevant changes, are made:
deriveKeyFromPath: Change the order of parametersnull, which is unergonomicindex.jsfile toderiversdirectory, re-export individual derivers from there