Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Docs | Rule Tuning] Add blog references to rules #4097

Merged
merged 7 commits into from
Sep 25, 2024
Merged

[Docs | Rule Tuning] Add blog references to rules #4097

merged 7 commits into from
Sep 25, 2024

Conversation

Mikaayenson
Copy link
Contributor

@Mikaayenson Mikaayenson commented Sep 23, 2024 •
edited
Loading

Pull Request

Issue link(s): N/A

Summary - What I changed

  • This PR adds our blog content as references to our prebuilt rules.
  • Noticed some auto formatting was added on toml_save.

How To Test

  • Check out any of the blogs added as a reference and double check that the rule is mentioned in the blog.

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, Rule: New, Rule: Deprecation, Rule: Tuning, Hunt: New, or Hunt: Tuning so guidelines can be generated
  • Added the meta:rapid-merge label if planning to merge within 24 hours
  • Secret and sensitive material has been managed correctly
  • Automated testing was updated or added to match the most common scenarios
  • Documentation and comments were added for features that require explanation

@Mikaayenson Mikaayenson added documentation Improvements or additions to documentation Rule: Tuning tweaking or tuning an existing rule labels Sep 23, 2024
@Mikaayenson Mikaayenson self-assigned this Sep 23, 2024
@protectionsmachine
Copy link
Collaborator

Rule: Tuning - Guidelines

These guidelines serve as a reminder set of considerations when tuning an existing rule.

Documentation and Context

  • Detailed description of the suggested changes.
  • Provide example JSON data or screenshots.
  • Provide evidence of reducing benign events mistakenly identified as threats (False Positives).
  • Provide evidence of enhancing detection of true threats that were previously missed (False Negatives).
  • Provide evidence of optimizing resource consumption and execution time of detection rules (Performance).
  • Provide evidence of specific environment factors influencing customized rule tuning (Contextual Tuning).
  • Provide evidence of improvements made by modifying sensitivity by changing alert triggering thresholds (Threshold Adjustments).
  • Provide evidence of refining rules to better detect deviations from typical behavior (Behavioral Tuning).
  • Provide evidence of improvements of adjusting rules based on time-based patterns (Temporal Tuning).
  • Provide reasoning of adjusting priority or severity levels of alerts (Severity Tuning).
  • Provide evidence of improving quality integrity of our data used by detection rules (Data Quality).
  • Ensure the tuning includes necessary updates to the release documentation and versioning.

Rule Metadata Checks

  • updated_date matches the date of tuning PR merged.
  • min_stack_version should support the widest stack versions.
  • name and description should be descriptive and not include typos.
  • query should be inclusive, not overly exclusive. Review to ensure the original intent of the rule is maintained.

Testing and Validation

  • Validate that the tuned rule's performance is satisfactory and does not negatively impact the stack.
  • Ensure that the tuned rule has a low false positive rate.

terrancedejesus
terrancedejesus approved these changes Sep 23, 2024
View reviewed changes
Copy link
Contributor

@terrancedejesus terrancedejesus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a note for Okta and GWS.

Mikaayenson and others added 2 commits September 25, 2024 09:56
@Mikaayenson @Samirbous
Apply suggestions from code review
57061b9 
Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>
@Mikaayenson
Merge branch 'main' into add_blog_references
8821070
DefSecSentinel
DefSecSentinel approved these changes Sep 25, 2024
View reviewed changes
Copy link
Contributor

@DefSecSentinel DefSecSentinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Mikaayenson Mikaayenson merged commit b80d834 into main Sep 25, 2024
9 checks passed
@Mikaayenson Mikaayenson deleted the add_blog_references branch September 25, 2024 20:19
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
09f7158 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

Removed changes from:
- rules/integrations/okta/credential_access_multiple_device_token_hashes_for_single_okta_session.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_from_single_source.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_with_the_same_device_token_hash.toml
- rules/integrations/okta/credential_access_okta_multiple_device_token_hashes_for_single_user.toml
- rules/integrations/okta/initial_access_okta_user_sessions_started_from_different_geolocations.toml
- rules/windows/collection_email_powershell_exchange_mailbox.toml

(selectively cherry picked from commit b80d834)
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
c2e5d2a 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

Removed changes from:
- rules/integrations/okta/credential_access_multiple_device_token_hashes_for_single_okta_session.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_from_single_source.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_with_the_same_device_token_hash.toml
- rules/integrations/okta/credential_access_okta_multiple_device_token_hashes_for_single_user.toml
- rules/integrations/okta/initial_access_okta_user_sessions_started_from_different_geolocations.toml
- rules/windows/collection_email_powershell_exchange_mailbox.toml

(selectively cherry picked from commit b80d834)
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
219c1f5 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

Removed changes from:
- rules/integrations/okta/credential_access_multiple_device_token_hashes_for_single_okta_session.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_from_single_source.toml
- rules/integrations/okta/credential_access_okta_authentication_for_multiple_users_with_the_same_device_token_hash.toml
- rules/integrations/okta/credential_access_okta_multiple_device_token_hashes_for_single_user.toml
- rules/integrations/okta/initial_access_okta_user_sessions_started_from_different_geolocations.toml
- rules/windows/collection_email_powershell_exchange_mailbox.toml

(selectively cherry picked from commit b80d834)
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
447e252 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

(cherry picked from commit b80d834)
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
a3b1274 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

(cherry picked from commit b80d834)
protectionsmachine pushed a commit that referenced this pull request Sep 25, 2024
@Mikaayenson @github-actions
[Docs | Rule Tuning] Add blog references to rules (#4097)
da7dc79 
* [Docs | Rule Tuning] Add blog references to rules

* Apply suggestions from code review

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

* Apply suggestions from code review

* Update google_workspace blog references

* add okta blog references

* Update dates

---------

Co-authored-by: Samirbous <64742097+Samirbous@users.noreply.github.com>

(cherry picked from commit b80d834)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DefSecSentinel DefSecSentinel DefSecSentinel approved these changes

@Samirbous Samirbous Samirbous approved these changes

@Aegrah Aegrah Aegrah approved these changes

@terrancedejesus terrancedejesus terrancedejesus approved these changes

@eric-forte-elastic eric-forte-elastic eric-forte-elastic approved these changes

@w0rk3r w0rk3r Awaiting requested review from w0rk3r

@imays11 imays11 Awaiting requested review from imays11

Assignees

@Mikaayenson Mikaayenson

Labels
backport: auto bbr Building Block Rules documentation Improvements or additions to documentation Domain: Cloud Domain: Endpoint Integration: Google Workspace Integration: Okta okta related rules OS: Linux OS: macOS OS: Windows windows related rules Rule: Tuning tweaking or tuning an existing rule
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Mikaayenson @protectionsmachine @DefSecSentinel @Samirbous @Aegrah @terrancedejesus @eric-forte-elastic