MISP
/
misp-modules
mirror of https://github.com/MISP/misp-modules
2
0
Fork 0
Code Issues Releases Wiki Activity

Minimal functions requirements updated + PR request

pull/2/head
Alexandre Dulaunoy 2016-03-09 07:49:46 +01:00
parent 0284aee1a2
commit 715e7f3a4b
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -14,10 +14,11 @@ MISP modules support is included in MISP starting from version 2.4.X.
## How to add your own MISP modules? ## How to add your own MISP modules?
Create your module in [modules/expansion/](modules/expansion/). The module should have at minimum two functions: Create your module in [modules/expansion/](modules/expansion/). The module should have at minimum three functions:
* **introspection** function that returns an array of the supported attributes by your expansion module. * **introspection** function that returns a dict of the supported attributes (input and output) by your expansion module.
* **handler** function which accepts a JSON document to expand the values and return a dictionary of the expanded values. * **handler** function which accepts a JSON document to expand the values and return a dictionary of the expanded values.
* **version** function that returns a dict with the version and the associated meta-data of the module.
Don't forget to return an error key and value if an error is raised to propagate it to the MISP user-interface. Don't forget to return an error key and value if an error is raised to propagate it to the MISP user-interface.
@ -103,3 +104,7 @@ Then you can POST this JSON format query towards the MISP object server:
curl -s http://127.0.0.1:6666/query -H "Content-Type: application/json" --data @body.json -X POST curl -s http://127.0.0.1:6666/query -H "Content-Type: application/json" --data @body.json -X POST
~~~ ~~~
## How to contribute your own module?
Fork the project, add your module, test it and make a pull-request. Modules can be also private as you can add a module in your own MISP installation.