94e3419c39
usage: add_generic_object.py [-h] -e EVENT -t TYPE -d DICT
Examples:
python3 add_generic_object.py -e 1683 -t email -d '{"subject":"The Pink Letter", "to":"jon@snow.org"}'
python3 add_generic_object.py -e 2343 -t person -d '{"first-name":"Daenerys", "last-name":"Targaryen", "place-of-birth":"Dragonstone"}'
python3 add_generic_object.py -e 3596 -t "domain|ip" -d '{"domain":"stormborn.org", "ip":"50.63.202.33"}'
|
||
|---|---|---|
| docs | ||
| examples | ||
| pymisp | ||
| tests | ||
| .gitchangelog.rc | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| CHANGELOG.txt | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.md | ||
| setup.cfg | ||
| setup.py | ||
README.md
README
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.
Requirements
Install from pip
pip3 install pymisp
Install the latest version from repo
git clone https://github.com/CIRCL/PyMISP.git && cd PyMISP
pip3 install -I .
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 last 10 events published.
cd examples
python3 last.py -l 10
Documentation
PyMISP API documentation is available.
Documentation can be generated with epydoc:
epydoc --url https://github.com/CIRCL/PyMISP --graph all --name PyMISP --pdf pymisp -o doc
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 inherit 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 will 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 need to 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.