Improve GitHub Webhook Modified rule #1324
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
### Background The original `Github.Repo.HookModified` rule is inappropriately named and had some errors in its tests. The `hook.*` audit log events capture any webhook event that occurs [in a repository, organization, GitHub Marketplace account, GitHub Sponsors account, or GitHub App](https://docs.github.com/en/webhooks/using-webhooks/creating-webhooks#:~:text=in%20a%20repository%2C%20organization%2C%20GitHub%20Marketplace%20account%2C%20GitHub%20Sponsors%20account%2C%20or%20GitHub%20App). The rule initially was designed to capture any webhook modification but labelled and titled as repo-specific. This corrects the minor error with a appropriately named rule, fixes the tests, and improves the alert title. The core logic remains the same. ### Changes - Disable GitHub.Repo.HookModified, remove from packs - Replicate original rule and create GitHub.Webhook.Modified, add to packs - Enhances alert context and improves title - Fix previous tests using incorrect field names, add test for GitHub App webhook ### Testing pat test, make lint
arielkr256
approved these changes
Aug 22, 2024
There was a problem hiding this comment.
@geoffg-sentry this looks good to me, thank you for your contribution!
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.
Background
The original
Github.Repo.HookModifiedrule is inappropriately named and had some errors in its tests. Thehook.*audit log events capture any webhook event that occurs in a repository, organization, GitHub Marketplace account, GitHub Sponsors account, or GitHub App. The rule initially was designed to capture any webhook modification but labelled and titled as repo-specific.This corrects the minor error with an appropriately named rule, fixes the tests, and improves the alert title. The core logic remains the same.
Changes
GitHub.Webhook.Modified, add to packsTesting
pat test, make lint