Skip to content

Added ML detection-rules for new Security Host package#4519

Merged
shashank-elastic merged 6 commits intomainfrom
adding_host_traffic_rules
Mar 6, 2025
Merged

Added ML detection-rules for new Security Host package#4519
shashank-elastic merged 6 commits intomainfrom
adding_host_traffic_rules

Conversation

@sodhikirti07
Copy link
Contributor

Pull Request

Issue link(s):

Summary - What I changed

  • Added ML detection rules for the new prebuilt Security:Host ML module.
    Note: Updates are scheduled for release in version 8.18.0.

How To Test

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, maintenance, 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

Contributor checklist

@tradebot-elastic
Copy link

tradebot-elastic commented Mar 4, 2025

⛔️ Tests failed:

  • ❌ Decline in host-based traffic (-)
    • coverage_issue: no_rta
    • stack_validation_failed: no_rta
  • ❌ Spike in host-based traffic (-)
    • coverage_issue: no_rta
    • stack_validation_failed: no_rta

@shashank-elastic shashank-elastic marked this pull request as ready for review March 5, 2025 06:00
@shashank-elastic shashank-elastic added Rule: New Proposal for new rule and removed backport: auto labels Mar 5, 2025
@tradebot-elastic
Copy link

tradebot-elastic commented Mar 5, 2025

⛔️ Tests failed:

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2025

Rule: New - Guidelines

These guidelines serve as a reminder set of considerations when proposing a new rule.

Documentation and Context

  • Detailed description of the rule.
  • List any new fields required in ECS/data sources.
  • Link related issues or PRs.
  • Include references.

Rule Metadata Checks

  • creation_date matches the date of creation PR initially 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, considering performance for diverse environments. Non ecs fields should be added to non-ecs-schema.json if not available in an integration.
  • min_stack_comments and min_stack_version should be included if the rule is only compatible starting from a specific stack version.
  • index pattern should be neither too specific nor too vague, ensuring it accurately matches the relevant data stream (e.g., use logs-endpoint.process-* for process data).
  • integration should align with the index. If the integration is newly introduced, ensure the manifest, schemas, and new_rule.yaml template are updated.
  • setup should include the necessary steps to configure the integration.
  • note should include any additional information (e.g. Triage and analysis investigation guides, timeline templates).
  • tags should be relevant to the threat and align/added to the EXPECTED_RULE_TAGS in the definitions.py file.
  • threat, techniques, and subtechniques should map to ATT&CK always if possible.

New BBR Rules

  • building_block_type should be included if the rule is a building block and the rule should be located in the rules_building_block folder.
  • bypass_bbr_timing should be included if adding custom lookback timing to the rule.

Testing and Validation

  • Provide evidence of testing and detecting the expected threat.
  • Check for existence of coverage to prevent duplication.

@botelastic botelastic bot added the ML machine learning related rule label Mar 5, 2025
@tradebot-elastic
Copy link

tradebot-elastic commented Mar 5, 2025

⛔️ Tests failed:

@shashank-elastic
Copy link
Contributor

@sodhikirti07 Added investigation guides for the rule using our internal tool.

@shashank-elastic
Copy link
Contributor

@terrancedejesus The ML team has split the PR and added new rules for ML package that already exists. Do we still need jobs in upstream for verification, or we manually verify them here and at least get this PR merged

Co-authored-by: Susan <23287722+susan-shu-c@users.noreply.github.com>
@tradebot-elastic
Copy link

tradebot-elastic commented Mar 6, 2025

⛔️ Tests failed:

@tradebot-elastic
Copy link

tradebot-elastic commented Mar 6, 2025

⛔️ Tests failed:

@shashank-elastic shashank-elastic merged commit a1d6ff4 into main Mar 6, 2025
10 checks passed
@shashank-elastic shashank-elastic deleted the adding_host_traffic_rules branch March 6, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport: auto ML machine learning related rule Rule: New Proposal for new rule

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants