Latest Version: 1.1.1
Release Date: 03/31/2021
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).
View the latest release notes here.
Use of the Carbon Black API is governed by the license found in LICENSE.
- View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.
- Use the Developer Community Forum to discuss issues and get answers from other API developers in the Carbon Black Community.
- Create a github issue for bugs and change requests. Formal Carbon Black Support coming with v1.0.
The Carbon Black Cloud Binary Toolkit is designed to work on Python 3.6 and above.
All requirements are installed as part of pip install cbc-binary-toolkit 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 -r requirements.txt
- Enterprise EDR
-
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 |
- argparse
- carbon-black-cloud-sdk
- python-dateutil
- pyyaml
- requests
- schema
- yara-python
For details on the expected performance for the CBC Binary Toolkit see the Performance Metrics wiki page here.
The wiki page will be updated with any changes or additional tests that may be run in the future.
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
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.
The following python code snippet allows you to begin developing with the Carbon Black Cloud Binary toolkit. For more information see the Developer Guide.
from cbc_binary_toolkit import *
Use the following steps if you want to provide additional examples, fix a bug, or add a feature to the Toolkit.
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 -r requirements.txt
If you want to test/execute the console scripts from the repo then install the toolkit with the following command. This will install the toolkit in editable mode so changes to the repo modify the installed package. See the manual-tests document for more information on testing from a fresh install.
pip install -e .
Note: The above command needs to be run from the base folder of the repo
If you want to execute the analysis tool without installing the package you can run the tool directly using the analysis_util.py script in src/cbc_binary_toolkit_examples/tools
To check that your code changes didn't break any use cases, or fail our linters, the following will show you how to set up and run our tests:
Install one or all of these versions of Python: Python 3.6.X, Python 3.7.X or Python 3.8.X and make sure it is accessible to this project.
For managing different versions of python, an easy solution is: pyenv(for UNIX based systems), or pyenv-win(for Windows based systems).
Install tox (e.g. pip install tox or brew install tox)
Run the command tox -e <the environment you want to run> from anywhere in the directory to run the tests and linter.
The tox.ini file shows that the tests are run against python versions 3.6.x, 3.7.x and 3.8.x as py36, py37, py38.
Example: If you just run tox -e py37, it will run the tests against the Python 3.7.X version installed locally.
But if tox is run, it will try to run against all the versions listed in the tox.ini file (currently py36, py37, and py38).
If a version is not installed locally, it will just throw an error of:
ERROR: pyXX: InterpreterNotFound: pythonX.X
It will continue running against the versions that are installed.
If there are any changes, you need to recreate the virtualenv that tox built. Just run tox --recreate -e <the environment you want to run> or tox --recreate for all environments.
If this error is thrown:
ERROR: cowardly refusing to delete `envdir` (it does not look like a virtualenv):
Delete the python env directory (py37) from .tox directory
and rerun tox --recreate.
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, 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.