generated from MetaMask/metamask-module-template
-
-
Notifications
You must be signed in to change notification settings - Fork 10
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
First part of a solution for fixing JSON validation security issue #103
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
We should merge all parts of this task at the same time so as not to have a release with unsafe JSON. |
hmalik88
previously approved these changes
May 18, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Mrtenz
requested changes
May 19, 2023
ritave
reviewed
May 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor stylistical
Mrtenz
reviewed
May 23, 2023
Mrtenz
requested changes
May 23, 2023
ritave
reviewed
May 23, 2023
Mrtenz
approved these changes
May 30, 2023
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.
First part to fix an issue around JSON validation.
Second part (PR): MetaMask/snaps#1405
Explanation
This PR resolves the security issue with JSON validation and usage of the validated objects.
JsonStruct
is updated to usecoerce
instead ofdefine
and it does sanitization now by havingJSON.parse(JSON.stringify(value))
as the return value.From now it is supposed that validation is done using
create
function from Superstruct which will return validated and sanitized JSON. New functiongetValidatedAndSanitizedJson
which handles this is added.isValidJson
function is updated in order to use newJsonStruct
and keep its return values the same.On the places (e.g.
snaps-monorepo
) where JSON structure is validated and used later in the process,getValidatedAndSanitizedJson
should always be used.