Skip to content

Symantec Endpoint Security C2C doc #4227

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.

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 11 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -1751,6 +1751,7 @@
"/cid/1964": "/docs/integrations/security-threat-detection/f5-big-ip-ltm",
"/cid/1965": "/docs/integrations/security-threat-detection/netskope",
"/cid/1966": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/carbon-black-cloud-source",
"/cid/1987": "/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-endpoint-security-source",
"/cid/1967": "/docs/integrations/web-servers/iis-10",
"/cid/1968": "/docs/integrations/partner-ecosystem-apps/",
"/cid/1969": "/docs/integrations/saas-cloud/opsgenie",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
id: symantec-endpoint-security-source
title: Symantec Endpoint Security Source (Beta)
sidebar_label: Symantec Endpoint Security
tags:
- cloud-to-cloud
- symantec-endpoint-security
description: Learn how to collect incident and incident events from the Symantec Endpoint Security source.
---
<head>
<meta name="robots" content="noindex" />
</head>

<p><a href="/docs/beta"><span className="beta">Closed Beta</span></a></p>

import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!/files/c2c/symantec-endpoint-security/example.json';
import TerraformExample from '!!raw-loader!/files/c2c/symantec-endpoint-security/example.tf';
import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/send-data/symantec-logo.svg')} alt="icon" width="125"/>

Symantec Endpoint Protection is a client-server solution that protects laptops, desktops, and servers in networks against malware, risks, and vulnerabilities. Symantec Endpoint Protection combines virus protection with advanced threat protection to proactively secure client computers against known and unknown threats. This integration collects this information using the [Symantec Incidents API](https://apidocs.securitycloud.symantec.com/#/doc?id=edr_incidents) and ingests it into Sumo Logic.

## Data collected

| Polling Interval | Data Source | Description |
| :--- | :--- | :--- |
| 5 min | [Incidents](https://api.sep.securitycloud.symantec.com/v1/incidents)| Used to retrieve incidents and incident events. |
| 5 min | [Incident Events](https://api.sep.securitycloud.symantec.com/v1/incidents/events)| Used to retrieve incident related events based on time range filter. |

## Setup

### Vendor configuration

The Symantec Endpoint Security source requires you to provide credentials. To obtain the client secret, follow the steps below.
1. Sign in to the [Symantec Endpoint Security](https://login.broadcom.com/) platform.
1. Go to **Integration** and select **Client Applications**.
1. Click on **Add Client Application**.
1. Enter any name for the application and press the **Add** button. The client application details screen appears.
1. Select required privileges for the client application and click **Save**.
1. Click the **More Options** icon and select **Client Secret**.

### Source configuration

When you create a Symantec Endpoint Security Source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).

To configure a Symantec Endpoint Security Source, follow the steps below:
1. <!--Kanso [**Classic UI**](/docs/get-started/sumo-logic-ui/). Kanso--> In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <!--Kanso <br/>[**New UI**](/docs/get-started/sumo-logic-ui-new/). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. Kanso-->
1. On the Collection page, click **Add Source** next to a Hosted Collector.
1. Search for and select **Symantec Endpoint Security**.
1. Enter a **Name** for the Source. The description is optional.
1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`.
1. (Optional) **Fields**. Click the **+Add** button to define the fields you want to associate. Each field needs a name (key) and value.
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists in the Fields table schema.
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema, it is ignored, also known as dropped.
1. In **Client ID**, enter the Client ID you generated from the Symantec Endpoint Security platform.
2. In **Client Secret**, enter the Client Secret you generated from the Symantec Endpoint Security platform.
3. (Optional) In **Initial LookBack**, enter the first collection start time. Default is 1 day and maximum is 30 days.
4. **Include Events**. Select this checkbox if you want to collect events from incidents.
5. (Optional) The **Polling Interval** is set for 24 hours by default. You can adjust it based on your needs.
6. (Optional) **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
7. When you are finished configuring the Source, click **Save**.

## JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. 

| Parameter | Type | Value | Required | Description |
|:--|:--|:--|:--|:--|
| schemaRef | JSON Object | `{"type":"Symantec Endpoint Security"}` | Yes | Define the specific schema type. |
| sourceType | String | `"Universal"` | Yes | Type of source. |
| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. |

### Configuration Object

| Parameter | Type | Required | Default | Description | Example |
|:---|:---|:---|:---|:---|:---|
| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` |
| description | String | No | `null` | Type a description of the source. | `"Testing source"`
| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"`
| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field `_siemForward` to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` |
| clientID | String | No | `null`| Client ID generated from the Symantec Endpoint Security platform. | |
| clientSecret | String | No | `null`| Client Secret generated from the Symantec Endpoint Security platform. | |
| incidentsIncludeEvents | String | No | false | Select the checkbox to include the incident events. | `5 minutes` |
| incidentsInitialLookback | Integer | No | 1 day | First collection start time. | |
| pollingInterval | String | No | 5 minutes | This sets how often the Source checks for data. | `5 minutes` |

### JSON example

<CodeBlock language="json">{MyComponentSource}</CodeBlock>

<a href="/files/c2c/symantec-endpoint-security/example.json" target="_blank">Download example</a>

### Terraform example

<CodeBlock language="json">{TerraformExample}</CodeBlock>

<a href="/files/c2c/symantec-endpoint-security/example.tf" target="_blank">Download example</a>

## FAQ

:::info
Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources.
:::
23 changes: 23 additions & 0 deletions static/files/c2c/symantec-endpoint-security/example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"api.version":"v1",
"source":{
"config":{
"name":"Symantec Endpoint Security Test",
"clientID":"********",
"incidentsIncludeEvents":true,
"incidentsInitialLookback":"1d",
"fields":{
"_siemForward":false
},
"clientSecret":"********",
"pollingInterval":"5m"
},
"schemaRef":{
"type":"Symantec Endpoint Security"
},
"state":{
"state":"Collecting"
},
"sourceType":"Universal"
}
}
21 changes: 21 additions & 0 deletions static/files/c2c/symantec-endpoint-security/example.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
resource "sumologic_cloud_to_cloud_source" "symantec-endpoint-security-source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "Symantec Endpoint Security"
}
config = jsonencode({
"name":"Symantec Endpoint Security Test",
"clientID":"********",
"incidentsIncludeEvents":true,
"incidentsInitialLookback":"1d",
"fields":{
"_siemForward":false
},
"clientSecret":"********",
"pollingInterval":"5m"
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}
Loading