First try of documentation for import & export modules

- Providing information about the general purpose of
  the modules, their requirements, how to use them
  (if there are special features), some references
  about the format concerned or the vendors, and their
  input and output.
- Documentation to be completed by additional fields
  of documentation and / or more detailed descriptions

doc/export_mod/cef_export.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to export a MISP event in CEF format."
+  "description": "Module to export a MISP event in CEF format.",
+  "requirements": [],
+  "features": "The module takes a MISP event in input, to look every attribute. Each attribute matching with some predefined types is then exported in Common Event Format.\nThus, there is no particular feature concerning MISP Events since any event can be exported. However, 4 configuration parameters recognized by CEF format are required and should be provided by users before exporting data: the device vendor, product and version, as well as the default severity of data.",
+  "references": ["https://community.softwaregrp.com/t5/ArcSight-Connectors/ArcSight-Common-Event-Format-CEF-Guide/ta-p/1589306?attachment-id=65537"],
+  "input": "MISP Event attributes",
+  "output": "Common Event Format file"
 }

doc/export_mod/liteexport.json

@@ -1,3 +1,8 @@
 {
-    "description": "Lite export of a MISP event."
+  "description": "Lite export of a MISP event.",
+  "requirements": [],
+  "features": "This module is simply producing a json MISP event format file, but exporting only Attributes from the Event. Thus, MISP Events exported with this module should have attributes that are not internal references, otherwise the resulting event would be empty.",
+  "references": [],
+  "input": "MISP Event attributes",
+  "output": "Lite MISP Event"
 }

doc/export_mod/pdfexport.json

@@ -1,3 +1,8 @@
 {
-    "description": "Simple export of a MISP event to PDF."
+  "description": "Simple export of a MISP event to PDF.",
+  "requirements": ["PyMISP", "asciidoctor"],
+  "features": "The module takes care of the PDF file building, and work with any MISP Event. Except the requirement of asciidoctor, used to create the file, there is no special feature concerning the Event.",
+  "references": ["https://acrobat.adobe.com/us/en/acrobat/about-adobe-pdf.html"],
+  "input": "MISP Event",
+  "output": "MISP Event in a PDF file."
 }

doc/export_mod/threatStream_misp_export.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to export a structured CSV file for uploading to threatStream."
+  "description": "Module to export a structured CSV file for uploading to threatStream.",
+  "requirements": ["csv"],
+  "features": "The module takes a MISP event in input, to look every attribute. Each attribute matching with some predefined types is then exported in a CSV format recognized by ThreatStream.",
+  "references": ["https://www.anomali.com/platform/threatstream", "https://github.com/threatstream"],
+  "input": "MISP Event attributes",
+  "output": "ThreatStream CSV format file"
 }

doc/export_mod/threat_connect_export.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to export a structured CSV file for uploading to ThreatConnect."
+  "description": "Module to export a structured CSV file for uploading to ThreatConnect.",
+  "requirements": ["csv"],
+  "features": "The module takes a MISP event in input, to look every attribute. Each attribute matching with some predefined types is then exported in a CSV format recognized by ThreatConnect.\nUsers should then provide, as module configuration, the source of data they export, because it is required by the output format.",
+  "references": ["https://www.threatconnect.com"],
+  "input": "MISP Event attributes",
+  "output": "ThreatConnect CSV format file"
 }

doc/import_doc/csvimport.json

@@ -4,5 +4,5 @@
   "features": "In order to parse data from a csv file, a header is required to let the module know which column is matching with known attribute fields / MISP types.\nThis header is part of the configuration of the module and should be filled out in MISP plugin settings, each field separated by COMMAS. Fields that do not match with any type known in MISP can be ignored in import, using a space or simply nothing between two separators (example: 'ip-src, , comment, ').\nThere is also one type that is confused and can be either a MISP attribute type or an attribute field: 'comment'. In this case, using 'attrComment' specifies that the attribute field 'comment' should be considered, otherwise it will be considered as the MISP attribute type.\n\nFor each MISP attribute type, an attribute is created.\nAttribute fields that are imported are the following: value, type, category, to-ids, distribution, comment, tag.",
   "references": ["https://tools.ietf.org/html/rfc4180", "https://tools.ietf.org/html/rfc7111"],
   "input": "CSV format file.",
