# Threat Intelligence Connector for Carbon Black Cloud
This is a python project that can be used for ingesting Threat Intelligence from various STIX Feeds. The current supported versions of STIX Feeds are 1.x, 2.0 and 2.1.
It supports python >= 3.8
[![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-threat-intelligence-connector/badge.svg?t=TczX1a)](https://coveralls.io/github/carbonblack/carbon-black-cloud-threat-intelligence-connector)
[![Codeship Status for carbonblack/carbon-black-cloud-threat-intelligence-connector](https://app.codeship.com/projects/73a21e3d-2c23-4fa8-a611-ada9d9849f2c/status?branch=main)](https://app.codeship.com/projects/456985)
## Installation
```shell-session
$ pip install carbon-black-cloud-threat-intelligence-connector
$ cbc-threat-intel --help
Usage: cbc-threat-intel [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
create-feed Creates a feed in CBC
create-watchlist Creates a Watchlist in CBC (from already created feed)
process-file Process and import a single STIX content file into...
process-server Process and import a TAXII Server (2.0/2.1/1.x)
version Shows the version of the connector
```
## Documentation
Visit the [developer network of Carbon Black Cloud](https://developer.carbonblack.com/reference/carbon-black-cloud/integrations/threat-intelligence-connector/) for more information of how to use the connector.
## Developing the connector
We rely on pull requests to keep this project maintained. By participating in this project, you agree to abide by the VMware [code of conduct](CODE-OF-CONDUCT.md).
### Setup
It is recommended to use Python3.8 / Python3.9 version for that project, assuming that you installed the deps with either virtualenv or poetry.
For a good code quality make sure to install the hooks from `pre-commit` as well.
```shell-session
$ pre-commit install
```
### Installation
Clone the repository
```bash
$ git clone https://github.com/carbonblack/carbon-black-cloud-threat-intelligence-connector.git
$ cd carbon-black-cloud-threat-intelligence-connector/
```
You can install this connector either via Poetry or using the `virtualenv`.
#### Using [Poetry](https://python-poetry.org/docs/)
You will need to [install poetry](https://python-poetry.org/docs/#installation) first.
To install the connector run:
```shell-session
$ poetry install
```
#### Using [virtualenv](https://virtualenv.pypa.io/en/latest/)
You will need to [install virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) first.
```bash
$ virtualenv venv
...
$ source ./venv/bin/activate
(venv) $ pip install -r requirements.txt
```
### Tests
The tests can be run with the following command:
```shell-session
$ pytest ./tests/unit/
```
For running the performance tests check out the [README](tests/performance/README.md)
### Support
1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.
2. Use the [Developer Community Forum](https://community.carbonblack.com/) 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 or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).
### Submitting a PR
It is strongly recommended to have written tests and documentation for your changes before submitting a PR to the project. Make sure to write good commit messages as well.
Raw data
{
"_id": null,
"home_page": null,
"name": "carbon-black-cloud-threat-intelligence-connector",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "connector, carbonblackcloud, stixtaxii, stix, taxii",
"author": "Dimitar Ganev",
"author_email": "dimitar.ganev@broadcom.com",
"download_url": "https://files.pythonhosted.org/packages/ce/e2/95296f7f6b97014a10d8ced27f45822d7bbc3383860b17004c05fe99328b/carbon_black_cloud_threat_intelligence_connector-1.8.tar.gz",
"platform": null,
"description": "# Threat Intelligence Connector for Carbon Black Cloud\n\nThis is a python project that can be used for ingesting Threat Intelligence from various STIX Feeds. The current supported versions of STIX Feeds are 1.x, 2.0 and 2.1.\nIt supports python >= 3.8\n\n[![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-threat-intelligence-connector/badge.svg?t=TczX1a)](https://coveralls.io/github/carbonblack/carbon-black-cloud-threat-intelligence-connector)\n[![Codeship Status for carbonblack/carbon-black-cloud-threat-intelligence-connector](https://app.codeship.com/projects/73a21e3d-2c23-4fa8-a611-ada9d9849f2c/status?branch=main)](https://app.codeship.com/projects/456985)\n\n## Installation\n\n```shell-session\n$ pip install carbon-black-cloud-threat-intelligence-connector\n$ cbc-threat-intel --help\nUsage: cbc-threat-intel [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n create-feed Creates a feed in CBC\n create-watchlist Creates a Watchlist in CBC (from already created feed)\n process-file Process and import a single STIX content file into...\n process-server Process and import a TAXII Server (2.0/2.1/1.x)\n version Shows the version of the connector\n```\n\n## Documentation\n\nVisit the [developer network of Carbon Black Cloud](https://developer.carbonblack.com/reference/carbon-black-cloud/integrations/threat-intelligence-connector/) for more information of how to use the connector.\n\n## Developing the connector\n\nWe rely on pull requests to keep this project maintained. By participating in this project, you agree to abide by the VMware [code of conduct](CODE-OF-CONDUCT.md).\n\n### Setup\n\nIt is recommended to use Python3.8 / Python3.9 version for that project, assuming that you installed the deps with either virtualenv or poetry.\n\nFor a good code quality make sure to install the hooks from `pre-commit` as well.\n\n```shell-session\n$ pre-commit install\n```\n\n### Installation\n\nClone the repository\n\n```bash\n$ git clone https://github.com/carbonblack/carbon-black-cloud-threat-intelligence-connector.git\n$ cd carbon-black-cloud-threat-intelligence-connector/\n```\n\nYou can install this connector either via Poetry or using the `virtualenv`.\n\n#### Using [Poetry](https://python-poetry.org/docs/)\n\nYou will need to [install poetry](https://python-poetry.org/docs/#installation) first.\n\nTo install the connector run:\n\n```shell-session\n$ poetry install\n```\n\n#### Using [virtualenv](https://virtualenv.pypa.io/en/latest/)\n\nYou will need to [install virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) first.\n\n```bash\n$ virtualenv venv\n...\n$ source ./venv/bin/activate\n(venv) $ pip install -r requirements.txt\n```\n\n### Tests\n\nThe tests can be run with the following command:\n\n```shell-session\n$ pytest ./tests/unit/\n```\nFor running the performance tests check out the [README](tests/performance/README.md)\n\n### Support\n\n1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.\n2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.\n3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).\n\n### Submitting a PR\n\nIt is strongly recommended to have written tests and documentation for your changes before submitting a PR to the project. Make sure to write good commit messages as well.\n\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Carbon Black Cloud Threat Intelligence Connector",
"version": "1.8",
"project_urls": null,
"split_keywords": [
"connector",
" carbonblackcloud",
" stixtaxii",
" stix",
" taxii"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f980e7ff2e90ddde3a741d028de0e61befd3566077d68946f04e92a050cb248f",
"md5": "0e976e437f12e18582fa04cf7e7b2a0b",
"sha256": "833217a432bb9c764d593e7a3fa0b19ceb03c379d2190d70362a59ef768723ff"
},
"downloads": -1,
"filename": "carbon_black_cloud_threat_intelligence_connector-1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e976e437f12e18582fa04cf7e7b2a0b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 27451,
"upload_time": "2024-05-13T14:25:59",
"upload_time_iso_8601": "2024-05-13T14:25:59.961474Z",
"url": "https://files.pythonhosted.org/packages/f9/80/e7ff2e90ddde3a741d028de0e61befd3566077d68946f04e92a050cb248f/carbon_black_cloud_threat_intelligence_connector-1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cee295296f7f6b97014a10d8ced27f45822d7bbc3383860b17004c05fe99328b",
"md5": "e41e2b2d6dd5ab6279827f95acdebc30",
"sha256": "2726c33f8aceed2e7603a803ecbd47cfd4345d858b1d7013dae729142462fbf0"
},
"downloads": -1,
"filename": "carbon_black_cloud_threat_intelligence_connector-1.8.tar.gz",
"has_sig": false,
"md5_digest": "e41e2b2d6dd5ab6279827f95acdebc30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21405,
"upload_time": "2024-05-13T14:26:01",
"upload_time_iso_8601": "2024-05-13T14:26:01.943358Z",
"url": "https://files.pythonhosted.org/packages/ce/e2/95296f7f6b97014a10d8ced27f45822d7bbc3383860b17004c05fe99328b/carbon_black_cloud_threat_intelligence_connector-1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-13 14:26:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "carbon-black-cloud-threat-intelligence-connector"
}