Connect the Carbon Black Cloud data
source to the platform to enable your applications and dashboards to collect and analyze Carbon Black Cloud security data. Universal Data Insights connectors enable federated search across
your security products.
Before you begin
Collaborate with a Carbon Black
administrator to obtain the hostname or IP address and organization key for the Carbon Black Cloud console. An API Token must be created
in the Carbon Black Cloud console. To create the
API token:
- Log in to the Carbon Black Cloud
console.
- Go to .
- Copy the ORG KEY value. You use this value in step 9.
- Click the Access Levels tab.
- Create an API access level entry with the following permissions:
org.search.events: create,
read, update, delete
- Click the API Keys tab and create a new API key based on the created
access level.
- Copy the API Secret Key and API ID. The API token that you use in step 9 is the API Secret Key
and API ID separated by a
/
, like this:
<API_secret_key>/<API_ID>
If you have a firewall between your cluster and the data source target, use the
IBM® Security Edge Gateway to host the containers. The Edge Gateway must be V1.6 or later. For more information,
see Setting up Edge
Gateway.
About this task
The CB Cloud connector is designed to work
with the V2 search API api/investigate/v2/orgs/{org_key}/processes/search_jobs
endpoint.
Structured Threat Information eXpression (STIX) is a language and
serialization format that organizations use to exchange cyberthreat intelligence. The Carbon Black Cloud connector uses STIX patterning to query Carbon Black Cloud data and returns results as STIX objects. For more information about how the Carbon Black Cloud data schema maps to STIX, see Carbon Black Cloud
STIX Mapping
(https://github.com/opencybersecurityalliance/stix-shifter/blob/develop/adapter-guide/connectors/cbcloud_supported_stix.md).
Procedure
- Go to
.
- On the Data Sources tab, click
Connect a data source.
- Click Carbon Black Cloud, then click
Next.
- Configure the connection to the data source.
- In the Data source name field, assign a
name to uniquely identify the data source connection.
You can create multiple connection
instances to a data source so it would be good to clearly set them apart by name. Only alphanumeric
characters and the following special characters are allowed: - .
_
- In the Data source description field,
write a description to indicate the purpose of the data source connection.
You can create
multiple connection instances to a data source, so it is useful to clearly indicate the purpose of
each connection by description. Only alphanumeric characters and the following special characters
are allowed: - . _
- If you have a firewall between your cluster and the data source target,
use the Edge Gateway to host the containers. In
the Edge gateway (optional) field, specify which Edge Gateway to use.
Select an Edge Gateway to host the connector. It can take up to five
minutes for the status of newly deployed data source connections on the Edge Gateway to show as being connected.
- In the Management IP address or Hostname field, set the
hostname or IP address of the data source so that the platform can communicate with it.
- In the Host port field, set the port number that is associated
with the data source host. The port is 443 by default.
-
Set the query parameters to control the behavior of the search query on the data source.
- In the Concurrent search limit field, set the
number of simultaneous connections that can be
made to the
data source. The default limit for the number of connections is 4. The value must not be less than 1
and must not be greater than 100.
- In the Query search timeout limit field,
set the time limit in minutes for how long the query is run on the data source. The default time
limit is 30. When the value is set to zero, there is no timeout. The value must not be less than 1
and must not be greater than 120.
- In the Result size limit field, set the maximum
number of entries or objects that are returned by search query. The default result size limit is
10,000. The value must not be less than 1 and must not be greater than 500,000.
- In the Query time range field, set the time
range in minutes for the search, represented as the last X minutes. The default
is 5 minutes. The value must not be less than 1 and must not be greater than 10,000.
Important: If
you increase the concurrent search limit and the result size limit, a greater amount of data can be
sent to the data source, which increases the strain on the data source. Increasing the query time
range also increases the amount of data.
- Optional: If you need to customize the STIX attributes mapping, click
Customize attribute mapping and edit the JSON blob to map new or existing
properties to their associated target data source fields.
- Configure identity and access.
- Click Add a Configuration.
- In the Configuration name field, enter a
unique name to describe the access configuration and distinguish it from the other access
configurations for this data source connection that you might set up. Only alphanumeric characters
and the following special characters are allowed: - . _
- In the Configuration description field, enter
a unique description to describe the access configuration and distinguish it from the other access
configurations for this data source connection that you might set up. Only alphanumeric characters
and the following special characters are allowed: - . _
- Click Edit access and choose which users can
connect to the data source and the type of access.
- In the Org key field, enter the organization key that you
copied in the Before you Begin section of this procedure.
- In the API Token field, enter the API Secret Key and API ID
that you copied in the Before you Begin section of this procedure, separated by a
/, like this:
<API_secret_key>/<API_ID>
- Click Add.
- To save your configuration and establish the connection, click
Done.
You can see the data source connection configuration that
you added under Connections on the data source settings page. A message on the card indicates
connection with the data source.
When you add a data source, it might take
a few minutes before the data source shows as being connected.
Tip: After you connect a
data source, it might take up to 30 seconds to retrieve the data. Before the full data set is
returned, the data source might display as unavailable. After the data is returned, the data source
shows as being connected, and a polling mechanism occurs to validate the connection status. The
connection status is valid for 60 seconds after every poll.
You can add other
connection configurations for this data source that have different users and different data access
permissions.
- To edit your configurations, complete the following steps:
- On the Data Sources tab, select the data source connection that
you want to edit.
- In the Configurations section, click Edit
Configuration (
).
- Edit the identity and access parameters and click
Save.
What to do next
Test the connection by running a query with IBM Security Data Explorer. To use Data Explorer, you must have data sources that are
connected so that the application can run queries and retrieve results across a unified set of data
sources. The search results vary depending on the data that is contained in your configured data
sources. For more information about how to build a query in Data Explorer, see Build a query.