Integration Details

ThreatQuotient provides the following details for this integration:

Introduction

ThreatQ v6 Users – while the connector’s overall operation remains the same, installation and usage commands for ThreatQ v6 users will differ from what is listed in this guide. See the Installing Custom Connectors in ThreatQ v6 and Installing Custom Connectors on Another Instance topics for additional information.

he VMware Carbon Black Cloud Enterprise EDR for ThreatQ integration allows a user to export prioritized threat intelligence from ThreatQ into reports within VMware Carbon Black Cloud Enterprise EDR. VMware Carbon Black Cloud Enterprise EDR will match endpoint activity to the threat intelligence from ThreatQ and generate alerts.

VMware Carbon Black Cloud Enterprise EDR supports the following indicator types:

• IPAddress
• MD5
• SHA-256
• FQDN

The connector name and driver have changed as of version 1.2.0. In order to maintain backwards compatibility, you can use the old connector name in commands for running the connector along with the new name. All the commands used in this doc, excluding the installation steps, reference the new name tq-conn-cb-enterprise-edr but can be used interchangeably with the old name tq-conn-cb-threat-hunter.

You must use the tq-conn-cb-threat-hunter name when performing pip install commands. 

Prerequisites

Review the following requirements before attempting to install the connector.  

VMware Carbon Black Cloud Enterprise EDR RBAC Permissions

Time Zone

The time zone steps are for ThreatQ v5 only.  ThreatQ v6 users should skip these steps.  

You should ensure all ThreatQ devices are set to the correct time, time zone, and date (UTC is recommended), and using a clock source available to all.

To identify which time zone is closest to your present location, use the timedatectl command with the list-timezones command line option.

For example, enter the following command to list all available time zones in Europe:

Enter the following command, as root, to change the time zone to UTC:

Integration Dependencies

The integration must be installed in a python 3.6 environment.

The following is a list of required dependencies for the integration.  These dependencies are downloaded and installed during the installation process.  If you are an Air Gapped Data Sync (AGDS) user, or run an instance that cannot connect to network services outside of your infrastructure, you will need to download and install these dependencies separately as the integration will not be able to download them during the install process.

Items listed in bold are pinned to a specific version.  In these cases, you should download the version specified to ensure proper function of the integration.

Installation

The following provides you with steps on installing a Python 3 Virtual Environment and installing the connector.

Creating a Python 3.6 Virtual Environment  

Run the following commands to create the virtual environment:

Proceed to Installing the Connector.

Installing the Connector

Upgrading Users - Review the Change Log for updates to configuration parameters before updating.  If there are changes to the configuration file (new/removed parameters), you must first delete the previous version's configuration file before proceeding with the install steps listed below.  Failure to delete the previous configuration file will result in the connector failing.

The connector name and driver have changed as of version 1.2.0. In order to maintain backwards compatibility, you can use the old connector name in commands for running the connector along with the new name. All the commands used in this doc reference the new name tq-conn-cb-enterprise-edr but can be used interchangeably with the old name tq-conn-cb-threat-hunter with the only exception being the install commands.

You must use the tq-conn-cb-threat-hunter name when performing a pip install/upgrade.  

1. Navigate to the ThreatQ Marketplace and download the .whl file for the integration.
2. Activate the virtual environment if you haven't already:
   source /opt/tqvenv/<environment_name>/bin/activate
3. Transfer the whl file to the /tmp directory on your ThreatQ instance.  
4. Install the connector on your ThreatQ instance:
   pip install /tmp/tq_conn_cb_threat_hunter-<version>-py3-none-any.whl 

   A driver called tq-conn-cb-threat-hunter will be installed.   After installing, a script stub will appear in /opt/tqvenv/<environment_name>/bin/tq-conn-cb-threat-hunter.

5. Once the application has been installed, a directory structure must be created for all configuration, logs and files, using the mkdir -p command. Use the commands below to create the required directories:
   mkdir -p /etc/tq_labs/
   mkdir -p /var/log/tq_labs/
6. Perform an initial run using the following command:
   /opt/tqvenv/<environment_name>/bin/tq-conn-cb-threat-hunter -ll /var/log/tq_labs/ -c /etc/tq_labs/ -v3
