-
Notifications
You must be signed in to change notification settings - Fork 5k
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
Enabling the MetaMask Security Code Scanner #22916
Conversation
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
Builds ready [68db3ae]
Page Load Metrics (961 ± 55 ms)
Bundle size diffs
|
Builds ready [1e58a01]
Page Load Metrics (1028 ± 33 ms)
Bundle size diffs
|
Builds ready [be81bb9]
Page Load Metrics (1065 ± 60 ms)
Bundle size diffs
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #22916 +/- ##
========================================
Coverage 68.60% 68.60%
========================================
Files 1097 1097
Lines 43309 43309
Branches 11544 11544
========================================
Hits 29711 29711
Misses 13598 13598 ☔ View full report in Codecov by Sentry. |
Builds ready [13f8900]
Page Load Metrics (1087 ± 52 ms)
Bundle size diffs
|
Builds ready [c477d72]
Page Load Metrics (1118 ± 86 ms)
Bundle size diffs
|
Builds ready [4333e8e]
Page Load Metrics (1063 ± 61 ms)
Bundle size diffs
|
Builds ready [1b687ca]
Page Load Metrics (1204 ± 111 ms)
Bundle size diffs
|
Builds ready [55c5572]
Page Load Metrics (1117 ± 52 ms)
Bundle size diffs
|
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.
Looks good from the security side of things. Will need someone from the @MetaMask/extension-devs team to push a commit highlighting the paths they would like to avoid scanning.
Builds ready [048aabb]
Page Load Metrics (1110 ± 64 ms)
Bundle size diffs
|
The examples of third-party/vendored code that I'm aware of are:
Definitely seems appropriate to ignore those two at least. |
Builds ready [1d87657]
Page Load Metrics (1008 ± 39 ms)
Bundle size diffs
|
I've added these two paths. CodeQL scans on just the repo- node_modules are not scanned by the default, Im ok leaving it in so it is explicit. |
Builds ready [64f30dc]
Page Load Metrics (1015 ± 38 ms)
Bundle size diffs
|
Builds ready [dbf5034]
Page Load Metrics (1065 ± 81 ms)
Bundle size diffs
|
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 but would it be not too tricky to have a preview available of what it would look like on current state of develop
to get a sense of the amount of signal and noise? Like running this change on a fork? :)
thank you @legobeat |
Builds ready [1dbcbda]
Page Load Metrics (1769 ± 83 ms)
Bundle size diffs
|
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.
Needs to accommodate to not make branches from external repos have failing CI.
This is fixed now |
Builds ready [f5ba74f]
Page Load Metrics (1509 ± 338 ms)
Bundle size diffs
|
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!
Builds ready [97d6827]
Page Load Metrics (1045 ± 377 ms)
Bundle size diffs
|
Required Action
Prior to merging this pull request, please ensure the following has been completed:
branches
correctly specifies this repository's default branch (usuallymain
).paths_ignored
configuration option (see setup)What is the Security Code Scanner?
This pull request enables the MetaMask Security Code Scanner GitHub Action. This action runs on each pull request, and will flag potential vulnerabilities as a review comment. It will also scan this repository's default branch, and log any findings in this repository's Code Scanning Alerts Tab.
The action itself runs various static analysis engines behind the scenes. Currently, it is only running GitHub's CodeQL engine. For this reason, we recommend disabling any existing CodeQL configuration your repository may have.
How do I interact with the tool?
Every finding raised by the Security Code Scanner will present context behind the potential vulnerability identified, and allow the developer to fix, or dismiss it.
The finding will automatically be dismissed by pushing a commit that fixes the identified issue, or by manually dismissing the alert using the button in GitHub's UI. If dismissing an alert manually, please add any additional context surrounding the reason for dismissal, as this informs our decision to disable, or improve any poor performing rules.
For more configuration options, please review the tool's README.
For any additional questions, please reach out to
@mm-application-security
slack.