Darktrace Integration with Security Validation

This integration provides the following benefits:

• Validate that security tools are writing log events to Darktrace to ensure compliance with security policies and regulations
• Collect events generated by security tools that write to Darktrace to test the efficacy and configuration of security controls 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

To configure an integration, this document walks you through the following high-level steps:

1. Configure the third-party technology
2. Configure Security Validation
3. Verify connectivity

API calls

Supported versions

Darktrace Threat Visualizer v6.1

Preparation

To configure this integration, you need:

• The hostname or IP address of your Darktrace instance
• API Secret (Private Token)
• API Key (Public Token)

Acquire an API token pair

1. Log into Darktrace Threat Visualizer with an account that has permission to access and modify the System Config page
2. Navigate to the System Config page, then select "Settings" from the left-hand menu
3. Locate the "API Token" subsection and click "New"
4. Make a note of the Public and Private Token, as the Private Token will not be displayed again.

Configure Security Validation

1. Go to Settings > Integrations.
2. From the Integrations table, click Add Integration > Darktrace.
   You can add this as either a Direct or Remote Integration.
3. Enter a meaningful Integration Name.
4. 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.
5. Enter the Host value for the Darktrace instance as a hostname or IP address.
6. Enter a Port value. The default is 443.
7. Optional: Change the HttpProtocols value to determine what protocol is used for requests (Http or Https).
8. Enter the Api Key and Api Secret.
9. Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
10. Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
11. Optional: Check Use Advanced Search Endpoint if you want to use this endpoint for queries. Customer-defined queries run only when this setting is enabled.
    The macros for this option are %IPS% and %HOSTNAMES%, resulting in the following queries:

    DEFAULT_QUERIES = [
        {
            "name": "IP Query",
            "query": f"@fields.src_ip:({IPS}) OR @fields.dest_ip:({IPS})",
        },
        {
            "name": "Hostname Query",
            "query": f"@fields.host:({HOSTNAMES})",
        },
    ]

12. 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.

13. Optional: Expand Advanced options and update the information as necessary.

    1. 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.
    2. Update Query Interval (seconds).
    3. Configure correlation queries:
       1. Select Correlation Query Enabled and fill in the Correlation Query.
       2. Modify the Correlation Query Interval, if necessary (minutes).
    4. 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.
    5. Select Save Suspicious Events.
    6. Modify the Event Time Adjustment (seconds). The default is 0.

    7. 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.

14. Click Save.

Verify connectivity

1. Go to Settings > Integrations.
2. 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

Update integration

Identify or create an API key for use with the Validation Platform. This is done by signing into Darktrace and going to Admin > Config > API Token Generate.

API calls

The following API calls are used by the Validation Platform.

Update the Validation platform

Prerequisites

Information to gather before you start:

• Hostname
• Port
• API Key
• API Secret

Configuration

To add the integration

1. Go to Settings > Integrations.

2. Click Add Integration > Darktrace.
   

   Darktrace Integration

3. Enter the Host and Port.
4. Select the Protocol.
5. Enter the API Token and API Secret.

6. Expand Advanced options.

   

   Advanced section of Darktrace Integration

7. (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.

8. (Optional) Clear Discover network devices automatically.

9. Modify the Query Interval and Event Time Adjustment, if necessary.

10. (Optional) Assign a Name.

11. (Optional) Choose Yes to save suspicious events.

12. Click Submit.

Set up Proxy Assignment

If all outbound connections go through a proxy, you may want to set up a proxy definition and assignment for your integration. For information on setting up your proxy rules, see Proxy Rules.

Verify connectivity

To verify connectivity to integration

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.

If you see the following error, either the API Key or the API Secret is incorrect or there is a time mismatch:

Api signature Error

Requests to API are signed with a timestamp. If the requesting machine (Director or Remote Actor) is out of time sync more than a few minutes, the requests will fail.