mirror of https://github.com/MISP/misp-modules
Merge pull request #242 from 0xmilkmix/module_writting
chg: [doc] Additional documentation for export modulepull/247/head
commit
c046d04712
15
README.md
15
README.md
|
@ -116,6 +116,8 @@ Create your module in [misp_modules/modules/expansion/](misp_modules/modules/exp
|
|||
|
||||
Don't forget to return an error key and value if an error is raised to propagate it to the MISP user-interface.
|
||||
|
||||
Your module's script name should also be added in the `__all__` list of `<module type folder>/__init__.py` in order for it to be loaded.
|
||||
|
||||
~~~python
|
||||
...
|
||||
# Checking for required value
|
||||
|
@ -207,6 +209,19 @@ def handler(q=False):
|
|||
codecs.encode(src, "rot-13")}
|
||||
~~~
|
||||
|
||||
#### export module
|
||||
|
||||
For an export module, the `request["data"]` object corresponds to a list of events (dictionaries) to handle.
|
||||
|
||||
Iterating over events attributes is performed using their `Attribute` key.
|
||||
|
||||
~~~python
|
||||
...
|
||||
for event in request["data"]:
|
||||
for attribute in event["Attribute"]:
|
||||
# do stuff w/ attribute['type'], attribute['value'], ...
|
||||
...
|
||||
|
||||
### Returning Binary Data
|
||||
|
||||
If you want to return a file or other data you need to add a data attribute.
|
||||
|
|
Loading…
Reference in New Issue