IMPORTANT NOTE: This library will require at least Python 3.10 starting the 1st of January 2024. If you have legacy versions of python, please use the latest PyMISP version that will be released in December 2023, and consider updating your system(s). Anything released within the last 2 years will do, starting with Ubuntu 22.04.
PyMISP - Python Library to access MISP¶
PyMISP is a Python library to access MISP platforms via their REST API.
PyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.
Install from pip¶
It is strongly recommended to use a virtual environment
If you want to know more about virtual environments, python has you covered
Only basic dependencies:
pip3 install pymisp
And there are a few optional dependencies:
fileobjects: to create PE/ELF/Mach-o objects
openioc: to import files in OpenIOC format (not really maintained)
virustotal: to query VirusTotal and generate the appropriate objects
docs: to generate te documentation
pdfexport: to generate PDF reports out of MISP events
url: to generate URL objects out of URLs with Pyfaup
email: to generate MISP Email objects
brotli: to use the brotli compression when interacting with a MISP instance
pip3 install pymisp[virustotal,email]
Install the latest version from repo from development purposes¶
Note: poetry is required; e.g., “pip3 install poetry”
git clone https://github.com/MISP/PyMISP.git && cd PyMISP git submodule update --init poetry install -E fileobjects -E openioc -E virustotal -E docs -E pdfexport
Running the tests¶
poetry run nosetests-3.4 --with-coverage --cover-package=pymisp,tests --cover-tests tests/test_*.py
If you have a MISP instance to test against, you can also run the live ones:
Note: You need to update the key in
tests/testlive_comprehensive.py to the automation key of your admin account.
poetry run nosetests-3.4 --with-coverage --cover-package=pymisp,tests --cover-tests tests/testlive_comprehensive.py
Samples and how to use PyMISP¶
Various examples and samples scripts are in the examples/ directory.
In the examples directory, you will need to change the keys.py.sample to enter your MISP url and API key.
cd examples cp keys.py.sample keys.py vim keys.py
The API key of MISP is available in the Automation section of the MISP web interface.
To test if your URL and API keys are correct, you can test with examples/last.py to fetch the events published in the last x amount of time (supported time indicators: days (d), hours (h) and minutes (m)). last.py
cd examples python3 last.py -l 10h # 10 hours python3 last.py -l 5d # 5 days python3 last.py -l 45m # 45 minutes
You have two options here:
PyMISPand it will enable logging.DEBUG to stderr on the whole module
Use the python logging module directly:
import logging logger = logging.getLogger('pymisp') # Configure it as you wish, for example, enable DEBUG mode: logger.setLevel(logging.DEBUG)
Or if you want to write the debug output to a file instead of stderr:
import pymisp import logging logger = logging.getLogger('pymisp') logging.basicConfig(level=logging.DEBUG, filename="debug.log", filemode='w', format=pymisp.FORMAT)
The content of
mispevent.pyis tested on every commit
The test cases that require a running MISP instance can be run the following way:
# From poetry nosetests-3.4 -s --with-coverage --cover-package=pymisp,tests --cover-tests tests/testlive_comprehensive.py:TestComprehensive.[test_name]
The documentation is available here.
A series of Jupyter notebooks for PyMISP tutorial are available in the repository.
Everything is a Mutable Mapping¶
… or at least everything that can be imported/exported from/to a json blob
AbstractMISP is the master class, and inherits from
collections.MutableMapping which means
the class can be represented as a python dictionary.
The abstraction assumes every property that should not be seen in the dictionary is prepended with a
or its name is added to the private list
__not_jsonable (accessible through
This master class has helpers that make it easy to load, and export to, and from, a json string.
are subclasses of AbstractMISP, which mean that they can be handled as python dictionaries.
Creating a new MISP object generator should be done using a pre-defined template and inherit
Your new MISPObject generator must generate attributes and add them as class properties using
When the object is sent to MISP, all the class properties will be exported to the JSON export.
PyMISP is distributed under an open source license. A simplified 2-BSD license.