Skip to content

Commit dd0454f

Browse files
authored
Merge branch 'main' into docs-72-rule-limits
2 parents 9238a91 + 51c0dba commit dd0454f

File tree

60 files changed

+840
-713
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+840
-713
lines changed

cid-redirects.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1613,6 +1613,7 @@
16131613
"/cid/10196": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/zero-networks-segment-source",
16141614
"/cid/10122": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/webex-source",
16151615
"/cid/10125": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/druva-cyber-resilience-source",
1616+
"/cid/10127": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/intel471-threat-intel-source",
16161617
"/cid/10126": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/trust-login-source",
16171618
"/cid/10128": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/vmware-workspace-one-source",
16181619
"/cid/10129": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/dragos-source",

docs/cse/administration/create-a-custom-tag-schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This topic has instructions for creating a custom tag schema in Cloud SIEM. 
1111

1212
## About tags in Cloud SIEM
1313

14-
Tags are metadata you can attach to Insights, Signals, Entities, and Rules. Tags are useful for adding context to these Cloud SIEM items. You can also search for and filter items by tag. There are two types of tags: *keyword tags*, which are arbitrary, freeform strings; and *schema keys*, which are predefined key-value pairs. Cloud SIEM provides built-in schemas keys that display in the Cloud SIEM UI with a Sumo label, as shown in the example below. You can’t edit the built-in schemas.
14+
Tags are metadata you can attach to insights, signals, entities, and rules. Tags are useful for adding context to these Cloud SIEM items. You can also search for and filter items by tag. There are two types of tags: *keyword tags*, which are arbitrary, freeform strings; and *schema keys*, which are predefined key-value pairs. Cloud SIEM provides built-in schemas keys that display in the Cloud SIEM UI with a Sumo Logic label, as shown in the example below. You can’t edit the built-in schemas.
1515

1616
<img src={useBaseUrl('img/cse/built-in-tags.png')} alt="Built-in schema keys" style={{border: '1px solid gray'}} width="800"/>
1717

