Carbon Black Response Integration with Security Validation

This integration collects events generated by Carbon Black Response 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

API Calls

Supported Versions

• Carbon Black Response API v7

Before You Begin

To configure this integration, you need:

• The hostname of your Carbon Black Response instance
• API Token

Get a Carbon Black API Token

Each Carbon Black user has a personal API key. That API key provides all rights and capabilities assigned to that user to anyone possessing the API key.

To find an API key corresponding with a particular Carbon Black user account,

1. Log into the Carbon Black console as that user.
2. Click the username in the upper right of the screen and then click Profile info.
3. Click the API Token button on the left hand side of the screen to reveal the API token for the logged-in user.
4. If there is no API token displayed, click the Reset button to create a new one.

Configure Security Validation

1. Go to Settings > Integrations.

2. From the Integrations table, click Add Integration > Carbon Black Response.
   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. Change the HttpProtocols to use for requests. (Https or Http.)
6. For the Host, enter the hostname of your Carbon Black Response instance.
7. Enter a Port value. The default is 443.
8. Choose the API version (V1 or V2) for CarbonBlackResponseApiVersion.
9. Enter the Api Token that you generated.
10. Optional: Check Verify Ssl if you want this verification done for requests to an upstream server.
11. Optional: Change the Timeout value if you want a different frequency of requests to an upstream server. The default is 30 (seconds).
12. Optional: Add or remove Queries, as needed. A default Hostname Query is provided.
13. Optional: Modify the Page Size to change the request for the upstream server. The default is 500.
14. 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.

15. 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. If supported by your integration, 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.

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

Generate an API key for CB Response

The CB Response integration supports V1 and V2 of the Carbon Black API.

API tokens are tied to user accounts and inherit the user's privileges. When capturing the API key, use an account with the necessary privileges.

Read permissions are required, at minimum.

To generate an API key

1. Access your profile by logging into the Carbon Black server, clicking your name, and choosing Profile.

2. Click the API Token link and copy your API token from the text box.

   Each user receives their own unique API token. This token has the same privileges that are assigned to your name. The token does not expire.

Update the Validation Platform

Prerequisites

Information to gather before you start:

• API key for CB Response.
• IP address or FQDN used to access CB Response.

Configuration

To add the Carbon Black CB Response integration

1. Go to Settings > Integrations.

2. Click Add Integration > Carbon Black CB Response.
3. Enter the Host and API Key information.
4. Select the API Version.

5. Expand Advanced options and update the information if necessary.

6. Click Submit.

Carbon Black CB Response Integration

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 the CB Response host

Click Test to verify that:

• The Director can communicate with the CB Response IP address on the port specified.
• The API key is working and has the necessary privileges.