Skip to content

Commit a741c45

Browse files
janvi-elasticjanvi-elastic
authored
[symantec_edr_cloud] Initial release of the symantec edr cloud (#8267)
1 parent 71cbd73 commit a741c45

26 files changed

+3071
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@
216216
/packages/stan @elastic/obs-cloudnative-monitoring
217217
/packages/statsd_input @elastic/obs-infraobs-integrations
218218
/packages/suricata @elastic/security-external-integrations
219+
/packages/symantec_edr_cloud @elastic/security-external-integrations
219220
/packages/symantec_endpoint @elastic/security-external-integrations
220221
/packages/synthetics @elastic/uptime
221222
/packages/synthetics_dashboards @elastic/uptime

‎packages/symantec_edr_cloud/_dev/build/build.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
ecs:
3+
reference: git@v8.10.0
4+
import_mappings: true

‎packages/symantec_edr_cloud/_dev/build/docs/README.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Symantec EDR Cloud
2+
3+
Symantec Endpoint Security is the fully cloud-managed version of the on-premises Symantec Endpoint Protection (SEP), which delivers multilayer protection to stop threats regardless of how they attack your endpoints. You manage Symantec Endpoint Security through a unified cloud console that provides threat visibility across your endpoints and uses multiple technologies to manage the security of your organization.
4+
5+
## Data streams
6+
7+
This integration supports ingestion of incidents from Symantec EDR Cloud, via the [Incidents API](https://apidocs.securitycloud.symantec.com/#/doc?id=edr_incidents).
8+
9+
**Incident** is used to retrieve EDR incidents. See more details in the API documentation [here](https://apidocs.securitycloud.symantec.com/#/doc?id=edr_incidents).
10+
11+
## Requirements
12+
13+
Elastic Agent must be installed. For more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).
14+
15+
### Installing and managing an Elastic Agent:
16+
17+
You have a few options for installing and managing an Elastic Agent:
18+
19+
### Install a Fleet-managed Elastic Agent (recommended):
20+
21+
With this approach, you install Elastic Agent and use Fleet in Kibana to define, configure, and manage your agents in a central location. We recommend using Fleet management because it makes the management and upgrade of your agents considerably easier.
22+
23+
### Install Elastic Agent in standalone mode (advanced users):
24+
25+
With this approach, you install Elastic Agent and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is reserved for advanced users only.
26+
27+
### Install Elastic Agent in a containerized environment:
28+
29+
You can run Elastic Agent inside a container, either with Fleet Server or standalone. Docker images for all versions of Elastic Agent are available from the Elastic Docker registry, and we provide deployment manifests for running on Kubernetes.
30+
31+
There are some minimum requirements for running Elastic Agent and for more information, refer to the link [here](https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html).
32+
33+
The minimum **Kibana version** required is **8.10.1**.
34+
This module has been tested against the **Symantec EDR Cloud API Version v1**.
35+
36+
## Setup
37+
38+
### To collect data from Symantec EDR Cloud, the following parameters from your Symantec EDR Cloud instance are required:
39+
40+
1. Client ID
41+
2. Client Secret
42+
43+
### Steps to obtain Client ID and Client Secret:
44+
45+
1. Login to your [Symantec EDR Cloud console](https://sep.securitycloud.symantec.com/v2/landing).
46+
2. Click Integration > Client Applications.
47+
3. Click Add for adding Client Application.
48+
4. Enter Client Application Name and press the Add button.
49+
5. Select Client Secret from the top.
50+
6. Copy the Client ID and Client Secret.
51+
52+
### Enabling the integration in Elastic:
53+
54+
1. In Kibana go to Management > Integrations
55+
2. In "Search for integrations" search bar, type Symantec EDR Cloud
56+
3. Click on the "Symantec EDR Cloud" integration from the search results.
57+
4. Click on the "Add Symantec EDR Cloud" button to add the integration.
58+
5. Add all the required integration configuration parameters, such as Client ID, Client Secret, URL, and Token URL. For incident data stream, these parameters must be provided in order to retrieve logs.
59+
6. Save the integration.
60+
61+
### Troubleshooting
62+
63+
If the user stops integration and starts integration again after 30 days, then user will not be able to collect data and will get an error as Symantec EDR Cloud only collects data for the last 30 days. To avoid this issue, create a new integration instead of restarting it after 30 days.
64+
65+
## Logs Reference
66+
67+
### Incident
68+
69+
This is the `Incident` dataset.
70+
71+
#### Example
72+
73+
{{event "incident"}}
74+
75+
{{fields "incident"}}

‎packages/symantec_edr_cloud/_dev/deploy/docker/docker-compose.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
version: '2.3'
2+
services:
3+
symantec_edr_cloud-incident:
4+
image: docker.elastic.co/observability/stream:v0.10.0
5+
hostname: symantec_edr_cloud-incident
6+
ports:
7+
- 8090
8+
volumes:
9+
- ./files:/files:ro
10+
environment:
11+
PORT: '8090'
12+
command:
13+
- http-server
14+
- --addr=:8090
15+
- --config=/files/config-incident.yml

‎packages/symantec_edr_cloud/_dev/deploy/docker/files/config-incident.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
rules:
2+
- path: /v1/oauth2/tokens
3+
methods: ['POST']
4+
responses:
5+
- status_code: 200
6+
headers:
7+
Content-Type:
8+
- 'application/json'
9+
body: |
10+
{"access_token":"xxxx","expires_in":3600,"token_type":"Bearer"}
11+
- path: /v1/incidents
12+
methods: ['POST']
13+
request_headers:
14+
Authorization:
15+
- 'Bearer xxxx'
16+
request_body: /.*"limit":1,"next":0,.*/
17+
responses:
18+
- status_code: 200
19+
headers:
20+
Content-Type:
21+
- application/json
22+
body: |-
23+
{"total":2,"next":1,"incidents":[{"customer_uid":"TEST-JvOsaJktSS-eyL-dXhxOvA","incident_uid":"8e7edfb1-27d2-4837-98ca-e7d794119c3b","type":"INCIDENT_CREATION","resolution_id":1,"conclusion":"Suspicious Activity","remediation":"Investigate further activity at the endpoint by downloading a full dump of the endpoint's recorded data. Give particular attention to activities performed by cmd.exe.","priority_id":4,"category_id":1,"modified":"2023-04-26T22:01:58.648+00:00","state_id":1,"id":4,"product_uid":"31B0C880-0229-49E8-94C5-48D56B1BD7B9","device_time":1682545570400,"ref_incident_uid":102110,"rule_name":"Advanced Attack Technique","created":"2023-04-26T21:46:10.400+00:00","type_id":8075,"incident_url":"https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details","message":"Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution","version":"1.0","product_name":"Symantec Integrated Cyber Defense Manager","event_id":8075004,"domain_uid":"TEST-ZBg_IqnyTAijNjP2BOOcuw","detection_type":"Advanced Analytics","severity_id":4,"time":1682545570400,"suspected_breach":"Yes"}]}
24+
- path: /v1/incidents
25+
methods: ['POST']
26+
request_headers:
27+
Authorization:
28+
- 'Bearer xxxx'
29+
request_body: /.*"limit":1,"next":1,.*/
30+
responses:
31+
- status_code: 200
32+
headers:
33+
Content-Type:
34+
- application/json
35+
body: |-
36+
{"total":2,"next":2,"incidents":[{"customer_uid":"TEST-JvOsaJktSS-eyL-dXhxOvA","incident_uid":"1e7edfb1-27d2-4837-98ca-e7d794119c3b","type":"INCIDENT_CREATION","resolution_id":1,"conclusion":"Suspicious Activity","remediation":"Investigate further activity at the endpoint by downloading a full dump of the endpoint's recorded data. Give particular attention to activities performed by cmd.exe.","priority_id":4,"category_id":1,"modified":"2023-04-26T22:01:58.648+00:00","state_id":1,"id":4,"product_uid":"31B0C880-0229-49E8-94C5-48D56B1BD7B9","device_time":1682545570400,"ref_incident_uid":102110,"rule_name":"Advanced Attack Technique","created":"2023-04-26T21:46:10.400+00:00","type_id":8075,"incident_url":"https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details","message":"Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution","version":"1.0","product_name":"Symantec Integrated Cyber Defense Manager","event_id":8075004,"domain_uid":"TEST-ZBg_IqnyTAijNjP2BOOcuw","detection_type":"Advanced Analytics","severity_id":4,"time":1682545570400,"suspected_breach":"Yes"}]}

‎packages/symantec_edr_cloud/changelog.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# newer versions go on top
2+
- version: "0.1.0"
3+
changes:
4+
- description: Initial release.
5+
type: enhancement
6+
link: https://github.com/elastic/integrations/pull/8267

‎packages/symantec_edr_cloud/data_stream/incident/_dev/test/pipeline/test-common-config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
fields:
2+
tags:
3+
- preserve_original_event
4+
- preserve_duplicate_custom_fields

‎packages/symantec_edr_cloud/data_stream/incident/_dev/test/pipeline/test-incident.log‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"customer_uid":"TEST-JvOsaJktSS-eyL-dXhxOvA","incident_uid":"8e7edfb1-27d2-4837-98ca-e7d794119c3b","type":"INCIDENT_CREATION","resolution_id":1,"conclusion":"Suspicious Activity","remediation":"Investigate further activity at the endpoint by downloading a full dump of the endpoint's recorded data. Give particular attention to activities performed by cmd.exe.","priority_id":4,"category_id":1,"modified":"2023-04-26T22:01:58.648+00:00","state_id":1,"id":4,"product_uid":"31B0C880-0229-49E8-94C5-48D56B1BD7B9","device_time":1682545570400,"ref_incident_uid":102110,"rule_name":"Advanced Attack Technique","created":"2023-04-26T21:46:10.400+00:00","type_id":8075,"incident_url":"https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details","message":"Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution","version":"1.0","product_name":"Symantec Integrated Cyber Defense Manager","event_id":8075004,"domain_uid":"TEST-ZBg_IqnyTAijNjP2BOOcuw","detection_type":"Advanced Analytics","severity_id":4,"time":1682545570400,"suspected_breach":"Yes"}

‎packages/symantec_edr_cloud/data_stream/incident/_dev/test/pipeline/test-incident.log-expected.json‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"expected": [
3+
{
4+
"@timestamp": "2023-04-26T21:46:10.400Z",
5+
"ecs": {
6+
"version": "8.10.0"
7+
},
8+
"event": {
9+
"category": [
10+
"malware"
11+
],
12+
"created": "2023-04-26T21:46:10.400Z",
13+
"id": "8e7edfb1-27d2-4837-98ca-e7d794119c3b",
14+
"kind": "alert",
15+
"original": "{\"customer_uid\":\"TEST-JvOsaJktSS-eyL-dXhxOvA\",\"incident_uid\":\"8e7edfb1-27d2-4837-98ca-e7d794119c3b\",\"type\":\"INCIDENT_CREATION\",\"resolution_id\":1,\"conclusion\":\"Suspicious Activity\",\"remediation\":\"Investigate further activity at the endpoint by downloading a full dump of the endpoint's recorded data. Give particular attention to activities performed by cmd.exe.\",\"priority_id\":4,\"category_id\":1,\"modified\":\"2023-04-26T22:01:58.648+00:00\",\"state_id\":1,\"id\":4,\"product_uid\":\"31B0C880-0229-49E8-94C5-48D56B1BD7B9\",\"device_time\":1682545570400,\"ref_incident_uid\":102110,\"rule_name\":\"Advanced Attack Technique\",\"created\":\"2023-04-26T21:46:10.400+00:00\",\"type_id\":8075,\"incident_url\":\"https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details\",\"message\":\"Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution\",\"version\":\"1.0\",\"product_name\":\"Symantec Integrated Cyber Defense Manager\",\"event_id\":8075004,\"domain_uid\":\"TEST-ZBg_IqnyTAijNjP2BOOcuw\",\"detection_type\":\"Advanced Analytics\",\"severity_id\":4,\"time\":1682545570400,\"suspected_breach\":\"Yes\"}",
16+
"provider": "Symantec Integrated Cyber Defense Manager",
17+
"reason": "Suspicious Activity",
18+
"severity": 4,
19+
"type": [
20+
"info"
21+
],
22+
"url": "https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details"
23+
},
24+
"http": {
25+
"version": "1.0"
26+
},
27+
"message": "Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution",
28+
"rule": {
29+
"name": "Advanced Attack Technique"
30+
},
31+
"symantec_edr_cloud": {
32+
"incident": {
33+
"category": "Security",
34+
"category_id": "1",
35+
"conclusion": "Suspicious Activity",
36+
"created": "2023-04-26T21:46:10.400Z",
37+
"customer_uid": "TEST-JvOsaJktSS-eyL-dXhxOvA",
38+
"detection_type": "Advanced Analytics",
39+
"device_time": "2023-04-26T21:46:10.400Z",
40+
"domain_uid": "TEST-ZBg_IqnyTAijNjP2BOOcuw",
41+
"event": "Incident Creation: Logged",
42+
"event_id": "8075004",
43+
"id": "4",
44+
"incident_uid": "8e7edfb1-27d2-4837-98ca-e7d794119c3b",
45+
"incident_url": "https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details",
46+
"message": "Victim-2:Signed Binary Proxy Execution, Deobfuscate/Decode Files or Information, Command and Scripting Interpreter: PowerShell, System Services: Service Execution",
47+
"modified": "2023-04-26T22:01:58.648Z",
48+
"outcome": "Logged",
49+
"priority": "Critical",
50+
"priority_id": "4",
51+
"product_name": "Symantec Integrated Cyber Defense Manager",
52+
"product_uid": "31B0C880-0229-49E8-94C5-48D56B1BD7B9",
53+
"ref_incident_uid": "102110",
54+
"remediation": "Investigate further activity at the endpoint by downloading a full dump of the endpoint's recorded data. Give particular attention to activities performed by cmd.exe.",
55+
"resolution": "Insufficient data",
56+
"resolution_id": "1",
57+
"rule_name": "Advanced Attack Technique",
58+
"severity": "Major",
59+
"severity_id": 4,
60+
"state": "New",
61+
"state_id": "1",
62+
"suspected_breach": true,
63+
"time": "2023-04-26T21:46:10.400Z",
64+
"type": "INCIDENT_CREATION",
65+
"type_id": "8075",
66+
"version": "1.0"
67+
}
68+
},
69+
"tags": [
70+
"preserve_original_event",
71+
"preserve_duplicate_custom_fields"
72+
],
73+
"url": {
74+
"domain": "sep.securitycloud.symantec.com",
75+
"original": "https://sep.securitycloud.symantec.com/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details",
76+
"path": "/v2/incidents/incidentListing/8e7edfb1-27d2-4837-98ca-e7d794119c3b/details",
77+
"scheme": "https"
78+
}
79+
}
80+
]
81+
}

‎packages/symantec_edr_cloud/data_stream/incident/_dev/test/system/test-default-config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
input: cel
2+
service: symantec_edr_cloud-incident
3+
vars:
4+
url: http://{{Hostname}}:{{Port}}
5+
client_id: xxxx
6+
client_secret: xxxx
7+
token_url: http://{{Hostname}}:{{Port}}/v1/oauth2/tokens
8+
data_stream:
9+
vars:
10+
preserve_original_event: true
11+
preserve_duplicate_custom_fields: true
12+
batch_size: 1
13+
assert:
14+
hit_count: 2

0 commit comments

Comments
 (0)