Skip to content

Commit 7b6a198

Browse files
jpipkin1kimsauce
andauthored
Update hasThreatMatch in beta article for threat intel (#5071)
* Update hasThreatMatch in beta article * Update docs/platform-services/threat-intelligence-indicators.md Co-authored-by: Kim (Sumo Logic) <[email protected]> --------- Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 320c374 commit 7b6a198

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

docs/platform-services/threat-intelligence-indicators.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,18 @@ The `hasThreatMatch` Cloud SIEM rules function searches incoming Records in Clou
259259
`hasThreatMatch([<fields>], <filters>, <indicators>)`
260260

261261
Parameters:
262-
* `<fields>` is a list of comma separated Entity field names. At least one field name is required.
263-
* `<filters>` is a logical expression using indicator attributes. (Allowed are parentheses `()`; `OR` and `AND` boolean operators; and comparison operators `=`, `<`, `>`, `=<`, `=>`, `!=`.)
262+
* `<fields>` is a list of comma-separated [entity field names](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/schema/entity_fields.md). At least one field name is required.
263+
* `<filters>` is a logical expression using [indicator attributes](/docs/platform-services/threat-intelligence-indicators/#normalized-json-format). Allowed in the filtering are parentheses `()`; `OR` and `AND` boolean operators; and comparison operators `=`, `<`, `>`, `=<`, `=>`, `!=`. <br/>You can filter on the following indicator attributes:
264+
* `actors`
265+
* `confidence`
266+
* `id`
267+
* `indicator`
268+
* `killChain`
269+
* `source`
270+
* `threatType`
271+
* `type`
272+
* `validFrom`
273+
* `validUntil`
264274
* `<indicators>` is an optional case insensitive option that describes how indicators should be matched with regard to their validity. Accepted values are:
265275
* `active_indicators`. Match active indicators only (default).
266276
* `expired_indicators`. Match expired indicators only.
@@ -270,9 +280,10 @@ Parameters:
270280

271281
* `hasThreatMatch([srcDevice_ip])`
272282
* `hasThreatMatch([srcDevice_ip, dstDevice_ip])`
283+
* `hasThreatMatch([srcDevice_ip], type="ipv4-addr")`
273284
* `hasThreatMatch([srcDevice_ip], confidence > 50)`
274285
* `hasThreatMatch([srcDevice_ip], confidence > 50 AND source="TAXII2Source")`
275-
* `hasThreatMatch([srcDevice_ip], source="s1" OR (source="s2" confidence > 50 AND))`
286+
* `hasThreatMatch([srcDevice_ip], source="s1" OR (source="s2" confidence > 50))`
276287
* `hasThreatMatch([srcDevice_ip], expired_indicators)`
277288
* `hasThreatMatch([srcDevice_ip], confidence > 50, all_indicators)`
278289

@@ -330,7 +341,7 @@ Following is an example threat indicator file in normalized JSON format. (For an
330341
{
331342
"id": "0001",
332343
"indicator": "192.0.2.0",
333-
"type": "ipv4-addr:value",
344+
"type": "ipv4-addr",
334345
"source": "TAXII2Source",
335346
"validFrom": "2023-03-21T12:00:00.000Z",
336347
"validUntil": "2025-03-21T12:00:00.000Z",
@@ -346,7 +357,7 @@ Following is an example threat indicator file in normalized JSON format. (For an
346357
{
347358
"id": "0002",
348359
"indicator": "192.0.2.1",
349-
"type": "ipv4-addr:value",
360+
"type": "ipv4-addr",
350361
"source": "TAXII2Source",
351362
"validFrom": "2023-03-21T12:00:00.000Z",
352363
"validUntil": "2025-03-21T12:00:00.000Z",
@@ -415,8 +426,8 @@ Comma-separated value (CSV) is a standard format for data upload.
415426
If uploading a CSV file with the UI, the format should be the same as used for a standard CSV file:
416427

417428
```
418-
0001,192.0.2.0,ipv4-addr:value,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,,
419-
0002,192.0.2.1,ipv4-addr:value,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,actor3,reconnaissance
429+
0001,192.0.2.0,ipv4-addr,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,,
430+
0002,192.0.2.1,ipv4-addr,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,actor3,reconnaissance
420431
```
421432

422433
##### Upload with the API
@@ -517,7 +528,7 @@ If you are uploading via the UI, do not include the `source` value in the file,
517528
"created": "2023-03-21T12:00:00.000Z",
518529
"modified": "2023-03-21T12:00:00.000Z",
519530
"confidence": 30,
520-
"pattern": "[ipv4-addr:value = '192.0.2.0']",
531+
"pattern": "[ipv4-addr = '192.0.2.0']",
521532
"pattern_type": "stix",
522533
"pattern_version": "string",
523534
"valid_from": "2023-03-21T12:00:00.000Z",
@@ -539,7 +550,7 @@ If you are uploading via the UI, do not include the `source` value in the file,
539550
"created": "2023-03-21T12:00:00.000Z",
540551
"modified": "2023-03-21T12:00:00.000Z",
541552
"confidence": 30,
542-
"pattern": "[ipv4-addr:value = '192.0.2.1']",
553+
"pattern": "[ipv4-addr = '192.0.2.1']",
543554
"pattern_type": "stix",
544555
"pattern_version": "string",
545556
"valid_from": "2023-03-21T12:00:00.000Z",
@@ -574,7 +585,7 @@ As shown in the following example, if uploading via the API you must add the `so
574585
"created": "2023-03-21T12:00:00.000Z",
575586
"modified": "2023-03-21T12:00:00.000Z",
576587
"confidence": 30,
577-
"pattern": "[ipv4-addr:value = '192.0.2.0']",
588+
"pattern": "[ipv4-addr = '192.0.2.0']",
578589
"pattern_type": "stix",
579590
"pattern_version": "string",
580591
"valid_from": "2023-03-21T12:00:00.000Z",
@@ -596,7 +607,7 @@ As shown in the following example, if uploading via the API you must add the `so
596607
"created": "2023-03-21T12:00:00.000Z",
597608
"modified": "2023-03-21T12:00:00.000Z",
598609
"confidence": 30,
599-
"pattern": "[ipv4-addr:value = '192.0.2.1']",
610+
"pattern": "[ipv4-addr = '192.0.2.1']",
600611
"pattern_type": "stix",
601612
"pattern_version": "string",
602613
"valid_from": "2023-03-21T12:00:00.000Z",
@@ -626,15 +637,15 @@ The following attributes are required:
626637
* **created** (string [date-time]). The time at which the object was originally created. Timestamp in UTC in RFC3339 format. For example, `2016-05-01T06:13:14.000Z`.
627638
* **modified** (string [date-time]). When the object is modified. Timestamp in UTC in RFC3339 format. For example, `2023-05-01T06:13:14.000Z`. This property is only used by STIX Objects that support versioning and represents the time that this particular version of the object was last modified.
628639
* **pattern** (string). The pattern of this indicator (as defined by [pattern in STIX 2.1](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_me3pzm77qfnf)). Following are valid values:
629-
* `domain-name:value`. Domain name. (Entity type in Cloud SIEM is `_domain`.)
630-
* `email-addr:value`. Email address. (Entity type in Cloud SIEM is `_email`.)
640+
* `domain-name`. Domain name. (Entity type in Cloud SIEM is `_domain`.)
641+
* `email-addr`. Email address. (Entity type in Cloud SIEM is `_email`.)
631642
* `file:hashes`. File hash. (Entity type in Cloud SIEM is `_hash`.)<br/>If you want to add the hash algorithm, enter `file:hashes.'<HASH-TYPE>'`. For example, `[file:hashes.'SHA-256' = '4bac393bdd']`.
632643
* `file:name`. File name. (Entity type in Cloud SIEM is `_file`.)
633-
* `ipv4-addr:value`. IPv4 IP address. (Entity type in Cloud SIEM is `_ip`.)
634-
* `ipv6-addr:value`. IPv6 IP address. (Entity type in Cloud SIEM is `_ip`.)
635-
* `mac-addr:value`. Mac address name. (Entity type in Cloud SIEM is `_mac`.)
644+
* `ipv4-addr`. IPv4 IP address. (Entity type in Cloud SIEM is `_ip`.)
645+
* `ipv6-addr`. IPv6 IP address. (Entity type in Cloud SIEM is `_ip`.)
646+
* `mac-addr`. Mac address name. (Entity type in Cloud SIEM is `_mac`.)
636647
* `process:name`. Process name. (Entity type in Cloud SIEM is `_process`.)
637-
* `url:value`. URL. (Entity type in Cloud SIEM is `_url`.)
648+
* `url`. URL. (Entity type in Cloud SIEM is `_url`.)
638649
* `user-account:user-id`. User ID. (Entity type in Cloud SIEM is `_username`.)
639650
* `user-account:login`. Login name. (Entity type in Cloud SIEM is `_username`.)
640651
* **pattern_type** (string). The pattern language used in this indicator (as defined by [pattern_type in STIX 2.1](https://docs.oasis-open.org/cti/stix/v2.1/os/stix-v2.1-os.html#_9lfdvxnyofxw)). Enter `stix` to specify the [STIX](https://oasis-open.github.io/cti-documentation/stix/intro) pattern language.

0 commit comments

Comments
 (0)