Carbon Black Predictive Security Cloud (PSC) Integration with Security Validation

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

• AppServices API v6
• Investigate API v2

Before You Begin

To configure this integration, you need:

• Org Key: This is found in your Carbon Black product console from Settings > API Access > API Keys.
• API Key
• API ID

Create an API Key and API ID

1. Log in to your Carbon Black product console
2. Navigate to the Settings | API Access | API Keys tab
3. Click Add API Key from the far right of the screen
4. Give the API Key a unique name, and select the /appservices/and /investigate/ access levels
5. Click Save, the API Secret Key and API ID values are displayed.
6. Copy and paste these values to a safe location.

Configure Security Validation

1. Go to Settings > Integrations.

2. From the Integrations table, click Add Integration > Carbon Black PSC.
   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. Optional: Change the Protocol value to determine what protocol is used for requests (Https or Http).
6. Enter the Host value (hostname or IP address) for the Carbon Black PSC instance. The default is defense.conferdeploy.net.
7. Enter a Port value. The default is 443.
8. Enter the Org Key value that you generated.
9. Enter the Api Id and Api Key values 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. Add or remove value for Queries. A default Hostname Query is provided.
13. Optional: Select any of the following checkboxes, as needed. See the Carbon Black PSC documentation for more information.
    • Enable Threat Cause
    • Enable Device Data
    • Enable Enriched Events
14. Optional: Modify the Page Size to change the request for the upstream server. The default is 1000.
    
15. Optional: Modify the FieldMapModel 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.

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

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

Since the API used is the same, the Carbon Black Cloud integration enables the Validation Platform Director to pull events from many of Carbon Black's products, including:

• Carbon Black Cloud
• Carbon Black Defense
• Carbon Black Threat Hunter

Update Carbon Black Cloud

Identify or create credentials to access Carbon Black Cloud with read access, at minimum.

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.

To identify the API and Organization keys

1. Sign into Carbon Black using the appropriate credentials.
2. Navigate in the Carbon Black Cloud console to Settings > API Access.
3. Select Access Levels and click + Add Access Level.
   

   Carbon Black API Access

4. Fill in the details for the Access Level and select the Alerts - General Information - org.alerts - READ permission and click Save.
   

   Carbon Black Add Access Level

5. Click API Keys at the top of the window and click + Add API Key.
6. Name the key and select Custom in the Access Level type drop-down list; then, select the Access Level you created in step Select Access Levels and click + Add Access Level.Carbon Black API Access.
   

   Carbon Black Add API Key

7. Click Save and copy/paste your credentials into the integration.

The Org Key displays in the upper-left of the window.

API Calls

The following API calls are used by the Validation Platform.

Update the Validation Platform

Prerequisites

Information to gather before you start:

• Port info
• Host info
  Look at the web address of your Carbon Black Cloud console to identify the Host. For more information, see the Carbon Black documentation.
• Organization Key
• API ID and API Secret Key

Configuration

To add Carbon Black Cloud

1. Go to Settings > Integrations.

2. Click Add Integration > Carbon Black Cloud.
3. (Optional) Replace the default Host value with the host from your Carbon Black Cloud console.
4. Enter the Port.
5. Enter the Organization Key.
6. Enter the API ID and API Secret Key.
7. Review and update the Query.

8. Expand Advanced options.

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

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

11. (Optional) Assign a Name.

12. (Optional) Select Discover network devices automatically.

13. Click Submit.

Carbon Black Cloud 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 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.