mirror of https://github.com/MISP/misp-modules
chg: [doc] updated
parent
e18ac776bb
commit
e8cb47a8c7
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,247 @@
|
|||
|
||||
#### [cef_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/cef_export.py)
|
||||
|
||||
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.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>Common Event Format file
|
||||
- **references**:
|
||||
>https://community.softwaregrp.com/t5/ArcSight-Connectors/ArcSight-Common-Event-Format-CEF-Guide/ta-p/1589306?attachment-id=65537
|
||||
|
||||
-----
|
||||
|
||||
#### [cisco_firesight_manager_ACL_rule_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/cisco_firesight_manager_ACL_rule_export.py)
|
||||
|
||||
<img src=../logos/cisco.png height=60>
|
||||
|
||||
Module to export malicious network activity attributes to Cisco fireSIGHT manager block rules.
|
||||
- **features**:
|
||||
>The module goes through the attributes to find all the network activity ones in order to create block rules for the Cisco fireSIGHT manager.
|
||||
- **input**:
|
||||
>Network activity attributes (IPs, URLs).
|
||||
- **output**:
|
||||
>Cisco fireSIGHT manager block rules.
|
||||
- **requirements**:
|
||||
>Firesight manager console credentials
|
||||
|
||||
-----
|
||||
|
||||
#### [defender_endpoint_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/defender_endpoint_export.py)
|
||||
|
||||
<img src=../logos/defender_endpoint.png height=60>
|
||||
|
||||
Defender for Endpoint KQL hunting query export module
|
||||
- **features**:
|
||||
>This module export an event as Defender for Endpoint KQL queries that can then be used in your own python3 or Powershell tool. If you are using Microsoft Sentinel, you can directly connect your MISP instance to Sentinel and then create queries using the `ThreatIntelligenceIndicator` table to match events against imported IOC.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>Defender for Endpoint KQL queries
|
||||
- **references**:
|
||||
>https://docs.microsoft.com/en-us/windows/security/threat-protection/microsoft-defender-atp/advanced-hunting-schema-reference
|
||||
|
||||
-----
|
||||
|
||||
#### [goamlexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/goamlexport.py)
|
||||
|
||||
<img src=../logos/goAML.jpg height=60>
|
||||
|
||||
This module is used to export MISP events containing transaction objects into GoAML format.
|
||||
- **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.
|
||||
- **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).
|
||||
- **references**:
|
||||
>http://goaml.unodc.org/
|
||||
- **requirements**:
|
||||
> - PyMISP
|
||||
> - MISP objects
|
||||
|
||||
-----
|
||||
|
||||
#### [liteexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/liteexport.py)
|
||||
|
||||
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
|
||||
|
||||
-----
|
||||
|
||||
#### [mass_eql_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/mass_eql_export.py)
|
||||
|
||||
<img src=../logos/eql.png height=60>
|
||||
|
||||
Mass EQL query export for a MISP event.
|
||||
- **features**:
|
||||
>This module produces EQL queries for all relevant attributes in a MISP event.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>Text file containing one or more EQL queries
|
||||
- **references**:
|
||||
>https://eql.readthedocs.io/en/latest/
|
||||
|
||||
-----
|
||||
|
||||
#### [nexthinkexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/nexthinkexport.py)
|
||||
|
||||
<img src=../logos/nexthink.svg height=60>
|
||||
|
||||
Nexthink NXQL query export module
|
||||
- **features**:
|
||||
>This module export an event as Nexthink NXQL queries that can then be used in your own python3 tool or from wget/powershell
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>Nexthink NXQL queries
|
||||
- **references**:
|
||||
>https://doc.nexthink.com/Documentation/Nexthink/latest/APIAndIntegrations/IntroducingtheWebAPIV2
|
||||
|
||||
-----
|
||||
|
||||
#### [osqueryexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/osqueryexport.py)
|
||||
|
||||
<img src=../logos/osquery.png height=60>
|
||||
|
||||
OSQuery export of a MISP event.
|
||||
- **features**:
|
||||
>This module export an event as osquery queries that can be used in packs or in fleet management solution like Kolide.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>osquery SQL queries
|
||||
|
||||
-----
|
||||
|
||||
#### [pdfexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/pdfexport.py)
|
||||
|
||||
Simple export of a MISP event to PDF.
|
||||
- **features**:
|
||||
>The module takes care of the PDF file building, and work with any MISP Event. Except the requirement of reportlab, used to create the file, there is no special feature concerning the Event. Some parameters can be given through the config dict. 'MISP_base_url_for_dynamic_link' is your MISP URL, to attach an hyperlink to your event on your MISP instance from the PDF. Keep it clear to avoid hyperlinks in the generated pdf.
|
||||
> 'MISP_name_for_metadata' is your CERT or MISP instance name. Used as text in the PDF' metadata
|
||||
> 'Activate_textual_description' is a boolean (True or void) to activate the textual description/header abstract of an event
|
||||
> 'Activate_galaxy_description' is a boolean (True or void) to activate the description of event related galaxies.
|
||||
> 'Activate_related_events' is a boolean (True or void) to activate the description of related event. Be aware this might leak information on confidential events linked to the current event !
|
||||
> 'Activate_internationalization_fonts' is a boolean (True or void) to activate Noto fonts instead of default fonts (Helvetica). This allows the support of CJK alphabet. Be sure to have followed the procedure to download Noto fonts (~70Mo) in the right place (/tools/pdf_fonts/Noto_TTF), to allow PyMisp to find and use them during PDF generation.
|
||||
> 'Custom_fonts_path' is a text (path or void) to the TTF file of your choice, to create the PDF with it. Be aware the PDF won't support bold/italic/special style anymore with this option
|
||||
- **input**:
|
||||
>MISP Event
|
||||
- **output**:
|
||||
>MISP Event in a PDF file.
|
||||
- **references**:
|
||||
>https://acrobat.adobe.com/us/en/acrobat/about-adobe-pdf.html
|
||||
- **requirements**:
|
||||
> - PyMISP
|
||||
> - reportlab
|
||||
|
||||
-----
|
||||
|
||||
#### [testexport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/testexport.py)
|
||||
|
||||
Skeleton export module.
|
||||
|
||||
-----
|
||||
|
||||
#### [threatStream_misp_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/threatStream_misp_export.py)
|
||||
|
||||
<img src=../logos/threatstream.png height=60>
|
||||
|
||||
Module to export a structured CSV file for uploading to 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.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>ThreatStream CSV format file
|
||||
- **references**:
|
||||
> - https://www.anomali.com/platform/threatstream
|
||||
> - https://github.com/threatstream
|
||||
- **requirements**:
|
||||
>csv
|
||||
|
||||
-----
|
||||
|
||||
#### [threat_connect_export](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/threat_connect_export.py)
|
||||
|
||||
<img src=../logos/threatconnect.png height=60>
|
||||
|
||||
Module to export a structured CSV file for uploading to ThreatConnect.
|
||||
- **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.
|
||||
- **input**:
|
||||
>MISP Event attributes
|
||||
- **output**:
|
||||
>ThreatConnect CSV format file
|
||||
- **references**:
|
||||
>https://www.threatconnect.com
|
||||
- **requirements**:
|
||||
>csv
|
||||
|
||||
-----
|
||||
|
||||
#### [virustotal_collections](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/virustotal_collections.py)
|
||||
|
||||
<img src=../logos/virustotal.png height=60>
|
||||
|
||||
Creates a VT Collection from an event iocs.
|
||||
- **features**:
|
||||
>This export module which takes advantage of a new endpoint in VT APIv3 to create VT Collections from IOCs contained in a MISP event. With this module users will be able to create a collection just using the Download as... button.
|
||||
- **input**:
|
||||
>A domain, hash (md5, sha1, sha256 or sha512), hostname, url or IP address attribute.
|
||||
- **output**:
|
||||
>A VirusTotal collection in VT.
|
||||
- **references**:
|
||||
> - https://www.virustotal.com/
|
||||
> - https://blog.virustotal.com/2021/11/introducing-virustotal-collections.html
|
||||
- **requirements**:
|
||||
>An access to the VirusTotal API (apikey).
|
||||
|
||||
-----
|
||||
|
||||
#### [vt_graph](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/export_mod/vt_graph.py)
|
||||
|
||||
<img src=../logos/virustotal.png height=60>
|
||||
|
||||
This module is used to create a VirusTotal Graph from a MISP event.
|
||||
- **features**:
|
||||
>The module takes the MISP event as input and queries the VirusTotal Graph API to create a new graph out of the event.
|
||||
>
|
||||
>Once the graph is ready, we get the url of it, which is returned so we can view it on VirusTotal.
|
||||
- **input**:
|
||||
>A MISP event.
|
||||
- **output**:
|
||||
>Link of the VirusTotal Graph created for the event.
|
||||
- **references**:
|
||||
>https://www.virustotal.com/gui/graph-overview
|
||||
- **requirements**:
|
||||
>vt_graph_api, the python library to query the VirusTotal graph API
|
||||
|
||||
-----
|
||||
|
|
@ -0,0 +1,198 @@
|
|||
|
||||
#### [cof2misp](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/cof2misp.py)
|
||||
|
||||
Passive DNS Common Output Format (COF) MISP importer
|
||||
- **features**:
|
||||
>Takes as input a valid COF file or the output of the dnsdbflex utility and creates MISP objects for the input.
|
||||
- **input**:
|
||||
>Passive DNS output in Common Output Format (COF)
|
||||
- **output**:
|
||||
>MISP objects
|
||||
- **references**:
|
||||
>https://tools.ietf.org/id/draft-dulaunoy-dnsop-passive-dns-cof-08.html
|
||||
- **requirements**:
|
||||
>PyMISP
|
||||
|
||||
-----
|
||||
|
||||
#### [csvimport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/csvimport.py)
|
||||
|
||||
Module to import MISP attributes from a csv file.
|
||||
- **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 either comes from the csv file itself or 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 or are not MISP attribute fields should be ignored in import, using a space or simply nothing between two separators (example: 'ip-src, , comment, ').
|
||||
>
|
||||
>If the csv file already contains a header that does not start by a '#', you should tick the checkbox 'has_header' to avoid importing it and have potential issues. You can also redefine the header even if it is already contained in the file, by following the rules for headers explained earlier. One reason why you would redefine a header is for instance when you want to skip some fields, or some fields are not valid types.
|
||||
- **input**:
|
||||
>CSV format file.
|
||||
- **output**:
|
||||
>MISP Event attributes
|
||||
- **references**:
|
||||
> - https://tools.ietf.org/html/rfc4180
|
||||
> - https://tools.ietf.org/html/rfc7111
|
||||
- **requirements**:
|
||||
>PyMISP
|
||||
|
||||
-----
|
||||
|
||||
#### [cuckooimport](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/cuckooimport.py)
|
||||
|
||||
<img src=../logos/cuckoo.png height=60>
|
||||
|
||||
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.
|
||||
- **input**:
|
||||
>Cuckoo JSON file
|
||||
- **output**:
|
||||
>MISP Event attributes
|
||||
- **references**:
|
||||
> - https://cuckoosandbox.org/
|
||||
> - https://github.com/cuckoosandbox/cuckoo
|
||||
|
||||
-----
|
||||
|
||||
#### [email_import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/email_import.py)
|
||||
|
||||
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](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/goamlimport.py)
|
||||
|
||||
<img src=../logos/goAML.jpg height=60>
|
||||
|
||||
Module to import MISP objects about financial transactions from GoAML files.
|
||||
- **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.
|
||||
- **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.
|
||||
- **references**:
|
||||
>http://goaml.unodc.org/
|
||||
- **requirements**:
|
||||
>PyMISP
|
||||
|
||||
-----
|
||||
|
||||
#### [joe_import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/joe_import.py)
|
||||
|
||||
<img src=../logos/joesandbox.png height=60>
|
||||
|
||||
A module to import data from a Joe Sandbox analysis json report.
|
||||
- **features**:
|
||||
>Module using the new format of modules able to return attributes and objects.
|
||||
>
|
||||
>The module returns the same results as the expansion module [joesandbox_query](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_query.py) using the submission link of the analysis to get the json report.
|
||||
- **input**:
|
||||
>Json report of a Joe Sandbox analysis.
|
||||
- **output**:
|
||||
>MISP attributes & objects parsed from the analysis report.
|
||||
- **references**:
|
||||
> - https://www.joesecurity.org
|
||||
> - https://www.joesandbox.com/
|
||||
|
||||
-----
|
||||
|
||||
#### [lastline_import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/lastline_import.py)
|
||||
|
||||
<img src=../logos/lastline.png height=60>
|
||||
|
||||
Deprecation notice: this module will be deprecated by December 2021, please use vmware_nsx module.
|
||||
|
||||
Module to import and parse reports from Lastline analysis links.
|
||||
- **features**:
|
||||
>The module requires a Lastline Portal `username` and `password`.
|
||||
>The module uses the new format and it is able to return MISP attributes and objects.
|
||||
>The module returns the same results as the [lastline_query](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/lastline_query.py) expansion module.
|
||||
- **input**:
|
||||
>Link to a Lastline analysis.
|
||||
- **output**:
|
||||
>MISP attributes and objects parsed from the analysis report.
|
||||
- **references**:
|
||||
>https://www.lastline.com
|
||||
|
||||
-----
|
||||
|
||||
#### [mispjson](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/mispjson.py)
|
||||
|
||||
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](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/ocr.py)
|
||||
|
||||
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](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/openiocimport.py)
|
||||
|
||||
Module to import OpenIOC packages.
|
||||
- **features**:
|
||||
>The module imports MISP Attributes from OpenIOC packages, there is then no special feature for users to make it work.
|
||||
- **input**:
|
||||
>OpenIOC packages
|
||||
- **output**:
|
||||
>MISP Event attributes
|
||||
- **references**:
|
||||
>https://www.fireeye.com/blog/threat-research/2013/10/openioc-basics.html
|
||||
- **requirements**:
|
||||
>PyMISP
|
||||
|
||||
-----
|
||||
|
||||
#### [threatanalyzer_import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/threatanalyzer_import.py)
|
||||
|
||||
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.
|
||||
- **input**:
|
||||
>ThreatAnalyzer format file
|
||||
- **output**:
|
||||
>MISP Event attributes
|
||||
- **references**:
|
||||
>https://www.threattrack.com/malware-analysis.aspx
|
||||
|
||||
-----
|
||||
|
||||
#### [vmray_import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/vmray_import.py)
|
||||
|
||||
<img src=../logos/vmray.png height=60>
|
||||
|
||||
Module to import VMRay (VTI) results.
|
||||
- **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.
|
||||
- **input**:
|
||||
>VMRay format
|
||||
- **output**:
|
||||
>MISP Event attributes
|
||||
- **references**:
|
||||
>https://www.vmray.com/
|
||||
- **requirements**:
|
||||
>vmray_rest_api
|
||||
|
||||
-----
|
||||
Loading…
Reference in New Issue