add: Started adding logos on documentation for each module
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "This module is used to export MISP events containing transaction objects into GoAML format.",
|
"description": "This module is used to export MISP events containing transaction objects into GoAML format.",
|
||||||
|
"logo": "logos/goAML.jpg",
|
||||||
"requirements": ["PyMISP","MISP objects"],
|
"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.",
|
"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/"],
|
"references": ["http://goaml.unodc.org/"],
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "Module to export a structured CSV file for uploading to threatStream.",
|
"description": "Module to export a structured CSV file for uploading to threatStream.",
|
||||||
|
"logo": "logos/threatstream.png",
|
||||||
"requirements": ["csv"],
|
"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.",
|
"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"],
|
"references": ["https://www.anomali.com/platform/threatstream", "https://github.com/threatstream"],
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "Module to export a structured CSV file for uploading to ThreatConnect.",
|
"description": "Module to export a structured CSV file for uploading to ThreatConnect.",
|
||||||
|
"logo": "logos/threatconnect.png",
|
||||||
"requirements": ["csv"],
|
"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.",
|
"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"],
|
"references": ["https://www.threatconnect.com"],
|
||||||
|
|
|
@ -9,12 +9,14 @@ markdown= ["# MISP modules documentation\n"]
|
||||||
for _path, title in zip(module_types, titles):
|
for _path, title in zip(module_types, titles):
|
||||||
markdown.append('\n## {}\n'.format(title))
|
markdown.append('\n## {}\n'.format(title))
|
||||||
current_path = os.path.join(root_path, _path)
|
current_path = os.path.join(root_path, _path)
|
||||||
files = os.listdir(current_path)
|
files = sorted(os.listdir(current_path))
|
||||||
for _file in files:
|
for _file in files:
|
||||||
markdown.append('\n### {}\n'.format(_file.split('.json')[0]))
|
markdown.append('\n#### {}\n'.format(_file.split('.json')[0]))
|
||||||
filename = os.path.join(current_path, _file)
|
filename = os.path.join(current_path, _file)
|
||||||
with open(filename, 'rt', encoding='utf-8') as f:
|
with open(filename, 'rt', encoding='utf-8') as f:
|
||||||
definition = json.loads(f.read())
|
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:
|
if 'description' in definition:
|
||||||
markdown.append('\n{}\n'.format(definition.pop('description')))
|
markdown.append('\n{}\n'.format(definition.pop('description')))
|
||||||
for field, value in definition.items():
|
for field, value in definition.items():
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "Module to import Cuckoo JSON.",
|
"description": "Module to import Cuckoo JSON.",
|
||||||
|
"logo": "logos/cuckoo.png",
|
||||||
"requirements": [],
|
"requirements": [],
|
||||||
"features": "The module simply imports MISP Attributes from a Cuckoo JSON format file. There is thus no special feature to make it work.",
|
"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"],
|
"references": ["https://cuckoosandbox.org/", "https://github.com/cuckoosandbox/cuckoo"],
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "Module to import MISP objects about financial transactions from GoAML files.",
|
"description": "Module to import MISP objects about financial transactions from GoAML files.",
|
||||||
|
"logo": "logos/goAML.jpg",
|
||||||
"requirements": ["PyMISP"],
|
"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.",
|
"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/",
|
"references": "http://goaml.unodc.org/",
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
{
|
{
|
||||||
"description": "Module to import VMRay (VTI) results.",
|
"description": "Module to import VMRay (VTI) results.",
|
||||||
|
"logo": "logos/vmray.png",
|
||||||
"requirements": ["vmray_rest_api"],
|
"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.",
|
"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/"],
|
"references": ["https://www.vmray.com/"],
|
||||||
|
|
After Width: | Height: | Size: 27 KiB |
After Width: | Height: | Size: 34 KiB |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 4.8 KiB |
After Width: | Height: | Size: 9.4 KiB |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 31 KiB |
After Width: | Height: | Size: 10 KiB |
After Width: | Height: | Size: 8.5 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 25 KiB |
After Width: | Height: | Size: 36 KiB |
After Width: | Height: | Size: 7.8 KiB |
After Width: | Height: | Size: 33 KiB |
After Width: | Height: | Size: 5.9 KiB |
After Width: | Height: | Size: 3.6 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 3.0 KiB |
After Width: | Height: | Size: 6.0 KiB |
After Width: | Height: | Size: 3.4 KiB |
After Width: | Height: | Size: 2.7 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 4.7 KiB |
After Width: | Height: | Size: 4.3 KiB |
After Width: | Height: | Size: 8.3 KiB |
After Width: | Height: | Size: 61 KiB |