Skip to content

Update hasThreatMatch in beta article for threat intel #5071

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 13, 2025
Merged

Update hasThreatMatch in beta article for threat intel #5071

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0a7034
Update hasThreatMatch in beta article
jpipkin1 Feb 13, 2025
d2b766a
Merge branch 'main' into update-hasthreatmatch-in-beta
kimsauce Feb 13, 2025
460b1d9
Update docs/platform-services/threat-intelligence-indicators.md
jpipkin1 Feb 13, 2025
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
45 changes: 28 additions & 17 deletions docs/platform-services/threat-intelligence-indicators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,18 @@ The `hasThreatMatch` Cloud SIEM rules function searches incoming Records in Clou
`hasThreatMatch([<fields>], <filters>, <indicators>)`

Parameters:
* `<fields>` is a list of comma separated Entity field names. At least one field name is required.
* `<filters>` is a logical expression using indicator attributes. (Allowed are parentheses `()`; `OR` and `AND` boolean operators; and comparison operators `=`, `<`, `>`, `=<`, `=>`, `!=`.)
* `<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.
* `<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:
* `actors`
* `confidence`
* `id`
* `indicator`
* `killChain`
* `source`
* `threatType`
* `type`
* `validFrom`
* `validUntil`
* `<indicators>` is an optional case insensitive option that describes how indicators should be matched with regard to their validity. Accepted values are:
* `active_indicators`. Match active indicators only (default).
* `expired_indicators`. Match expired indicators only.
Expand All @@ -270,9 +280,10 @@ Parameters:

* `hasThreatMatch([srcDevice_ip])`
* `hasThreatMatch([srcDevice_ip, dstDevice_ip])`
* `hasThreatMatch([srcDevice_ip], type="ipv4-addr")`
* `hasThreatMatch([srcDevice_ip], confidence > 50)`
* `hasThreatMatch([srcDevice_ip], confidence > 50 AND source="TAXII2Source")`
* `hasThreatMatch([srcDevice_ip], source="s1" OR (source="s2" confidence > 50 AND))`
* `hasThreatMatch([srcDevice_ip], source="s1" OR (source="s2" confidence > 50))`
* `hasThreatMatch([srcDevice_ip], expired_indicators)`
* `hasThreatMatch([srcDevice_ip], confidence > 50, all_indicators)`

Expand Down Expand Up @@ -330,7 +341,7 @@ Following is an example threat indicator file in normalized JSON format. (For an
{
"id": "0001",
"indicator": "192.0.2.0",
"type": "ipv4-addr:value",
"type": "ipv4-addr",
"source": "TAXII2Source",
"validFrom": "2023-03-21T12:00:00.000Z",
"validUntil": "2025-03-21T12:00:00.000Z",
Expand All @@ -346,7 +357,7 @@ Following is an example threat indicator file in normalized JSON format. (For an
{
"id": "0002",
"indicator": "192.0.2.1",
"type": "ipv4-addr:value",
"type": "ipv4-addr",
"source": "TAXII2Source",
"validFrom": "2023-03-21T12:00:00.000Z",
"validUntil": "2025-03-21T12:00:00.000Z",
Expand Down Expand Up @@ -415,8 +426,8 @@ Comma-separated value (CSV) is a standard format for data upload.
If uploading a CSV file with the UI, the format should be the same as used for a standard CSV file:

```
0001,192.0.2.0,ipv4-addr:value,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,,
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
0001,192.0.2.0,ipv4-addr,TAXII2Source,2023-02-21T12:00:00.00Z,2025-05-21T12:00:00.00Z,30,malicious-activity,,
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
```

##### Upload with the API
Expand Down Expand Up @@ -517,7 +528,7 @@ If you are uploading via the UI, do not include the `source` value in the file,
"created": "2023-03-21T12:00:00.000Z",
"modified": "2023-03-21T12:00:00.000Z",
"confidence": 30,
"pattern": "[ipv4-addr:value = '192.0.2.0']",
"pattern": "[ipv4-addr = '192.0.2.0']",
"pattern_type": "stix",
"pattern_version": "string",
"valid_from": "2023-03-21T12:00:00.000Z",
Expand All @@ -539,7 +550,7 @@ If you are uploading via the UI, do not include the `source` value in the file,
"created": "2023-03-21T12:00:00.000Z",
"modified": "2023-03-21T12:00:00.000Z",
"confidence": 30,
"pattern": "[ipv4-addr:value = '192.0.2.1']",
"pattern": "[ipv4-addr = '192.0.2.1']",
"pattern_type": "stix",
"pattern_version": "string",
"valid_from": "2023-03-21T12:00:00.000Z",
Expand Down Expand Up @@ -574,7 +585,7 @@ As shown in the following example, if uploading via the API you must add the `so
"created": "2023-03-21T12:00:00.000Z",
"modified": "2023-03-21T12:00:00.000Z",
"confidence": 30,
"pattern": "[ipv4-addr:value = '192.0.2.0']",
"pattern": "[ipv4-addr = '192.0.2.0']",
"pattern_type": "stix",
"pattern_version": "string",
"valid_from": "2023-03-21T12:00:00.000Z",
Expand All @@ -596,7 +607,7 @@ As shown in the following example, if uploading via the API you must add the `so
"created": "2023-03-21T12:00:00.000Z",
"modified": "2023-03-21T12:00:00.000Z",
"confidence": 30,
"pattern": "[ipv4-addr:value = '192.0.2.1']",
"pattern": "[ipv4-addr = '192.0.2.1']",
"pattern_type": "stix",
"pattern_version": "string",
"valid_from": "2023-03-21T12:00:00.000Z",
Expand Down Expand Up @@ -626,15 +637,15 @@ The following attributes are required:
* **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`.
* **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.
* **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:
* `domain-name:value`. Domain name. (Entity type in Cloud SIEM is `_domain`.)
* `email-addr:value`. Email address. (Entity type in Cloud SIEM is `_email`.)
* `domain-name`. Domain name. (Entity type in Cloud SIEM is `_domain`.)
* `email-addr`. Email address. (Entity type in Cloud SIEM is `_email`.)
* `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']`.
* `file:name`. File name. (Entity type in Cloud SIEM is `_file`.)
* `ipv4-addr:value`. IPv4 IP address. (Entity type in Cloud SIEM is `_ip`.)
* `ipv6-addr:value`. IPv6 IP address. (Entity type in Cloud SIEM is `_ip`.)
* `mac-addr:value`. Mac address name. (Entity type in Cloud SIEM is `_mac`.)
* `ipv4-addr`. IPv4 IP address. (Entity type in Cloud SIEM is `_ip`.)
* `ipv6-addr`. IPv6 IP address. (Entity type in Cloud SIEM is `_ip`.)
* `mac-addr`. Mac address name. (Entity type in Cloud SIEM is `_mac`.)
* `process:name`. Process name. (Entity type in Cloud SIEM is `_process`.)
* `url:value`. URL. (Entity type in Cloud SIEM is `_url`.)
* `url`. URL. (Entity type in Cloud SIEM is `_url`.)
* `user-account:user-id`. User ID. (Entity type in Cloud SIEM is `_username`.)
* `user-account:login`. Login name. (Entity type in Cloud SIEM is `_username`.)
* **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.
Expand Down
Loading