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.

License

MIT

Copyright 2021, Aplura, LLC.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Scripts and binaries

For more information on these scripts, and what they do, please refer to the Initial Application Configuration section of this document.

This app includes the following scripts:

Release notes

Version 1.1.1 of VMware Carbon Black Cloud has the following known issues:

• Splunk App Alert Input returns 500 error

Version 1.1.1

• Known Issues:

  • Splunk App Alert Input returns 500 error

• Improvements

  • Updated CBC SDK to v1.2.3: Release Notes

  • Added a warning when more than one VMware CBC App is installed on the node. If you see this message, reference the Deployment Guide below and delete extra copies of VMware CBC apps/add-ons

  • Added an app configuration demo video

  • Added a Splunk FAQ to Developer Network

• Fixes

  • Fixed Proxy issue

  • Fixed error with Checkboxes on Proxy Configuration Tab

  • Updated logging modules to respect log.cfg settings

Version 1.1.0

• New Features

  • Data Input - Audit Logs

  • Data Input - Live Query Results

  • Data Input - Vulnerability Assessment

  • Dashboard - Devices

  • Dashboard - Processes

  • Dashboard - Vulnerabilities

  • Alert Action - Run Live Query

  • Alert Action - Dismiss Alert

  • Alert Action - Update Device Policy

  • Alert Action - Process GUID Details

  • Alert Action - Ban Hash

  • Alert Action - Enrich CB Analytic Events

  • Command - CBC Device Info

  • Command - CBC Hash Info

• Improvements

  • Events Dashboard performance improvements

  • Update Top 10 CB Analytics panel

  • Stability improvements in Alerts Inputs

Version 1.0.0

• Initial Release

About this release

Version 1.1.1 of VMware Carbon Black Cloud is compatible with:

Use Cases

This app realizes many key SOC use cases, from conventional SIEM to XDR:

• Use Splunk as a single pane of glass for your Carbon Black Cloud alerts

  • Triage and investigate from Splunk, or pivot back to the Carbon Black Cloud console

• Automate workflows with built-in SOAR capabilities

  • Enrich alerts with event or process context

  • Kick off Live Response and Live Query actions to gather information directly from endpoints

  • Remediate critical issues by killing a process or banning hashes from future execution

• Bring full EDR visibility to Splunk

  • Endpoint Events enable your SOC to perform threat hunting, conduct forensic investigations, and build custom analytics

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.

Download

Download VMware Carbon Black Cloud at https://splunkbase.splunk.com/app/5332.

Deployment Guide

Note: Installing the VMware CBC TA or IA on the same node as the App is an unsupported configuration that may result in instability or errors. If you are seeing the error message More than 1 VMware CBC App detected, refer to the recommendations below for which Apps/Add-ons should be installed on which node and fully delete (not just disable) extra copies of VMware CBC apps/add-ons from nodes where they are not needed. Then restart Splunk on that node.

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

Configuration

Watch the app configuration demo video before you begin your deployment and 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

End-to-End Configuration Video

Watch the app configuration demo video before you begin your deployment and configuration.