7. Enter the following parameters when prompted:

   Parameter	Description
   ThreatQ Host	This is the host of the ThreatQ instance, either the IP Address or Hostname as resolvable by ThreatQ.
   ThreatQ Client ID	This is the OAuth id that can be found at Settings Gear → User Management → API details within the user’s details.
   ThreatQ Username	This is the Email Address of the user in the ThreatQ System for integrations.
   ThreatQ Password	The password for the above ThreatQ account.
   Status	This is the default status for objects that are created by this Integration.

   Example Output

   /opt/tqvenv/<environment_name>/bin/tq-conn-cb-threat-hunter -ll /var/log/tq_labs/ -c /etc/tq_labs/ -v3
   ThreatQ Host: <ThreatQ Host IP or Hostname> 
   ThreatQ Client ID: <ClientID> 
   ThreatQ Username: <EMAIL ADDRESS> 
   ThreatQ Password: <PASSWORD>
   Status: Review 
   Connector configured. Set information in UI

You will still need to configure and then enable the connector.

Configuration

ThreatQuotient does not issue API keys for third-party vendors. Contact the specific vendor to obtain API keys and other integration-related credentials.

To configure the integration:

1. Navigate to your integrations management page in ThreatQ.
2. Select the Labs option from the Category dropdown (optional).
3. Click on the integration entry to open its details page.
4. Enter the following parameters under the Configuration tab:

   Parameter	Description
   Enterprise EDR API FQDN	The FQDN to access Enterprise EDR's API. The default is defense.conferdeploy.net
   Enterprise EDR API Secret Key	Your Enterprise EDR API Secret Key for authentication.
   Enterprise EDR API ID	Your Enterprise EDR API ID for authentication.
   Enterprise EDR Organization Key	Your Enterprise EDR Organization Key for authentication.
   Data Collection Names (Threat Library)	A comma-separated list of Threat Library collection names you want to export.
   Report Tags	A comma-separated list of tags to add to the reports. The tags will be added to each report.
   ThreatQ Hostname or IP Address	This is the hostname or IP address of your ThreatQ instance in order to link back to it.  This is typically the domain/IP that can be viewed in your browser's URL bar.

5. Review any additional settings, make any changes if needed, and click on Save.
6. Click on the toggle switch, located above the Additional Information section, to enable it.

Usage

The connector name and driver have changed as of version 1.2.0. In order to maintain backwards compatibility, you can use the old connector name in commands for installing/running the connector along with the new name. All the commands used in this doc reference the old name tq-conn-cb-threat-hunter but can be used interchangeably with the new name tq-conn-cb-enterprise-edr

Use the following command to execute the driver:

Command Line Arguments

This connector supports the following custom command line arguments:

CRON

Automatic CRON configuration has been removed from this script. To run this script on a recurring basis, use CRON or some other jobs scheduler. The argument in the CRON script must specify the config and log locations.

Add an entry to your Linux crontab to execute the connector at a recurring interval. Depending on how quickly you need updates, this can be run multiple times a day (no more than once an hour) or a few times a week.

In the example below, the command will execute the connector every two hours.

1. Log into your ThreatQ host via a CLI terminal session.
2. Enter the following command:
   crontab -e

   This will enable the editing of the crontab, using vi. Depending on how often you wish the cronjob to run, you will need to adjust the time to suit the environment.

3. Enter the commands below:

   Every 2 Hours Example

   0 */2 * * * /opt/tqvenv/<environment_name>/bin/tq-conn-cb-threat-hunter -c /etc/tq_labs/ -ll /var/log/tq_labs/ -v3  
4. Save and exit CRON.

Change Log

• Version 1.2.1
  • Updated the user field validation.
• Version 1.2.0
  • Rebranded connector name from Carbon Black Threat Hunter to VMware Carbon Black Cloud Enterprise EDR.  The connector name and driver have changed as of version 1.2.0. In order to maintain backwards compatibility, you can use the old connector name in commands for installing/running it along with the new one. All the commands used in this doc reference the new name tq-conn-cb-enterprise-edr but can be used interchangeably with the old name tq-conn-cb-threat-hunter.
  • Added submission support for SHA-256 indicator types.
  • Added a new Prerequisites chapter for permissions and timezone requirements.  
• Version 1.1.0
  • Added Python 3 support.
• Version 1.0.0
  • Initial Release