Skip to main content

Minimal, consistent API for building integrations with malware sandboxes.

Project description

.. raw:: html

<p align="center">
<img height="128" src="https://inquest.readthedocs.io/projects/sandboxapi/en/latest/_static/sandboxapi.png" alt="sandboxapi" title="sandboxapi">
</p>

<h1 align="center">sandboxapi</h1>

.. image:: https://inquest.net/images/inquest-badge.svg
:target: https://inquest.net/
:alt: Developed by InQuest
.. image:: https://travis-ci.org/InQuest/python-sandboxapi.svg?branch=master
:target: https://travis-ci.org/InQuest/python-sandboxapi
:alt: Build Status
.. image:: https://readthedocs.org/projects/sandboxapi/badge/?version=latest
:target: https://inquest.readthedocs.io/projects/sandboxapi/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://api.codacy.com/project/badge/Grade/7ddb5b4791404aa2a6a9670099fe53ad
:target: https://www.codacy.com/app/rshipp/python-sandboxapi?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=InQuest/python-sandboxapi&amp;utm_campaign=Badge_Grade
:alt: Code Health
.. image:: https://api.codacy.com/project/badge/Coverage/7ddb5b4791404aa2a6a9670099fe53ad
:target: https://www.codacy.com/app/rshipp/python-sandboxapi?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=InQuest/python-sandboxapi&amp;utm_campaign=Badge_Coverage
:alt: Test Coverage
.. image:: http://img.shields.io/pypi/v/sandboxapi.svg
:target: https://pypi.python.org/pypi/sandboxapi
:alt: PyPi Version

A minimal, consistent API for building integrations with malware sandboxes.

This library currently supports the following sandbox systems:

* `Cuckoo Sandbox`_
* `FireEye AX Series`_
* `Joe Sandbox`_
* `VMRay Analyzer`_
* `Falcon Sandbox`_ (Formerly VxStream)

It provides at least the following methods for each sandbox:

* ``is_available()``: Check if the sandbox is operable and reachable; returns a boolean
* ``analyze(handle, filename)``: Submit a file for analysis; returns an ``item_id``
* ``check(item_id)``: Check if analysis has completed for a file; returns a boolean
* ``report(item_id, report_format='json')``: Retrieve the report for a submitted file
* ``score(report)``: Parse out and return an integer score from the report object

Some sandbox classes may have additional methods implemented. See inline
documentation for more details.

Note that the value returned from the ``score`` method may be on the range
0-10, or 0-100, depending on the sandbox in question, so you should refer to
the specific sandbox's documentation when interpreting this value.

Installation
------------

Install through pip::

pip install sandboxapi

Supports Python 2.7+.

Usage
-----

Basic usage is as follows:

.. code-block:: python

import sys
import time
import pprint

from sandboxapi import cuckoo

# connect to the sandbox
sandbox = cuckoo.CuckooAPI('http://192.168.0.20:8090/')

# verify connectivity
if not sandbox.is_available():
print("sandbox is down, exiting")
sys.exit(1)

# submit a file
with open('myfile.exe', "rb") as handle:
file_id = sandbox.analyze(handle, 'myfile.exe')
print("file {f} submitted for analysis, id {i}".format(f=filename, i=file_id))

# wait for the analysis to complete
while not sandbox.check(file_id):
print("not done yet, sleeping 10 seconds...")
time.sleep(10)

# print the report
print("analysis complete. fetching report...")
report = sandbox.report(file_id)
pprint.pprint(report)
print("Score: {score}".format(score=sandbox.score(report)))

Since the library provides a consistent API, you can treat all sandoxes
the same way:

.. code-block:: python

import sys
import time
import pprint

from sandboxapi import cuckoo, fireeye, joe

# connect to the sandbox
sandboxes = [
cuckoo.CuckooAPI('http://192.168.0.20:8090/'),
fireeye.FireEyeAPI('myusername', 'mypassword', 'https://192.168.0.21', 'winxp-sp3'),
joe.JoeAPI('mykey', 'https://jbxcloud.joesecurity.org/api', True)
]

for sandbox in sandboxes:
# verify connectivity
if not sandbox.is_available():
print("sandbox is down, exiting")
sys.exit(1)

