-
Notifications
You must be signed in to change notification settings - Fork 224
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
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
abd72fd
Symantec Endpoint Security C2C doc
JV0812 41d1de3
minor fix
JV0812 207820c
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 f5cd06b
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 e318cf8
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 affac46
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 60c036e
Update docs/send-data/hosted-collectors/cloud-to-cloud-integration-fr…
JV0812 792f2a9
Update symantec-endpoint-security-source.md
JV0812 6689e09
converted to beta
JV0812 880a069
Update product-list.md
JV0812 ded21a4
Merge branch 'main' into Symantec-Endpoint-Security-Source
JV0812 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Symantec Endpoint Security C2C Source (Collection) | ||
| image: https://help.sumologic.com/img/sumo-square.png | ||
| keywords: | ||
| - collection | ||
| - symantec-endpoint-security | ||
| hide_table_of_contents: true | ||
| authors: | ||
| - url: https://help.sumologic.com/release-notes-service/rss.xml | ||
| image_url: /img/release-notes/rss-orange.png | ||
| --- | ||
|
|
||
| We're excited to announce the release of our new cloud-to-cloud source for Symantec Endpoint Security. This source collects incident and incident event data from the Symantec Endpoint Security platform using the [Incidents API](https://apidocs.securitycloud.symantec.com/#/doc?id=edr_incidents). [Learn more](/docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/symantec-endpoint-security-source). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
...ctors/cloud-to-cloud-integration-framework/symantec-endpoint-security-source.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| id: symantec-endpoint-security-source | ||
| title: Symantec Endpoint Security Source | ||
| 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. | ||
| --- | ||
|
|
||
| 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 network against malware, risks, and vulnerabilities. Symantec Endpoint Protection combines virus protection with advanced threat protection to proactively secure the client computers against known and unknown threats. This integration collects these information using the [Symantec Incidents API](https://apidocs.securitycloud.symantec.com/#/doc?id=edr_incidents) and ingests them into Sumo Logic. | ||
|
|
||
| ## Data collected | ||
|
|
||
| | Polling Interval | Data Source | Description | | ||
| | :--- | :--- | :--- | | ||
| | 5 min | [Token](https://api.sep.securitycloud.symantec.com/v1/oauth2/tokens)| Used to generate a bearer token to subsequent API calls. | | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | 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 an authentication token. To obtain the token, follow the steps below. | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 on **More Options icon** and select **Client Secret**. | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 1. Copy the **OAuth Credentials** value. | ||
| 1. Run the below curl command with the required headers to generate the bearer token: | ||
| ``` | ||
| curl -X POST https://api.sep.securitycloud.symantec.com/v1/oauth2/tokens | ||
| -H “accept: application/json” | ||
| -H “authorization: {{OAuth Credentials value}}" | ||
| -H “content-type: application/x-www-form-urlencoded” | ||
| ``` | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 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. | ||
| *  A green circle with a check mark is shown when the field exists in the Fields table schema. | ||
| *  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 [how to use JSON to configure Sources](/docs/send-data/use-json-configure-sources) for details. | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| | 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. | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.