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

[8.5] Prebuilt rules tags documentation (backport #3625) #3631

Merged
merged 1 commit into from
Jul 25, 2023
Merged

[8.5] Prebuilt rules tags documentation (backport #3625) #3631

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/detections/rules-ui-manage.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ On the Rules page, you can:

* <<sort-filter-rules>>
* <<load-prebuilt-rules>>
* <<prebuilt-rule-tags>>
* <<select-all-prebuilt-rules>>
* <<download-prebuilt-rules>>
* <<rule-prerequisites>>
Expand Down Expand Up @@ -51,6 +52,30 @@ default. If you want to modify a prebuilt rule, you must first duplicate it, the
To learn how to enable detection rules in Elastic Security, watch the <<enable-detection-rules, tutorial>> at the end of this topic.
==============

[float]
[[prebuilt-rule-tags]]
=== Prebuilt rule tags

Each prebuilt rule includes several tags identifying the rule's purpose, detection method, associated resources, and other information to help categorize your rules. These tags are category-value pairs; for example, `OS: Windows` indicates rules designed for Windows endpoints. Categories include:

* `Data Source`: The application, cloud provider, data shipper, or Elastic integration providing data for the rule.
* `Domain`: A general category of data source types (such as cloud, endpoint, or network).
* `OS`: The host operating system, which could be considered another data source type.
* `Resources`: Additional rule resources such as investigation guides.
* `Rule Type`: Identifies if the rule depends on specialized resources (such as machine learning jobs or threat intelligence indicators), or if it's a higher-order rule built from other rules' alerts.
* `Tactic`: MITRE ATT&CK tactics that the rule addresses.
* `Threat`: Specific threats the rule detects (such as Cobalt Strike or BPFDoor).
* `Use Case`: The type of activity the rule detects and its purpose. Use cases include:
** `Active Directory Monitoring`: Detects changes related to Active Directory.
** `Asset Visibility`: Detects changes to specified asset types.
** `Configuration Audit`: Detects undesirable configuration changes.
** `Guided Onboarding`: Example rule, used for {elastic-sec}'s guided onboarding tour.
** `Identity and Access Audit`: Detects activity related to identity and access management (IAM).
** `Log Auditing`: Detects activity on log configurations or storage.
** `Network Security Monitoring`: Detects network security configuration activity.
** `Threat Detection`: Detects threats.
** `Vulnerability`: Detects exploitation of specific vulnerabilities.

[float]
[[select-all-prebuilt-rules]]
=== Select and duplicate all prebuilt rules
Expand Down