mirror of https://github.com/MISP/misp-modules
sebdraven
GitHub
commit
55a1a61994
|
|
@ -5,3 +5,9 @@ __pycache__
|
|||
build/
|
||||
dist/
|
||||
misp_modules.egg-info/
|
||||
|
||||
# For MKDOCS
|
||||
docs/expansion*
|
||||
docs/import_mod*
|
||||
docs/export_mod*
|
||||
site*
|
||||
46
.travis.yml
46
.travis.yml
|
|
@ -6,31 +6,51 @@ services:
|
|||
cache: pip
|
||||
|
||||
python:
|
||||
- "3.4"
|
||||
- "3.5"
|
||||
- "3.5-dev"
|
||||
- "3.6"
|
||||
- "3.6-dev"
|
||||
- "3.7-dev"
|
||||
- "3.8-dev"
|
||||
|
||||
before_install:
|
||||
- docker build -t misp-modules --build-arg BUILD_DATE=$(date -u +"%Y-%m-%d") docker/
|
||||
|
||||
install:
|
||||
- pip install -U nose codecov pytest
|
||||
- pip install -U -r REQUIREMENTS
|
||||
- sudo apt-get install libzbar0 libzbar-dev libpoppler-cpp-dev tesseract-ocr libfuzzy-dev libcaca-dev liblua5.3-dev
|
||||
- pip install pipenv
|
||||
- pipenv install --dev
|
||||
# install gtcaca
|
||||
- git clone git://github.com/stricaud/gtcaca.git
|
||||
- mkdir -p gtcaca/build
|
||||
- pushd gtcaca/build
|
||||
- cmake .. && make
|
||||
- sudo make install
|
||||
- popd
|
||||
# install pyfaup
|
||||
- git clone https://github.com/stricaud/faup.git
|
||||
- pushd faup/build
|
||||
- cmake .. && make
|
||||
- sudo make install
|
||||
- popd
|
||||
- sudo ldconfig
|
||||
- pushd faup/src/lib/bindings/python
|
||||
- pip install .
|
||||
- popd
|
||||
|
||||
script:
|
||||
- coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -l 127.0.0.1 &
|
||||
- pipenv run coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -l 127.0.0.1 &
|
||||
- pid=$!
|
||||
- sleep 5
|
||||
- nosetests --with-coverage --cover-package=misp_modules
|
||||
- kill -s INT $pid
|
||||
- pipenv run nosetests --with-coverage --cover-package=misp_modules
|
||||
- kill -s KILL $pid
|
||||
- pushd ~/
|
||||
- coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -s -l 127.0.0.1 &
|
||||
- pipenv run coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -s -l 127.0.0.1 &
|
||||
- pid=$!
|
||||
- popd
|
||||
- sleep 5
|
||||
- nosetests --with-coverage --cover-package=misp_modules
|
||||
- kill -s INT $pid
|
||||
- pipenv run nosetests --with-coverage --cover-package=misp_modules
|
||||
- kill -s KILL $pid
|
||||
- pipenv run flake8 --ignore=E501,W503,E226 misp_modules
|
||||
|
||||
after_success:
|
||||
- coverage combine .coverage*
|
||||
- codecov
|
||||
- pipenv run coverage combine .coverage*
|
||||
- pipenv run codecov
|
||||
|
|
|
|||
|
|
@ -0,0 +1,34 @@
|
|||
# https://www.mkdocs.org/user-guide/deploying-your-docs/
|
||||
|
||||
.PHONY: prepare_docs generate_docs ci_generate_docs test_docs
|
||||
|
||||
prepare_docs:
|
||||
cd doc; python generate_documentation.py
|
||||
mkdir -p docs/expansion/logos docs/export_mod/logos docs/import_mod/logos
|
||||
cp -R doc/logos/* docs/expansion/logos
|
||||
cp -R doc/logos/* docs/export_mod/logos
|
||||
cp -R doc/logos/* docs/import_mod/logos
|
||||
cp LICENSE docs/license.md
|
||||
|
||||
install_requirements:
|
||||
pip install -r docs/REQUIREMENTS.txt
|
||||
|
||||
generate_docs: prepare_docs
|
||||
mkdocs build
|
||||
|
||||
deploy:
|
||||
mkdocs gh-deploy
|
||||
|
||||
test_docs: prepare_docs
|
||||
mkdocs serve
|
||||
|
||||
|
||||
# DOCKER make commands
|
||||
generate_docs_docker: prepare_docs
|
||||
docker run --rm -it -v $(PWD):/docs squidfunk/mkdocs-material build
|
||||
|
||||
deploy_docker:
|
||||
docker run --rm -it -v $(PWD):/docs -v /home/$(whoami)/.docker:/root/.docker:ro squidfunk/mkdocs-material gh-deploy
|
||||
|
||||
test_docs_docker: prepare_docs
|
||||
docker run --rm -it -p 8000:8000 -v $(PWD):/docs squidfunk/mkdocs-material
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
[[source]]
|
||||
name = "pypi"
|
||||
url = "https://pypi.org/simple"
|
||||
verify_ssl = true
|
||||
|
||||
[dev-packages]
|
||||
nose = "*"
|
||||
codecov = "*"
|
||||
pytest = "*"
|
||||
flake8 = "*"
|
||||
|
||||
[packages]
|
||||
dnspython = "*"
|
||||
requests = {extras = ["security"],version = "*"}
|
||||
urlarchiver = "*"
|
||||
passivetotal = "*"
|
||||
pypdns = "*"
|
||||
pypssl = "*"
|
||||
pyeupi = "*"
|
||||
uwhois = {editable = true,git = "https://github.com/Rafiot/uwhoisd.git",ref = "testing",subdirectory = "client"}
|
||||
pymisp = {editable = true,extras = ["fileobjects,openioc,pdfexport"],git = "https://github.com/MISP/PyMISP.git"}
|
||||
pyonyphe = {editable = true,git = "https://github.com/sebdraven/pyonyphe"}
|
||||
pydnstrails = {editable = true,git = "https://github.com/sebdraven/pydnstrails"}
|
||||
pytesseract = "*"
|
||||
pygeoip = "*"
|
||||
beautifulsoup4 = "*"
|
||||
oauth2 = "*"
|
||||
yara-python = "==3.8.1"
|
||||
sigmatools = "*"
|
||||
stix2-patterns = "*"
|
||||
maclookup = "*"
|
||||
vulners = "*"
|
||||
blockchain = "*"
|
||||
reportlab = "*"
|
||||
pyintel471 = {editable = true,git = "https://github.com/MISP/PyIntel471.git"}
|
||||
shodan = "*"
|
||||
Pillow = "*"
|
||||
Wand = "*"
|
||||
SPARQLWrapper = "*"
|
||||
domaintools_api = "*"
|
||||
misp-modules = {editable = true,path = "."}
|
||||
pybgpranking = {editable = true,git = "https://github.com/D4-project/BGP-Ranking.git/",subdirectory = "client"}
|
||||
pyipasnhistory = {editable = true,git = "https://github.com/D4-project/IPASN-History.git/",subdirectory = "client"}
|
||||
backscatter = "*"
|
||||
pyzbar = "*"
|
||||
opencv-python = "*"
|
||||
np = "*"
|
||||
ODTReader = {editable = true,git = "https://github.com/cartertemm/ODTReader.git/"}
|
||||
python-pptx = "*"
|
||||
python-docx = "*"
|
||||
ezodf = "*"
|
||||
pandas = "*"
|
||||
pandas_ods_reader = "*"
|
||||
pdftotext = "*"
|
||||
lxml = "*"
|
||||
xlrd = "*"
|
||||
idna-ssl = {markers = "python_version < '3.7'"}
|
||||
jbxapi = "*"
|
||||
geoip2 = "*"
|
||||
apiosintDS = "*"
|
||||
assemblyline_client = "*"
|
||||
vt-graph-api = "*"
|
||||
trustar = "*"
|
||||
|
||||
[requires]
|
||||
python_version = "3"
|
||||
File diff suppressed because it is too large
Load Diff
185
README.md
185
README.md
|
|
@ -11,76 +11,171 @@ without modifying core components. The API is available via a simple REST API wh
|
|||
|
||||
MISP modules support is included in MISP starting from version 2.4.28.
|
||||
|
||||
For more information: [Extending MISP with Python modules](https://www.circl.lu/assets/files/misp-training/switch2016/2-misp-modules.pdf) slides from MISP training.
|
||||
For more information: [Extending MISP with Python modules](https://www.misp-project.org/misp-training/3.1-misp-modules.pdf) slides from MISP training.
|
||||
|
||||
## Existing MISP modules
|
||||
|
||||
### Expansion modules
|
||||
|
||||
* [ASN History](misp_modules/modules/expansion/asn_history.py) - a hover and expansion module to expand an AS number with the ASN description and its history.
|
||||
* [apiosintDS](misp_modules/modules/expansion/apiosintds.py) - a hover and expansion module to query the OSINT.digitalside.it API.
|
||||
* [API Void](misp_modules/modules/expansion/apivoid.py) - an expansion and hover module to query API Void with a domain attribute.
|
||||
* [AssemblyLine submit](misp_modules/modules/expansion/assemblyline_submit.py) - an expansion module to submit samples and urls to AssemblyLine.
|
||||
* [AssemblyLine query](misp_modules/modules/expansion/assemblyline_query.py) - an expansion module to query AssemblyLine and parse the full submission report.
|
||||
* [Backscatter.io](misp_modules/modules/expansion/backscatter_io.py) - a hover and expansion module to expand an IP address with mass-scanning observations.
|
||||
* [BGP Ranking](misp_modules/modules/expansion/bgpranking.py) - a hover and expansion module to expand an AS number with the ASN description, its history, and position in BGP Ranking.
|
||||
* [RansomcoinDB check](misp_modules/modules/expansion/ransomcoindb.py) - An expansion hover module to query the [ransomcoinDB](https://ransomcoindb.concinnity-risks.com): it contains mapping between BTC addresses and malware hashes. Enrich MISP by querying for BTC -> hash or hash -> BTC addresses.
|
||||
* [BTC scam check](misp_modules/modules/expansion/btc_scam_check.py) - An expansion hover module to instantly check if a BTC address has been abused.
|
||||
* [BTC transactions](misp_modules/modules/expansion/btc_steroids.py) - An expansion hover module to get a blockchain balance and the transactions from a BTC address in MISP.
|
||||
* [Censys-enrich](misp_modules/modules/expansion/censys_enrich.py) - An expansion and module to retrieve information from censys.io about a particular IP or certificate.
|
||||
* [CIRCL Passive DNS](misp_modules/modules/expansion/circl_passivedns.py) - a hover and expansion module to expand hostname and IP addresses with passive DNS information.
|
||||
* [CIRCL Passive SSL](misp_modules/modules/expansion/circl_passivessl.py) - a hover and expansion module to expand IP addresses with the X.509 certificate seen.
|
||||
* [CIRCL Passive SSL](misp_modules/modules/expansion/circl_passivessl.py) - a hover and expansion module to expand IP addresses with the X.509 certificate(s) seen.
|
||||
* [countrycode](misp_modules/modules/expansion/countrycode.py) - a hover module to tell you what country a URL belongs to.
|
||||
* [CrowdStrike Falcon](misp_modules/modules/expansion/crowdstrike_falcon.py) - an expansion module to expand using CrowdStrike Falcon Intel Indicator API.
|
||||
* [CVE](misp_modules/modules/expansion/cve.py) - a hover module to give more information about a vulnerability (CVE).
|
||||
* [CVE advanced](misp_modules/modules/expansion/cve_advanced.py) - An expansion module to query the CIRCL CVE search API for more information about a vulnerability (CVE).
|
||||
* [Cuckoo submit](misp_modules/modules/expansion/cuckoo_submit.py) - A hover module to submit malware sample, url, attachment, domain to Cuckoo Sandbox.
|
||||
* [Cytomic Orion](misp_modules/modules/expansion/cytomic_orion.py) - An expansion module to enrich attributes in MISP and share indicators of compromise with Cytomic Orion.
|
||||
* [DBL Spamhaus](misp_modules/modules/expansion/dbl_spamhaus.py) - a hover module to check Spamhaus DBL for a domain name.
|
||||
* [DNS](misp_modules/modules/expansion/dns.py) - a simple module to resolve MISP attributes like hostname and domain to expand IP addresses attributes.
|
||||
* [docx-enrich](misp_modules/modules/expansion/docx_enrich.py) - an enrichment module to get text out of Word document into MISP (using free-text parser).
|
||||
* [DomainTools](misp_modules/modules/expansion/domaintools.py) - a hover and expansion module to get information from [DomainTools](http://www.domaintools.com/) whois.
|
||||
* [EQL](misp_modules/modules/expansion/eql.py) - an expansion module to generate event query language (EQL) from an attribute. [Event Query Language](https://eql.readthedocs.io/en/latest/)
|
||||
* [EUPI](misp_modules/modules/expansion/eupi.py) - a hover and expansion module to get information about an URL from the [Phishing Initiative project](https://phishing-initiative.eu/?lang=en).
|
||||
* [Farsight DNSDB Passive DNS](misp_modules/modules/expansion/farsight_passivedns.py) - a hover and expansion module to expand hostname and IP addresses with passive DNS information.
|
||||
* [GeoIP](misp_modules/modules/expansion/geoip_country.py) - a hover and expansion module to get GeoIP information from geolite/maxmind.
|
||||
* [GeoIP_City](misp_modules/modules/expansion/geoip_city.py) - a hover and expansion module to get GeoIP City information from geolite/maxmind.
|
||||
* [GeoIP_ASN](misp_modules/modules/expansion/geoip_asn.py) - a hover and expansion module to get GeoIP ASN information from geolite/maxmind.
|
||||
* [Greynoise](misp_modules/modules/expansion/greynoise.py) - a hover to get information from greynoise.
|
||||
* [hashdd](misp_modules/modules/expansion/hashdd.py) - a hover module to check file hashes against [hashdd.com](http://www.hashdd.com) including NSLR dataset.
|
||||
* [hibp](misp_modules/modules/expansion/hibp.py) - a hover module to lookup against Have I Been Pwned?
|
||||
* [intel471](misp_modules/modules/expansion/intel471.py) - an expansion module to get info from [Intel471](https://intel471.com).
|
||||
* [IPASN](misp_modules/modules/expansion/ipasn.py) - a hover and expansion to get the BGP ASN of an IP address.
|
||||
* [iprep](misp_modules/modules/expansion/iprep.py) - an expansion module to get IP reputation from packetmail.net.
|
||||
* [Joe Sandbox submit](misp_modules/modules/expansion/joesandbox_submit.py) - Submit files and URLs to Joe Sandbox.
|
||||
* [Joe Sandbox query](misp_modules/modules/expansion/joesandbox_query.py) - Query Joe Sandbox with the link of an analysis and get the parsed data.
|
||||
* [Lastline submit](misp_modules/modules/expansion/lastline_submit.py) - Submit files and URLs to Lastline.
|
||||
* [Lastline query](misp_modules/modules/expansion/lastline_query.py) - Query Lastline with the link to an analysis and parse the report.
|
||||
* [macaddress.io](misp_modules/modules/expansion/macaddress_io.py) - a hover module to retrieve vendor details and other information regarding a given MAC address or an OUI from [MAC address Vendor Lookup](https://macaddress.io). See [integration tutorial here](https://macaddress.io/integrations/MISP-module).
|
||||
* [macvendors](misp_modules/modules/expansion/macvendors.py) - a hover module to retrieve mac vendor information.
|
||||
* [MALWAREbazaar](misp_modules/modules/expansion/malwarebazaar.py) - an expansion module to query MALWAREbazaar with some payload.
|
||||
* [ocr-enrich](misp_modules/modules/expansion/ocr_enrich.py) - an enrichment module to get OCRized data from images into MISP.
|
||||
* [ods-enrich](misp_modules/modules/expansion/ods_enrich.py) - an enrichment module to get text out of OpenOffice spreadsheet document into MISP (using free-text parser).
|
||||
* [odt-enrich](misp_modules/modules/expansion/odt_enrich.py) - an enrichment module to get text out of OpenOffice document into MISP (using free-text parser).
|
||||
* [onyphe](misp_modules/modules/expansion/onyphe.py) - a modules to process queries on Onyphe.
|
||||
* [onyphe_full](misp_modules/modules/expansion/onyphe_full.py) - a modules to process full queries on Onyphe.
|
||||
* [OTX](misp_modules/modules/expansion/otx.py) - an expansion module for [OTX](https://otx.alienvault.com/).
|
||||
* [passivetotal](misp_modules/modules/expansion/passivetotal.py) - a [passivetotal](https://www.passivetotal.org/) module that queries a number of different PassiveTotal datasets.
|
||||
* [pdf-enrich](misp_modules/modules/expansion/pdf_enrich.py) - an enrichment module to extract text from PDF into MISP (using free-text parser).
|
||||
* [pptx-enrich](misp_modules/modules/expansion/pptx_enrich.py) - an enrichment module to get text out of PowerPoint document into MISP (using free-text parser).
|
||||
* [qrcode](misp_modules/modules/expansion/qrcode.py) - a module decode QR code, barcode and similar codes from an image and enrich with the decoded values.
|
||||
* [rbl](misp_modules/modules/expansion/rbl.py) - a module to get RBL (Real-Time Blackhost List) values from an attribute.
|
||||
* [reversedns](misp_modules/modules/expansion/reversedns.py) - Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.
|
||||
* [securitytrails](misp_modules/modules/expansion/securitytrails.py) - an expansion module for [securitytrails](https://securitytrails.com/).
|
||||
* [shodan](misp_modules/modules/expansion/shodan.py) - a minimal [shodan](https://www.shodan.io/) expansion module.
|
||||
* [Sigma queries](misp_modules/modules/expansion/sigma_queries.py) - Experimental expansion module querying a sigma rule to convert it into all the available SIEM signatures.
|
||||
* [Sigma syntax validator](misp_modules/modules/expansion/sigma_syntax_validator.py) - Sigma syntax validator.
|
||||
* [SophosLabs Intelix](misp_modules/modules/expansion/sophoslabs_intelix.py) - SophosLabs Intelix is an API for Threat Intelligence and Analysis (free tier availible). [SophosLabs](https://aws.amazon.com/marketplace/pp/B07SLZPMCS)
|
||||
* [sourcecache](misp_modules/modules/expansion/sourcecache.py) - a module to cache a specific link from a MISP instance.
|
||||
* [STIX2 pattern syntax validator](misp_modules/modules/expansion/stix2_pattern_syntax_validator.py) - a module to check a STIX2 pattern syntax.
|
||||
* [ThreatCrowd](misp_modules/modules/expansion/threatcrowd.py) - an expansion module for [ThreatCrowd](https://www.threatcrowd.org/).
|
||||
* [threatminer](misp_modules/modules/expansion/threatminer.py) - an expansion module to expand from [ThreatMiner](https://www.threatminer.org/).
|
||||
* [virustotal](misp_modules/modules/expansion/virustotal.py) - an expansion module to pull known resolutions and malware samples related with an IP/Domain from virusTotal (this modules require a VirusTotal private API key)
|
||||
* [urlhaus](misp_modules/modules/expansion/urlhaus.py) - Query urlhaus to get additional data about a domain, hash, hostname, ip or url.
|
||||
* [urlscan](misp_modules/modules/expansion/urlscan.py) - an expansion module to query [urlscan.io](https://urlscan.io).
|
||||
* [virustotal](misp_modules/modules/expansion/virustotal.py) - an expansion module to query the [VirusTotal](https://www.virustotal.com/gui/home) API with a high request rate limit required. (More details about the API: [here](https://developers.virustotal.com/reference))
|
||||
* [virustotal_public](misp_modules/modules/expansion/virustotal_public.py) - an expansion module to query the [VirusTotal](https://www.virustotal.com/gui/home) API with a public key and a low request rate limit. (More details about the API: [here](https://developers.virustotal.com/reference))
|
||||
* [VMray](misp_modules/modules/expansion/vmray_submit.py) - a module to submit a sample to VMray.
|
||||
* [VulnDB](misp_modules/modules/expansion/vulndb.py) - a module to query [VulnDB](https://www.riskbasedsecurity.com/).
|
||||
* [whois](misp_modules/modules/expansion) - a module to query a local instance of [uwhois](https://github.com/rafiot/uwhoisd).
|
||||
* [Vulners](misp_modules/modules/expansion/vulners.py) - an expansion module to expand information about CVEs using Vulners API.
|
||||
* [whois](misp_modules/modules/expansion/whois.py) - a module to query a local instance of [uwhois](https://github.com/rafiot/uwhoisd).
|
||||
* [wikidata](misp_modules/modules/expansion/wiki.py) - a [wikidata](https://www.wikidata.org) expansion module.
|
||||
* [xforce](misp_modules/modules/expansion/xforceexchange.py) - an IBM X-Force Exchange expansion module.
|
||||
* [xlsx-enrich](misp_modules/modules/expansion/xlsx_enrich.py) - an enrichment module to get text out of an Excel document into MISP (using free-text parser).
|
||||
* [YARA query](misp_modules/modules/expansion/yara_query.py) - a module to create YARA rules from single hash attributes.
|
||||
* [YARA syntax validator](misp_modules/modules/expansion/yara_syntax_validator.py) - YARA syntax validator.
|
||||
|
||||
### Export modules
|
||||
|
||||
* [CEF](misp_modules/modules/export_mod/cef_export.py) module to export Common Event Format (CEF).
|
||||
* [GoAML export](misp_modules/modules/export_mod/goamlexport.py) module to export in [GoAML format](http://goaml.unodc.org/goaml/en/index.html).
|
||||
* [Lite Export](misp_modules/modules/export_mod/liteexport.py) module to export a lite event.
|
||||
* [Simple PDF export](misp_modules/modules/export_mod/pdfexport.py) module to export in PDF (required: asciidoctor-pdf).
|
||||
* [ThreatConnect](misp_modules/modules/export_mod/threat_connect_export.py) module to export in ThreatConnect CSV format.
|
||||
* [ThreatStream](misp_modules/modules/export_mod/threatStream_misp_export.py) module to export in ThreatStream format.
|
||||
* [CEF](misp_modules/modules/export_mod/cef_export.py) - module to export Common Event Format (CEF).
|
||||
* [Cisco FireSight Manager ACL rule](misp_modules/modules/export_mod/cisco_firesight_manager_ACL_rule_export.py) - module to export as rule for the Cisco FireSight manager ACL.
|
||||
* [GoAML export](misp_modules/modules/export_mod/goamlexport.py) - module to export in [GoAML format](http://goaml.unodc.org/goaml/en/index.html).
|
||||
* [Lite Export](misp_modules/modules/export_mod/liteexport.py) - module to export a lite event.
|
||||
* [PDF export](misp_modules/modules/export_mod/pdfexport.py) - module to export an event in PDF.
|
||||
* [Mass EQL Export](misp_modules/modules/export_mod/mass_eql_export.py) - module to export applicable attributes from an event to a mass EQL query.
|
||||
* [Nexthink query format](misp_modules/modules/export_mod/nexthinkexport.py) - module to export in Nexthink query format.
|
||||
* [osquery](misp_modules/modules/export_mod/osqueryexport.py) - module to export in [osquery](https://osquery.io/) query format.
|
||||
* [ThreatConnect](misp_modules/modules/export_mod/threat_connect_export.py) - module to export in ThreatConnect CSV format.
|
||||
* [ThreatStream](misp_modules/modules/export_mod/threatStream_misp_export.py) - module to export in ThreatStream format.
|
||||
* [VirusTotal Graph](misp_modules/modules/export_mod/vt_graph.py) - Module to create a VirusTotal graph out of an event.
|
||||
|
||||
### Import modules
|
||||
|
||||
* [CSV import](misp_modules/modules/import_mod/csvimport.py) Customizable CSV import module.
|
||||
* [Cuckoo JSON](misp_modules/modules/import_mod/cuckooimport.py) Cuckoo JSON import.
|
||||
* [Email Import](misp_modules/modules/import_mod/email_import.py) Email import module for MISP to import basic metadata.
|
||||
* [GoAML import](misp_modules/modules/import_mod/) Module to import [GoAML](http://goaml.unodc.org/goaml/en/index.html) XML format.
|
||||
* [OCR](misp_modules/modules/import_mod/ocr.py) Optical Character Recognition (OCR) module for MISP to import attributes from images, scan or faxes.
|
||||
* [OpenIOC](misp_modules/modules/import_mod/openiocimport.py) OpenIOC import based on PyMISP library.
|
||||
* [CSV import](misp_modules/modules/import_mod/csvimport.py) - Customizable CSV import module.
|
||||
* [Cuckoo JSON](misp_modules/modules/import_mod/cuckooimport.py) - Cuckoo JSON import.
|
||||
* [Email Import](misp_modules/modules/import_mod/email_import.py) - Email import module for MISP to import basic metadata.
|
||||
* [GoAML import](misp_modules/modules/import_mod/goamlimport.py) - Module to import [GoAML](http://goaml.unodc.org/goaml/en/index.html) XML format.
|
||||
* [Joe Sandbox import](misp_modules/modules/import_mod/joe_import.py) - Parse data from a Joe Sandbox json report.
|
||||
* [Lastline import](misp_modules/modules/import_mod/lastline_import.py) - Module to import Lastline analysis reports.
|
||||
* [OCR](misp_modules/modules/import_mod/ocr.py) - Optical Character Recognition (OCR) module for MISP to import attributes from images, scan or faxes.
|
||||
* [OpenIOC](misp_modules/modules/import_mod/openiocimport.py) - OpenIOC import based on PyMISP library.
|
||||
* [ThreatAnalyzer](misp_modules/modules/import_mod/threatanalyzer_import.py) - An import module to process ThreatAnalyzer archive.zip/analysis.json sandbox exports.
|
||||
* [VMRay](misp_modules/modules/import_mod/vmray_import.py) - An import module to process VMRay export.
|
||||
|
||||
## How to install and start MISP modules?
|
||||
## How to install and start MISP modules in a Python virtualenv? (recommended)
|
||||
|
||||
~~~~bash
|
||||
sudo apt-get install python3-dev python3-pip libpq5 libjpeg-dev
|
||||
sudo apt-get install python3-dev python3-pip libpq5 libjpeg-dev tesseract-ocr libpoppler-cpp-dev imagemagick virtualenv libopencv-dev zbar-tools libzbar0 libzbar-dev libfuzzy-dev build-essential -y
|
||||
sudo -u www-data virtualenv -p python3 /var/www/MISP/venv
|
||||
cd /usr/local/src/
|
||||
chown -R www-data .
|
||||
sudo git clone https://github.com/MISP/misp-modules.git
|
||||
cd misp-modules
|
||||
sudo pip3 install -I -r REQUIREMENTS
|
||||
sudo pip3 install -I .
|
||||
sudo vi /etc/rc.local, add this line: `sudo -u www-data misp-modules -s &`
|
||||
misp-modules #to start the modules
|
||||
sudo -u www-data /var/www/MISP/venv/bin/pip install -I -r REQUIREMENTS
|
||||
sudo -u www-data /var/www/MISP/venv/bin/pip install .
|
||||
# Start misp-modules as a service
|
||||
sudo cp etc/systemd/system/misp-modules.service /etc/systemd/system/
|
||||
sudo systemctl daemon-reload
|
||||
sudo systemctl enable --now misp-modules
|
||||
/var/www/MISP/venv/bin/misp-modules -l 127.0.0.1 -s & #to start the modules
|
||||
~~~~
|
||||
|
||||
## How to install and start MISP modules on RHEL-based distributions ?
|
||||
As of this writing, the official RHEL repositories only contain Ruby 2.0.0 and Ruby 2.1 or higher is required. As such, this guide installs Ruby 2.2 from the [SCL](https://access.redhat.com/documentation/en-us/red_hat_software_collections/3/html/3.2_release_notes/chap-installation#sect-Installation-Subscribe) repository.
|
||||
|
||||
~~~~bash
|
||||
sudo yum install rh-ruby22
|
||||
sudo yum install openjpeg-devel
|
||||
sudo yum install rubygem-rouge rubygem-asciidoctor zbar-devel opencv-devel gcc-c++ pkgconfig poppler-cpp-devel python-devel redhat-rpm-config
|
||||
cd /var/www/MISP
|
||||
git clone https://github.com/MISP/misp-modules.git
|
||||
cd misp-modules
|
||||
sudo -u apache /usr/bin/scl enable rh-python36 "virtualenv -p python3 /var/www/MISP/venv"
|
||||
sudo -u apache /var/www/MISP/venv/bin/pip install -U -I -r REQUIREMENTS
|
||||
sudo -u apache /var/www/MISP/venv/bin/pip install -U .
|
||||
~~~~
|
||||
|
||||
Create the service file /etc/systemd/system/misp-modules.service :
|
||||
~~~~
|
||||
echo "[Unit]
|
||||
Description=MISP's modules
|
||||
After=misp-workers.service
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=apache
|
||||
Group=apache
|
||||
ExecStart=/usr/bin/scl enable rh-python36 rh-ruby22 '/var/www/MISP/venv/bin/misp-modules –l 127.0.0.1 –s'
|
||||
Restart=always
|
||||
RestartSec=10
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target" | sudo tee /etc/systemd/system/misp-modules.service
|
||||
~~~~
|
||||
|
||||
The `After=misp-workers.service` must be changed or removed if you have not created a misp-workers service.
|
||||
Then, enable the misp-modules service and start it:
|
||||
~~~~bash
|
||||
systemctl daemon-reload
|
||||
systemctl enable --now misp-modules
|
||||
~~~~
|
||||
|
||||
## How to add your own MISP modules?
|
||||
|
|
@ -93,6 +188,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
|
||||
|
|
@ -184,6 +281,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.
|
||||
|
|
@ -380,7 +490,7 @@ Recommended Plugin.Import_ocr_enabled true Enable or disable the ocr
|
|||
In this same menu set any other plugin settings that are required for testing.
|
||||
|
||||
## Install misp-module on an offline instance.
|
||||
First, you need to grab all necessery packages for example like this :
|
||||
First, you need to grab all necessary packages for example like this :
|
||||
|
||||
Use pip wheel to create an archive
|
||||
~~~
|
||||
|
|
@ -388,7 +498,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
|
||||
|
|
@ -409,7 +519,7 @@ Download a pre-built virtual image from the [MISP training materials](https://ww
|
|||
- Create a Host-Only adapter in VirtualBox
|
||||
- Set your Misp OVA to that Host-Only adapter
|
||||
- Start the virtual machine
|
||||
- Get the IP address of the virutal machine
|
||||
- Get the IP address of the virtual machine
|
||||
- SSH into the machine (Login info on training page)
|
||||
- Go into the misp-modules directory
|
||||
|
||||
|
|
@ -427,16 +537,18 @@ sudo git checkout MyModBranch
|
|||
|
||||
Remove the contents of the build directory and re-install misp-modules.
|
||||
|
||||
~~~python
|
||||
~~~bash
|
||||
sudo rm -fr build/*
|
||||
sudo pip3 install --upgrade .
|
||||
sudo -u www-data /var/www/MISP/venv/bin/pip install --upgrade .
|
||||
~~~
|
||||
|
||||
SSH in with a different terminal and run `misp-modules` with debugging enabled.
|
||||
|
||||
~~~python
|
||||
sudo killall misp-modules
|
||||
misp-modules -d
|
||||
~~~bash
|
||||
# In case misp-modules is not a service do:
|
||||
# sudo killall misp-modules
|
||||
sudo systemctl disable --now misp-modules
|
||||
sudo -u www-data /var/www/MISP/venv/bin/misp-modules -d
|
||||
~~~
|
||||
|
||||
|
||||
|
|
@ -447,3 +559,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
|
||||
|
|
|
|||
135
REQUIREMENTS
135
REQUIREMENTS
|
|
@ -1,23 +1,112 @@
|
|||
tornado
|
||||
dnspython
|
||||
requests
|
||||
urlarchiver
|
||||
passivetotal
|
||||
PyPDNS
|
||||
pypssl
|
||||
redis
|
||||
pyeupi
|
||||
ipasn-redis
|
||||
asnhistory
|
||||
git+https://github.com/Rafiot/uwhoisd.git@testing#egg=uwhois&subdirectory=client
|
||||
git+https://github.com/MISP/PyMISP.git#egg=pymisp
|
||||
git+https://github.com/sebdraven/pyonyphe#egg=pyonyphe
|
||||
pillow
|
||||
pytesseract
|
||||
SPARQLWrapper
|
||||
domaintools_api
|
||||
pygeoip
|
||||
bs4
|
||||
oauth2
|
||||
yara
|
||||
sigmatools
|
||||
-i https://pypi.org/simple
|
||||
-e .
|
||||
-e git+https://github.com/D4-project/BGP-Ranking.git/@fd9c0e03af9b61d4bf0b67ac73c7208a55178a54#egg=pybgpranking&subdirectory=client
|
||||
-e git+https://github.com/D4-project/IPASN-History.git/@fc5e48608afc113e101ca6421bf693b7b9753f9e#egg=pyipasnhistory&subdirectory=client
|
||||
-e git+https://github.com/MISP/PyIntel471.git@0df8d51f1c1425de66714b3a5a45edb69b8cc2fc#egg=pyintel471
|
||||
-e git+https://github.com/MISP/PyMISP.git@b5b40ae2c5225a4b349c26294cfc012309a61352#egg=pymisp[fileobjects,openioc,virustotal,pdfexport]
|
||||
-e git+https://github.com/Rafiot/uwhoisd.git@411572840eba4c72dc321c549b36a54ed5cea9de#egg=uwhois&subdirectory=client
|
||||
-e git+https://github.com/cartertemm/ODTReader.git/@49d6938693f6faa3ff09998f86dba551ae3a996b#egg=odtreader
|
||||
-e git+https://github.com/sebdraven/pydnstrails@48c1f740025c51289f43a24863d1845ff12fd21a#egg=pydnstrails
|
||||
-e git+https://github.com/sebdraven/pyonyphe@1ce15581beebb13e841193a08a2eb6f967855fcb#egg=pyonyphe
|
||||
-e git+https://github.com/stricaud/faup.git#egg=pyfaup&subdirectory=src/lib/bindings/python
|
||||
aiohttp==3.4.4
|
||||
antlr4-python3-runtime==4.8 ; python_version >= '3'
|
||||
apiosintds==1.8.3
|
||||
argparse==1.4.0
|
||||
assemblyline-client==3.7.3
|
||||
async-timeout==3.0.1
|
||||
attrs==19.3.0
|
||||
backscatter==0.2.4
|
||||
beautifulsoup4==4.8.2
|
||||
blockchain==1.4.4
|
||||
censys==0.0.8
|
||||
certifi==2019.11.28
|
||||
cffi==1.14.0
|
||||
chardet==3.0.4
|
||||
click-plugins==1.1.1
|
||||
click==7.1.1
|
||||
colorama==0.4.3
|
||||
cryptography==2.8
|
||||
decorator==4.4.2
|
||||
deprecated==1.2.7
|
||||
dnspython==1.16.0
|
||||
domaintools-api==0.3.3
|
||||
enum-compat==0.0.3
|
||||
ez-setup==0.9
|
||||
ezodf==0.3.2
|
||||
future==0.18.2
|
||||
futures==3.1.1
|
||||
geoip2==3.0.0
|
||||
httplib2==0.17.0
|
||||
idna-ssl==1.1.0 ; python_version < '3.7'
|
||||
idna==2.9
|
||||
importlib-metadata==1.6.0 ; python_version < '3.8'
|
||||
isodate==0.6.0
|
||||
jbxapi==3.4.0
|
||||
jsonschema==3.2.0
|
||||
lief==0.10.1
|
||||
lxml==4.5.0
|
||||
maclookup==1.0.3
|
||||
maxminddb==1.5.2
|
||||
multidict==4.7.5
|
||||
np==1.0.2
|
||||
numpy==1.18.2
|
||||
oauth2==1.9.0.post1
|
||||
opencv-python==4.2.0.32
|
||||
pandas-ods-reader==0.0.7
|
||||
pandas==1.0.3
|
||||
passivetotal==1.0.31
|
||||
pdftotext==2.1.4
|
||||
pillow==7.0.0
|
||||
progressbar2==3.50.1
|
||||
psutil==5.7.0
|
||||
pycparser==2.20
|
||||
pycryptodome==3.9.7
|
||||
pycryptodomex==3.9.7
|
||||
pydeep==0.4
|
||||
pyeupi==1.0
|
||||
pygeoip==0.3.2
|
||||
pyopenssl==19.1.0
|
||||
pyparsing==2.4.6
|
||||
pypdns==1.5.1
|
||||
pypssl==2.1
|
||||
pyrsistent==0.16.0
|
||||
pytesseract==0.3.3
|
||||
python-dateutil==2.8.1
|
||||
python-docx==0.8.10
|
||||
python-magic==0.4.15
|
||||
python-pptx==0.6.18
|
||||
python-utils==2.4.0
|
||||
pytz==2019.3
|
||||
pyyaml==5.3.1
|
||||
pyzbar==0.1.8
|
||||
pyzipper==0.3.1 ; python_version >= '3.5'
|
||||
rdflib==4.2.2
|
||||
redis==3.4.1
|
||||
reportlab==3.5.42
|
||||
requests-cache==0.5.2
|
||||
requests[security]==2.23.0
|
||||
shodan==1.22.0
|
||||
sigmatools==0.16.0
|
||||
six==1.14.0
|
||||
socketio-client==0.5.6
|
||||
soupsieve==2.0
|
||||
sparqlwrapper==1.8.5
|
||||
stix2-patterns==1.3.0
|
||||
tabulate==0.8.7
|
||||
tornado==6.0.4
|
||||
trustar==0.3.28
|
||||
url-normalize==1.4.1
|
||||
urlarchiver==0.2
|
||||
urllib3==1.25.8
|
||||
validators==0.14.0
|
||||
vt-graph-api==1.0.1
|
||||
vulners==1.5.5
|
||||
wand==0.5.9
|
||||
websocket-client==0.57.0
|
||||
wrapt==1.12.1
|
||||
xlrd==1.2.0
|
||||
xlsxwriter==1.2.8
|
||||
yara-python==3.8.1
|
||||
yarl==1.4.2
|
||||
zipp==3.1.0
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "On demand query API for OSINT.digitalside.it project.",
|
||||
"requirements": ["The apiosintDS python library to query the OSINT.digitalside.it API."],
|
||||
"input": "A domain, ip, url or hash attribute.",
|
||||
"output": "Hashes and urls resulting from the query to OSINT.digitalside.it",
|
||||
"references": ["https://osint.digitalside.it/#About"],
|
||||
"features": "The module simply queries the API of OSINT.digitalside.it with a domain, ip, url or hash attribute.\n\nThe result of the query is then parsed to extract additional hashes or urls. A module parameters also allows to parse the hashes related to the urls.\n\nFurthermore, it is possible to cache the urls and hashes collected over the last 7 days by OSINT.digitalside.it"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to query APIVoid with some domain attributes.",
|
||||
"logo": "logos/apivoid.png",
|
||||
"requirements": ["A valid APIVoid API key with enough credits to proceed 2 queries"],
|
||||
"input": "A domain attribute.",
|
||||
"output": "DNS records and SSL certificates related to the domain.",
|
||||
"features": "This module takes a domain name and queries API Void to get the related DNS records and the SSL certificates. It returns then those pieces of data as MISP objects that can be added to the event.\n\nTo make it work, a valid API key and enough credits to proceed 2 queries (0.06 + 0.07 credits) are required.",
|
||||
"references": ["https://www.apivoid.com/"]
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "A module tu query the AssemblyLine API with a submission ID to get the submission report and parse it.",
|
||||
"logo": "logos/assemblyline.png",
|
||||
"requirements": ["assemblyline_client: Python library to query the AssemblyLine rest API."],
|
||||
"input": "Link of an AssemblyLine submission report.",
|
||||
"output": "MISP attributes & objects parsed from the AssemblyLine submission.",
|
||||
"references": ["https://www.cyber.cg.ca/en/assemblyline"],
|
||||
"features": "The module requires the address of the AssemblyLine server you want to query as well as your credentials used for this instance. Credentials include the used-ID and an API key or the password associated to the user-ID.\n\nThe submission ID extracted from the submission link is then used to query AssemblyLine and get the full submission report. This report is parsed to extract file objects and the associated IPs, domains or URLs the files are connecting to.\n\nSome more data may be parsed in the future."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "A module to submit samples and URLs to AssemblyLine for advanced analysis, and return the link of the submission.",
|
||||
"logo": "logos/assemblyline.png",
|
||||
"requirements": ["assemblyline_client: Python library to query the AssemblyLine rest API."],
|
||||
"input": "Sample, or url to submit to AssemblyLine.",
|
||||
"output": "Link of the report generated in AssemblyLine.",
|
||||
"references": ["https://www.cyber.gc.ca/en/assemblyline"],
|
||||
"features": "The module requires the address of the AssemblyLine server you want to query as well as your credentials used for this instance. Credentials include the user-ID and an API key or the password associated to the user-ID.\n\nIf the sample or url is correctly submitted, you get then the link of the submission."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Query backscatter.io (https://backscatter.io/).",
|
||||
"requirements": ["backscatter python library"],
|
||||
"features": "The module takes a source or destination IP address as input and displays the information known by backscatter.io.\n\n",
|
||||
"logo": "logos/backscatter_io.png",
|
||||
"references": ["https://pypi.org/project/backscatter/"],
|
||||
"input": "IP addresses.",
|
||||
"output": "Text containing a history of the IP addresses especially on scanning based on backscatter.io information ."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Query BGP Ranking (https://bgpranking-ng.circl.lu/).",
|
||||
"requirements": ["pybgpranking python library"],
|
||||
"features": "The module takes an AS number attribute as input and displays its description and history, and position in BGP Ranking.\n\n",
|
||||
"references": ["https://github.com/D4-project/BGP-Ranking/"],
|
||||
"input": "Autonomous system number.",
|
||||
"output": "Text containing a description of the ASN, its history, and the position in BGP Ranking."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to query a special dns blacklist to check if a bitcoin address has been abused.",
|
||||
"requirements": ["dnspython3: dns python library"],
|
||||
"features": "The module queries a dns blacklist directly with the bitcoin address and get a response if the address has been abused.",
|
||||
"logo": "logos/bitcoin.png",
|
||||
"input": "btc address attribute.",
|
||||
"output" : "Text to indicate if the BTC address has been abused.",
|
||||
"references": ["https://btcblack.it/"]
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"description": "An expansion hover module to get a blockchain balance from a BTC address in MISP.",
|
||||
"logo": "logos/bitcoin.png",
|
||||
"input": "btc address attribute.",
|
||||
"output": "Text to describe the blockchain balance and the transactions related to the btc address in input."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "An expansion module to enrich attributes in MISP by quering the censys.io API",
|
||||
"requirements": ["API credentials to censys.io"],
|
||||
"input": "IP, domain or certificate fingerprint (md5, sha1 or sha256)",
|
||||
"output": "MISP objects retrieved from censys, including open ports, ASN, Location of the IP, x509 details",
|
||||
"references": ["https://www.censys.io"],
|
||||
"features": "This module takes an IP, hostname or a certificate fingerprint and attempts to enrich it by querying the Censys API."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access CIRCL Passive DNS.",
|
||||
"logo": "logos/passivedns.png",
|
||||
"requirements": ["pypdns: Passive DNS python library", "A CIRCL passive DNS account with username & password"],
|
||||
"input": "Hostname, domain, or ip-address attribute.",
|
||||
"ouput": "Passive DNS objects related to the input attribute.",
|
||||
"features": "This module takes a hostname, domain or ip-address (ip-src or ip-dst) attribute as input, and queries the CIRCL Passive DNS REST API to get the asssociated passive dns entries and return them as MISP objects.\n\nTo make it work a username and a password are thus required to authenticate to the CIRCL Passive DNS API.",
|
||||
"references": ["https://www.circl.lu/services/passive-dns/", "https://datatracker.ietf.org/doc/draft-dulaunoy-dnsop-passive-dns-cof/"]
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Modules to access CIRCL Passive SSL.",
|
||||
"logo": "logos/passivessl.png",
|
||||
"requirements": ["pypssl: Passive SSL python library", "A CIRCL passive SSL account with username & password"],
|
||||
"input": "IP address attribute.",
|
||||
"output": "x509 certificate objects seen by the IP address(es).",
|
||||
"features": "This module takes an ip-address (ip-src or ip-dst) attribute as input, and queries the CIRCL Passive SSL REST API to gather the related certificates and return the corresponding MISP objects.\n\nTo make it work a username and a password are required to authenticate to the CIRCL Passive SSL API.",
|
||||
"references": ["https://www.circl.lu/services/passive-ssl/"]
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"description": "Module to expand country codes.",
|
||||
"input": "Hostname or domain attribute.",
|
||||
"output": "Text with the country code the input belongs to.",
|
||||
"features": "The module takes a domain or a hostname as input, and returns the country it belongs to.\n\nFor non country domains, a list of the most common possible extensions is used."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to query Crowdstrike Falcon.",
|
||||
"logo": "logos/crowdstrike.png",
|
||||
"requirements": ["A CrowdStrike API access (API id & key)"],
|
||||
"input": "A MISP attribute included in the following list:\n- domain\n- email-attachment\n- email-dst\n- email-reply-to\n- email-src\n- email-subject\n- filename\n- hostname\n- ip-src\n- ip-dst\n- md5\n- mutex\n- regkey\n- sha1\n- sha256\n- uri\n- url\n- user-agent\n- whois-registrant-email\n- x509-fingerprint-md5",
|
||||
"output": "MISP attributes mapped after the CrowdStrike API has been queried, included in the following list:\n- hostname\n- email-src\n- email-subject\n- filename\n- md5\n- sha1\n- sha256\n- ip-dst\n- ip-dst\n- mutex\n- regkey\n- url\n- user-agent\n- x509-fingerprint-md5",
|
||||
"references": ["https://www.crowdstrike.com/products/crowdstrike-falcon-faq/"],
|
||||
"features": "This module takes a MISP attribute as input to query a CrowdStrike Falcon API. The API returns then the result of the query with some types we map into compatible types we add as MISP attributes.\n\nPlease note that composite attributes composed by at least one of the input types mentionned below (domains, IPs, hostnames) are also supported."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion module to submit files and URLs to Cuckoo Sandbox.",
|
||||
"logo": "logos/cuckoo.png",
|
||||
"requirements": ["Access to a Cuckoo Sandbox API and an API key if the API requires it. (api_url and api_key)"],
|
||||
"input": "A malware-sample or attachment for files. A url or domain for URLs.",
|
||||
"output": "A text field containing 'Cuckoo task id: <id>'",
|
||||
"references": ["https://cuckoosandbox.org/", "https://cuckoo.sh/docs/"],
|
||||
"features": "The module takes a malware-sample, attachment, url or domain and submits it to Cuckoo Sandbox.\n The returned task id can be used to retrieve results when the analysis completed."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "An expansion hover module to expand information about CVE id.",
|
||||
"logo": "logos/cve.png",
|
||||
"input": "Vulnerability attribute.",
|
||||
"output": "Text giving information about the CVE related to the Vulnerability.",
|
||||
"references": ["https://cve.circl.lu/", "https://cve.mitre.org/"],
|
||||
"features": "The module takes a vulnerability attribute as input and queries the CIRCL CVE search API to get information about the vulnerability as it is described in the list of CVEs."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion module to enrich attributes in MISP by quering the Cytomic Orion API",
|
||||
"logo": "logos/cytomic_orion.png",
|
||||
"requirements": ["Access (license) to Cytomic Orion"],
|
||||
"input": "MD5, hash of the sample / malware to search for.",
|
||||
"output": "MISP objects with sightings of the hash in Cytomic Orion. Includes files and machines.",
|
||||
"references": ["https://www.vanimpe.eu/2020/03/10/integrating-misp-and-cytomic-orion/", "https://www.cytomicmodel.com/solutions/"],
|
||||
"features": "This module takes an MD5 hash and searches for occurrences of this hash in the Cytomic Orion database. Returns observed files and machines."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to check Spamhaus DBL for a domain name.",
|
||||
"logo": "logos/spamhaus.jpg",
|
||||
"requirements": ["dnspython3: DNS python3 library"],
|
||||
"input": "Domain or hostname attribute.",
|
||||
"output": "Information about the nature of the input.",
|
||||
"references": ["https://www.spamhaus.org/faq/section/Spamhaus%20DBL"],
|
||||
"features": "This modules takes a domain or a hostname in input and queries the Domain Block List provided by Spamhaus to determine what kind of domain it is.\n\nDBL then returns a response code corresponding to a certain classification of the domain we display. If the queried domain is not in the list, it is also mentionned.\n\nPlease note that composite MISP attributes containing domain or hostname are supported as well."
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"description": "A simple DNS expansion service to resolve IP address from domain MISP attributes.",
|
||||
"requirements": ["dnspython3: DNS python3 library"],
|
||||
"input": "Domain or hostname attribute.",
|
||||
"output": "IP address resolving the input.",
|
||||
"features": "The module takes a domain of hostname attribute as input, and tries to resolve it. If no error is encountered, the IP address that resolves the domain is returned, otherwise the origin of the error is displayed.\n\nThe address of the DNS resolver to use is also configurable, but if no configuration is set, we use the Google public DNS address (8.8.8.8).\n\nPlease note that composite MISP attributes containing domain or hostname are supported as well."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a .docx document.",
|
||||
"logo": "logos/docx.png",
|
||||
"requirements": ["docx python library"],
|
||||
"input": "Attachment attribute containing a .docx document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a .docx document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "DomainTools MISP expansion module.",
|
||||
"logo": "logos/domaintools.png",
|
||||
"requirements": ["Domaintools python library", "A Domaintools API access (username & apikey)"],
|
||||
"input": "A MISP attribute included in the following list:\n- domain\n- hostname\n- email-src\n- email-dst\n- target-email\n- whois-registrant-email\n- whois-registrant-name\n- whois-registrant-phone\n- ip-src\n- ip-dst",
|
||||
"output": "MISP attributes mapped after the Domaintools API has been queried, included in the following list:\n- whois-registrant-email\n- whois-registrant-phone\n- whois-registrant-name\n- whois-registrar\n- whois-creation-date\n- text\n- domain",
|
||||
"references": ["https://www.domaintools.com/"],
|
||||
"features": "This module takes a MISP attribute as input to query the Domaintools API. The API returns then the result of the query with some types we map into compatible types we add as MISP attributes.\n\nPlease note that composite attributes composed by at least one of the input types mentionned below (domains, IPs, hostnames) are also supported."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "EQL query generation for a MISP attribute.",
|
||||
"logo": "logos/eql.png",
|
||||
"requirements": [],
|
||||
"input": "A filename or ip attribute.",
|
||||
"output": "Attribute containing EQL for a network or file attribute.",
|
||||
"references": ["https://eql.readthedocs.io/en/latest/"],
|
||||
"features": "This module adds a new attribute to a MISP event containing an EQL query for a network or file attribute."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "A module to query the Phishing Initiative service (https://phishing-initiative.lu).",
|
||||
"logo": "logos/eupi.png",
|
||||
"requirements": ["pyeupi: eupi python library", "An access to the Phishing Initiative API (apikey & url)"],
|
||||
"input": "A domain, hostname or url MISP attribute.",
|
||||
"output": "Text containing information about the input, resulting from the query on Phishing Initiative.",
|
||||
"references": ["https://phishing-initiative.eu/?lang=en"],
|
||||
"features": "This module takes a domain, hostname or url MISP attribute as input to query the Phishing Initiative API. The API returns then the result of the query with some information about the value queried.\n\nPlease note that composite attributes containing domain or hostname are also supported."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access Farsight DNSDB Passive DNS.",
|
||||
"logo": "logos/farsight.png",
|
||||
"requirements": ["An access to the Farsight Passive DNS API (apikey)"],
|
||||
"input": "A domain, hostname or IP address MISP attribute.",
|
||||
"output": "Text containing information about the input, resulting from the query on the Farsight Passive DNS API.",
|
||||
"references": ["https://www.farsightsecurity.com/"],
|
||||
"features": "This module takes a domain, hostname or IP address MISP attribute as input to query the Farsight Passive DNS API. The API returns then the result of the query with some information about the value queried."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to query a local copy of Maxmind's Geolite database.",
|
||||
"logo": "logos/maxmind.png",
|
||||
"requirements": ["A local copy of Maxmind's Geolite database"],
|
||||
"input": "An IP address MISP Attribute.",
|
||||
"output": "Text containing information about the location of the IP address.",
|
||||
"references": ["https://www.maxmind.com/en/home"],
|
||||
"features": "This module takes an IP address MISP attribute as input and queries a local copy of the Maxmind's Geolite database to get information about the location of this IP address.\n\nPlease note that composite attributes domain|ip are also supported."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access GreyNoise.io API",
|
||||
"logo": "logos/greynoise.png",
|
||||
"requirements": [],
|
||||
"input": "An IP address.",
|
||||
"output": "Additional information about the IP fetched from Greynoise API.",
|
||||
"references": ["https://greynoise.io/", "https://github.com/GreyNoise-Intelligence/api.greynoise.io"],
|
||||
"features": "The module takes an IP address as input and queries Greynoise for some additional information about it. The result is returned as text."
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"description": "A hover module to check hashes against hashdd.com including NSLR dataset.",
|
||||
"input": "A hash MISP attribute (md5).",
|
||||
"output": "Text describing the known level of the hash in the hashdd databases.",
|
||||
"references": ["https://hashdd.com/"],
|
||||
"features": "This module takes a hash attribute as input to check its known level, using the hashdd API. This information is then displayed."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access haveibeenpwned.com API.",
|
||||
"logo": "logos/hibp.png",
|
||||
"requirements": [],
|
||||
"input": "An email address",
|
||||
"output": "Additional information about the email address.",
|
||||
"references": ["https://haveibeenpwned.com/"],
|
||||
"features": "The module takes an email address as input and queries haveibeenpwned.com API to find additional information about it. This additional information actually tells if any account using the email address has already been compromised in a data breach."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access intelmqs eventdb.",
|
||||
"logo": "logos/intelmq.png",
|
||||
"requirements": ["psycopg2: Python library to support PostgreSQL", "An access to the IntelMQ database (username, password, hostname and database reference)"],
|
||||
"input": "A hostname, domain, IP address or AS attribute.",
|
||||
"output": "Text giving information about the input using IntelMQ database.",
|
||||
"references": ["https://github.com/certtools/intelmq", "https://intelmq.readthedocs.io/en/latest/Developers-Guide/"],
|
||||
"features": "/!\\ EXPERIMENTAL MODULE, some features may not work /!\\\n\nThis module takes a domain, hostname, IP address or Autonomous system MISP attribute as input to query the IntelMQ database. The result of the query gives then additional information about the input."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to query an IP ASN history service (https://github.com/D4-project/IPASN-History).",
|
||||
"requirements": ["pyipasnhistory: Python library to access IPASN-history instance"],
|
||||
"input": "An IP address MISP attribute.",
|
||||
"output": "Asn object(s) objects related to the IP address used as input.",
|
||||
"references": ["https://github.com/D4-project/IPASN-History"],
|
||||
"features": "This module takes an IP address attribute as input and queries the CIRCL IPASN service. The result of the query is the latest asn related to the IP address, that is returned as a MISP object."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to query IPRep data for IP addresses.",
|
||||
"requirements": ["An access to the packetmail API (apikey)"],
|
||||
"input": "An IP address MISP attribute.",
|
||||
"output": "Text describing additional information about the input after a query on the IPRep API.",
|
||||
"references": ["https://github.com/mahesh557/packetmail"],
|
||||
"features": "This module takes an IP address attribute as input and queries the database from packetmail.net to get some information about the reputation of the IP."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Query Joe Sandbox API with a submission url to get the json report and extract its data that is parsed and converted into MISP attributes and objects.\n\nThis url can by the way come from the result of the [joesandbox_submit expansion module](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_submit.py).",
|
||||
"logo": "logos/joesandbox.png",
|
||||
"requirements": ["jbxapi: Joe Sandbox API python3 library"],
|
||||
"input": "Link of a Joe Sandbox sample or url submission.",
|
||||
"output": "MISP attributes & objects parsed from the analysis report.",
|
||||
"references": ["https://www.joesecurity.org", "https://www.joesandbox.com/"],
|
||||
"features": "Module using the new format of modules able to return attributes and objects.\n\nThe module returns the same results as the import module [joe_import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/joe_import.py) taking directly the json report as input.\n\nEven if the introspection will allow all kinds of links to call this module, obviously only the ones presenting a sample or url submission in the Joe Sandbox API will return results.\n\nTo make it work you will need to fill the 'apikey' configuration with your Joe Sandbox API key and provide a valid link as input."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "A module to submit files or URLs to Joe Sandbox for an advanced analysis, and return the link of the submission.",
|
||||
"logo": "logos/joesandbox.png",
|
||||
"requirements": ["jbxapi: Joe Sandbox API python3 library"],
|
||||
"input": "Sample, url (or domain) to submit to Joe Sandbox for an advanced analysis.",
|
||||
"output": "Link of the report generated in Joe Sandbox.",
|
||||
"references": ["https://www.joesecurity.org", "https://www.joesandbox.com/"],
|
||||
"features": "The module requires a Joe Sandbox API key to submit files or URL, and returns the link of the submitted analysis.\n\nIt is then possible, when the analysis is completed, to query the Joe Sandbox API to get the data related to the analysis, using the [joesandbox_query module](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_query.py) directly on this submission link."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Query Lastline with an analysis link and parse the report into MISP attributes and objects.\nThe analysis link can also be retrieved from the output of the [lastline_submit](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/lastline_submit.py) expansion module.",
|
||||
"logo": "logos/lastline.png",
|
||||
"requirements": [],
|
||||
"input": "Link to a Lastline analysis.",
|
||||
"output": "MISP attributes and objects parsed from the analysis report.",
|
||||
"references": ["https://www.lastline.com"],
|
||||
"features": "The module requires a Lastline Portal `username` and `password`.\nThe module uses the new format and it is able to return MISP attributes and objects.\nThe module returns the same results as the [lastline_import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/lastline_import.py) import module."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to submit a file or URL to Lastline.",
|
||||
"logo": "logos/lastline.png",
|
||||
"requirements": [],
|
||||
"input": "File or URL to submit to Lastline.",
|
||||
"output": "Link to the report generated by Lastline.",
|
||||
"references": ["https://www.lastline.com"],
|
||||
"features": "The module requires a Lastline Analysis `api_token` and `key`.\nWhen the analysis is completed, it is possible to import the generated report by feeding the analysis link to the [lastline_query](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/lastline_query.py) module."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "MISP hover module for macaddress.io",
|
||||
"logo": "logos/macaddress_io.png",
|
||||
"requirements": ["maclookup: macaddress.io python library", "An access to the macaddress.io API (apikey)"],
|
||||
"input": "MAC address MISP attribute.",
|
||||
"output": "Text containing information on the MAC address fetched from a query on macaddress.io.",
|
||||
"references": ["https://macaddress.io/", "https://github.com/CodeLineFi/maclookup-python"],
|
||||
"features": "This module takes a MAC address attribute as input and queries macaddress.io for additional information.\n\nThis information contains data about:\n- MAC address details\n- Vendor details\n- Block details"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to access Macvendors API.",
|
||||
"logo": "logos/macvendors.png",
|
||||
"requirements": [],
|
||||
"input": "A MAC address.",
|
||||
"output": "Additional information about the MAC address.",
|
||||
"references": ["https://macvendors.com/", "https://macvendors.com/api"],
|
||||
"features": "The module takes a MAC address as input and queries macvendors.com for some information about it. The API returns the name of the vendor related to the address."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Query the MALWAREbazaar API to get additional information about the input hash attribute.",
|
||||
"requirements": [],
|
||||
"input": "A hash attribute (md5, sha1 or sha256).",
|
||||
"output": "File object(s) related to the input attribute found on MALWAREbazaar databases.",
|
||||
"references": ["https://bazaar.abuse.ch/"],
|
||||
"features": "The module takes a hash attribute as input and queries MALWAREbazaar's API to fetch additional data about it. The result, if the payload is known on the databases, is at least one file object describing the file the input hash is related to.\n\nThe module is using the new format of modules able to return object since the result is one or multiple MISP object(s)."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to process some optical character recognition on pictures.",
|
||||
"requirements": ["cv2: The OpenCV python library."],
|
||||
"input": "A picture attachment.",
|
||||
"output": "Text and freetext fetched from the input picture.",
|
||||
"references": [],
|
||||
"features": "The module takes an attachment attributes as input and process some optical character recognition on it. The text found is then passed to the Freetext importer to extract potential IoCs."
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a .ods document.",
|
||||
"logo": "logos/ods.png",
|
||||
"requirements": ["ezodf: Python package to create/manipulate OpenDocumentFormat files.",
|
||||
"pandas_ods_reader: Python library to read in ODS files."],
|
||||
"input": "Attachment attribute containing a .ods document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a .ods document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a .odt document.",
|
||||
"logo": "logos/odt.png",
|
||||
"requirements": ["ODT reader python library."],
|
||||
"input": "Attachment attribute containing a .odt document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a .odt document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to process a query on Onyphe.",
|
||||
"logo": "logos/onyphe.jpg",
|
||||
"requirements": ["onyphe python library", "An access to the Onyphe API (apikey)"],
|
||||
"input": "A domain, hostname or IP address MISP attribute.",
|
||||
"output": "MISP attributes fetched from the Onyphe query.",
|
||||
"references": ["https://www.onyphe.io/", "https://github.com/sebdraven/pyonyphe"],
|
||||
"features": "This module takes a domain, hostname, or IP address attribute as input in order to query the Onyphe API. Data fetched from the query is then parsed and MISP attributes are extracted."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to process a full query on Onyphe.",
|
||||
"logo": "logos/onyphe.jpg",
|
||||
"requirements": ["onyphe python library", "An access to the Onyphe API (apikey)"],
|
||||
"input": "A domain, hostname or IP address MISP attribute.",
|
||||
"output": "MISP attributes fetched from the Onyphe query.",
|
||||
"references": ["https://www.onyphe.io/", "https://github.com/sebdraven/pyonyphe"],
|
||||
"features": "This module takes a domain, hostname, or IP address attribute as input in order to query the Onyphe API. Data fetched from the query is then parsed and MISP attributes are extracted.\n\nThe parsing is here more advanced than the one on onyphe module, and is returning more attributes, since more fields of the query result are watched and parsed."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to get information from AlienVault OTX.",
|
||||
"logo": "logos/otx.png",
|
||||
"requirements": ["An access to the OTX API (apikey)"],
|
||||
"input": "A MISP attribute included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- md5\n- sha1\n- sha256\n- sha512",
|
||||
"output": "MISP attributes mapped from the result of the query on OTX, included in the following list:\n- domain\n- ip-src\n- ip-dst\n- text\n- md5\n- sha1\n- sha256\n- sha512\n- email",
|
||||
"references": ["https://www.alienvault.com/open-threat-exchange"],
|
||||
"features": "This module takes a MISP attribute as input to query the OTX Alienvault API. The API returns then the result of the query with some types we map into compatible types we add as MISP attributes."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "",
|
||||
"logo": "logos/passivetotal.png",
|
||||
"requirements": ["Passivetotal python library", "An access to the PassiveTotal API (apikey)"],
|
||||
"input": "A MISP attribute included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- x509-fingerprint-sha1\n- email-src\n- email-dst\n- target-email\n- whois-registrant-email\n- whois-registrant-phone\n- text\n- whois-registrant-name\n- whois-registrar\n- whois-creation-date",
|
||||
"output": "MISP attributes mapped from the result of the query on PassiveTotal, included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- x509-fingerprint-sha1\n- email-src\n- email-dst\n- target-email\n- whois-registrant-email\n- whois-registrant-phone\n- text\n- whois-registrant-name\n- whois-registrar\n- whois-creation-date\n- md5\n- sha1\n- sha256\n- link",
|
||||
"references": ["https://www.passivetotal.org/register"],
|
||||
"features": "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"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a PDF document.",
|
||||
"logo": "logos/pdf.jpg",
|
||||
"requirements": ["pdftotext: Python library to extract text from PDF."],
|
||||
"input": "Attachment attribute containing a PDF document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a PDF document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a .pptx document.",
|
||||
"logo": "logos/pptx.png",
|
||||
"requirements": ["pptx: Python library to read PowerPoint files."],
|
||||
"input": "Attachment attribute containing a .pptx document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a .pptx document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to decode QR codes.",
|
||||
"requirements": ["cv2: The OpenCV python library.",
|
||||
"pyzbar: Python library to read QR codes."],
|
||||
"input": "A QR code stored as attachment attribute.",
|
||||
"output": "The URL or bitcoin address the QR code is pointing to.",
|
||||
"references": [],
|
||||
"features": "The module reads the QR code and returns the related address, which can be an URL or a bitcoin address."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to check an IPv4 address against known RBLs.",
|
||||
"requirements": ["dnspython3: DNS python3 library"],
|
||||
"input": "IP address attribute.",
|
||||
"output": "Text with additional data from Real-time Blackhost Lists about the IP address.",
|
||||
"references": ["[RBLs list](https://github.com/MISP/misp-modules/blob/8817de476572a10a9c9d03258ec81ca70f3d926d/misp_modules/modules/expansion/rbl.py#L20)"],
|
||||
"features": "This module takes an IP address attribute as input and queries multiple know Real-time Blackhost Lists to check if they have already seen this IP address.\n\nWe display then all the information we get from those different sources."
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"description": "Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.",
|
||||
"requirements": ["DNS python library"],
|
||||
"input": "An IP address attribute.",
|
||||
"output": "Hostname attribute the input is resolved into.",
|
||||
"features": "The module takes an IP address as input and tries to find the hostname this IP address is resolved into.\n\nThe address of the DNS resolver to use is also configurable, but if no configuration is set, we use the Google public DNS address (8.8.8.8).\n\nPlease note that composite MISP attributes containing IP addresses are supported as well."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion modules for SecurityTrails.",
|
||||
"logo": "logos/securitytrails.png",
|
||||
"requirements": ["dnstrails python library", "An access to the SecurityTrails API (apikey)"],
|
||||
"input": "A domain, hostname or IP address attribute.",
|
||||
"output": "MISP attributes resulting from the query on SecurityTrails API, included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- dns-soa-email\n- whois-registrant-email\n- whois-registrant-phone\n- whois-registrant-name\n- whois-registrar\n- whois-creation-date\n- domain",
|
||||
"references": ["https://securitytrails.com/"],
|
||||
"features": "The module takes a domain, hostname or IP address attribute as input and queries the SecurityTrails API with it.\n\nMultiple parsing operations are then processed on the result of the query to extract a much information as possible.\n\nFrom this data extracted are then mapped MISP attributes."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to query on Shodan.",
|
||||
"logo": "logos/shodan.png",
|
||||
"requirements": ["shodan python library", "An access to the Shodan API (apikey)"],
|
||||
"input": "An IP address MISP attribute.",
|
||||
"output": "Text with additional data about the input, resulting from the query on Shodan.",
|
||||
"references": ["https://www.shodan.io/"],
|
||||
"features": "The module takes an IP address as input and queries the Shodan API to get some additional data about it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to display the result of sigma queries.",
|
||||
"logo": "logos/sigma.png",
|
||||
"requirements": ["Sigma python library"],
|
||||
"input": "A Sigma attribute.",
|
||||
"output": "Text displaying results of queries on the Sigma attribute.",
|
||||
"references": ["https://github.com/Neo23x0/sigma/wiki"],
|
||||
"features": "This module takes a Sigma rule attribute as input and tries all the different queries available to convert it into different formats recognized by SIEMs."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to perform a syntax check on sigma rules.",
|
||||
"logo": "logos/sigma.png",
|
||||
"requirements": ["Sigma python library", "Yaml python library"],
|
||||
"input": "A Sigma attribute.",
|
||||
"output": "Text describing the validity of the Sigma rule.",
|
||||
"references": ["https://github.com/Neo23x0/sigma/wiki"],
|
||||
"features": "This module takes a Sigma rule attribute as input and performs a syntax check on it.\n\nIt displays then that the rule is valid if it is the case, and the error related to the rule otherwise."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to cache web pages of analysis reports, OSINT sources. The module returns a link of the cached page.",
|
||||
"requirements": ["urlarchiver: python library to fetch and archive URL on the file-system"],
|
||||
"input": "A link or url attribute.",
|
||||
"output": "A malware-sample attribute describing the cached page.",
|
||||
"references": ["https://github.com/adulau/url_archiver"],
|
||||
"features": "This module takes a link or url attribute as input and caches the related web page. It returns then a link of the cached page."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to perform a syntax check on stix2 patterns.",
|
||||
"logo": "logos/stix.png",
|
||||
"requirements": ["stix2patterns python library"],
|
||||
"input": "A STIX2 pattern attribute.",
|
||||
"output": "Text describing the validity of the STIX2 pattern.",
|
||||
"references": ["[STIX2.0 patterning specifications](http://docs.oasis-open.org/cti/stix/v2.0/cs01/part5-stix-patterning/stix-v2.0-cs01-part5-stix-patterning.html)"],
|
||||
"features": "This module takes a STIX2 pattern attribute as input and performs a syntax check on it.\n\nIt displays then that the rule is valid if it is the case, and the error related to the rule otherwise."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to get information from ThreatCrowd.",
|
||||
"logo": "logos/threatcrowd.png",
|
||||
"input": "A MISP attribute included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- md5\n- sha1\n- sha256\n- sha512\n- whois-registrant-email",
|
||||
"output": "MISP attributes mapped from the result of the query on ThreatCrowd, included in the following list:\n- domain\n- ip-src\n- ip-dst\n- text\n- md5\n- sha1\n- sha256\n- sha512\n- hostname\n- whois-registrant-email",
|
||||
"references": ["https://www.threatcrowd.org/"],
|
||||
"features": "This module takes a MISP attribute as input and queries ThreatCrowd with it.\n\nThe result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to get information from ThreatMiner.",
|
||||
"logo": "logos/threatminer.png",
|
||||
"input": "A MISP attribute included in the following list:\n- hostname\n- domain\n- ip-src\n- ip-dst\n- md5\n- sha1\n- sha256\n- sha512",
|
||||
"output": "MISP attributes mapped from the result of the query on ThreatMiner, included in the following list:\n- domain\n- ip-src\n- ip-dst\n- text\n- md5\n- sha1\n- sha256\n- sha512\n- ssdeep\n- authentihash\n- filename\n- whois-registrant-email\n- url\n- link",
|
||||
"references": ["https://www.threatminer.org/"],
|
||||
"features": "This module takes a MISP attribute as input and queries ThreatMiner with it.\n\nThe result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to get enrich indicators with TruSTAR.",
|
||||
"logo": "logos/trustar.png",
|
||||
"input": "Any of the following MISP attributes:\n- btc\n- domain\n- email-src\n- filename\n- hostname\n- ip-src\n- ip-dst\n- md5\n- sha1\n- sha256\n- url",
|
||||
"output": "MISP attributes enriched with indicator summary data from the TruSTAR API. Data includes a severity level score and additional source and scoring info.",
|
||||
"references": ["https://docs.trustar.co/api/v13/indicators/get_indicator_summaries.html"],
|
||||
"features": "This module enriches MISP attributes with scoring and metadata from TruSTAR.\n\nThe TruSTAR indicator summary is appended to the attributes along with links to any associated reports."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Query of the URLhaus API to get additional information about the input attribute.",
|
||||
"logo": "logos/urlhaus.png",
|
||||
"requirements": [],
|
||||
"input": "A domain, hostname, url, ip, md5 or sha256 attribute.",
|
||||
"output": "MISP attributes & objects fetched from the result of the URLhaus API query.",
|
||||
"references": ["https://urlhaus.abuse.ch/"],
|
||||
"features": "Module using the new format of modules able to return attributes and objects.\n\nThe module takes one of the attribute type specified as input, and query the URLhaus API with it. If any result is returned by the API, attributes and objects are created accordingly."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion module to query urlscan.io.",
|
||||
"logo": "logos/urlscan.jpg",
|
||||
"requirements": ["An access to the urlscan.io API"],
|
||||
"input": "A domain, hostname or url attribute.",
|
||||
"output": "MISP attributes mapped from the result of the query on urlscan.io.",
|
||||
"references": ["https://urlscan.io/"],
|
||||
"features": "This module takes a MISP attribute as input and queries urlscan.io with it.\n\nThe result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to get advanced information from virustotal.",
|
||||
"logo": "logos/virustotal.png",
|
||||
"requirements": ["An access to the VirusTotal API (apikey), with a high request rate limit."],
|
||||
"input": "A domain, hash (md5, sha1, sha256 or sha512), hostname or IP address attribute.",
|
||||
"output": "MISP attributes and objects resulting from the parsing of the VirusTotal report concerning the input attribute.",
|
||||
"references": ["https://www.virustotal.com/", "https://developers.virustotal.com/reference"],
|
||||
"features": "New format of modules able to return attributes and objects.\n\nA module to take a MISP attribute as input and query the VirusTotal API to get additional data about it.\n\nCompared to the [standard VirusTotal expansion module](https://github.com/MISP/misp-modules/blob/master/misp_modules/modules/expansion/virustotal_public.py), this module is made for advanced parsing of VirusTotal report, with a recursive analysis of the elements found after the first request.\n\nThus, it requires a higher request rate limit to avoid the API to return a 204 error (Request rate limit exceeded), and the data parsed from the different requests are returned as MISP attributes and objects, with the corresponding relations between each one of them."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to get information from VirusTotal.",
|
||||
"logo": "logos/virustotal.png",
|
||||
"requirements": ["An access to the VirusTotal API (apikey)"],
|
||||
"input": "A domain, hostname, ip, url or hash (md5, sha1, sha256 or sha512) attribute.",
|
||||
"output": "MISP attributes and objects resulting from the parsing of the VirusTotal report concerning the input attribute.",
|
||||
"references": ["https://www.virustotal.com", "https://developers.virustotal.com/reference"],
|
||||
"features": "New format of modules able to return attributes and objects.\n\nA module to take a MISP attribute as input and query the VirusTotal API to get additional data about it.\n\nCompared to the [more advanced VirusTotal expansion module](https://github.com/MISP/misp-modules/blob/master/misp_modules/modules/expansion/virustotal.py), this module is made for VirusTotal users who have a low request rate limit.\n\nThus, it only queries the API once and returns the results that is parsed into MISP attributes and objects."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to submit a sample to VMRay.",
|
||||
"logo": "logos/vmray.png",
|
||||
"requirements": ["An access to the VMRay API (apikey & url)"],
|
||||
"input": "An attachment or malware-sample attribute.",
|
||||
"output": "MISP attributes mapped from the result of the query on VMRay API, included in the following list:\n- text\n- sha1\n- sha256\n- md5\n- link",
|
||||
"references": ["https://www.vmray.com/"],
|
||||
"features": "This module takes an attachment or malware-sample attribute as input to query the VMRay API.\n\nThe sample contained within the attribute in then enriched with data from VMRay mapped into MISP attributes."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to query VulnDB (RiskBasedSecurity.com).",
|
||||
"logo": "logos/vulndb.png",
|
||||
"requirements": ["An access to the VulnDB API (apikey, apisecret)"],
|
||||
"input": "A vulnerability attribute.",
|
||||
"output": "Additional data enriching the CVE input, fetched from VulnDB.",
|
||||
"references": ["https://vulndb.cyberriskanalytics.com/"],
|
||||
"features": "This module takes a vulnerability attribute as input and queries VulnDB in order to get some additional data about it.\n\nThe API gives the result of the query which can be displayed in the screen, and/or mapped into MISP attributes to add in the event."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to expand information about CVE id using Vulners API.",
|
||||
"logo": "logos/vulners.png",
|
||||
"requirements": ["Vulners python library", "An access to the Vulners API"],
|
||||
"input": "A vulnerability attribute.",
|
||||
"output": "Text giving additional information about the CVE in input.",
|
||||
"references": ["https://vulners.com/"],
|
||||
"features": "This module takes a vulnerability attribute as input and queries the Vulners API in order to get some additional data about it.\n\nThe API then returns details about the vulnerability."
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd).",
|
||||
"requirements": ["uwhois: A whois python library"],
|
||||
"input": "A domain or IP address attribute.",
|
||||
"output": "Text describing the result of a whois request for the input value.",
|
||||
"references": ["https://github.com/rafiot/uwhoisd"],
|
||||
"features": "This module takes a domain or IP address attribute as input and queries a 'Univseral Whois proxy server' to get the correct details of the Whois query on the input value (check the references for more details about this whois server)."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to extract information from Wikidata to have additional information about particular term for analysis.",
|
||||
"logo": "logos/wikidata.png",
|
||||
"requirements": ["SPARQLWrapper python library"],
|
||||
"input": "Text attribute.",
|
||||
"output": "Text attribute.",
|
||||
"references": ["https://www.wikidata.org"],
|
||||
"features": "This module takes a text attribute as input and queries the Wikidata API. If the text attribute is clear enough to define a specific term, the API returns a wikidata link in response."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion module for IBM X-Force Exchange.",
|
||||
"logo": "logos/xforce.png",
|
||||
"requirements": ["An access to the X-Force API (apikey)"],
|
||||
"input": "A MISP attribute included in the following list:\n- ip-src\n- ip-dst\n- vulnerability\n- md5\n- sha1\n- sha256",
|
||||
"output": "MISP attributes mapped from the result of the query on X-Force Exchange.",
|
||||
"references": ["https://exchange.xforce.ibmcloud.com/"],
|
||||
"features": "This module takes a MISP attribute as input to query the X-Force API. The API returns then additional information known in their threats data, that is mapped into MISP attributes."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to extract freetext from a .xlsx document.",
|
||||
"logo": "logos/xlsx.png",
|
||||
"requirements": ["pandas: Python library to perform data analysis, time series and statistics."],
|
||||
"input": "Attachment attribute containing a .xlsx document.",
|
||||
"output": "Text and freetext parsed from the document.",
|
||||
"references": [],
|
||||
"features": "The module reads the text contained in a .xlsx document. The result is passed to the freetext import parser so IoCs can be extracted out of it."
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion & hover module to translate any hash attribute into a yara rule.",
|
||||
"logo": "logos/yara.png",
|
||||
"requirements": ["yara-python python library"],
|
||||
"features": "The module takes a hash attribute (md5, sha1, sha256, imphash) as input, and is returning a YARA rule from it. This YARA rule is also validated using the same method as in 'yara_syntax_validator' module.\nBoth hover and expansion functionalities are supported with this module, where the hover part is displaying the resulting YARA rule and the expansion part allows you to add the rule as a new attribute, as usual with expansion modules.",
|
||||
"input": "MISP Hash attribute (md5, sha1, sha256, imphash, or any of the composite attribute with filename and one of the previous hash type).",
|
||||
"output": "YARA rule.",
|
||||
"references": ["https://virustotal.github.io/yara/", "https://github.com/virustotal/yara-python"]
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "An expansion hover module to perform a syntax check on if yara rules are valid or not.",
|
||||
"logo": "logos/yara.png",
|
||||
"requirements": ["yara_python python library"],
|
||||
"input": "YARA rule attribute.",
|
||||
"output": "Text to inform users if their rule is valid.",
|
||||
"references": ["http://virustotal.github.io/yara/"],
|
||||
"features": "This modules simply takes a YARA rule as input, and checks its syntax. It returns then a confirmation if the syntax is valid, otherwise the syntax error is displayed."
|
||||
}
|
||||
|
|
@ -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": "Module to export malicious network activity attributes to Cisco fireSIGHT manager block rules.",
|
||||
"logo": "logos/cisco.png",
|
||||
"requirements": ["Firesight manager console credentials"],
|
||||
"input": "Network activity attributes (IPs, URLs).",
|
||||
"output": "Cisco fireSIGHT manager block rules.",
|
||||
"references": [],
|
||||
"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."
|
||||
}
|
||||
|
|
@ -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,9 @@
|
|||
{
|
||||
"description": "Mass EQL query export for a MISP event.",
|
||||
"logo": "logos/eql.png",
|
||||
"requirements": [],
|
||||
"features": "This module produces EQL queries for all relevant attributes in a MISP event.",
|
||||
"references": ["https://eql.readthedocs.io/en/latest/"],
|
||||
"input": "MISP Event attributes",
|
||||
"output": "Text file containing one or more EQL queries"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Nexthink NXQL query export module",
|
||||
"requirements": [],
|
||||
"features": "This module export an event as Nexthink NXQL queries that can then be used in your own python3 tool or from wget/powershell",
|
||||
"references": ["https://doc.nexthink.com/Documentation/Nexthink/latest/APIAndIntegrations/IntroducingtheWebAPIV2"],
|
||||
"input": "MISP Event attributes",
|
||||
"output": "Nexthink NXQL queries",
|
||||
"logo": "logos/nexthink.svg"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "OSQuery export of a MISP event.",
|
||||
"requirements": [],
|
||||
"features": "This module export an event as osquery queries that can be used in packs or in fleet management solution like Kolide.",
|
||||
"references": [],
|
||||
"input": "MISP Event attributes",
|
||||
"output": "osquery SQL queries",
|
||||
"logo": "logos/osquery.png"
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"description": "Simple export of a MISP event to PDF.",
|
||||
"requirements": ["PyMISP", "reportlab"],
|
||||
"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.\n 'MISP_name_for_metadata' is your CERT or MISP instance name. Used as text in the PDF' metadata\n 'Activate_textual_description' is a boolean (True or void) to activate the textual description/header abstract of an event\n 'Activate_galaxy_description' is a boolean (True or void) to activate the description of event related galaxies.\n '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 !\n '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.\n '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 ",
|
||||
"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,9 @@
|
|||
{
|
||||
"description": "This module is used to create a VirusTotal Graph from a MISP event.",
|
||||
"logo": "logos/virustotal.png",
|
||||
"requirements": ["vt_graph_api, the python library to query the VirusTotal graph API"],
|
||||
"features": "The module takes the MISP event as input and queries the VirusTotal Graph API to create a new graph out of the event.\n\nOnce the graph is ready, we get the url of it, which is returned so we can view it on VirusTotal.",
|
||||
"references": ["https://www.virustotal.com/gui/graph-overview"],
|
||||
"input": "A MISP event.",
|
||||
"output": "Link of the VirusTotal Graph created for the event."
|
||||
}
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
import os
|
||||
import json
|
||||
|
||||
module_types = ['expansion', 'export_mod', 'import_mod']
|
||||
titles = ['Expansion Modules', 'Export Modules', 'Import Modules']
|
||||
markdown = ["# MISP modules documentation\n"]
|
||||
githublink = 'https://github.com/MISP/misp-modules/tree/master/misp_modules/modules'
|
||||
|
||||
|
||||
def generate_doc(root_path):
|
||||
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))
|
||||
githubpath = '{}/{}'.format(githublink, _path)
|
||||
for _file in files:
|
||||
modulename = _file.split('.json')[0]
|
||||
githubref = '{}/{}.py'.format(githubpath, modulename)
|
||||
markdown.append('\n#### [{}]({})\n'.format(modulename, githubref))
|
||||
filename = os.path.join(current_path, _file)
|
||||
with open(filename, 'rt') as f:
|
||||
definition = json.loads(f.read())
|
||||
if 'logo' in definition:
|
||||
markdown.append('\n<img src={} height=60>\n'.format(definition.pop('logo')))
|
||||
if 'description' in definition:
|
||||
markdown.append('\n{}\n'.format(definition.pop('description')))
|
||||
for field, value in sorted(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('README.md', 'w') as w:
|
||||
w.write(''.join(markdown))
|
||||
|
||||
def generate_docs_for_mkdocs(root_path):
|
||||
for _path, title in zip(module_types, titles):
|
||||
markdown = []
|
||||
#markdown.append('## {}\n'.format(title))
|
||||
current_path = os.path.join(root_path, _path)
|
||||
files = sorted(os.listdir(current_path))
|
||||
githubpath = '{}/{}'.format(githublink, _path)
|
||||
for _file in files:
|
||||
modulename = _file.split('.json')[0]
|
||||
githubref = '{}/{}.py'.format(githubpath, modulename)
|
||||
markdown.append('\n#### [{}]({})\n'.format(modulename, githubref))
|
||||
filename = os.path.join(current_path, _file)
|
||||
with open(filename, 'rt') as f:
|
||||
definition = json.loads(f.read())
|
||||
if 'logo' in definition:
|
||||
markdown.append('\n<img src={} height=60>\n'.format(definition.pop('logo')))
|
||||
if 'description' in definition:
|
||||
markdown.append('\n{}\n'.format(definition.pop('description')))
|
||||
for field, value in sorted(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(root_path+"/../"+"/docs/"+_path+".md", 'w') as w:
|
||||
w.write(''.join(markdown))
|
||||
|
||||
if __name__ == '__main__':
|
||||
root_path = os.path.dirname(os.path.realpath(__file__))
|
||||
generate_doc(root_path)
|
||||
generate_docs_for_mkdocs(root_path)
|
||||
|
|
@ -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.\n\nThis 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, ').\n\nIf 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.",
|
||||
"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,9 @@
|
|||
{
|
||||
"description": "A module to import data from a Joe Sandbox analysis json report.",
|
||||
"logo": "logos/joesandbox.png",
|
||||
"requirements": [],
|
||||
"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/"],
|
||||
"features": "Module using the new format of modules able to return attributes and objects.\n\nThe 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.\n\n"
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"description": "Module to import and parse reports from Lastline analysis links.",
|
||||
"logo": "logos/lastline.png",
|
||||
"requirements": [],
|
||||
"input": "Link to a Lastline analysis.",
|
||||
"output": "MISP attributes and objects parsed from the analysis report.",
|
||||
"references": ["https://www.lastline.com"],
|
||||
"features": "The module requires a Lastline Portal `username` and `password`.\nThe module uses the new format and it is able to return MISP attributes and objects.\nThe 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."
|
||||
}
|
||||
|
|
@ -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"
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue