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

Merge pull request #78 from deralexxx/patch-2 

Update README.md
pull/83/head
Alexandre Dulaunoy 2016-12-01 22:13:53 +01:00 committed by GitHub
parent 7718f3cd0c 1637304691
commit 50dcc02700
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -54,7 +54,7 @@ sudo vi /etc/rc.local, add this line: `sudo -u www-data misp-modules -s &`
## How to add your own MISP modules? ## How to add your own MISP modules?
Create your module in [misp_modules/modules/expansion/](misp_modules/modules/expansion/). The module should have at minimum three functions: Create your module in [misp_modules/modules/](misp_modules/modules/). The module should have at minimum three functions:
* **introspection** function that returns a dict of the supported attributes (input and output) 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.
@ -81,10 +81,11 @@ If your module requires additional configuration (to be exposed via the MISP use
### Module type ### Module type
A MISP module can be of two types: A MISP module can be of different types:
- **expansion** - service related to an attribute that can be used to extend and update an existing event. - **expansion** - service related to an attribute that can be used to extend and update an existing event.
- **hover** - service related to an attribute to provide additional information to the users without updating the event. - **hover** - service related to an attribute to provide additional information to the users without updating the event.
- **import/export** - import / export data
module-type is an array where the list of supported types can be added. module-type is an array where the list of supported types can be added.