This integration collects events generated by Symantec Endpoint Protection to test the efficacy and configuration of the security control using Security Validation jobs.
Use this document to configure the integration using one of the following methods:
- MSI (Supported and recommended for new integration configurations)
- Legacy (Supported for existing integration configurations)
Configure MSI Integration
This document covers the the MSI method of creating an integration. This method is the recommended approach for configuring new integrations in Security Validation.
API Calls
| API | Usage |
|---|---|
/Reporting/login/Login_verify.php |
Authenticate against the Symantec EP Reporting API |
/Reporting/reports/action_summary_infected.php |
Retrieve reports from the Symantec EP Reporting API |
Supported Versions
14.3
Before You Begin
To configure this integration, you need:
- A valid username and password for a user with permissions to use the API endpoints described in the previous step
- The hostname or IP address of your Symantec EP instance
Configure Security Validation
-
Go to Settings > Integrations.
- From the Integrations table, click Add Integration > Symantec Endpoint Protection.
You can add this as either a Direct or Remote Integration.
- Enter a meaningful Integration Name.
- Optional: From the Proxy drop-down, choose a proxy profile if one is available. If one isn't available and all outbound connections go through a proxy, first, set up a Proxy Rule.
- Change the HttpProtocols to use for requests. (Https or Http.)
- For the Host, enter the hostname of your Symantec Endpoint Protection instance.
- Enter a Port value. The default is 8445.
- Enter the Username and Password for the account with permissions to use the API endpoints.
- Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
- Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
- Optional: Modify the Report Types entries, if needed. Default values are provided.
- Optional: Modify the Field Map values, as necessary.
- Each field map box can hold a JSON-formatted comma-separated list of columns returned by the API to be considered for each field when translating into the normalized event object format. Example: description could be configured to be 'msg_s' or 'SyslogMessage' in some environments. The field map tries both if set to: ['msg_s','SyslogMessage'] and whichever matches first is the column that is used.
- When configuring an integration in Security Validation, you can assign additional host values in the Field Map settings. If none of the assigned fields return a valid host name, Network Actions may miss matched events from the third-party technology. Additional hosts values helps ensure the likelihood of a match between the two environments.
-
Optional: Expand Advanced options and update the information as necessary.
- Update Query Time and Delay Time.The Query time is the amount of time (minutes) before and after the query runs that the platform looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the first query after a Job Action starts. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, this configuration impacts the pass/fail results for AEDA monitors.
- Update Query Interval (seconds).
- If supported by your integration, configure correlation queries:
- Select Correlation Query Enabled and fill in the Correlation Query.
- Modify the Correlation Query Interval, if necessary (minutes).
- Select
Discover network devices automatically, the default and recommended option.If unselected, reported events won't include product information for any matching network security technology.
- Select Save Suspicious Events.
- Modify the Event Time Adjustment (seconds). The default is 0.
Modify the Limit value if you need to prevent a flood of results. This value is set to 10000 by default. This limit applies to both events and alerts individually, so if you set it to 10, you can still see a maximum of 10 events and 10 alerts.
- Update Query Time and Delay Time.
-
Click Save.
Verify connectivity
- Go to Settings > Integrations.
- From the Direct Integrations table, click
> Test to verify that:
- The Director can communicate with the integration host on the port and protocol specified.
- The integration credentials are valid and working.
For more information on setting up queries, see Manage Integrations.
Configure Legacy Integration
This document applies to Classic/Legacy Integrations. You may continue to use these integration configurations. While no active development is happening for these integrations, we continue to provide Classic/Legacy Integrations in the product. You do not have to move to MSI Integrations. If your support engineer or TSC recommends or you choose to move to MSI Integrations, you can take advantage of the latest features and functionality. For more information, see the MSI Integration documentation in the Integrations Overview.
Update Symantec EP
To update Symantec EP
- Log in to the Symantec Endpoint Protection Manager.
-
Create an admin user.
-
Click Admin in the left-hand pane and select Add an administrator.
-
-
In the General tab, enter a User name, Full name, and Email address.
-
In the Access Permissions tab, select System Administrator.
-
On the Authentication tab, choose Symantec Endpoint Protection Manager Authentication and set a password. You may want to increase the password expiration time for this account (depending on your policy requirements for integration/service accounts).
- Click Save to create the account.
<Username>:<Active_Directory_Domain_In_Upper_Case>
or<Role>\<Username>:<Active_Directory_Domain_In_Upper_Case>- Examples:
svc-verodin:ACME.COM OR api-user\svc-verodin:ACME.COM - Reference: https://www.symantec.com/connect/forums/ad-user-authentication-dlp-reporting-and-updating-api#comment-8394101
Syncronize Systems
Time plays an important part in event matching when tests are run. After you update SEP, verify the following systems are all using the same time: the endpoint, the Validation Platform Director, the Windows system running SEP Manager (SEPM), and real time.
Update the Validation Platform
Prerequisites
Information to gather before you start:
- Identify the IP address or hostname used to access Symantec Endpoint Protection.
- Identify the port for Symantec Endpoint Protection communications (typically 8445).
- Identify or create credentials to access Symantec Endpoint Protection.
Configuration
To add the Symantec EP integration
-
Go to Settings > Integrations.
- Click Add Integration > Symantec EP.
-
Enter information for the Host, Port, Username, and Password.
-
Expand Advanced options.
-
(Optional) Update Query time and Delay time.
The Query time is the amount of time (minutes) before and after the query runs that the looks for events, while the Delay time is the amount of time (minutes) that the platform waits to run the query after a Job Action. For example, you configure your integration with the following values: Query time = 5, Query interval = 30 seconds, and Delay time = 0. When a Job Actions starts at 12:00:00, the first time the query runs, the platform looks for events from 11:55:00 to 12:00:00. Then 30 seconds later, it looks for events from 11:55:30 to 12:00:30. This interval continues, with the last query looking from 12:00:00 to 12:05:00. If you instead configured the Delay time to equal 10, it would run the same query, but it wouldn't start that query until 12:10:00.If your monitors are set to run more frequently than the query time, it will impact the pass/fail results for AEDA monitors. - Verify that the correct Version is selected. Authentication may fail if the incorrect version is selected.
- Select the Timestamp Format.
- Modify the Query Interval, if necessary.
-
Modify the Event Time Adjustment.
The timestamp retrieved from SEPM is not the time the event occurred on the host but is the time that SEPM received the event from the Symantec agent running on the host. The time difference varies from environment to environment, so you need to adjust the Event Time Adjustment field to account for the change in your environment. We have seen -12 work in many environments, but there is not a one-size-fits all value for it. -
(Optional) Assign a Name.
-
(Optional) Choose Yes to save suspicious events.
-
Click Submit.
Verify connectivity
To verify connectivity to Symantec EP
Click Test to verify that:
- The Director can communicate with Symantec EP using the port specified.
- User credentials are working.