cbc-binary-toolkit 1.0a2

The VMware Carbon Black Cloud Binary Toolkit provides useful tools to process binaries and upload IOCs to your Feeds

Carbon Black Cloud Binary Toolkit

**Disclaimer: This is an ALPHA release**

Latest Version: 1.0a2
Release Date: 05/11/2020

The Carbon Black Cloud Binary Toolkit provides a system of processing incoming SHA256 hashes by integrating with the Unified Binary Store (UBS) on the Carbon Black Cloud (CBC).

Recent updates

View the latest release notes here.

License

Use of the Carbon Black API is governed by the license found in LICENSE.

Support

1. View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.
2. Use the Developer Community Forum to discuss issues and get answers from other API developers in the Carbon Black Community.
3. Create a github issue for bugs and change requests. Formal Carbon Black Support coming with v1.0.

Requirements

The Carbon Black Cloud Binary Toolkit is design to work on Python 3.6 and above.

All requirements are installed as part of pip install or if you're planning on pushing changes to the Carbon Black Cloud Binary Toolkit, the following can be used after cloning the repo pip install requirements.txt

Carbon Black Cloud

• Enterprise EDR

Python Packages

• argparse
• cbapi
• python-dateutil
• pyyaml
• requests
• schema
• yara-python

Note:

• Windows users will need to have Microsoft Visual C++ 14.0 Build Tools installed in order to compile yara-python.

• Linux users will need to have the python developer package installed in order to compile yara-python. If you receive compile errors, make sure you are on the latest gcc compiler version

Linux Distribution	Command
Amazon Linux/Centos/RHEL	yum install python3-devel
Ubuntu	apt-get install python3-dev
OpenSUSE/SUSE	zypper install python3-devel

Getting Started

There are two ways to use the Carbon Black Cloud Binary Toolkit. You can either run the Binary Analysis Tool using out-of-the-box functionality, or you can use the Toolkit to develop your own tool for processing binaries.

First you will need to install the Binary Toolkit with the following command:

pip install cbc-binary-toolkit

Running Binary Analysis tool

The cbc-binary-analysis tool provides out-of-the-box builtin resources for processing binaries and managing the analysis results. For more information see the User Guide wiki page.

usage: cbc-binary-analysis [-h] [-c CONFIG]
                           [-ll {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                           {analyze,restart,clear} ...

positional arguments:
  {analyze,restart,clear}
                        Binary analysis commands
    analyze             Analyze a list of hashes by command line or file
    restart             Restart a failed job and pick up where the job crashed
                        or exited
    clear               Clear cache of analyzed hashes. All or by timestamp

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Location of the configuration file (default .../carbonblackcloud/binary-toolkit/binary-analysis-config.yaml.example)
  -ll {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        The base log level (default INFO)

Note: Run --help on any of the commands for up to date arguments

Using the Toolkit to develop your own tools

The following python code snippet will allow you to begin developing with the Carbon Black Cloud Binary toolkit. For more information see the Developer Guide wiki page.

from cbc_binary_toolkit import *

Developing Improvements for the Carbon Black Cloud Binary Toolkit

If you want to provide additional examples, fix a bug, or add a feature to the Toolkit the following steps will get you started.

Installing for Toolkit development

You will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, see here

git clone https://github.com/{fork-name}/cbc-binary-toolkit
cd cbc-binary-toolkit
pip install requirements.txt

Running the Toolkit tests

To check if your code changes didn't break any use cases the following command will run all the tests:

pytest
  Optional args:
    -s Logs streamed to stdout
    -k {test or file} Selectively runs test matching string or file

Development Flow

To begin a code change start by creating a branch off of the develop branch.

git checkout develop
git checkout -b {branch-name}

When the feature or bug fix is finished you will need to create a pull request to the CarbonBlack repo, the following will push your changes to Github.

git push {remote} {branch-name}

If your branch is behind the develop branch then you will need to rebase.

git checkout {branch-name}
git rebase develop

Note if your develop branch is out of sync with the CarbonBlack repo then you will need to sync your fork. For information on syncing your fork, see here