Merge pull request #233 from chrisr3d/documentation

Modules documentation
pull/239/head
Christian Studer 4 years ago committed by GitHub
commit 267fbfbb7c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 13
      README.md
  2. 508
      doc/documentation.md
  3. 4
      doc/expansion/asn_history.json
  4. 4
      doc/expansion/circl_passivedns.json
  5. 4
      doc/expansion/circl_passivessl.json
  6. 3
      doc/expansion/countrycode.json
  7. 4
      doc/expansion/crowdstrike_falcon.json
  8. 3
      doc/expansion/cve.json
  9. 4
      doc/expansion/dbl_spamhaus.json
  10. 3
      doc/expansion/dns.json
  11. 4
      doc/expansion/domaintools.json
  12. 4
      doc/expansion/eupi.json
  13. 4
      doc/expansion/farsight_passivedns.json
  14. 3
      doc/expansion/geoip_country.json
  15. 3
      doc/expansion/intelmq_eventdb.json
  16. 3
      doc/expansion/ipasn.json
  17. 3
      doc/expansion/iprep.json
  18. 4
      doc/expansion/onyphe.json
  19. 4
      doc/expansion/onyphe_full.json
  20. 4
      doc/expansion/otx.json
  21. 4
      doc/expansion/passivetotal.json
  22. 4
      doc/expansion/rbl.json
  23. 3
      doc/expansion/reversedns.json
  24. 4
      doc/expansion/shodan.json
  25. 3
      doc/expansion/sourcecache.json
  26. 4
      doc/expansion/threatcrowd.json
  27. 4
      doc/expansion/threatminer.json
  28. 4
      doc/expansion/virustotal.json
  29. 4
      doc/expansion/vmray_submit.json
  30. 4
      doc/expansion/vulndb.json
  31. 4
      doc/expansion/whois.json
  32. 4
      doc/expansion/wiki.json
  33. 4
      doc/expansion/xforceexchange.json
  34. 4
      doc/expansion/yara_syntax_validator.json
  35. 8
      doc/export_mod/cef_export.json
  36. 9
      doc/export_mod/goamlexport.json
  37. 8
      doc/export_mod/liteexport.json
  38. 8
      doc/export_mod/pdfexport.json
  39. 3
      doc/export_mod/testexport.json
  40. 9
      doc/export_mod/threatStream_misp_export.json
  41. 9
      doc/export_mod/threat_connect_export.json
  42. 28
      doc/generate_documentation.py
  43. 8
      doc/import_mod/csvimport.json
  44. 9
      doc/import_mod/cuckooimport.json
  45. 8
      doc/import_mod/email_import.json
  46. 9
      doc/import_mod/goamlimport.json
  47. 8
      doc/import_mod/mispjson.json
  48. 8
      doc/import_mod/ocr.json
  49. 8
      doc/import_mod/openiocimport.json
  50. 8
      doc/import_mod/threatanalyzer_import.json
  51. 9
      doc/import_mod/vmray_import.json
  52. BIN
      doc/logos/Sigma.png
  53. BIN
      doc/logos/crowdstrike.png
  54. BIN
      doc/logos/cuckoo.png
  55. BIN
      doc/logos/domaintools.png
  56. BIN
      doc/logos/eupi.png
  57. BIN
      doc/logos/farsight.png
  58. BIN
      doc/logos/goAML.jpg
  59. BIN
      doc/logos/onyphe.jpg
  60. BIN
      doc/logos/otx.png
  61. BIN
      doc/logos/passivedns.png
  62. BIN
      doc/logos/passivessl.png
  63. BIN
      doc/logos/passivetotal.png
  64. BIN
      doc/logos/securitytrails.png
  65. BIN
      doc/logos/shodan.png
  66. BIN
      doc/logos/spamhaus.jpg
  67. BIN
      doc/logos/stix.png
  68. BIN
      doc/logos/threatconnect.png
  69. BIN
      doc/logos/threatcrowd.png
  70. BIN
      doc/logos/threatminer.png
  71. BIN
      doc/logos/threatstream.png
  72. BIN
      doc/logos/virustotal.png
  73. BIN
      doc/logos/vmray.png
  74. BIN
      doc/logos/vulndb.png
  75. BIN
      doc/logos/wikidata.png
  76. BIN
      doc/logos/xforce.png
  77. BIN
      doc/logos/yara.png

