Azure-Sentinel/Solutions/VMware Carbon Black Cloud/Playbooks/readme.md

5.8 KiB

Carbon Black Logic Apps connector and playbook templates

Table of Contents

  1. Overview
  2. Deploy Custom Connector + 3 Playbook templates
  3. Authentication
  4. Prerequisites
  5. Deployment
  6. Post Deployment Steps
  7. References
  8. Known issues and limitations

Overview

The Carbon Black Cloud is a cloud-native endpoint protection platform (EPP) that provides what you need to secure your endpoints using a single, lightweight agent and an easy-to-use console.

Deploy Custom Connector + 3 Playbook templates

This package includes:

  • Logic Apps custom connector for Carbon Black

    custom connector

  • Three playbook templates leverage CarbonBlack custom connector:

    • Response from Teams - allow SOC to take action on suspicious devices arrived in incidents (apply a pre-defined policy or quarantine) and change incident configuration directly from Teams channel. Post information about the incident as a comment to the incident.
    • Quarantine device - move the device arrived in the incident to quarantine (if not already quarantined). Post information about the incident as a comment to the incident.
    • Enrichment - collect information about the devices and post them as incident comment.

You can choose to deploy the whole package: connector + all three playbook templates, or each one separately from it's specific folder.

Deploy to Azure Deploy to Azure

CarbonBlack connector documentation

Authentication

This connector supports API Key authentication. When creating the connection for the custom connector, you will be asked to provide the API key which you generated in Carbon Black platform. API Key authentication.

Prerequisites in Carbon Black

  1. CarbonBlack cloud end point should be known. (e.g. https://{CarbonblackBaseURL})

  2. Generate an API key (learn how), and grant it /appservices/ Access level. (For playbooks built from scratch which leverage the process API, /investigate/ Access level is also relevant.)

  3. For Response from Teams playbook, a policy needs to be created, so SOC will be able to move a device to it from the Teams adaptive card.

Deployment instructions

  1. Deploy the Custom Connector and playbooks by clicking on "Deploy to Azure" button. This will take you to deploying an ARM Template wizard.
  2. Fill in the required parameters for deploying custom connector and playbooks
Parameters Description
For Custom Connector
Custom Connector name Enter the Custom connector name (e.g. CarbonBlackConnector)
Service Endpoint Enter the CarbonBlack cloud end point (e.g. https://{CarbonblackBaseURL})
For Playbooks
CarbonBlack-TakeDeviceActionFromTeams Playbook Name Enter the playbook name here (e.g. CarbonBlack-TakeDeviceActionFromTeams)
CarbonBlack-DeviceEnrichment Playbook Name Enter the playbook name here (e.g. CarbonBlack-QuarantineDevice)
CarbonBlack-QuarantineDevice Playbook Name Enter the playbook name here (e.g. CarbonBlack-DeviceEnrichment)
OrganizationId Enter the OrganizationId
PolicyId Enter the pre-defined PolicyId to which Teams adaptive card will offer to move device
Teams GroupId Enter the Teams channel id to send the adaptive card
Teams ChannelId Enter the Teams Group id to send the adaptive card Refer the below link to get the channel id and group id

Post-Deployment instructions

a. Authorize connections

Once deployment is complete, you will need to authorize each connection.

  1. Click the Microsoft Sentinel connection resource
  2. Click edit API connection
  3. Click Authorize
  4. Sign in
  5. Click Save
  6. Repeat steps for other connections such as Teams connection and CarbonBlack connector API Connection (For authorizing the CarbonBlack connector API connection, API Key needs to be provided. The API Key is the combination of API Key / API Id)

b. Configurations in Sentinel

  1. In Microsoft sentinel analytical rules should be configured to trigger an incident with risky user account.
  2. Configure the automation rules to trigger the playbooks.

Known Issues and Limitations

  1. Quaraninte is not support for Linux OS devices.