-  "output": "MISP attributes"
+  "output": "MISP Event attributes"
 }

doc/import_doc/cuckooimport.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import Cuckoo JSON."
+  "description": "Module to import Cuckoo JSON.",
+  "requirements": [],
+  "features": "The module simply imports MISP Attributes from a Cuckoo JSON format file. There is thus no special feature to make it work.",
+  "references": ["https://cuckoosandbox.org/", "https://github.com/cuckoosandbox/cuckoo"],
+  "input": "Cuckoo JSON file",
+  "output": "MISP Event attributes"
 }

doc/import_doc/email_import.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import emails in MISP."
+  "description": "Module to import emails in MISP.",
+  "requirements": [],
+  "features": "This module can be used to import e-mail text as well as attachments and urls.\n3 configuration parameters are then used to unzip attachments, guess zip attachment passwords, and extract urls: set each one of them to True or False to process or not the respective corresponding actions.",
+  "references": [],
+  "input": "E-mail file",
+  "output": "MISP Event attributes"
 }

doc/import_doc/mispjson.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import MISP JSON format for merging MISP events."
+  "description": "Module to import MISP JSON format for merging MISP events.",
+  "requirements": [],
+  "features": "The module simply imports MISP Attributes from an other MISP Event in order to merge events together. There is thus no special feature to make it work.",
+  "references": [],
+  "input": "MISP Event",
+  "output": "MISP Event attributes"
 }

doc/import_doc/ocr.json

@@ -1,3 +1,8 @@
 {
-    "description": "Optical Character Recognition (OCR) module for MISP."
+  "description": "Optical Character Recognition (OCR) module for MISP.",
+  "requirements": [],
+  "features": "The module tries to recognize some text from an image and import the result as a freetext attribute, there is then no special feature asked to users to make it work.",
+  "references": [],
+  "input": "Image",
+  "output": "freetext MISP attribute"
 }

doc/import_doc/openiocimport.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import OpenIOC packages."
+  "description": "Module to import OpenIOC packages.",
+  "requirements": ["PyMISP"],
+  "features": "The module imports MISP Attributes from OpenIOC packages, there is then no special feature for users to make it work.",
+  "references": ["https://www.fireeye.com/blog/threat-research/2013/10/openioc-basics.html"],
+  "input": "OpenIOC packages",
+  "output": "MISP Event attributes"
 }

doc/import_doc/stiximport.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import some stix stuff."
+  "description": "Module to import some stix stuff.",
+  "requirements": ["stix"],
+  "features": "The module imports MISP Attributes from a STIX 1 file, using the stix library, there is thus no special feature for users to make it work.",
+  "references": ["https://oasis-open.github.io/cti-documentation/", "https://github.com/STIXProject/python-stix"],
+  "input": "STIX format file",
+  "output": "MISP Event attributes"
 }

doc/import_doc/threatanalyzer_import.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import ThreatAnalyzer archive.zip / analysis.json files."
+  "description": "Module to import ThreatAnalyzer archive.zip / analysis.json files.",
+  "requirements": [],
+  "features": "The module imports MISP Attributes from a ThreatAnalyzer format file. This file can be either ZIP, or JSON format.\nThere is by the way no special feature for users to make the module work.",
+  "references": ["https://www.threattrack.com/malware-analysis.aspx"],
+  "input": "ThreatAnalyzer format file",
+  "output": "MISP Event attributes"
 }

doc/import_doc/vmray_import.json

@@ -1,3 +1,8 @@
 {
-    "description": "Module to import VMRay (VTI) results."
+  "description": "Module to import VMRay (VTI) results.",
+  "requirements": ["vmray_rest_api"],
+  "features": "The module imports MISP Attributes from VMRay format, using the VMRay api.\nUsers should then provide as the module configuration the API Key as well as the server url in order to fetch their data to import.",
+  "references": ["https://www.vmray.com/"],
+  "input": "VMRay format",
+  "output": "MISP Event attributes"
 }