Skip to content

Commit bf770f2

Browse files
nastasha-solomonmergify[bot]
authored andcommitted
[ESS][Pt. Duex] Adding value list file size constraints to UI docs (#5001)
* First draft * Input from Yara * Update docs/detections/value-list-exceptions.asciidoc * Update docs/detections/value-list-exceptions.asciidoc * Remove duplicated content (cherry picked from commit 2e9f4b1) # Conflicts: # docs/detections/value-list-exceptions.asciidoc
1 parent 15e5058 commit bf770f2

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
[[value-lists-exceptions]]
2+
== Create and manage value lists
3+
4+
Value lists hold multiple values of the same Elasticsearch data type, such as IP addresses, which are used to determine when an exception prevents an alert from being generated. You can use value lists to define exceptions for detection rules; however, you cannot use value lists to define endpoint rule exceptions.
5+
6+
Value lists are lists of items with the same {es} {ref}/mapping-types.html[data type]. You can create value lists with these types:
7+
8+
* `Keywords` (many {ecs-ref}/ecs-field-reference.html[ECS fields] are keywords)
9+
* `IP Addresses`
10+
* `IP Ranges`
11+
* `Text`
12+
13+
After creating value lists, you can use `is in list` and `is not in list` operators to <<add-exceptions,define exceptions>>.
14+
15+
TIP: You can also use a value list as the <<indicator-value-lists,indicator match index>> when creating an indicator match rule.
16+
17+
[float]
18+
[[create-value-lists]]
19+
=== Create value lists
20+
When you create a value list for a rule exception, be mindful of the list's size and data type. All rule types support value list exceptions, but extremely large lists or certain data types have limitations.
21+
22+
Custom query, machine learning, and indicator match rules support the following value list types and sizes:
23+
24+
* **Keywords** or **IP addresses** list types with more than 65,536 values
25+
* **IP ranges** list type with over 200 dash notation values (for example, `127.0.0.1-127.0.0.4` is one value) or more than 65,536 CIDR notation values
26+
27+
To create a value list:
28+
29+
. Prepare a `txt` or `csv` file with all the values you want to use for
30+
determining exceptions from a single list. If you use a `txt` file, new lines
31+
act as delimiters.
32+
+
33+
[IMPORTANT]
34+
=========================
35+
* All values in the file must be of the same {es} type.
36+
37+
* Wildcards are not supported in value lists. Values must be literal values.
38+
39+
* The maximum accepted file size is 9 million bytes.
40+
=========================
41+
42+
. Go to *Rules* -> *Detection rules (SIEM)*.
43+
. Click *Manage value lists*. The *Manage value lists* window opens.
44+
+
45+
[role="screenshot"]
46+
image::images/upload-lists-ui.png[Manage value lists flyout,75%]
47+
48+
. Select the list type (*Keywords*, *IP addresses*, *IP ranges*, or *Text*) from the *Type of value list* drop-down.
49+
. Drag or select the `csv` or `txt` file that contains the values.
50+
. Click *Import value list*.
51+
52+
NOTE: If you import a file with a name that already exists, a new list is not created. The imported values are added to the existing list instead.
53+
54+
[[manage-value-lists]]
55+
[discrete]
56+
=== Manage value lists
57+
58+
You can edit, remove, or export existing value lists.
59+
60+
[[edit-value-lists]]
61+
[discrete]
62+
==== Edit value lists
63+
64+
. Go to **Rules** → **Detection rules (SIEM)**.
65+
. Click **Manage value lists**. The **Manage value lists** window opens.
66+
. In the **Value lists** table, click the value list you want to edit.
67+
. Do any of the following:
68+
69+
** **Filter items in the list**: Use the KQL search bar to find values in the list. Depending on your list's type, you can filter by the `keyword`, `ip_range`, `ip`, or `text` fields. For example, to filter by Gmail addresses in a value list of the `keyword` type, enter `keyword:*gmail.com` into the search bar.
70+
+
71+
You can also filter by the `updated_by` field (for example, `updated_by:testuser`), or the `updated at` field (for example, `updated_at < now`).
72+
** **Add individual items to the list**: Click **Create list item**, enter a value, then click **Add list item**.
73+
** **Bulk upload list items**: Drag or select the `csv` or `txt` file that contains the values that you want to add, then click **Upload**.
74+
** **Edit a value**: In the Value column, go to the value you want to edit and click the **Edit** button (image:images/edit-value-list-item.png[Edit button from Manage value lists window,15,15]). When you're done editing, click the **Save** button (image:images/save-value-list-item-changes.png[Save button from Manage value lists window,18,18]) to save your changes. Click the **Cancel** button (image:images/cancel-value-list-item-changes.png[Cancel button from Manage value lists window,18,18]) to revert your changes.
75+
** **Remove a value**: Click the **Remove value** button (image:images/remove-value-list-item.png[Remove value list button from Manage value lists window,15,15]) to delete a value from the list.
76+
77+
[role="screenshot"]
78+
image::images/edit-value-lists.png[Manage items in a value lists,75%]
79+
80+
TIP: You can also edit value lists while creating and managing exceptions that use value lists.
81+
82+
[[export-remove-value-lists]]
83+
[discrete]
84+
==== Export or remove value lists
85+
86+
. Go to *Rules* -> *Detection rules (SIEM)*.
87+
. Click *Manage value lists*. The *Manage value lists* window opens.
88+
. From the *Value lists* table, you can:
89+
.. Click the **Export value list** button (image:images/export-value-list.png[Export button from Manage value lists window,15,15]) to export the value list.
90+
.. Click the **Remove value list** button (image:images/remove-value-list.png[Remove button from Manage value lists window,15,15]) to delete the value list.
91+
+
92+
[role="screenshot"]
93+
image::images/manage-value-list.png[Import value list flyout with action buttons highlighted,75%]

0 commit comments

Comments
 (0)