@ -393,7 +393,7 @@ mkdir misp-modules-offline
pip3 wheel -r REQUIREMENTS shodan --wheel-dir=./misp-modules-offline
tar -cjvf misp-module-bundeled.tar.bz2 ./misp-modules-offline/*
~~~
On offline machine :
On offline machine :
~~~
mkdir misp-modules-bundle
tar xvf misp-module-bundeled.tar.bz2 -C misp-modules-bundle
@ -452,3 +452,14 @@ cd tests/
curl -s http://127.0.0.1:6666/query -H "Content-Type: application/json" --data @MY_TEST_FILE.json -X POST
cd ../
~~~
## Documentation
In order to provide documentation about some modules that require specific input / output / configuration, the [doc](doc) directory contains detailed information about the general purpose, requirements, features, input and ouput of each of these modules:
- ***description** - quick description of the general purpose of the module, as the one given by the moduleinfo
- **requirements** - special libraries needed to make the module work
- **features** - description of the way to use the module, with the required MISP features to make the module give the intended result
- **references** - link(s) giving additional information about the format concerned in the module
- **input** - description of the format of data used in input
- **output** - description of the format given as the result of the module execution

@ -0,0 +1,508 @@
# MISP modules documentation
## Expansion Modules
#### asn_history
Query an ASN description history service (https://github.com/CIRCL/ASN-Description-History.git).
- **requirements**:
>asnhistory
-----
#### circl_passivedns
<img src=logos/passivedns.png height=100>
Module to access CIRCL Passive DNS.
-----
#### circl_passivessl
<img src=logos/passivessl.png height=100>
Modules to access CIRCL Passive SSL.
-----
#### countrycode
Module to expand country codes.
-----
#### crowdstrike_falcon
<img src=logos/crowdstrike.png height=100>
Module to query Crowdstrike Falcon.
-----
#### cve
An expansion hover module to expand information about CVE id.
-----
#### dbl_spamhaus
<img src=logos/spamhaus.jpg height=100>
Module to check Spamhaus DBL for a domain name.
-----
#### dns
A simple DNS expansion service to resolve IP address from MISP attributes.
-----
#### domaintools
<img src=logos/domaintools.png height=100>
DomainTools MISP expansion module.
-----
#### eupi
<img src=logos/eupi.png height=100>
A module to query the Phishing Initiative service (https://phishing-initiative.lu).
-----
#### farsight_passivedns
<img src=logos/farsight.png height=100>
Module to access Farsight DNSDB Passive DNS.
-----
#### geoip_country
Module to query a local copy of Maxminds Geolite database.
-----
#### intelmq_eventdb
Module to access intelmqs eventdb.
-----
#### ipasn
Module to query an IP ASN history service (https://github.com/CIRCL/IP-ASN-history.git).
-----
#### iprep
Module to query IPRep data for IP addresses.
-----
#### onyphe
<img src=logos/onyphe.jpg height=100>
-----
#### onyphe_full
<img src=logos/onyphe.jpg height=100>
-----
#### otx
<img src=logos/otx.png height=100>
Module to get information from AlienVault OTX.
-----
#### passivetotal
<img src=logos/passivetotal.png height=100>
The PassiveTotal MISP expansion module brings the datasets derived from Internet scanning directly into your MISP instance. This module supports passive DNS, historic SSL, WHOIS, and host attributes. In order to use the module, you must have a valid PassiveTotal account username and API key. Registration is free and can be done by visiting https://www.passivetotal.org/register
-----
#### rbl
Module to check an IPv4 address against known RBLs.
- **requirements**:
>dnspython3
-----
#### reversedns
Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.
-----
#### shodan
<img src=logos/shodan.png height=100>
Module to query on Shodan.
-----
#### sourcecache
Module to cache web pages of analysis reports, OSINT sources. The module returns a link of the cached page.
-----
#### threatcrowd
<img src=logos/threatcrowd.png height=100>
Module to get information from ThreatCrowd.
-----
#### threatminer
<img src=logos/threatminer.png height=100>
Module to get information from ThreatMiner.
-----
#### virustotal
<img src=logos/virustotal.png height=100>
Module to get information from virustotal.
-----
#### vmray_submit
<img src=logos/vmray.png height=100>
Module to submit a sample to VMRay.
-----
#### vulndb
<img src=logos/vulndb.png height=100>
Module to query VulnDB (RiskBasedSecurity.com).
-----
#### whois
Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd).
- **requirements**:
>uwhois
-----
#### wiki
<img src=logos/wikidata.png height=100>
An expansion hover module to extract information from Wikidata to have additional information about particular term for analysis.
-----
#### xforceexchange
<img src=logos/xforce.png height=100>
An expansion module for IBM X-Force Exchange.
-----
#### yara_syntax_validator
<img src=logos/yara.png height=100>
An expansion hover module to perform a syntax check on if yara rules are valid or not.
-----
## Export Modules
#### cef_export
Module to export a MISP event in CEF format.
- **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.
>Thus, 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
-----
#### goamlexport
<img src=logos/goAML.jpg height=100>
This module is used to export MISP events containing transaction objects into GoAML format.
- **requirements**:
>PyMISP, MISP objects
- **features**:
>The module works as long as there is at least one transaction object in the Event.
>
>Then in order to have a valid GoAML document, please follow these guidelines:
>- For each transaction object, use either a bank-account, person, or legal-entity object to describe the origin of the transaction, and again one of them to describe the target of the transaction.
>- Create an object reference for both origin and target objects of the transaction.
>- A bank-account object needs a signatory, which is a person object, put as object reference of the bank-account.
>- A person can have an address, which is a geolocation object, put as object reference of the person.
>
>Supported relation types for object references that are recommended for each object are the folowing:
>- transaction:
> - 'from', 'from_my_client': Origin of the transaction - at least one of them is required.
> - 'to', 'to_my_client': Target of the transaction - at least one of them is required.
> - 'address': Location of the transaction - optional.
>- bank-account:
> - 'signatory': Signatory of a bank-account - the reference from bank-account to a signatory is required, but the relation-type is optional at the moment since this reference will always describe a signatory.
> - 'entity': Entity owning the bank account - optional.
>- person:
> - 'address': Address of a person - optional.
- **references**:
>http://goaml.unodc.org/
- **input**:
>MISP objects (transaction, bank-account, person, legal-entity, geolocation), with references, describing financial transactions and their origin and target.
- **output**:
>GoAML format file, describing financial transactions, with their origin and target (bank accounts, persons or entities).
-----
#### liteexport
Lite export of a MISP event.
- **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.
- **input**:
>MISP Event attributes
- **output**:
>Lite MISP Event
-----
#### pdfexport
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.
-----
#### testexport
Skeleton export module.
-----
#### threatStream_misp_export
<img src=logos/threatstream.png height=100>
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
-----
#### threat_connect_export
<img src=logos/threatconnect.png height=100>
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.
>Users 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
-----
## Import Modules
#### csvimport
Module to import MISP attributes from a csv file.
- **requirements**:
>PyMISP
- **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.
>This 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, ').
>There 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.
>
>For each MISP attribute type, an attribute is created.
>Attribute 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 Event attributes
-----
#### cuckooimport
<img src=logos/cuckoo.png height=100>
Module to import Cuckoo JSON.
- **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
-----
#### email_import
Module to import emails in MISP.
- **features**:
>This module can be used to import e-mail text as well as attachments and urls.
>3 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.
- **input**:
>E-mail file
- **output**:
>MISP Event attributes
-----
#### goamlimport
<img src=logos/goAML.jpg height=100>
Module to import MISP objects about financial transactions from GoAML files.
- **requirements**:
>PyMISP
- **features**:
>Unlike the GoAML export module, there is here no special feature to import data from GoAML external files, since the module will import MISP Objects with their References on its own, as it is required for the export module to rebuild a valid GoAML document.
- **references**:
>http://goaml.unodc.org/
- **input**:
>GoAML format file, describing financial transactions, with their origin and target (bank accounts, persons or entities).
- **output**:
>MISP objects (transaction, bank-account, person, legal-entity, geolocation), with references, describing financial transactions and their origin and target.
-----
#### mispjson
Module to import MISP JSON format for merging MISP events.
- **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.
- **input**:
>MISP Event
- **output**:
>MISP Event attributes
-----
#### ocr
Optical Character Recognition (OCR) module for MISP.
- **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.
- **input**:
>Image
- **output**:
>freetext MISP attribute
-----
#### openiocimport
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
-----
#### threatanalyzer_import
Module to import ThreatAnalyzer archive.zip / analysis.json files.
- **features**:
>The module imports MISP Attributes from a ThreatAnalyzer format file. This file can be either ZIP, or JSON format.
>There 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
-----
#### vmray_import
<img src=logos/vmray.png height=100>
Module to import VMRay (VTI) results.
- **requirements**:
>vmray_rest_api
- **features**:
>The module imports MISP Attributes from VMRay format, using the VMRay api.
>Users 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
-----

@ -0,0 +1,4 @@
{
"description": "Query an ASN description history service (https://github.com/CIRCL/ASN-Description-History.git).",
"requirements": ["asnhistory"]
}

@ -0,0 +1,4 @@
{
"description": "Module to access CIRCL Passive DNS.",
"logo": "logos/passivedns.png"
}

@ -0,0 +1,4 @@
{
"description": "Modules to access CIRCL Passive SSL.",
"logo": "logos/passivessl.png"
}

@ -0,0 +1,3 @@
{
"description": "Module to expand country codes."
}

@ -0,0 +1,4 @@
{
"description": "Module to query Crowdstrike Falcon.",
"logo": "logos/crowdstrike.png"
}

@ -0,0 +1,3 @@
{
"description": "An expansion hover module to expand information about CVE id."
}

@ -0,0 +1,4 @@
{
"description": "Module to check Spamhaus DBL for a domain name.",
"logo": "logos/spamhaus.jpg"
}

@ -0,0 +1,3 @@
{
"description": "A simple DNS expansion service to resolve IP address from MISP attributes."
}

@ -0,0 +1,4 @@
{
"description": "DomainTools MISP expansion module.",
"logo": "logos/domaintools.png"
}

@ -0,0 +1,4 @@
{
"description": "A module to query the Phishing Initiative service (https://phishing-initiative.lu).",
"logo": "logos/eupi.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to access Farsight DNSDB Passive DNS.",
"logo": "logos/farsight.png"
}

@ -0,0 +1,3 @@
{
"description": "Module to query a local copy of Maxminds Geolite database."
}

@ -0,0 +1,3 @@
{
"description": "Module to access intelmqs eventdb."
}

@ -0,0 +1,3 @@
{
"description": "Module to query an IP ASN history service (https://github.com/CIRCL/IP-ASN-history.git)."
}

@ -0,0 +1,3 @@
{
"description": "Module to query IPRep data for IP addresses."
}

@ -0,0 +1,4 @@
{
"description": "Module to process a query on Onyphe.",
"logo": "logos/onyphe.jpg"
}

@ -0,0 +1,4 @@
{
"description": "Module to process a full query on Onyphe.",
"logo": "logos/onyphe.jpg"
}

@ -0,0 +1,4 @@
{
"description": "Module to get information from AlienVault OTX.",
"logo": "logos/otx.png"
}

@ -0,0 +1,4 @@
{
"description": "The PassiveTotal MISP expansion module brings the datasets derived from Internet scanning directly into your MISP instance. This module supports passive DNS, historic SSL, WHOIS, and host attributes. In order to use the module, you must have a valid PassiveTotal account username and API key. Registration is free and can be done by visiting https://www.passivetotal.org/register",
"logo": "logos/passivetotal.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to check an IPv4 address against known RBLs.",
"requirements": ["dnspython3"]
}

@ -0,0 +1,3 @@
{
"description": "Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes."
}

@ -0,0 +1,4 @@
{
"description": "Module to query on Shodan.",
"logo": "logos/shodan.png"
}

@ -0,0 +1,3 @@
{
"description": "Module to cache web pages of analysis reports, OSINT sources. The module returns a link of the cached page."
}

@ -0,0 +1,4 @@
{
"description": "Module to get information from ThreatCrowd.",
"logo": "logos/threatcrowd.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to get information from ThreatMiner.",
"logo": "logos/threatminer.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to get information from virustotal.",
"logo": "logos/virustotal.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to submit a sample to VMRay.",
"logo": "logos/vmray.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to query VulnDB (RiskBasedSecurity.com).",
"logo": "logos/vulndb.png"
}

@ -0,0 +1,4 @@
{
"description": "Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd).",
"requirements": ["uwhois"]
}

@ -0,0 +1,4 @@
{
"description": "An expansion hover module to extract information from Wikidata to have additional information about particular term for analysis.",
"logo": "logos/wikidata.png"
}

@ -0,0 +1,4 @@
{
"description": "An expansion module for IBM X-Force Exchange.",
"logo": "logos/xforce.png"
}

@ -0,0 +1,4 @@
{
"description": "An expansion hover module to perform a syntax check on if yara rules are valid or not.",
"logo": "logos/yara.png"
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,9 @@
{
"description": "This module is used to export MISP events containing transaction objects into GoAML format.",
"logo": "logos/goAML.jpg",
"requirements": ["PyMISP","MISP objects"],
"features": "The module works as long as there is at least one transaction object in the Event.\n\nThen in order to have a valid GoAML document, please follow these guidelines:\n- For each transaction object, use either a bank-account, person, or legal-entity object to describe the origin of the transaction, and again one of them to describe the target of the transaction.\n- Create an object reference for both origin and target objects of the transaction.\n- A bank-account object needs a signatory, which is a person object, put as object reference of the bank-account.\n- A person can have an address, which is a geolocation object, put as object reference of the person.\n\nSupported relation types for object references that are recommended for each object are the folowing:\n- transaction:\n\t- 'from', 'from_my_client': Origin of the transaction - at least one of them is required.\n\t- 'to', 'to_my_client': Target of the transaction - at least one of them is required.\n\t- 'address': Location of the transaction - optional.\n- bank-account:\n\t- 'signatory': Signatory of a bank-account - the reference from bank-account to a signatory is required, but the relation-type is optional at the moment since this reference will always describe a signatory.\n\t- 'entity': Entity owning the bank account - optional.\n- person:\n\t- 'address': Address of a person - optional.",
"references": ["http://goaml.unodc.org/"],
"input": "MISP objects (transaction, bank-account, person, legal-entity, geolocation), with references, describing financial transactions and their origin and target.",
"output": "GoAML format file, describing financial transactions, with their origin and target (bank accounts, persons or entities)."
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,8 @@
{
"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."
}

@ -0,0 +1,3 @@
{
"description": "Skeleton export module."
}

@ -0,0 +1,9 @@
{
"description": "Module to export a structured CSV file for uploading to threatStream.",
"logo": "logos/threatstream.png",
"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"
}

@ -0,0 +1,9 @@
{
"description": "Module to export a structured CSV file for uploading to ThreatConnect.",
"logo": "logos/threatconnect.png",
"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"
}

@ -0,0 +1,28 @@
# -*- coding: utf-8 -*-
import os
import json
root_path = os.path.dirname(os.path.realpath(__file__))
module_types = ['expansion', 'export_mod', 'import_mod']
titles = ['Expansion Modules', 'Export Modules', 'Import Modules']
markdown= ["# MISP modules documentation\n"]
for _path, title in zip(module_types, titles):
markdown.append('\n## {}\n'.format(title))
current_path = os.path.join(root_path, _path)
files = sorted(os.listdir(current_path))
for _file in files:
markdown.append('\n#### {}\n'.format(_file.split('.json')[0]))
filename = os.path.join(current_path, _file)
with open(filename, 'rt', encoding='utf-8') as f:
definition = json.loads(f.read())
if 'logo' in definition:
markdown.append('\n<img src={} height=100>\n'.format(definition.pop('logo')))
if 'description' in definition:
markdown.append('\n{}\n'.format(definition.pop('description')))
for field, value in definition.items():
if value:
value = ', '.join(value) if isinstance(value, list) else '{}'.format(value.replace('\n', '\n>'))
markdown.append('- **{}**:\n>{}\n'.format(field, value))
markdown.append('\n-----\n')
with open('documentation.md', 'w') as w:
w.write(''.join(markdown))

@ -0,0 +1,8 @@
{
"description": "Module to import MISP attributes from a csv file.",
"requirements": ["PyMISP"],
"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 Event attributes"
}

@ -0,0 +1,9 @@
{
"description": "Module to import Cuckoo JSON.",
"logo": "logos/cuckoo.png",
"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"
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,9 @@
{
"description": "Module to import MISP objects about financial transactions from GoAML files.",
"logo": "logos/goAML.jpg",
"requirements": ["PyMISP"],
"features": "Unlike the GoAML export module, there is here no special feature to import data from GoAML external files, since the module will import MISP Objects with their References on its own, as it is required for the export module to rebuild a valid GoAML document.",
"references": "http://goaml.unodc.org/",
"input": "GoAML format file, describing financial transactions, with their origin and target (bank accounts, persons or entities).",
"output": "MISP objects (transaction, bank-account, person, legal-entity, geolocation), with references, describing financial transactions and their origin and target."
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,8 @@
{
"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"
}

@ -0,0 +1,9 @@
{
"description": "Module to import VMRay (VTI) results.",
"logo": "logos/vmray.png",
"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"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Loading…
Cancel
Save