@@ -30,7 +30,7 @@ For more information about tags in Cloud SIEM, see [Using Tags with Insights, Si
3030
available for. You can select one or more of the following:
3131
* **Custom Insight**
3232
* **Rule**
33-
* **Entity** The options do not include **Signal** or **Insight**. Signals and Insights inherit tag values from the rule(s) or Custom Insight definition that triggered the Signal or Insight and involved Entities.
33+
* **Entity** The options do not include **Signal** or **Insight**. Signals and insights inherit tag values from the rule(s) or custom insight definition that triggered the signal or insight and involved entities.
3434
1. **Allow Custom Values**. Check this box to allow users to add additional allowable values to the tag schema. Otherwise, when applying the tag users may only select one of the values you define in the **Value Options** section below.
3535
1. If **Allow Custom Values** is not checked, you must define at least one value for the tag:
3636
* **Enter Value**. Enter an allowable value for the tag.

docs/cse/administration/create-cse-actions.md

Lines changed: 64 additions & 64 deletions
Large diffs are not rendered by default.

docs/cse/administration/create-cse-context-actions.md

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,38 @@
22
id: create-cse-context-actions
33
title: Create Context Actions
44
sidebar_label: Create Context Actions
5-
description: Learn about Context Actions, options that a Cloud SIEM analyst can use to query an external system for information about an Entity, IOC, or data encountered in Record.
5+
description: Learn about context actions, options that a Cloud SIEM analyst can use to query an external system for information about an entity, IOC, or data encountered in a record.
66
---
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
99

10-
This topic has information about Cloud SIEM Context Actions and how to create them. 
10+
This topic has information about Cloud SIEM context actions and how to create them. 
1111

12-
## About Context Actions
12+
## About context actions
1313

14-
A Context Action is an option that a Cloud SIEM analyst can use to query an external system for information about an Entity, IOC, or data encountered in a Record. For example, you might want to check an IP address against a threat intel service, google a username, or run a log search in Sumo Logic for a hostname. 
14+
A context action is an option that a Cloud SIEM analyst can use to query an external system for information about an entity, IOC, or data encountered in a record. For example, you might want to check an IP address against a threat intel service, google a username, or run a log search in Sumo Logic for a hostname. 
1515

16-
An authorized user can configure Context Actions and assign them to particular Entity types, Record fields, or common IOC types.
17-
18-
* **Context Actions on Entity types**. You can assign a Context Action to one or more Entity types, including custom Entity types. An action assigned to an Entity type will be available on any instance of that type in the **Entities** page, or in Insights or Signals that contain Entities of the selected type. For an example, see the screenshot in [How a user accesses Context Actions](#how-a-user-accesses-contextactions).
19-
20-
An action you assign to an Entity type will also be available for Record fields that contain the Entity type. For example, an action assigned to the Hostname Entity type will be available for the `srcDevice_hostname`, `dstDevice_hostname`, and `device_hostname` Record fields.
21-
 
22-
* **Context Actions on Record fields**. You can assign a Context Action to selected Record fields, or all Record fields. In the Cloud SIEM UI, the action will be available on the Context Action menu for selected fields.
23-
 
24-
* **Context Actions on IOC Types**. You can assign a Context Action to one or more of the following IOC data types:
16+
An authorized user can configure context actions and assign them to particular entity types, record fields, or common IOC types.
17+
* **Context actions on entity types**. You can assign a context action to one or more entity types, including custom entity types. An action assigned to an entity type will be available on any instance of that type in the **Entities** page, or in insights or signals that contain entities of the selected type. For an example, see the screenshot in [How a user accesses context actions](#how-a-user-accesses-contextactions). <br/>An action you assign to an entity type will also be available for record fields that contain the entity type. For example, an action assigned to the Hostname entity type will be available for the `srcDevice_hostname`, `dstDevice_hostname`, and `device_hostname` record fields.
18+
* **Context actions on record fields**. You can assign a context action to selected record fields, or all record fields. In the Cloud SIEM UI, the action will be available on the context action menu for selected fields.  
19+
* **Context actions on IOC types**. You can assign a context action to one or more of the following IOC data types:
2520
* Domain
2621
* IP Address
2722
* URL
2823
* Hash
2924
* MAC Address
3025

31-
The Context Actions menu will be available for any of these types, wherever they appear in the Cloud SIEM UI.
26+
The context actions menu will be available for any of these types, wherever they appear in the Cloud SIEM UI.
3227

33-
## How a user accesses Context Actions
28+
## How a user accesses context actions
3429

35-
A user runs a Context Action by clicking the Context Action icon <img src={useBaseUrl('img/cse/context-action-icon.png')} alt="Context action icon" style={{border: '1px solid gray'}} width="20"/> next to an Entity, Record field, or IOC and choosing an action from the list that appears. The icon appears when you hover over the value of the item.
30+
A user runs a context action by clicking the context action icon <img src={useBaseUrl('img/cse/context-action-icon.png')} alt="Context action icon" style={{border: '1px solid gray'}} width="20"/> next to an entity, record field, or IOC and choosing an action from the list that appears. The icon appears when you hover over the value of the item.
3631

37-
In the screenshot below, Context Actions are listed below the built-in **Add to Match List** and **Add to Suppressed List** options.
32+
In the screenshot below, context actions are listed below the built-in **Add to Match List** and **Add to Suppressed List** options.
3833

3934
<img src={useBaseUrl('img/cse/action-icon-entity.png')} alt="List of context actions" style={{border: '1px solid gray'}} width="300"/>
4035

41-
If an action name is shown in red font, that indicates that the action depends on a Record field that doesn’t exist.
36+
If an action name is shown in red font, that indicates that the action depends on a record field that doesn’t exist.
4237

4338
Watch this micro lesson to learn more about how to use context actions.
4439

@@ -55,20 +50,20 @@ Watch this micro lesson to learn more about how to use context actions.
5550

5651
import Iframe from 'react-iframe'; 
5752

58-
## Configure a Context Action
53+
## Configure a context action
5954

6055
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the top menu select **Configuration**, and then under **Integrations** select **Context Actions**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Cloud SIEM Integrations** select **Context Actions**. You can also click the **Go To...** menu at the top of the screen and select **Context Actions**.
6156
1. On the **Context Actions** tab click **+ Add Context Action**.
6257
1. Create the context action. <br/><img src={useBaseUrl('img/cse/configured-action.png')} alt="Configure action" style={{border: '1px solid gray'}} width="400"/>
63-
1. **Name**. Enter a name for the Context Action
58+
1. **Name**. Enter a name for the context action
6459
1. **Action Type**. Choose whether you want to open a **Sumo Logic Query** or a **URL** to an external service. 
6560
1. **Query**. Enter the URL or log query that the context action will issue.
6661
For instructions, see:
6762
* [Create a Sumo Logic search URL](#create-a-sumo-logic-search-url)
6863
* [Create a URL to external service](#create-an-url-to-an-external-service)
69-
1. If you chose **Sumo Logic Query** above, the **Timestamp offset** option appears, which set the query time range. The offset can be either -30m or +30m, and it will be applied to the timestamp in the target Record’s [timestamp](/docs/cse/schema/schema-attributes) field.
70-
1. **Entity Types**. Select the Entity types that the context action will apply to.
71-
1. **Record Properties**. Select the Record properties that the context action will apply to.
64+
1. If you chose **Sumo Logic Query** above, the **Timestamp offset** option appears, which set the query time range. The offset can be either -30m or +30m, and it will be applied to the timestamp in the target record’s [timestamp](/docs/cse/schema/schema-attributes) field.
65+
1. **Entity Types**. Select the entity types that the context action will apply to.
66+
1. **Record Properties**. Select the record properties that the context action will apply to.
7267
1. **IOC Data Types**. Choose the IOC data types to which the context action will apply. You can select one or more of the following data types listed below. Your context action will be available for any occurrences of the IOCs you select.
7368
* **Domain**
7469
* **Entity Types**
@@ -80,7 +75,7 @@ import Iframe from 'react-iframe'; 
8075

8176
### Create a Sumo Logic search URL
8277

83-
To create an URL for a Sumo Logic search, you enter a Sumo Logic search query as you would in a Sumo Logic search tab, but use the `{{value}}` parameter placeholder for the target item. For example, for a Context Action whose target is **Username**, you could enter the following query to search for Cloud SIEM Records of any type whose `user_username` field matches the username on which you run the action. 
78+
To create an URL for a Sumo Logic search, you enter a Sumo Logic search query as you would in a Sumo Logic search tab, but use the `{{value}}` parameter placeholder for the target item. For example, for a context action whose target is **Username**, you could enter the following query to search for Cloud SIEM records of any type whose `user_username` field matches the username on which you run the action. 
8479

8580
`_index=sec_record* AND user_username = "{{value}}"`
8681

@@ -90,7 +85,7 @@ When you save the action, the URL template will be populated with your Sumo Logi
9085

9186
### Create an URL to an external service
9287

93-
To create a URL to be sent to an external service, enter the URL in the format required by the external service, and use the `{{value}}` parameter placeholder for the target Entity, Record field, or IOC. 
88+
To create a URL to be sent to an external service, enter the URL in the format required by the external service, and use the `{{value}}` parameter placeholder for the target entity, record field, or IOC. 
9489

9590
Examples:
9691

@@ -102,15 +97,15 @@ Examples:
10297

10398
`https://www.abuseipdb.com/check/{{value}}`
10499

105-
The only required parameter in the URL is `{{value}}`. Depending on your use case, you can use other template parameters to insert timestamps in the action URL. For more information, see [Template parameters for Context Actions](#template-parameters-for-context-actions)
100+
The only required parameter in the URL is `{{value}}`. Depending on your use case, you can use other template parameters to insert timestamps in the action URL. For more information, see [Template parameters for context actions](#template-parameters-for-context-actions)
106101

107102
#### Open the Criminal IP lookup page for an IP address
108103

109104
`https://www.criminalip.io/asset/report/{{value}}`
110105

111-
## Template parameters for Context Actions
106+
## Template parameters for context actions
112107

113-
The table below defines the parameters you can use in the URL template for a Context Action.
108+
The table below defines the parameters you can use in the URL template for a context action.
114109

115110
### Value
116111

@@ -120,25 +115,25 @@ The table below defines the parameters you can use in the URL template for a Con
120115

121116
### Record value
122117

123-
You can insert any field from the target of a Context Action into the action URL with the `{{field_name}}` placeholder. For example, you could include `device_ip` in the URL with `{{device_ip}}`.  
118+
You can insert any field from the target of a context action into the action URL with the `{{field_name}}` placeholder. For example, you could include `device_ip` in the URL with `{{device_ip}}`.  
124119

125120
### Sumo Logic Base URL
126121

127-
The `{{sumobaseurl}}` parameter applies to Context Actions that run a Sumo Logic log search.
122+
The `{{sumobaseurl}}` parameter applies to context actions that run a Sumo Logic log search.
128123

129124
Assuming your Cloud SIEM instance is configured to communicate with the Sumo Logic platform, when you create an action that runs a Sumo Logic search, Cloud SIEM will automatically insert this placeholder in your URL template—you don’t need to explicitly insert `{{sumobaseurl}} `placeholder yourself.
130125

131126
### Timestamp
132127

133-
When you run an action on a Cloud SIEM Record, if that Record has a [timestamp](/docs/cse/schema/schema-attributes) field value, you can insert the timestamp in UTC format into the URL using the `{{timestamp}}` parameter.
128+
When you run an action on a Cloud SIEM record, if that record has a [timestamp](/docs/cse/schema/schema-attributes) field value, you can insert the timestamp in UTC format into the URL using the `{{timestamp}}` parameter.
134129

135130
### Formatted timestamp
136131

137-
To insert a Record’s [timestamp](/docs/cse/schema/schema-attributes) field value into the action URL as a Unix timestamp, use `{{timestamp [ms]}}`.
132+
To insert a record’s [timestamp](/docs/cse/schema/schema-attributes) field value into the action URL as a Unix timestamp, use `{{timestamp [ms]}}`.
138133

139134
### Timestamp with delta
140135

141-
If desired, you can insert a timestamp value that is some offset of the Record’s [timestamp](/docs/cse/schema/schema-attributes) field in the action URL, for example: 
136+
If desired, you can insert a timestamp value that is some offset of the record’s [timestamp](/docs/cse/schema/schema-attributes) field in the action URL, for example: 
142137

143138
`{{timestamp-5h}}`
144139

docs/cse/administration/create-custom-threat-intel-source.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ import Iframe from 'react-iframe'; 
3030
### How Cloud SIEM uses indicators
3131

3232
When Cloud SIEM encounters an indicator from your threat source in an incoming
33-
Record it adds relevant information to the Record. Because threat intelligence
34-
information is persisted within Records, you can reference it downstream
33+
record it adds relevant information to the record. Because threat intelligence
34+
information is persisted within records, you can reference it downstream
3535
in both rules and search. The built-in rules that come with Cloud SIEM
36-
automatically create a Signal for Records that have been enriched in
36+
automatically create a signal for records that have been enriched in
3737
this way.
3838

39-
Rule authors can also write rules that look for threat intelligence information in Records. To leverage the information in a rule, you can extend your custom rule expression, or add a Rule Tuning Expression to a built-in rule. For a more detailed explanation of how to use threat intelligence information in rules, see [Threat Intelligence](/docs/cse/rules/about-cse-rules/#threat-intelligence) in the
39+
Rule authors can also write rules that look for threat intelligence information in records. To leverage the information in a rule, you can extend your custom rule expression, or add a Rule Tuning Expression to a built-in rule. For a more detailed explanation of how to use threat intelligence information in rules, see [Threat Intelligence](/docs/cse/rules/about-cse-rules/#threat-intelligence) in the
4040
*About Cloud SIEM Rules* topic.
4141

4242
### Create a threat intelligence source from Cloud SIEM UI
@@ -83,7 +83,7 @@ The .csv file can contain up to four columns, which are described below. 
8383
| value | Required. Must be one of the following: <br/>- A valid IPV4 or IPv6 address<br/>- A valid, complete URL <br/>- A valid email address<br/>- A hostname (without protocol or path)<br/>- A hexadecimal string of 32, 40, 64, or 128 characters |
8484
| description | Optional. |
8585
| expires| Optional. The data and time when you want the indicator to be removed, in any ISO date format. |
86-
| active | Required. Specifies whether the indicator actively looks for threat intelligence in Records. Valid values are `true` or `false`. |
86+
| active | Required. Specifies whether the indicator actively looks for threat intelligence in records. Valid values are `true` or `false`. |
8787

8888
**Example .csv file**
8989

0 commit comments

Comments
 (0)