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.

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

[DOCS] Create rule updates - 7.10 #336

Merged
merged 19 commits into from
Nov 10, 2020
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
11 changes: 11 additions & 0 deletions docs/detections/detection-engine-intro.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ Detection rules::
Background tasks that run periodically and produce alerts when suspicious
activity is detected.

[[term-sec-indices]]
{es-sec} indices::
Indices containing host and network source events (such as
`packetbeat-*`, `log-*`, and `winlogbeat-*`). Detection rules use these
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
indices to generate alerts when suspicious activity is detected.

Endpoint exceptions::
<<term-exceptions, Exceptions>> added to both rules and Endpoint agents on
hosts. Endpoint exceptions can only be added when:
Expand All @@ -103,6 +109,11 @@ alerts.
External alerts::
Alerts {es-sec} receives from external systems, such as Suricata.

Threat indices::
Indices containing suspect field values. Threat-match detection rules use these
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
indices to compare their field values with source event values contained in
<<term-sec-indices, {es-sec} indices>>.

[float]
[[detections-permissions]]
== Detections configuration and index privilege prerequisites
Expand Down
36 changes: 25 additions & 11 deletions docs/detections/detections-ui-exceptions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@
[role="xpack"]
== Rule exceptions and value lists

To prevent the creation of unwanted alerts, you can add exceptions to detection
rules. Exceptions contain the source event conditions that determine when
To prevent the creation of unwanted alerts, you can add exceptions to these
detection rule types:

* Custom query
* EQL
* Threat match
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

Exceptions contain the source event conditions that determine when
alerts are not generated. They provide a convenient way of allowing trusted
processes and network activity to function without producing unnecessary noise.

Expand Down Expand Up @@ -42,7 +48,6 @@ NOTE: All values in the file must be of the same {es} type.
. Click *Upload value lists*.
+
The *Upload value lists* window opens.

[role="screenshot"]
image::images/upload-lists-ui.png[]

Expand All @@ -61,15 +66,23 @@ To view, delete, or export existing lists:

[float]
[[detection-rule-exceptions]]
=== Add detection exceptions to a rule
=== Add exceptions to a rule

You can add exceptions to a rule via the Rule details page or the Alerts table.
When you add an exception, you can also close all alerts that meet the
exception's criteria.

IMPORTANT: When you select to close all alerts that meet the exception's
criteria, all matching alerts are closed, *including* alerts generated by other
rules.
[IMPORTANT]
==============
Be careful when adding exceptions to EQL sequence rules. Exceptions are
evaluated against every event in the sequence and when the exception matches any
event(s) in the sequence, alerts are not generated. To exclude values from a
specific event in the sequence, update the rule's EQL statement. For example:

`sequence
[file where file.extension == "exe" and file.name != "app-name.exe"]
[process where true and process.name != "process-name.exe"]`
==============

. To add an exception via the Rule details page:
.. Go to the Rule details page of the rule to which you want to add the
Expand All @@ -86,7 +99,6 @@ The *Add Exception* window opens (via Alerts table).
+
[role="screenshot"]
image::images/add-exception-ui.png[]

. Add conditions that define when the exception prevents alerts. You can define
multiple conditions with `OR` and `AND` relationships. In the example above,
the exception prevents the rule from generating alerts when the
Expand All @@ -105,7 +117,6 @@ values in a list with `is in list` and `is not in list` operators:
+
[role="screenshot"]
image::images/exceptions-ui-list.png[]

NOTE: When using a list, all exception statements must use `is in list` and
`is not in list` operators.

Expand All @@ -115,6 +126,10 @@ NOTE: When using a list, all exception statements must use `is in list` and
is only available when adding exceptions via the Alerts table.
* _Close all alerts that match this exception, including alerts generated by other rules_:
Closes all alerts that match the exception's conditions.
+
IMPORTANT: When you select to close all alerts that meet the exception's
criteria, all matching alerts are closed, *including* alerts generated by other
rules.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

. Click *Add Exception*.

Expand Down Expand Up @@ -156,7 +171,6 @@ The *Add Endpoint Exception* window opens (via Alerts table).
+
[role="screenshot"]
image::images/endpoint-add-exp.png[]

. If required, modify the conditions.
+
NOTE: <<ex-nested-conditions>> describes when nested conditions are required.
Expand Down Expand Up @@ -234,4 +248,4 @@ correctly:
Creates an exception that excludes all LFC-signed trusted processes:

[role="screenshot"]
image::images/nested-exp.png[]
image::images/nested-exp.png[]
Binary file modified docs/detections/images/create-new-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/detections/images/preview-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading