https://github.com/blockadeio/analyst_toolbench
Analyst tools to speed up interacting with the Blockade cloud node
https://github.com/blockadeio/analyst_toolbench
analyst information-security threat-sharing threats
Last synced: 6 months ago
JSON representation
Analyst tools to speed up interacting with the Blockade cloud node
- Host: GitHub
- URL: https://github.com/blockadeio/analyst_toolbench
- Owner: blockadeio
- License: gpl-2.0
- Created: 2017-01-06T05:52:57.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:51:37.000Z (over 3 years ago)
- Last Synced: 2026-01-03T20:03:54.135Z (6 months ago)
- Topics: analyst, information-security, threat-sharing, threats
- Language: Python
- Homepage: http://analyst-toolbench.readthedocs.io/en/latest/?badge=latest
- Size: 5.26 MB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Blockade Analyst Bench
======================
.. image:: https://readthedocs.org/projects/analyst-toolbench/badge/?version=latest
:target: http://analyst-toolbench.readthedocs.io/en/latest/?badge=latest
.. image:: https://badge.fury.io/py/blockade-toolkit.svg
:target: https://badge.fury.io/py/blockade-toolkit
.. image:: https://img.shields.io/badge/License-GPL%20v2-blue.svg
:target: https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html
*Python client for Blockade.io services*
Command-line scripts
--------------------
The following command line scripts are installed with the library:
- **blockade-cfg**: utility to set or query API configuration options for the
library (email and API key).
- **blockade-aws-deploy**: utility to set automatically deploy a Blockade cloud node within Amazon Web Services.
- **blockade**: primary client to interface with the blockade back-end services.
See the *Usage* section for getting started or our wiki_ for more information.
.. _wiki: https://github.com/blockadeio/analyst_toolbench/wiki
Installation
------------
From the downloaded source distribution::
$ python setup.py install
Or from PyPI::
$ pip install blockade-toolkit [--upgrade]
The package depends on several external libraries. If these are not present, they will be installed automatically. A ``requirements.txt`` file is included in the repository which outlines these dependencies in detail.
Setup
-----
Users must supply their email and API key in order for this library to function. On the first setup run, validated whitelists will be downloaded and stored within the configuration directory. First-time setup requires configuring your API email and private key for authentication::
$ blockade-cfg setup
At any time, the current API configuration parameters can be queried using the same utility::
$ blockade-cfg show
Configuration parameters are stored in **$HOME/.config/blockade/api_config.json**.
Usage
-----
Every command-line script has several sub-commands that may be passed to it. The
commands usage may be described with the ``-h/--help`` option.
For example::
$ blockade -h
usage: blockade [-h] {ioc} ...
Blockade Analyst Bench
positional arguments:
{ioc}
ioc Perform actions with IOCs
optional arguments:
-h, --help show this help message and exit
Support
-------
Please use the issues_ section for any bug reporting, comments or other feedback.
.. _issues: https://github.com/blockadeio/analyst_toolbench/issues