From 537c192ce24b58ea458005308e22b9330500f1c3 Mon Sep 17 00:00:00 2001 From: Joe Peeples Date: Thu, 21 Mar 2024 12:06:36 -0400 Subject: [PATCH 1/2] Manual prebuilt rule updates support notice (#4934) * Add statement to relevant pages - Upgrade Elastic Security - Install and manage Elastic prebuilt rules * Update docs/detections/prebuilt-rules-management.asciidoc Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> * Update docs/upgrade/upgrade-security.asciidoc Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> * Update docs/upgrade/upgrade-security.asciidoc --------- Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com> Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com> (cherry picked from commit 9ad5d7054bafa40235c2df6888c29b92f87845f3) # Conflicts: # docs/detections/prebuilt-rules-management.asciidoc # docs/upgrade/upgrade-security.asciidoc --- .../prebuilt-rules-management.asciidoc | 136 ++++++++++++++++++ docs/upgrade/upgrade-security.asciidoc | 6 + 2 files changed, 142 insertions(+) create mode 100644 docs/detections/prebuilt-rules-management.asciidoc diff --git a/docs/detections/prebuilt-rules-management.asciidoc b/docs/detections/prebuilt-rules-management.asciidoc new file mode 100644 index 0000000000..12a6635633 --- /dev/null +++ b/docs/detections/prebuilt-rules-management.asciidoc @@ -0,0 +1,136 @@ +[[prebuilt-rules-management]] +== Install and manage Elastic prebuilt rules + +:frontmatter-description: Start detections quickly with prebuilt rules designed and updated by Elastic. +:frontmatter-tags-products: [security] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [manage] + +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] +==== +* Prebuilt rules don't start running by default. You must first install the rules, then enable them. 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. + +* Automatic updates of Elastic prebuilt rules are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re on {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates. +==== + +[float] +[[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-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*. +* Install a single rule: Click *Install rule* for that rule. +* Install multiple rules: Select the rules and click *Install _x_ selected rule(s)*. ++ +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: + +* 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. + +[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 + +. 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. + +[float] +[[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-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-update-diff.png[Prebuilt rule comparison,75%] + +. 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 <>. + +[float] +[[rule-prerequisites]] +=== Confirm rule prerequisites + +Many Elastic prebuilt rules are designed to work with specific Elastic integrations and data fields. These prerequisites are identified in the *Related integrations* and *Required fields* fields on a rule's details page (*Rules* -> *Detection rules (SIEM)*, then click a rule's name). *Related integrations* also displays each integration's installation status and includes links for installing and configuring the listed integrations. + +Additionally, the *Setup guide* section provides guidance on setting up the rule's requirements. + +[role="screenshot"] +image::images/rule-details-prerequisites.png[Rule details page with Related integrations, Required fields, and Setup guide highlighted] + +You can also check rules' related integrations in the *Installed Rules* and *Rule Monitoring* tables. Click the *integrations* badge to display the related integrations in a popup. + +[role="screenshot"] +image::images/rules-table-related-integrations.png[Rules table with related integrations popup,75%] + +TIP: You can hide the *integrations* badge in the rules tables. Go to *{kib}* -> *Stack Management* -> *Advanced Settings*, then turn off `securitySolution:showRelatedIntegrations`. diff --git a/docs/upgrade/upgrade-security.asciidoc b/docs/upgrade/upgrade-security.asciidoc index 96f67486da..8a9cec8a1a 100644 --- a/docs/upgrade/upgrade-security.asciidoc +++ b/docs/upgrade/upgrade-security.asciidoc @@ -25,7 +25,13 @@ IMPORTANT: There is a known issue that significantly impacts UI responsiveness. Upgrade your {stack} and {agent}s to 7.17 first (refer to {fleet-guide}/upgrade-elastic-agent.html[Upgrade Fleet-managed Elastic Agents]). Afterwards, you can {stack-ref}/upgrading-elastic-stack.html[upgrade the {stack}] to 8.x. Initially, {agent}s will be version 7.17; this is fine because {elastic-sec} 8.x supports the last minor release in 7.x (7.17) and any subsequent {elastic-endpoint} versions in 8.x. After the {stack} upgrade, you can decide whether to upgrade {agent}s to 8.0, which is recommended to ensure you get the latest features. +<<<<<<< HEAD NOTE: You do not need to shut down your {agent}s or endpoints to upgrade the {stack}. +======= +[float] +=== Support for Elastic prebuilt detection rule automatic updates +<> are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re upgrading to {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates. +>>>>>>> 9ad5d70 (Manual prebuilt rule updates support notice (#4934)) [float] [[update-prebuilt-rules]] From 2abcf4692da55c8dd64e64cee4554c09856df721 Mon Sep 17 00:00:00 2001 From: Joe Peeples Date: Thu, 21 Mar 2024 19:41:26 -0400 Subject: [PATCH 2/2] Fix merge conflict --- .../prebuilt-rules-management.asciidoc | 136 ------------------ docs/detections/rules-ui-manage.asciidoc | 6 +- docs/upgrade/upgrade-security.asciidoc | 11 +- 3 files changed, 9 insertions(+), 144 deletions(-) delete mode 100644 docs/detections/prebuilt-rules-management.asciidoc diff --git a/docs/detections/prebuilt-rules-management.asciidoc b/docs/detections/prebuilt-rules-management.asciidoc deleted file mode 100644 index 12a6635633..0000000000 --- a/docs/detections/prebuilt-rules-management.asciidoc +++ /dev/null @@ -1,136 +0,0 @@ -[[prebuilt-rules-management]] -== Install and manage Elastic prebuilt rules - -:frontmatter-description: Start detections quickly with prebuilt rules designed and updated by Elastic. -:frontmatter-tags-products: [security] -:frontmatter-tags-content-type: [how-to] -:frontmatter-tags-user-goals: [manage] - -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] -==== -* Prebuilt rules don't start running by default. You must first install the rules, then enable them. 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. - -* Automatic updates of Elastic prebuilt rules are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re on {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates. -==== - -[float] -[[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-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*. -* Install a single rule: Click *Install rule* for that rule. -* Install multiple rules: Select the rules and click *Install _x_ selected rule(s)*. -+ -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: - -* 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. - -[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 - -. 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. - -[float] -[[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-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-update-diff.png[Prebuilt rule comparison,75%] - -. 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 <>. - -[float] -[[rule-prerequisites]] -=== Confirm rule prerequisites - -Many Elastic prebuilt rules are designed to work with specific Elastic integrations and data fields. These prerequisites are identified in the *Related integrations* and *Required fields* fields on a rule's details page (*Rules* -> *Detection rules (SIEM)*, then click a rule's name). *Related integrations* also displays each integration's installation status and includes links for installing and configuring the listed integrations. - -Additionally, the *Setup guide* section provides guidance on setting up the rule's requirements. - -[role="screenshot"] -image::images/rule-details-prerequisites.png[Rule details page with Related integrations, Required fields, and Setup guide highlighted] - -You can also check rules' related integrations in the *Installed Rules* and *Rule Monitoring* tables. Click the *integrations* badge to display the related integrations in a popup. - -[role="screenshot"] -image::images/rules-table-related-integrations.png[Rules table with related integrations popup,75%] - -TIP: You can hide the *integrations* badge in the rules tables. Go to *{kib}* -> *Stack Management* -> *Advanced Settings*, then turn off `securitySolution:showRelatedIntegrations`. diff --git a/docs/detections/rules-ui-manage.asciidoc b/docs/detections/rules-ui-manage.asciidoc index 0d0b063886..3a62368786 100644 --- a/docs/detections/rules-ui-manage.asciidoc +++ b/docs/detections/rules-ui-manage.asciidoc @@ -31,10 +31,12 @@ You can then activate whichever rules you want. If you delete any prebuilt rules [NOTE] ============== -Apart from the Elastic Endpoint rule, prebuilt rules are not activated by +* Apart from the Elastic Endpoint rule, prebuilt rules are not activated by default. If you want to modify a prebuilt rule, you must first duplicate it, then make your changes to the duplicated rule. All Elastic prebuilt rules are tagged with the word `Elastic`. - ++ To learn how to enable detection rules in Elastic Security, watch the <> at the end of this topic. + +* Automatic updates of Elastic prebuilt rules are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re on {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates. ============== [float] diff --git a/docs/upgrade/upgrade-security.asciidoc b/docs/upgrade/upgrade-security.asciidoc index 8a9cec8a1a..f627776a12 100644 --- a/docs/upgrade/upgrade-security.asciidoc +++ b/docs/upgrade/upgrade-security.asciidoc @@ -25,13 +25,7 @@ IMPORTANT: There is a known issue that significantly impacts UI responsiveness. Upgrade your {stack} and {agent}s to 7.17 first (refer to {fleet-guide}/upgrade-elastic-agent.html[Upgrade Fleet-managed Elastic Agents]). Afterwards, you can {stack-ref}/upgrading-elastic-stack.html[upgrade the {stack}] to 8.x. Initially, {agent}s will be version 7.17; this is fine because {elastic-sec} 8.x supports the last minor release in 7.x (7.17) and any subsequent {elastic-endpoint} versions in 8.x. After the {stack} upgrade, you can decide whether to upgrade {agent}s to 8.0, which is recommended to ensure you get the latest features. -<<<<<<< HEAD NOTE: You do not need to shut down your {agent}s or endpoints to upgrade the {stack}. -======= -[float] -=== Support for Elastic prebuilt detection rule automatic updates -<> are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re upgrading to {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates. ->>>>>>> 9ad5d70 (Manual prebuilt rule updates support notice (#4934)) [float] [[update-prebuilt-rules]] @@ -118,3 +112,8 @@ Changes to the indicator match rule's <>. + +[float] +[[prebuilt-rule-updates]] +=== Support for Elastic prebuilt detection rule automatic updates +<> are supported for the current {elastic-sec} version and the latest three previous minor releases. For example, if you’re upgrading to {elastic-sec} 8.10, you’ll be able to use the Rules UI to update your prebuilt rules until {elastic-sec} 8.14 is released. After that point, you can still manually download and install updated prebuilt rules, but you must upgrade to the latest {elastic-sec} version to receive automatic updates.