diff --git a/docs/detections/images/boxesVertical.svg b/docs/detections/images/boxesVertical.svg new file mode 100644 index 0000000000..aed10b0d8e --- /dev/null +++ b/docs/detections/images/boxesVertical.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/detections/images/prebuilt-rules-add.png b/docs/detections/images/prebuilt-rules-add.png index 6cd3efff46..ec7993aa03 100644 Binary files a/docs/detections/images/prebuilt-rules-add.png and b/docs/detections/images/prebuilt-rules-add.png differ diff --git a/docs/detections/prebuilt-rules-management.asciidoc b/docs/detections/prebuilt-rules-management.asciidoc index 2f2efc421e..092c0c0340 100644 --- a/docs/detections/prebuilt-rules-management.asciidoc +++ b/docs/detections/prebuilt-rules-management.asciidoc @@ -16,7 +16,7 @@ Follow these guidelines to start using the {security-app}'s <> and <>. If you want to modify other settings on a prebuilt rule, you must first duplicate it, then make your changes to the duplicated rule. However, your customized rule is entirely separate from the original prebuilt rule, and will not get updates from Elastic if the prebuilt rule is updated. @@ -39,16 +39,19 @@ image::images/prebuilt-rules-add-badge.png[The Add Elastic Rules page] TIP: To examine the details of a rule before you install it, select the rule name. This opens the rule details flyout. . Do one of the following: -* Install all available rules: Click *Install all*. -* Install a single rule: Click *Install rule* for that rule. -* Install multiple rules: Select the rules and click *Install _x_ selected rule(s)*. ++ +-- +* Install all available rules: Click *Install all* at the top of the page. (This doesn't enable the rules; you still need to do that manually.) +* Install a single rule: In the rules table, either click **Install** to install a rule without enabling it, or click image:images/boxesVertical.svg[Vertical boxes button] → **Install and enable** to start running the rule once it's installed. +* Install multiple rules: Select the rules, and then at the top of the page either click *Install _x_ selected rule(s)* to install without enabling the rules, or click image:images/icons/boxesVertical.svg[Vertical boxes button] → **Install and enable** to install and start running the rules. +-- + TIP: Use the search bar and *Tags* filter to find the rules you want to install. For example, filter by `OS: Windows` if your environment only includes Windows endpoints. For more on tag categories, refer to <>. + [role="screenshot"] image::images/prebuilt-rules-add.png[The Add Elastic Rules page] -. Go back to the *Rules* page, search or filter for any rules you want to run, and do either of the following: +. For any rules you haven't already enabled, go back to the *Rules* page, search or filter for the rules you want to run, and do either of the following: * Enable a single rule: Turn on the rule's *Enabled* switch. * Enable multiple rules: Select the rules, then click *Bulk actions* -> *Enable*. diff --git a/docs/serverless/images/prebuilt-rules-management/-detections-prebuilt-rules-add.png b/docs/serverless/images/prebuilt-rules-management/-detections-prebuilt-rules-add.png new file mode 100644 index 0000000000..ec7993aa03 Binary files /dev/null and b/docs/serverless/images/prebuilt-rules-management/-detections-prebuilt-rules-add.png differ diff --git a/docs/serverless/rules/prebuilt-rules/prebuilt-rules-management.asciidoc b/docs/serverless/rules/prebuilt-rules/prebuilt-rules-management.asciidoc new file mode 100644 index 0000000000..1f7d3cd530 --- /dev/null +++ b/docs/serverless/rules/prebuilt-rules/prebuilt-rules-management.asciidoc @@ -0,0 +1,131 @@ +[[security-prebuilt-rules-management]] += Install and manage Elastic prebuilt rules + +// :description: Start detections quickly with prebuilt rules designed and updated by Elastic. +// :keywords: serverless, security, how-to, manage + +++++ +Use Elastic prebuilt rules +++++ + +preview:[] + +Follow these guidelines to start using the {security-app}'s <>, keep them updated, and make sure they have the data needed to run successfully. + +* <> +* <> +* <> +* <> +* <> + +[NOTE] +==== +* Most prebuilt rules don't start running by default. You can use the **Install and enable** option to start running rules as you install them, or first install the rules, then enable them manually. After installation, only a few prebuilt rules will be enabled by default, such as the Endpoint Security rule. +* You can't modify most settings on Elastic prebuilt rules. You can only edit <> and <>. If you want to modify other settings on a prebuilt rule, you must first duplicate it, then make your changes to the duplicated rule. However, your customized rule is entirely separate from the original prebuilt rule, and will not get updates from Elastic if the prebuilt rule is updated. +==== + +[discrete] +[[load-prebuilt-rules]] +== Install and enable Elastic prebuilt rules + +. Go to **Rules** → **Detection rules (SIEM)**. The badge next to **Add Elastic rules** shows the number of prebuilt rules available for installation. ++ +[role="screenshot"] +image::images/prebuilt-rules-management/-detections-prebuilt-rules-add-badge.png[The Add Elastic Rules page] +. Click **Add Elastic rules**. ++ +[TIP] +==== +To examine the details of a rule before you install it, select the rule name. This opens the rule details flyout. +==== +. Do one of the following: ++ +-- +* Install all available rules: Click *Install all* at the top of the page. (This doesn't enable the rules; you still need to do that manually.) +* Install a single rule: In the rules table, either click **Install** to install a rule without enabling it, or click image:images/icons/boxesVertical.svg[Vertical boxes button] → **Install and enable** to start running the rule once it's installed. +* Install multiple rules: Select the rules, and then at the top of the page either click *Install _x_ selected rule(s)* to install without enabling the rules, or click image:images/icons/boxesVertical.svg[Vertical boxes button] → **Install and enable** to install and start running the rules. +-- ++ +[TIP] +==== +Use the search bar and **Tags** filter to find the rules you want to install. For example, filter by `OS: Windows` if your environment only includes Windows endpoints. For more on tag categories, refer to <>. +==== ++ +[role="screenshot"] +image::images/prebuilt-rules-management/-detections-prebuilt-rules-add.png[The Add Elastic Rules page] +. For any rules you haven't already enabled, go back to the *Rules* page, search or filter for the rules you want to run, and do either of the following: ++ +** Enable a single rule: Turn on the rule's **Enabled** switch. +** Enable multiple rules: Select the rules, then click **Bulk actions** → **Enable**. + +Once you enable a rule, it starts running on its configured schedule. To confirm that it's running successfully, check its **Last response** status in the rules table, or open the rule's details page and check the <> tab. + +[discrete] +[[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. + +[discrete] +[[select-all-prebuilt-rules]] +== Select and duplicate all prebuilt rules + +. Go to **Rules** → **Detection rules (SIEM)**, then select the **Elastic rules** filter. +. Click **Select all _x_ rules** above the rules table. +. Click **Bulk actions** → **Duplicate**. +. Select whether to duplicate the rules' exceptions, then click **Duplicate**. + +You can then modify the duplicated rules and, if required, delete the prebuilt ones. However, your customized rules are entirely separate from the original prebuilt rules, and will not get updates from Elastic if the prebuilt rules are updated. + +[discrete] +[[update-prebuilt-rules]] +== Update Elastic prebuilt rules + +Elastic regularly updates prebuilt rules to optimize their performance and ensure they detect the latest threats and techniques. When updated versions are available for your installed prebuilt rules, the **Rule Updates** tab appears on the **Rules** page, allowing you to update your installed rules with the latest versions. + +. Go to **Rules** → **Detection rules (SIEM)**, then select the **Rule Updates** tab. ++ +[NOTE] +==== +The **Rule Updates** tab doesn't appear if all your installed prebuilt rules are up to date. +==== ++ +[role="screenshot"] +image::images/prebuilt-rules-management/-detections-prebuilt-rules-update.png[The Rule Updates tab on the Rules page] +. (Optional) To examine the details of a rule's latest version before you update it, select the rule name. This opens the rule details flyout. ++ +Select the **Updates** tab to view rule changes field by field, or the **JSON view** tab to view changes for the entire rule in JSON format. Both tabs display side-by-side comparisons of the **Current rule** (what you currently have installed) and the **Elastic update** version (what you can choose to install). Deleted characters are highlighted in red; added characters are highlighted in green. ++ +To accept the changes and install the updated version, select **Update**. ++ +[role="screenshot"] +image::images/prebuilt-rules-management/prebuilt-rules-update-diff.png[Prebuilt rule comparison] +. Do one of the following to update prebuilt rules on the **Rules** page: ++ +** Update all available rules: Click **Update all**. +** Update a single rule: Click **Update rule** for that rule. +** Update multiple rules: Select the rules and click **Update _x_ selected rule(s)**. ++ +[TIP] +==== +Use the search bar and **Tags** filter to find the rules you want to update. For example, filter by `OS: Windows` if your environment only includes Windows endpoints. For more on tag categories, refer to <>. +====