This repository has been archived by the owner on Oct 7, 2024. It is now read-only.
generated from MetaMask/metamask-module-template
-
-
Notifications
You must be signed in to change notification settings - Fork 3
feat: enforce async request redirect URL is in the snaps 'allowedOrigins' #228
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
…e snap's allowed origins
gantunesr
reviewed
Feb 28, 2024
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.
Love to see that coverage at a 100%. Left a big comment
danroc
changed the title
feat: enforce async request redirect url is in the snaps 'allowedOrigins'
feat: enforce async request redirect URL is in the snaps 'allowedOrigins'
Feb 29, 2024
…dated optional chaining logic
…ow an error if undefined
ccharly
reviewed
Mar 4, 2024
danroc
approved these changes
Mar 5, 2024
ccharly
approved these changes
Mar 5, 2024
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! :) Thanks for those cosmetic changes!
Note
The main description is faulty for the jest
tests, I tested using:
yarn jest src/SnapKeyring.test.ts -t "throws an error if async request redirect url is not an allowed origin"
yarn jest src/SnapKeyring.test.ts -t "throws an error if no allowed origins"
yarn jest src/SnapKeyring.test.ts -t "throws an error if the snap is undefined"
and also re-run jest
globally to make sure the coverage is still 100%, so all good 😄
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Currently, in the async flow, we do not check that the redirect URL matches a domain of one of the allowed origins present in the Snap's manifest, and this has to be checked during the Snap review process. This change will add an additional check when receiving an async request that verifies whether or not the URL domain is within the Snap's allowed origins.
Testing
Coverage remains at 100%
Test Coverage Report
Jest
yarn jest src/SnapKeyring.test.ts -t "throws an error if async request redirect url is not an allowed origin"
yarn jest src/SnapKeyring.test.ts -t "throws an error if no allowed origins and async request redirect url"