Python API for MISP.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
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
Example:
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 -E email
Running the tests
poetry run pytest --cov=pymisp 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 pytest --cov=pymisp 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
Debugging
You have two options here:
-
Pass
debug=TruetoPyMISPand 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)
Test cases
- 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
pytest --cov=pymisp tests/test_*.py tests/testlive_comprehensive.py:TestComprehensive.[test_name]
Documentation
The documentation is available here.
Jupyter notebook
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 update_not_jsonable and set_not_jsonable.
This master class has helpers that make it easy to load, and export to, and from, a json string.
MISPEvent, MISPAttribute, MISPObjectReference, MISPObjectAttribute, and MISPObject
are subclasses of AbstractMISP, which mean that they can be handled as python dictionaries.
MISP Objects
Creating a new MISP object generator should be done using a pre-defined template and inherit AbstractMISPObjectGenerator.
Your new MISPObject generator must generate attributes and add them as class properties using add_attribute.
When the object is sent to MISP, all the class properties will be exported to the JSON export.
Installing PyMISP on a machine with no internet access
This is done using poetry and you need to have this repository cloned on your machine. The commands below have to be run from inside the cloned directory.
- From a machine with access to the internet, get the dependencies:
mkdir offline
poetry export --all-extras > offline/requirements.txt
poetry run pip download -r offline/requirements.txt -d offline/packages/
- Prepare the PyMISP Package
poetry build
mv dist/*.whl offline/packages/
-
Copy the content of
offline/packages/to the machine with no internet access. -
Install the packages:
python -m pip install --no-index --no-deps packages/*.whl
License
PyMISP is distributed under an open source license. A simplified 2-BSD license.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pymisp-2.5.17.3.tar.gz.
File metadata
- Download URL: pymisp-2.5.17.3.tar.gz
- Upload date:
- Size: 2.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e1d8595ab62d6fb9376674b3ee8990dff04cc3dec7f0361f41e7c991c0d9c258
|
|
| MD5 |
cd563b4f0d695dfaa2532823b898f585
|
|
| BLAKE2b-256 |
1319312a6625f1920e1932f99cf6a0ddccdbcd337441a20429ae0e9714cb1e39
|
Provenance
The following attestation bundles were made for pymisp-2.5.17.3.tar.gz:
Publisher:
release.yml on MISP/PyMISP
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymisp-2.5.17.3.tar.gz -
Subject digest:
e1d8595ab62d6fb9376674b3ee8990dff04cc3dec7f0361f41e7c991c0d9c258 - Sigstore transparency entry: 724958963
- Sigstore integration time:
-
Permalink:
MISP/PyMISP@6eeacba57a68828beeacb5afdf7b61630e36220e -
Branch / Tag:
refs/tags/v2.5.17.3 - Owner: https://github.com/MISP
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6eeacba57a68828beeacb5afdf7b61630e36220e -
Trigger Event:
release
-
Statement type:
File details
Details for the file pymisp-2.5.17.3-py3-none-any.whl.
File metadata
- Download URL: pymisp-2.5.17.3-py3-none-any.whl
- Upload date:
- Size: 489.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f8b44762d066163cce8db6f0c72c3db25a32146af9094a17eafea05abdf5b95c
|
|
| MD5 |
e548f951e4cc6eb9acf2943e75c62252
|
|
| BLAKE2b-256 |
87dddcb560e1f24554a0a27c62419cf0b3f38063d6257fc070551bf82e2268ac
|
Provenance
The following attestation bundles were made for pymisp-2.5.17.3-py3-none-any.whl:
Publisher:
release.yml on MISP/PyMISP
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pymisp-2.5.17.3-py3-none-any.whl -
Subject digest:
f8b44762d066163cce8db6f0c72c3db25a32146af9094a17eafea05abdf5b95c - Sigstore transparency entry: 724958965
- Sigstore integration time:
-
Permalink:
MISP/PyMISP@6eeacba57a68828beeacb5afdf7b61630e36220e -
Branch / Tag:
refs/tags/v2.5.17.3 - Owner: https://github.com/MISP
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@6eeacba57a68828beeacb5afdf7b61630e36220e -
Trigger Event:
release
-
Statement type:
