Skip to content

Commit 8254566

Browse files
jmikell821Ben Skelkernarcher7rylndlcawl
authored
[DOCS] Create rule updates - 7.10 (#336)
* Adds EQL and threat-match rule types * updates terminology * adds warning about eql seq exceptions * Update docs/detections/detections-ui-exceptions.asciidoc Co-authored-by: Ryland Herrick <ryalnd@gmail.com> * Testing addition of preview rule. * comitting so I don't lose. * Committing rule updates so I don't lose. * Merging feedback and testing formatting. * Fixing build error, updating image * formatting changes and updates. * Fix build error. * Attempt build error fix. * Fix missing anchor link * small fixes. * merging feedback. * build fix * and...another build fix. * [DOCS] Terminates important admonition block * merging feedback. Co-authored-by: Ben Skelker <ben.skelker@elastic.co> Co-authored-by: Nate Archer <12628964+DonNateR@users.noreply.github.com> Co-authored-by: Ryland Herrick <ryalnd@gmail.com> Co-authored-by: DonNateR <nathaniel.archer@elastic.co> Co-authored-by: lcawl <lcawley@elastic.co>
1 parent 278b13a commit 8254566

11 files changed

+232
-109
lines changed

docs/detections/api/exceptions/api-create-exception-item.asciidoc

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ lists, such as a list of IP addresses or host names.
99

1010
NOTE: Before creating exception items, you must create an exception container.
1111

12-
[IMPORTANT]
13-
==============
14-
Endpoint rule exception items cannot use
12+
IMPORTANT: Endpoint rule exception items cannot use
1513
<<lists-api-overview, lists>> (the `list` in the `entries` array), and the
1614
following fields cannot be used in exception queries (as `field` values in the
1715
`entries` object):
@@ -21,7 +19,6 @@ following fields cannot be used in exception queries (as `field` values in the
2119
* `process.entity_id`
2220
* `process.parent.entity_id`
2321
* `process.ancestry`
24-
==============
2522

2623
==== Request URL
2724

@@ -61,7 +58,7 @@ Must be the same value as its associated exception container.
6158

6259
|No, defaults to `single`.
6360
|`tags` |String[] |String array containing words and phrases to help categorize
64-
exception items. |No
61+
exception items. |No
6562
|`type` |String a|Exception query type, must be `simple`. |Yes
6663
|`_tags` |String[] a|For endpoint rules only, defines the OS on which the
6764
exception is implemented. Valid values are:
@@ -106,7 +103,7 @@ Can be:
106103
* `nested`: Array of `entries` objects. Nested conditions are required for
107104
excluding some Endpoint fields (<<nested-field-ex-api, see example below>>).
108105
<<ex-nested-conditions>> lists all Endpoint fields that require the `nested`
109-
type.
106+
type.
110107

111108
|Yes
112109

@@ -124,16 +121,12 @@ a|Field value or values:
124121

125122
|==============================================
126123

127-
[IMPORTANT]
128-
==============
129-
When you use <<lists-api-create-container, list containers>>
124+
IMPORTANT: When you use <<lists-api-create-container, list containers>>
130125
(`"type": "list"`), you cannot use other types in the `entries` array (`match`,
131126
`match_any`, `exists`, or `nested`).
132127

133128
For endpoint exceptions, you cannot create exception items based on excluded
134-
values (`"operator": "excluded"`).
135-
==============
136-
129+
values (`"operator": "excluded"`).
137130

138131
===== Example requests
139132

@@ -334,9 +327,9 @@ POST api/lists/exception_lists/items
334327

335328
==== Response code
336329

337-
`200`::
330+
`200`::
338331
Indicates a successful call.
339-
332+
340333
==== Response payload
341334

342335
[source,json]

docs/detections/detection-engine-intro.asciidoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ Detection rules::
8888
Background tasks that run periodically and produce alerts when suspicious
8989
activity is detected.
9090

91+
[[term-sec-indices]]
92+
{es-sec} indices::
93+
Indices containing host and network source events (such as
94+
`packetbeat-*`, `log-*`, and `winlogbeat-*`). When you <<rules-ui-create, create a new rule>>, the default index pattern corresponds to the <<update-sec-indices, values defined>> in the `securitySolution:defaultIndex`.
95+
9196
Endpoint exceptions::
9297
<<term-exceptions, Exceptions>> added to both rules and Endpoint agents on
9398
hosts. Endpoint exceptions can only be added when:
@@ -103,6 +108,11 @@ alerts.
103108
External alerts::
104109
Alerts {es-sec} receives from external systems, such as Suricata.
105110

111+
Threat indices::
112+
Indices containing suspect field values. <<create-indicator-rule, Indicator match rules>> use these
113+
indices to compare their field values with source event values contained in
114+
<<term-sec-indices, {es-sec} indices>>.
115+
106116
[float]
107117
[[detections-permissions]]
108118
== Detections configuration and index privilege prerequisites

docs/detections/detections-ui-exceptions.asciidoc

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22
[role="xpack"]
33
== Rule exceptions and value lists
44

5-
To prevent the creation of unwanted alerts, you can add exceptions to detection
6-
rules. Exceptions contain the source event conditions that determine when
5+
To prevent the creation of unwanted alerts, you can add exceptions to these
6+
detection rule types:
7+
8+
* Custom query
9+
* Event Correlation
10+
* Indicator match
11+
12+
Exceptions contain the source event conditions that determine when
713
alerts are not generated. They provide a convenient way of allowing trusted
814
processes and network activity to function without producing unnecessary noise.
915

@@ -39,10 +45,8 @@ act as value delimiters.
3945
NOTE: All values in the file must be of the same {es} type.
4046

4147
. Go to *Security* -> *Detections* -> *Manage detection rules*.
42-
. Click *Upload value lists*.
48+
. Click *Upload value lists*. The *Upload value lists* window opens.
4349
+
44-
The *Upload value lists* window opens.
45-
4650
[role="screenshot"]
4751
image::images/upload-lists-ui.png[]
4852

@@ -61,15 +65,28 @@ To view, delete, or export existing lists:
6165

6266
[float]
6367
[[detection-rule-exceptions]]
64-
=== Add detection exceptions to a rule
68+
=== Add exceptions to a rule
6569

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

70-
IMPORTANT: When you select to close all alerts that meet the exception's
71-
criteria, all matching alerts are closed, *including* alerts generated by other
72-
rules.
74+
[IMPORTANT]
75+
==============
76+
Be careful when adding exceptions to EQL sequence rules. Exceptions are
77+
evaluated against every event in the sequence, and when the exception matches any
78+
event(s) in the sequence, alerts are not generated. To exclude values from a
79+
specific event in the sequence, update the rule's EQL statement. For example:
80+
81+
[source,eql]
82+
----
83+
`sequence
84+
[file where file.extension == "exe"
85+
and file.name != "app-name.exe"]
86+
[process where true
87+
and process.name != "process-name.exe"]`
88+
----
89+
==============
7390

7491
. To add an exception via the Rule details page:
7592
.. Go to the Rule details page of the rule to which you want to add the
@@ -86,7 +103,6 @@ The *Add Exception* window opens (via Alerts table).
86103
+
87104
[role="screenshot"]
88105
image::images/add-exception-ui.png[]
89-
90106
. Add conditions that define when the exception prevents alerts. You can define
91107
multiple conditions with `OR` and `AND` relationships. In the example above,
92108
the exception prevents the rule from generating alerts when the
@@ -97,25 +113,24 @@ the exception prevents the rule from generating alerts when the
97113
============
98114
You can use nested conditions. However, this is only required for
99115
<<nested-field-list, these fields>>. For all other fields, nested conditions
100-
should not be used.
116+
should not be used.
101117
============
102118
+
103119
If you have created value lists, you can use them to exclude or include all
104120
values in a list with `is in list` and `is not in list` operators:
105121
+
106122
[role="screenshot"]
107123
image::images/exceptions-ui-list.png[]
108-
109124
NOTE: When using a list, all exception statements must use `is in list` and
110125
`is not in list` operators.
111126

112127
. You can select any of the following:
113128

114-
* _Close this alert_: Closes the alert when the exception is added. This option
129+
* *Close this alert*: Closes the alert when the exception is added. This option
115130
is only available when adding exceptions via the Alerts table.
116-
* _Close all alerts that match this exception, including alerts generated by other rules_:
117-
Closes all alerts that match the exception's conditions.
118-
131+
* *Close all alerts that match this exception and were generated by this rule*:
132+
Closes all alerts that match the exception's conditions and were generated only by the current rule.
133+
+
119134
. Click *Add Exception*.
120135

121136
[float]
@@ -156,7 +171,6 @@ The *Add Endpoint Exception* window opens (via Alerts table).
156171
+
157172
[role="screenshot"]
158173
image::images/endpoint-add-exp.png[]
159-
160174
. If required, modify the conditions.
161175
+
162176
NOTE: <<ex-nested-conditions>> describes when nested conditions are required.
@@ -166,7 +180,7 @@ NOTE: <<ex-nested-conditions>> describes when nested conditions are required.
166180
* _Close this alert_: Closes the alert when the exception is added. This option
167181
is only available when adding exceptions via the Alerts table.
168182
* _Close all alerts that match this exception, including alerts generated by other rules_:
169-
Closes all alerts that match the exception's conditions.
183+
Closes all alerts that match the exception's conditions.
170184

171185
. Click *Add Exception*.
172186
+
@@ -231,7 +245,7 @@ correctly:
231245
[discrete]
232246
==== Nested condition example
233247

234-
Creates an exception that excludes all LFC-signed trusted processes:
248+
Creates an exception that excludes all LFC-signed trusted processes:
235249

236250
[role="screenshot"]
237-
image::images/nested-exp.png[]
251+
image::images/nested-exp.png[]
-62 KB
Loading
102 KB
Loading
91.9 KB
Loading
60.9 KB
Loading
193 KB
Loading

0 commit comments

Comments
 (0)