VMware Carbon Black Cloud Documentation

Overview

About VMware Carbon Black Cloud

VMware Carbon Black Cloud allows a Carbon Black Cloud administrator or analyst to interact with the CBC product.

Support and resources

Questions and answers

Access questions and answers specific to VMware Carbon Black Cloud at https://answers.splunk.com . Be sure to tag your question with the name of the app: Carbon Black Cloud Splunk App.

Support

• Support Offered: Splunk Answers, Community Engagement, Carbon Black Support

• View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.

• Use the Developer Community Forum to discuss issues and get answers from other API developers in the Carbon Black Community.

• Report bugs and change requests to Carbon Black Support.

Diagnostics Generation

If a support representative asks for it, a support diagnostic file can be generated. Use the following command to generate the file. Send the resulting file to support.

$SPLUNK_HOME/bin/splunk diag --collect=app:vmware_app_for_splunk

Installation and Configuration

Software requirements

Splunk Enterprise system requirements

Because this App runs on Splunk Enterprise, all of the Splunk Enterprise system requirements apply.

The Splunk CIM Add-on is a required pre-requisite.

Deployment Guide

Note: Installing the VMware CBC TA or IA on the same node as the App may result in instability or errors.

• • Splunk 7.X

    • Consult documentation for Endpoint Standard VMware Carbon Black Cloud App and Enterprise EDR VMware Carbon Black Cloud App

• • Single Instance (8.X)

    • (Pre-requisite) Splunk CIM Add-on

    • Only the VMware Carbon Black Cloud App (vmware_app_for_splunk)

• • Single Instance + Heavy Forwarder (8.X)

    • • Single Instance:

        • (Pre-requisite) Splunk CIM Add-on

        • VMware Carbon Black Cloud App (vmware_app_for_splunk)

    • Heavy Forwarder: IA-vmware_app_for_splunk (IA-vmware_app_for_splunk)

• • Distributed deployment (8.x)

    • Heavy Forwarder: IA-vmware_app_for_splunk (IA-vmware_app_for_splunk)

    • • Search Head:

        • (Pre-requisite) Splunk CIM Add-on

        • VMware Carbon Black Cloud App (vmware_app_for_splunk)

    • Indexer: TA-vmware_app_for_splunk (TA-vmware_app_for_splunk)

• • Splunk Cloud

    • Contact Splunk Cloud Support handle this installation.

Data Onboarding

The VMware Carbon Black Cloud App offers two methods to ingest various data. More detailed configuration instructions are included in Table 1 below.

• Event Forwarder

  • Configure the VMware Carbon Black Cloud Event Forwarder to stream data into an AWS S3 bucket

  • Use the AWS Add-on for Splunk to pull the data from AWS S3 into Splunk

• Built-In Input

  • Use the VMware Carbon Black Cloud App (or Input Add-on via a Heavy Forwarder), which leverages VMware Carbon Black REST APIs to pull data into Splunk

Configuration

1. Deploy the Apps and/or Add-ons per the Deployment Guide above.

2. Create the index(s) for your data

   1. One index for the Carbon Black Cloud data

   2. One index for the results of the Alert Actions

3. Navigate to the Administration > Application Configuration menu, VMware CBC Base Configuration tab.

   1. Update the index names to those created above

4. Configure a proxy if needed from the Proxies tab

5. If you are using the Event Forwarder to ingest Alerts and Events, configure the forwarder and AWS add-on for S3, setting the index to the event type for data ingest specified in step 3. Details on this are in a later section Configuring Event Forwarder & S3 Inputs.

6. If you are using the built-in inputs, alert actions, or commands you will need to configure API token information for each organization and access level. View the Authorization section below for details.

7. If using the Alerts API instead of the Event Forwarder, use the Alerts Inputs tab to configure the types of Alerts to ingest. Select the API Token configured in the previous step and with the permissions specified in Table 1 below

   1. You can use the Enrich CB Analytics Events Alert Action to automatically fetch Enriched Events following a CB Analytics Alert. Enriched Events provide valuable alert context such as the process _cmdline.

   2. First, configure the Enrich CB Analytics Events Alert Action from the Alert Actions tab.

   3. Then open the Splunk > Alerts menu, find the included CB Analytics - Ingest Enriched Events Splunk Alert, and add the VMwareCBC Enrich CB Analytic Events Alert Action.

8. To ingest Audit Logs, select an API Token configured at step 6 on Audit Log Inputs tab

9. To ingest Live Query results, select an API Token configured at step 6 on Live Query Inputs

10. To ingest vulnerability assessment information, select an API Token configured at step 6 on the Vulnerabilities Inputs tab

11. Add API tokens in the Alert Actions & Custom Commands tabs

    1. A description of each can be found in Tables 2 and 3

    2. Note: The Alert Actions tab defaults to showing 10 rows. Change to 20 rows to see all alert actions at once.

12. The Administration > Application Health Overview menu shows errors during processing and can be very useful during troubleshooting

13. The Administration > Application Usage menu provides insights into which Splunk users are using the app

Authorization

For built-in data inputs, alert actions, and commands, create API Keys with the correct permissions in the Carbon Black Cloud and then configure Splunk to use those keys.

1. Identify the built-in data inputs, alert actions, and commands you intend to use.

2. Reference Tables 1, 2, and 3 below to identify the required API Key Access Levels and RBAC Permissions.

3. Generate API Keys in the Carbon Black Cloud console under Settings > API Access. Refer to the VMware Carbon Black Cloud Authentication Guide for additional guidance.

   1. Access Level: If you are using any functions that require an Access Level Type Custom, create a Custom Access Level with the with the permissions required for the Inputs and Actions you want to use. The tables below list the necessary permissions that must be included in your Custom Access Level for each Action.

   2. API Keys: You may need multiple API Keys depending on the Actions you want to use because a different API key is required for each Access Level Type used (Custom, API, Live Response).

      1. For Custom Access Levels create one API key with Access Level set to Custom, then select the Access Level you created

      2. If needed, create one API key with the Access Level set to Live Response

      3. If needed, create one API key with the Access Level set to API

4. On the Splunk API Token Configuration tab, enter the API information and give the record a meaningful API Name. Youll use this to configure Alert Inputs and Actions.

Table 1: Access Level Permissions for Data Inputs

Table 2: Access Level Permissions for Adaptive Responses

Table 3: Access Level Permissions for Commands