# submit a file
with open('myfile.exe', "rb") as handle:
file_id = sandbox.analyze(handle, 'myfile.exe')
print("file {f} submitted for analysis, id {i}".format(f=filename, i=file_id))

# wait for the analysis to complete
while not sandbox.check(file_id):
print("not done yet, sleeping 10 seconds...")
time.sleep(10)

# print the report
print("analysis complete. fetching report...")
report = sandbox.report(file_id)
pprint.pprint(report)
print("Score: {score}".format(score=sandbox.score(report)))

Cuckoo Sandbox
~~~~~~~~~~~~~~

Constructor signature::

CuckooAPI(url, verify_ssl=False)

Example::

CuckooAPI('http://192.168.0.20:8090/')

This library attempts to support any Cuckoo-like API, including older 1.x
installations (though those without a score won't be able to use the ``.score``
method), compatible forks like spender-sandbox and CAPE, and the latest 2.x
Cuckoo releases. If you find a version that doesn't work, let us know.

There is an `unofficial Cuckoo library`_ written by @keithjjones with much
more functionality. For more information on the Cuckoo API, see the `Cuckoo API
documentation`_.

FireEye AX
~~~~~~~~~~

Constructor signature::

FireEyeAPI(username, password, url, profile, legacy_api=False, verify_ssl=True)

Example::

FireEyeAPI('myusername', 'mypassword', 'https://192.168.0.20', 'winxp-sp3')

By default, the ``FireEyeAPI`` class uses v1.2.0 of the FireEye API, which is
available on v8.x FireEye AX series appliances. The v1.1.0 API, which is
available on v7.x appliances, is also supported - just set ``legacy_api=True``
to use the older version.

There is some limited `FireEye API documentation`_ on their blog. For more
information on FireEye's sandbox systems, see the `AX Series product page`_.
FireEye customers have access to more API documentation.

Joe Sandbox
~~~~~~~~~~~

Constructor signature::

JoeAPI(apikey, apiurl, accept_tac, timeout=None, verify_ssl=True, retries=3)

Example::

JoeAPI('mykey', 'https://jbxcloud.joesecurity.org/api', True)

There is an `official Joe Sandbox library`_ with much more functionality.
This library is installed as a dependency of sandboxapi, and wrapped by the
``sandboxapi.joe.JoeSandbox`` class.

VMRay Analyzer
~~~~~~~~~~~~~~

Constructor signature::

VMRayAPI(api_key, url='https://cloud.vmray.com', verify_ssl=True)

Example::

VMRayAPI('mykey')

VMRay customers have access to a Python library with much more functionality.
Check your VMRay documentation for more details.

Falcon Sandbox
~~~~~~~~~~~~~~

Constructor signature::

FalconAPI(key, url='https://www.reverse.it/api/v2', env=100)

Example::

FalconAPI('mykey')

This class only supports version 2.0+ of the Falcon API, which is available
in version 8.0.0+ of the Falcon Sandbox.

There is an `official Falcon library`_ with much more functionality, that
supports the current and older versions of the Falcon API. Note that the
official library only supports Python 3.4+.


Notes
-----

You may also be interested in `malsub`_, a similar project with support for a
number of online analysis services.


.. _Cuckoo Sandbox: https://www.cuckoosandbox.org/
.. _Fireeye AX Series: https://www.fireeye.com/products/malware-analysis.html
.. _Joe Sandbox: https://www.joesecurity.org/
.. _VMRay Analyzer: https://www.vmray.com/
.. _Falcon Sandbox: https://www.falcon-sandbox.com/
.. _unofficial Cuckoo library: https://github.com/keithjjones/cuckoo-api
.. _Cuckoo API documentation: https://cuckoo.sh/docs/usage/api.html
.. _FireEye API documentation: https://www.fireeye.com/blog/products-and-services/2015/12/restful_apis_thatdo.html
.. _AX Series product page: https://www.fireeye.com/products/malware-analysis.html
.. _official Joe Sandbox library: https://github.com/joesecurity/joesandboxcloudapi
.. _official Falcon library: https://github.com/PayloadSecurity/VxAPI
.. _malsub: https://github.com/diogo-fernan/malsub


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sandboxapi-1.4.0-py2.py3-none-any.whl (21.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Sep 19, 2018
sandboxapi-1.4.0.tar.gz (21.1 kB) Copy SHA256 hash SHA256 Source None Sep 19, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page