Skip to main content
Sumo Logic

Carbon Black Defense Source

The Carbon Black Defense Source provides a secure endpoint to receive data from the CB Defense API. It securely stores the required authentication, scheduling, and state tracking information.

Collection from the following three APIs are supported:

  1. The Notification API requires the creation of an API key with SEIM access. See the CB API documentation for more information.

  2. The Event API is an available option to query all the events associated with a notification and ingest them. This option requires an API key with API access.

  1. The Devices API is an available option to ingest inventory (device) data periodically. This option requires an API key with Custom access that has view rights to the Devices API.

States

A Carbon Black Defense Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A Carbon Black Defense Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Carbon Black Defense.
  5. Collecting: The Source is actively collecting data from Carbon Black Defense.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection.

Carbon Black Defense error.png

Hover your mouse over the status icon to view a tooltip with details on the detected issue.

health error generic.png

Create a Carbon Black Defense Source

When you create a Carbon Black Defense Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure A Carbon Black Defense Source:

  1. In the Sumo Logic web app, select Manage Data > Collection > Collection
  1. In the Collectors page, click Add Source next to a Hosted Collector.
  1. Select Carbon Black Defense.
    Carbon Black Defense Icon.png
  1. Enter a Name for the Source. The description is optional.
    CB defense.png
  1. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor CarbonBlack
_siemProduct Defense
_siemFormat JSON
_siemEventID Notifications have the value of the type field in the notification, such as POLICY_ACTION or THREAT.

Events have the value of the eventType field in the event, such as SYSTEM_API_CALL.
_dataType

When Inventory Collection is true this field is assigned.
Inventory
  1. Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped. 
  2. CB Defense Domain. Enter your Carbon Black Defense domain, such as, dev-prod05.conferdeploy.net. See this knowledge base article to determine which domain to use.

  3. CB Defense SIEM Key. Enter the Carbon Black Defense API key you want to use to authenticate requests. Ensure the key is granted the required permissions for the APIs you are collecting from, see the available APIs above.

  4. CB Defense SIEM Connector ID. Enter your Carbon Black Defense connector ID correlated to your API key. Authentication is handled by an API key and Connector ID, which is generated from the Connectors page of the Carbon Black Cloud console.

  5. (Optional) The Polling Interval is set for 60 seconds by default, you can adjust it based on your needs.

  6. Event Collection. Set to true to collect from the Event API, see details on the available APIs above. Provide the API Key and Connector ID.
    event collection input.png

  7. Inventory Collection. Set to true to collect from the Devices API, see details on the available APIs above. Provide the Org KeyDevices API Connector ID, and Devices API Key.
    Inventory input.png

  8. When you are finished configuring the Source click Submit.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which retries will be attempted every 60 minutes. FirstPartyGenericError

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"Carbon Black Defense"} for a Carbon Black Defense Source. not modifiable
sourceType String Yes Use Universal for a Carbon Black Defense Source. not modifiable

The following table shows the config parameters are for a Carbon Black Defense Source.

Parameter Type Required Description Access
name String Yes Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No Type a description of the Source. modifiable
category String No Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable
domain String Yes Enter your Carbon Black Defense domain, such as, dev-prod05.conferdeploy.net. See this knowledge base article to determine which domain to use. modifiable
siem_key String Yes The Carbon Black Defense API key you want to use to authenticate requests. Ensure the API key has SEIM access. See the CB API documentation for more information. modifiable
siem_id String Yes Your Carbon Black Defense connector ID correlated to your API key. Authentication is handled by an API key and Connector ID, which is generated from the Connectors page of the Carbon Black Cloud console. modifiable
pollingInterval Integer No This sets how many seconds the Source checks for new data. The default is 60 seconds. modifiable
collect_events Boolean No Collect Events associated with each Notification. You must provide api_key and api_id if this is set to true. modifiable
api_key String Only if collect_events is true Your API key with API access. modifiable
api_id String Only if collect_events is true Your API key identifier with API access. modifiable
collect_inventory Boolean No Collect Inventory (device) information. You must provide org_keyinventory_id, and inventory_key if this is set to true. modifiable
org_key String Only if collect_inventory is true Your organization's Carbon Black Defense key.  modifiable
inventory_id String Only if collect_inventory is true Your API key identifier with Custom access that has view rights to the Devices API. modifiable
inventory_key String Only if collect_inventory is true Your API key with Custom access that has view rights to the Devices API. modifiable

Carbon Black Defense Source JSON example:

{
  "api.version":"v1",
  "source":{
    "schemaRef":{
      "type":"Carbon Black Defense",
    },
    "config":{
      "name":"Carbon Black Defense",
      "description":"East field",
      "domain":"dev-prod05.conferdeploy.net",
      "collect_inventory":true,
      "siem_key":"********",
      "siem_id":"*******",
      "fields":{
        "_siemForward":false
      },
      "category":"eastTeamF",
      "pollingInterval":90
    },
    "sourceType":"Universal"
  }
}