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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

wants to merge 1 commit into from
+676 −385

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 reviewed Sep 23, 2024
View reviewed changes
...ons/google_workspace/collection_google_drive_ownership_transferred_via_google_workspace.toml
references = ["https://support.google.com/a/answer/1247799?hl=en"]
references = [
"https://support.google.com/a/answer/1247799?hl=en",
"https://www.elastic.co/security-labs/google-workspace-attack-surface-part-two",
Copy link
Contributor

Choose a reason for hiding this comment

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

https://www.elastic.co/security-labs/google-workspace-attack-surface-part-one
https://www.elastic.co/security-labs/google-workspace-attack-surface-part-two

I'd just add these to each rule for Google Workspace then. They are referenced in docs.

terrancedejesus
terrancedejesus reviewed Sep 23, 2024
View reviewed changes
rules/integrations/okta/credential_access_attempted_bypass_of_okta_mfa.toml
@@ -58,6 +58,8 @@ references = [
"https://developer.okta.com/docs/reference/api/system-log/",
"https://developer.okta.com/docs/reference/api/event-types/",
"https://www.elastic.co/security-labs/testing-okta-visibility-and-detection-dorothy",
"https://www.elastic.co/security-labs/monitoring-okta-threats-with-elastic-security",
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd add these to all Okta, along with https://www.elastic.co/security-labs/starter-guide-to-understanding-okta

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.

Samirbous
Samirbous approved these changes Sep 23, 2024
View reviewed changes
rules/windows/command_and_control_common_webservices.toml
@@ -128,10 +127,18 @@ This rule looks for processes outside known legitimate program locations communi
- Determine the initial vector abused by the attacker and take action to prevent reinfection through the same vector.
- Using the incident response data, update logging and audit policies to improve the mean time to detect (MTTD) and the mean time to respond (MTTR).
"""
references = ["https://www.elastic.co/security-labs/operation-bleeding-bear"]
Copy link
Contributor

Choose a reason for hiding this comment

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

siestagraph uses a websvc domain for C2 graph.microsoft.com (covered in this rule)

Suggested change
references = ["https://www.elastic.co/security-labs/operation-bleeding-bear"]
references = [
"https://www.elastic.co/security-labs/operation-bleeding-bear",
"https://www.elastic.co/security-labs/siestagraph-new-implant-uncovered-in-asean-member-foreign-ministry"
]

rules/windows/defense_evasion_defender_exclusion_via_powershell.toml
Comment on lines 71 to 75
references = [
"https://www.bitdefender.com/files/News/CaseStudies/study/400/Bitdefender-PR-Whitepaper-MosaicLoader-creat5540-en-EN.pdf",
"https://www.elastic.co/security-labs/elastic-security-uncovers-blister-malware-campaign",
"https://www.elastic.co/security-labs/operation-bleeding-bear",
]
Copy link
Contributor

Choose a reason for hiding this comment

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

ghostengine also disables Windows defender:

Suggested change
references = [
"https://www.bitdefender.com/files/News/CaseStudies/study/400/Bitdefender-PR-Whitepaper-MosaicLoader-creat5540-en-EN.pdf",
"https://www.elastic.co/security-labs/elastic-security-uncovers-blister-malware-campaign",
"https://www.elastic.co/security-labs/operation-bleeding-bear",
]
references = [
"https://www.bitdefender.com/files/News/CaseStudies/study/400/Bitdefender-PR-Whitepaper-MosaicLoader-creat5540-en-EN.pdf",
"https://www.elastic.co/security-labs/elastic-security-uncovers-blister-malware-campaign",
"https://www.elastic.co/security-labs/operation-bleeding-bear",
"https://www.elastic.co/security-labs/invisible-miners-unveiling-ghostengine"
]

rules/windows/defense_evasion_disabling_windows_defender_powershell.toml
@@ -58,6 +58,7 @@ This rule monitors the execution of commands that can tamper the Windows Defende
"""
references = [
"https://docs.microsoft.com/en-us/powershell/module/defender/set-mppreference?view=windowsserver2019-ps",
"https://www.elastic.co/security-labs/operation-bleeding-bear",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"https://www.elastic.co/security-labs/operation-bleeding-bear",
"https://www.elastic.co/security-labs/operation-bleeding-bear",
"https://www.elastic.co/security-labs/invisible-miners-unveiling-ghostengine"

rules/windows/defense_evasion_from_unusual_directory.toml
@@ -102,6 +102,7 @@ This rule identifies processes that are executed from suspicious default Windows
- Determine the initial vector abused by the attacker and take action to prevent reinfection through the same vector.
- Using the incident response data, update logging and audit policies to improve the mean time to detect (MTTD) and the mean time to respond (MTTR).
"""
references = ["https://www.elastic.co/security-labs/invisible-miners-unveiling-ghostengine"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Siestagraph executes from Windows\\Tasks covered in this rule :

Suggested change
references = ["https://www.elastic.co/security-labs/invisible-miners-unveiling-ghostengine"]
references = [
"https://www.elastic.co/security-labs/invisible-miners-unveiling-ghostengine",
"https://www.elastic.co/security-labs/siestagraph-new-implant-uncovered-in-asean-member-foreign-ministry"
]

rules/windows/lateral_movement_direct_outbound_smb_connection.toml
Comment on lines +101 to +103
references = [
"https://www.elastic.co/security-labs/elastic-protects-against-data-wiper-malware-targeting-ukraine-hermeticwiper",
]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
references = [
"https://www.elastic.co/security-labs/elastic-protects-against-data-wiper-malware-targeting-ukraine-hermeticwiper",
]
references = [
"https://www.elastic.co/security-labs/elastic-protects-against-data-wiper-malware-targeting-ukraine-hermeticwiper",
"https://www.elastic.co/security-labs/hunting-for-lateral-movement-using-event-query-language"
]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@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

@DefSecSentinel DefSecSentinel Awaiting requested review from DefSecSentinel

@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.
6 participants
@Mikaayenson @protectionsmachine @Samirbous @Aegrah @terrancedejesus @eric-forte-elastic