Collect Carbon Black App Control (formerly CB Protection) logs

Supported in:

This document explains how to ingest Carbon Black App Control (formerly known as CB Protection, now part of Broadcom) logs to Google Security Operations using Bindplane. The parser supports both CEF and JSON formats. It first attempts to parse the input as JSON; if that fails, it treats the input as CEF, performs text substitutions, extracts CEF fields, maps them to UDM, and sets the event type to GENERIC_EVENT.

Carbon Black App Control is an application control and whitelisting solution that allows organizations to lock down servers and critical systems. It prevents unauthorized and malicious software from executing by enforcing trust-based policies, monitoring file integrity changes, and providing real-time visibility into endpoint activity.

Before you begin

Make sure you have the following prerequisites:

  • A Google SecOps instance.
  • A Windows Server 2016 or later or Linux host with systemd.
  • If running behind a proxy, ensure firewall ports are open.
  • Carbon Black App Control Server version 8.x or later.
  • Privileged access (Administrator account) to the Carbon Black App Control console.

Get Google SecOps ingestion authentication file

  1. Sign in to the Google SecOps console.
  2. Go to SIEM Settings > Collection Agents.
  3. Download the Ingestion Authentication File. Save the file securely on the system where Bindplane will be installed.

Get Google SecOps customer ID

  1. Sign in to the Google SecOps console.
  2. Go to SIEM Settings > Profile.
  3. Copy and save the Customer ID from the Organization Details section.

Install the Bindplane agent

Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.

Windows installation

  1. Open Command Prompt or PowerShell as an administrator.
  2. Run the following command:

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
    

Linux installation

  1. Open a terminal with root or sudo privileges.
  2. Run the following command:

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
    

Additional installation resources

For additional installation options, see the Bindplane agent installation guide.

Configure the Bindplane agent to ingest syslog and send to Google SecOps

  1. Access the configuration file:

    • Locate the config.yaml file. Typically, it is in the /observiq-otel-collector/ directory on Linux or in the installation directory on Windows.
    • Open the file using a text editor (for example, nano, vi, or Notepad).
  2. Edit the config.yaml file as follows:

    receivers:
        tcplog:
            # Replace the port and IP address as required
            listen_address: "0.0.0.0:514"
    
    exporters:
        chronicle/chronicle_w_labels:
            compression: gzip
            # Adjust the path to the credentials file you downloaded in Step 1
            creds_file_path: '/path/to/ingestion-authentication-file.json'
            # Replace with your actual customer ID from Step 2
            customer_id: '<customer_id>'
            endpoint: malachiteingestion-pa.googleapis.com
            # Add optional ingestion labels for better organization
            log_type: CB_APP_CONTROL
            raw_log_field: body
            ingestion_labels:
    
    service:
        pipelines:
            logs/source0__chronicle_w_labels-0:
                receivers:
                    - tcplog
                exporters:
                    - chronicle/chronicle_w_labels
    
  • Replace the port and IP address as required in your infrastructure.
  • Replace <customer_id> with the actual Customer ID.
  • Update /path/to/ingestion-authentication-file.json to the file path where the authentication file was saved in the Get Google SecOps ingestion authentication file section.

Restart the Bindplane agent to apply the changes

To restart the Bindplane agent in Linux:

  1. Run the following command:

    sudo systemctl restart observiq-otel-collector
    
  2. Verify the service is running:

    sudo systemctl status observiq-otel-collector
    
  3. Check logs for errors:

    sudo journalctl -u observiq-otel-collector -f
    

To restart the Bindplane agent in Windows:

  1. Choose one of the following options:

    • Command Prompt or PowerShell as administrator:
    net stop observiq-otel-collector && net start observiq-otel-collector
    
    • Services console:
      1. Press Win+R, type services.msc, and press Enter.
      2. Locate observIQ OpenTelemetry Collector.
      3. Right-click and select Restart.
  2. Verify the service is running:

    sc query observiq-otel-collector
    
  3. Check logs for errors:

    type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
    

Configure Carbon Black App Control syslog forwarding

  1. Sign in to the Carbon Black App Control console with an Administrator account.
  2. Click the Settings (gear) icon and click System Configuration.
  3. On the System Configuration page, click the Events tab.
  4. Click the Edit button at the bottom of the page.
  5. In the External Event Logging panel, select the Syslog Enabled checkbox.
  6. Provide the following configuration details:
    • Syslog Address: Enter the IP address or FQDN of the Bindplane agent host (for example, 192.168.1.100).
    • Syslog Port: Enter 514 (or the port configured in Bindplane).
    • Syslog Format: Select the output format from the Syslog Format menu:
      • CEF (ArcSight) - recommended for Google SecOps ingestion.
      • Enhanced (RFC 5424) - default for new installations of v6.0.1 and later.
      • Basic (RFC 3164) - default for upgrades from pre-6.0.1 versions.
      • LEEF (Q1 Labs) - for QRadar integration.
  7. Click Update and then click Yes in the confirmation dialog box.

UDM mapping table

Log Field UDM Mapping Logic
ABId principal.asset.asset_id The ABId from the JSON log is used as part of the asset ID in the format PRODUCT_SPECIFIC_ID:{ABId}-{Bit9Server}.
Bit9Server principal.asset.asset_id Used as part of the principal's asset ID, combined with ABId. Also used to construct the metadata.url_back_to_product field.
CommandLine about.process.command_line Directly mapped.
EventType metadata.product_event_type Mapped with the corresponding EventTypeId in square brackets (for example, [5] - Discovery).
EventTypeId metadata.product_event_type Used with EventType to populate metadata.product_event_type.
EventSubType metadata.description Appended to the metadata.description field.
EventSubTypeId metadata.description Not explicitly mapped, but potentially contributes to the description based on the parser's internal logic.
externalId metadata.product_log_id Directly mapped.
FileHash about.file.sha256 Directly mapped.
FileName additional.fields (with key FileName) Added as an additional field. Also used as part of file information in metadata.description for some events.
FilePath about.file.full_path Directly mapped.
FileThreat additional.fields (with key fileThreat) Added as an additional field.
FileTrust additional.fields (with key fileTrust) Added as an additional field.
HostId principal.asset.asset_id Used to construct the URL back to the product in metadata.url_back_to_product.
HostName target.hostname Directly mapped.
HostIP target.ip Directly mapped.
Message metadata.description Directly mapped.
PathName about.file.full_path Directly mapped.
Platform target.platform Mapped to the enum value WINDOWS.
Policy additional.fields (with key Policy) Added as an additional field.
PolicyId additional.fields (with key PolicyId) Added as an additional field.
ProcessKey additional.fields (with key ProcessKey) Added as an additional field.
ProcessPath about.process.command_line Directly mapped.
ProcessPathName about.process.command_line Directly mapped.
ProcessThreat additional.fields (with key ProcessThreat) Added as an additional field.
ProcessTrust additional.fields (with key ProcessTrust) Added as an additional field.
RuleName additional.fields (with key ruleName) Added as an additional field.
Timestamp metadata.event_timestamp Directly mapped.
UserName target.user.user_display_name Directly mapped.
UserSid principal.user.userid Directly mapped.
agent.ephemeral_id observer.labels (with key ephemeral_id) Added as an observer label.
agent.name principal.hostname, observer.hostname, observer.user.userid Mapped to multiple fields.
agent.type observer.application Directly mapped.
agent.version metadata.product_version Directly mapped for JSON logs. For CEF logs, extracted from the CEF message.
cat security_result.category_details Directly mapped.

Need more help? Get answers from Community members and Google SecOps professionals.