Merge branch 'main'

.travis.yml

@@ -17,7 +17,8 @@ before_install:
 install:
     - 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
+    - pip install -r REQUIREMENTS
+    #    - pipenv install --dev
     # install gtcaca
     - git clone git://github.com/stricaud/gtcaca.git
     - mkdir -p gtcaca/build
@@ -37,20 +38,22 @@ install:
     - popd
 
 script:
-    - pipenv run coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__  -l 127.0.0.1 &
+    - pip install coverage
+    - coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__  -l 127.0.0.1 &
     - pid=$!
     - sleep 5
-    - pipenv run nosetests --with-coverage --cover-package=misp_modules
+    - nosetests --with-coverage --cover-package=misp_modules
     - kill -s KILL $pid
     - pushd ~/
-    - pipenv run coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -s -l 127.0.0.1 &
+    - coverage run -m --parallel-mode --source=misp_modules misp_modules.__init__ -s -l 127.0.0.1 &
     - pid=$!
     - popd
     - sleep 5
-    - pipenv run nosetests --with-coverage --cover-package=misp_modules
+    - nosetests --with-coverage --cover-package=misp_modules
     - kill -s KILL $pid
-    - pipenv run flake8 --ignore=E501,W503,E226 misp_modules
+    - pip install flake8
+    - flake8 --ignore=E501,W503,E226 misp_modules
 
 after_success:
-    - pipenv run coverage combine .coverage*
-    - pipenv run codecov
+    - coverage combine .coverage*
+    - codecov

Makefile

@@ -3,12 +3,15 @@
 .PHONY: prepare_docs generate_docs ci_generate_docs test_docs
 
 prepare_docs:
-	cd doc; python generate_documentation.py
+	cd documentation; python3 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
+	mkdir -p docs/logos
+	cd documentation; cp -R ./logos/*  ../docs/logos
+	cd documentation; cp -R ./logos/* ../docs/expansion/logos
+	cd documentation; cp -R ./logos/* ../docs/export_mod/logos
+	cd documentation; cp -R ./logos/* ../docs/import_mod/logos
+	cp ./documentation/mkdocs/*.md ./docs
+	cp LICENSE ../docs/license.md
 
 install_requirements:
 	pip install -r docs/REQUIREMENTS.txt

Pipfile

@@ -11,16 +11,16 @@ flake8 = "*"
 
 [packages]
 dnspython = "*"
-requests = {extras = ["security"],version = "*"}
+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"}
+uwhois = { editable = true, git = "https://github.com/Rafiot/uwhoisd.git", ref = "testing", subdirectory = "client" }
+pymisp = { extras = ["fileobjects,openioc,pdfexport,email"], version = "*" }
+pyonyphe = { editable = true, git = "https://github.com/sebdraven/pyonyphe" }
+pydnstrails = { editable = true, git = "https://github.com/sebdraven/pydnstrails" }
 pytesseract = "*"
 pygeoip = "*"
 beautifulsoup4 = "*"
@@ -32,20 +32,20 @@ maclookup = "*"
 vulners = "*"
 blockchain = "*"
 reportlab = "*"
-pyintel471 = {editable = true,git = "https://github.com/MISP/PyIntel471.git"}
+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"}
+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/"}
+ODTReader = { editable = true, git = "https://github.com/cartertemm/ODTReader.git/" }
 python-pptx = "*"
 python-docx = "*"
 ezodf = "*"
@@ -54,13 +54,17 @@ pandas_ods_reader = "*"
 pdftotext = "*"
 lxml = "*"
 xlrd = "*"
-idna-ssl = {markers = "python_version < '3.7'"}
+idna-ssl = { markers = "python_version < '3.7'" }
 jbxapi = "*"
 geoip2 = "*"
 apiosintDS = "*"
 assemblyline_client = "*"
 vt-graph-api = "*"
 trustar = "*"
+markdownify = "==0.5.3"
+socialscan = "*"
+dnsdb2 = "*"
+clamd = "*"
 
 [requires]
 python_version = "3"

README.md

@@ -1,17 +1,15 @@
 # MISP modules
 
-[![Build Status](https://travis-ci.org/MISP/misp-modules.svg?branch=master)](https://travis-ci.org/MISP/misp-modules)
-[![Coverage Status](https://coveralls.io/repos/github/MISP/misp-modules/badge.svg?branch=master)](https://coveralls.io/github/MISP/misp-modules?branch=master)
-[![codecov](https://codecov.io/gh/MISP/misp-modules/branch/master/graph/badge.svg)](https://codecov.io/gh/MISP/misp-modules)
+[![Build Status](https://travis-ci.org/MISP/misp-modules.svg?branch=main)](https://travis-ci.org/MISP/misp-modules)
+[![Coverage Status](https://coveralls.io/repos/github/MISP/misp-modules/badge.svg?branch=main)](https://coveralls.io/github/MISP/misp-modules?branch=main)
+[![codecov](https://codecov.io/gh/MISP/misp-modules/branch/main/graph/badge.svg)](https://codecov.io/gh/MISP/misp-modules)
 
-MISP modules are autonomous modules that can be used for expansion and other services in [MISP](https://github.com/MISP/MISP).
+MISP modules are autonomous modules that can be used to extend [MISP](https://github.com/MISP/MISP) for new services such as expansion, import and export.
 
 The modules are written in Python 3 following a simple API interface. The objective is to ease the extensions of MISP functionalities
 without modifying core components. The API is available via a simple REST API which is independent from MISP installation or configuration.
 
-MISP modules support is included in MISP starting from version 2.4.28.
-
-For more information: [Extending MISP with Python modules](https://www.misp-project.org/misp-training/3.1-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](https://github.com/MISP/misp-training).
 
 ## Existing MISP modules
 
@@ -22,7 +20,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
 * [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.
+* [BGP Ranking](misp_modules/modules/expansion/bgpranking.py) - a hover and expansion module to expand an AS number with the ASN description and its ranking 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.
@@ -31,6 +29,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
 * [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.
+* [CPE](misp_modules/modules/expansion/cpe.py) - An expansion module to query the CVE Search API with a cpe code, to get its related vulnerabilities.
 * [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.
@@ -48,6 +47,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
 * [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?
+* [html_to_markdown](misp_modules/modules/expansion/html_to_markdown.py) - Simple HTML to markdown converter
 * [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.
@@ -75,11 +75,13 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
 * [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)
+* [Socialscan](misp_modules/modules/expansion/socialscan.py) - a hover module to check if an email address or a username is used on different online platforms, using the [socialscan](https://github.com/iojw/socialscan) python library
+* [SophosLabs Intelix](misp_modules/modules/expansion/sophoslabs_intelix.py) - SophosLabs Intelix is an API for Threat Intelligence and Analysis (free tier available). [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/).
+* [TruSTAR Enrich](misp_modules/modules/expansion/trustar_enrich.py) - an expansion module to enrich MISP data with [TruSTAR](https://www.trustar.co/).
 * [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))
@@ -127,8 +129,8 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
 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
+sudo chown -R www-data: .
+sudo -u www-data git clone https://github.com/MISP/misp-modules.git
 cd misp-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 .
@@ -143,7 +145,7 @@ sudo systemctl enable --now misp-modules
 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 rh-python36 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
@@ -164,7 +166,7 @@ After=misp-workers.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'
+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
 

REQUIREMENTS

@@ -1,113 +1,144 @@
+#
+# These requirements were autogenerated by pipenv
+# To regenerate from the project's Pipfile, run:
+#
+#    pipenv lock --requirements
+#
+
 -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/Rafiot/uwhoisd.git@783bba09b5a6964f25566089826a1be4b13f2a22#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'
+aiohttp==3.7.3; python_version >= '3.6'
+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
+assemblyline-client==4.0.1
+async-timeout==3.0.1; python_full_version >= '3.5.3'
+attrs==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 backscatter==0.2.4
-beautifulsoup4==4.8.2
+beautifulsoup4==4.9.3
+bidict==0.21.2; python_version >= '3.6'
 blockchain==1.4.4
-censys==0.0.8
-certifi==2019.11.28
-cffi==1.14.0
+censys==1.1.1
+certifi==2020.12.5
+cffi==1.14.4
 chardet==3.0.4
+clamd==1.0.2
 click-plugins==1.1.1
-click==7.1.1
-colorama==0.4.3
-cryptography==2.8
+click==7.1.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+colorama==0.4.4; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+colorclass==2.2.0
+compressed-rtf==1.0.6
+configparser==5.0.1; python_version >= '3.6'
+cryptography==3.3.1
 decorator==4.4.2
-deprecated==1.2.7
-dnspython==1.16.0
-domaintools-api==0.3.3
+deprecated==1.2.11; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+dnsdb2==1.1.2
+dnspython3==1.15.0
+domaintools-api==0.5.2
+easygui==0.98.1
+ebcdic==1.1.1
 enum-compat==0.0.3
+extract-msg==0.28.1
 ez-setup==0.9
 ezodf==0.3.2
-future==0.18.2
+future==0.18.2; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
 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'
+geoip2==4.1.0
+httplib2==0.18.1
+idna-ssl==1.1.0; python_version < '3.7'
+idna==2.10; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+imapclient==2.1.0
 isodate==0.6.0
-jbxapi==3.4.0
+jbxapi==3.14.0
+json-log-formatter==0.3.0
 jsonschema==3.2.0
-lief==0.10.1
-lxml==4.5.0
+lark-parser==0.11.1
+lief==0.11.0
+lxml==4.6.2
 maclookup==1.0.3
-maxminddb==1.5.2
-multidict==4.7.5
+markdownify==0.5.3
+maxminddb==2.0.3; python_version >= '3.6'
+msoffcrypto-tool==4.11.0
+multidict==5.1.0; python_version >= '3.6'
 np==1.0.2
-numpy==1.18.2
+numpy==1.19.5; python_version >= '3.6'
 oauth2==1.9.0.post1
-opencv-python==4.2.0.32
+olefile==0.46; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+oletools==0.56
+opencv-python==4.5.1.48
+openpyxl
 pandas-ods-reader==0.0.7
-pandas==1.0.3
+pandas==1.1.5
 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
+pcodedmp==1.2.6
+pdftotext==2.1.5
+pillow==8.1.0
+progressbar2==3.53.1
+psutil==5.8.0; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
+pycparser==2.20; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+pycryptodome==3.9.9; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
+pycryptodomex==3.9.9; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
 pydeep==0.4
-pyeupi==1.0
+pyeupi==1.1
+pyfaup==1.2
 pygeoip==0.3.2
-pyopenssl==19.1.0
-pyparsing==2.4.6
+pymisp[email,fileobjects,openioc,pdfexport]==2.4.137.1
+pyopenssl==20.0.1
+pyparsing==2.4.7; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
 pypdns==1.5.1
 pypssl==2.1
-pyrsistent==0.16.0
-pytesseract==0.3.3
-python-dateutil==2.8.1
+pyrsistent==0.17.3; python_version >= '3.5'
+pytesseract==0.3.7
+python-baseconv==1.2.2
+python-dateutil==2.8.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 python-docx==0.8.10
-python-magic==0.4.15
+python-engineio==4.0.0
+python-magic==0.4.18
 python-pptx==0.6.18
-python-utils==2.4.0
+python-socketio[client]==5.0.4
+python-utils==2.5.2
 pytz==2019.3
-pyyaml==5.3.1
+pyyaml==5.4.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
 pyzbar==0.1.8
-pyzipper==0.3.1 ; python_version >= '3.5'
-rdflib==4.2.2
-redis==3.4.1
-reportlab==3.5.42
+pyzipper==0.3.4; python_version >= '3.5'
+rdflib==5.0.0
+redis==3.5.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
+reportlab==3.5.59
 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
+requests[security]==2.25.1
+rtfde==0.0.2
+shodan==1.24.0
+sigmatools==0.18.1
+six==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+socialscan==1.4.1
+socketio-client==0.5.7.4
+soupsieve==2.1; python_version >= '3'
 sparqlwrapper==1.8.5
-stix2-patterns==1.3.0
+stix2-patterns==1.3.2
 tabulate==0.8.7
-tornado==6.0.4
-trustar==0.3.28
-url-normalize==1.4.1
+tornado==6.1; python_version >= '3.5'
+tqdm==4.56.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
+trustar==0.3.34
+typing-extensions==3.7.4.3; python_version < '3.8'
+tzlocal==2.1
+unicodecsv==0.14.1
+url-normalize==1.4.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'
 urlarchiver==0.2
-urllib3==1.25.8
+urllib3==1.26.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4.0'
 validators==0.14.0
 vt-graph-api==1.0.1
-vulners==1.5.5
-wand==0.5.9
+vulners==1.5.9
+wand==0.6.5
 websocket-client==0.57.0
 wrapt==1.12.1
-xlrd==1.2.0
-xlsxwriter==1.2.8
-pyeti-python3==1.0
+xlrd==2.0.1
+xlsxwriter==1.3.7
 yara-python==3.8.1
-yarl==1.4.2
-zipp==3.1.0
+yarl==1.6.3; python_version >= '3.6'

doc/expansion/bgpranking.json

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

doc/expansion/farsight_passivedns.json

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

doc/expansion/greynoise.json

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

doc/export_mod/cef_export.json

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

doc/export_mod/goamlexport.json

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

doc/export_mod/liteexport.json

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

doc/export_mod/nexthinkexport.json

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

doc/export_mod/osqueryexport.json

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

doc/export_mod/pdfexport.json

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

doc/export_mod/threatStream_misp_export.json

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

doc/export_mod/threat_connect_export.json

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

doc/generate_documentation.py

@@ -1,65 +0,0 @@
-# -*- 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)

doc/import_mod/csvimport.json

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

doc/import_mod/cuckooimport.json

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

doc/import_mod/email_import.json

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

doc/import_mod/goamlimport.json

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

doc/import_mod/mispjson.json

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

doc/import_mod/ocr.json

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

doc/import_mod/openiocimport.json

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

doc/import_mod/threatanalyzer_import.json

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

doc/import_mod/vmray_import.json

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

docs/index.md

@@ -1,120 +1,4 @@
-# Home
 
-[![Build Status](https://travis-ci.org/MISP/misp-modules.svg?branch=master)](https://travis-ci.org/MISP/misp-modules)
-[![Coverage Status](https://coveralls.io/repos/github/MISP/misp-modules/badge.svg?branch=master)](https://coveralls.io/github/MISP/misp-modules?branch=master)
-[![codecov](https://codecov.io/gh/MISP/misp-modules/branch/master/graph/badge.svg)](https://codecov.io/gh/MISP/misp-modules)
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%MISP%2Fmisp-modules.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FMISP%2Fmisp-modules?ref=badge_shield)
-
-MISP modules are autonomous modules that can be used for expansion and other services in [MISP](https://github.com/MISP/MISP).
-
-The modules are written in Python 3 following a simple API interface. The objective is to ease the extensions of MISP functionalities
-without modifying core components. The API is available via a simple REST API which is independent from MISP installation or configuration.
-
-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.
-
-
-## Existing MISP modules
-
-### Expansion modules
-
-* [Backscatter.io](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/backscatter_io.py) - a hover and expansion module to expand an IP address with mass-scanning observations.
-* [BGP Ranking](https://github.com/MISP/misp-modules/tree/master/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.
-* [BTC scam check](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/btc_scam_check.py) - An expansion hover module to instantly check if a BTC address has been abused.
-* [BTC transactions](https://github.com/MISP/misp-modules/tree/master/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.
-* [CIRCL Passive DNS](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/circl_passivessl.py) - a hover and expansion module to expand IP addresses with the X.509 certificate seen.
-* [countrycode](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/countrycode.py) - a hover module to tell you what country a URL belongs to.
-* [CrowdStrike Falcon](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/crowdstrike_falcon.py) - an expansion module to expand using CrowdStrike Falcon Intel Indicator API.
-* [CVE](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/cve.py) - a hover module to give more information about a vulnerability (CVE).
-* [CVE advanced](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/cuckoo_submit.py) - A hover module to submit malware sample, url, attachment, domain to Cuckoo Sandbox.
-* [DBL Spamhaus](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/dbl_spamhaus.py) - a hover module to check Spamhaus DBL for a domain name.
-* [DNS](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/dns.py) - a simple module to resolve MISP attributes like hostname and domain to expand IP addresses attributes.
-* [docx-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/docx-enrich.py) - an enrichment module to get text out of Word document into MISP (using free-text parser).
-* [DomainTools](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/domaintools.py) - a hover and expansion module to get information from [DomainTools](http://www.domaintools.com/) whois.
-* [EUPI](https://github.com/MISP/misp-modules/tree/master/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).
-* [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/)
-* [Farsight DNSDB Passive DNS](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/farsight_passivedns.py) - a hover and expansion module to expand hostname and IP addresses with passive DNS information.
-* [GeoIP](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/geoip_country.py) - a hover and expansion module to get GeoIP information from geolite/maxmind.
-* [Greynoise](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/greynoise.py) - a hover to get information from greynoise.
-* [hashdd](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/hashdd.py) - a hover module to check file hashes against [hashdd.com](http://www.hashdd.com) including NSLR dataset.
-* [hibp](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/hibp.py) - a hover module to lookup against Have I Been Pwned?
-* [intel471](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/intel471.py) - an expansion module to get info from [Intel471](https://intel471.com).
-* [IPASN](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/ipasn.py) - a hover and expansion to get the BGP ASN of an IP address.
-* [iprep](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/iprep.py) - an expansion module to get IP reputation from packetmail.net.
-* [Joe Sandbox submit](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_submit.py) - Submit files and URLs to Joe Sandbox.
-* [Joe Sandbox query](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_query.py) - Query Joe Sandbox with the link of an analysis and get the parsed data.
-* [macaddress.io](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/macvendors.py) - a hover module to retrieve mac vendor information.
-* [ocr-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/ocr-enrich.py) - an enrichment module to get OCRized data from images into MISP.
-* [ods-enrich](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/odt-enrich.py) - an enrichment module to get text out of OpenOffice document into MISP (using free-text parser).
-* [onyphe](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/onyphe.py) - a modules to process queries on Onyphe.
-* [onyphe_full](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/onyphe_full.py) - a modules to process full queries on Onyphe.
-* [OTX](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/otx.py) - an expansion module for [OTX](https://otx.alienvault.com/).
-* [passivetotal](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/passivetotal.py) - a [passivetotal](https://www.passivetotal.org/) module that queries a number of different PassiveTotal datasets.
-* [pdf-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/pdf-enrich.py) - an enrichment module to extract text from PDF into MISP (using free-text parser).
-* [pptx-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/pptx-enrich.py) - an enrichment module to get text out of PowerPoint document into MISP (using free-text parser).
-* [qrcode](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/rbl.py) - a module to get RBL (Real-Time Blackhost List) values from an attribute.
-* [reversedns](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/reversedns.py) - Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.
-* [securitytrails](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/securitytrails.py) - an expansion module for [securitytrails](https://securitytrails.com/).
-* [shodan](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/shodan.py) - a minimal [shodan](https://www.shodan.io/) expansion module.
-* [Sigma queries](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/sigma_syntax_validator.py) - Sigma syntax validator.
-* [sourcecache](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/sourcecache.py) - a module to cache a specific link from a MISP instance.
-* [STIX2 pattern syntax validator](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/stix2_pattern_syntax_validator.py) - a module to check a STIX2 pattern syntax.
-* [ThreatCrowd](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/threatcrowd.py) - an expansion module for [ThreatCrowd](https://www.threatcrowd.org/).
-* [threatminer](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/threatminer.py) - an expansion module to expand from [ThreatMiner](https://www.threatminer.org/).
-* [urlhaus](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/urlhaus.py) - Query urlhaus to get additional data about a domain, hash, hostname, ip or url.
-* [urlscan](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/urlscan.py) - an expansion module to query [urlscan.io](https://urlscan.io).
-* [virustotal](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vmray_submit.py) - a module to submit a sample to VMray.
-* [VulnDB](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vulndb.py) - a module to query [VulnDB](https://www.riskbasedsecurity.com/).
-* [Vulners](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vulners.py) - an expansion module to expand information about CVEs using Vulners API.
-* [whois](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/whois.py) - a module to query a local instance of [uwhois](https://github.com/rafiot/uwhoisd).
-* [wikidata](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/wiki.py) - a [wikidata](https://www.wikidata.org) expansion module.
-* [xforce](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/xforceexchange.py) - an IBM X-Force Exchange expansion module.
-* [xlsx-enrich](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/yara_query.py) - a module to create YARA rules from single hash attributes.
-* [YARA syntax validator](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/yara_syntax_validator.py) - YARA syntax validator.
-
-### Export modules
-
-* [CEF](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/cef_export.py) module to export Common Event Format (CEF).
-* [Cisco FireSight Manager ACL rule](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/goamlexport.py) module to export in [GoAML format](http://goaml.unodc.org/goaml/en/index.html).
-* [Lite Export](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/liteexport.py) module to export a lite event.
-* [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.
-* [PDF export](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/pdfexport.py) module to export an event in PDF.
-* [Nexthink query format](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/nexthinkexport.py) module to export in Nexthink query format.
-* [osquery](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/osqueryexport.py) module to export in [osquery](https://osquery.io/) query format.
-* [ThreatConnect](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/threat_connect_export.py) module to export in ThreatConnect CSV format.
-* [ThreatStream](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/threatStream_misp_export.py) module to export in ThreatStream format.
-
-### Import modules
-
-* [CSV import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/csvimport.py) Customizable CSV import module.
-* [Cuckoo JSON](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/cuckooimport.py) Cuckoo JSON import.
-* [Email Import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/email_import.py) Email import module for MISP to import basic metadata.
-* [GoAML import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/goamlimport.py) Module to import [GoAML](http://goaml.unodc.org/goaml/en/index.html) XML format.
-* [Joe Sandbox import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/joe_import.py) Parse data from a Joe Sandbox json report.
-* [OCR](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/ocr.py) Optical Character Recognition (OCR) module for MISP to import attributes from images, scan or faxes.
-* [OpenIOC](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/openiocimport.py) OpenIOC import based on PyMISP library.
-* [ThreatAnalyzer](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/threatanalyzer_import.py) - An import module to process ThreatAnalyzer archive.zip/analysis.json sandbox exports.
-* [VMRay](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/vmray_import.py) - An import module to process VMRay export.
-
-
-## How to contribute your own module?
-
-Fork the project, add your module, test it and make a pull-request. Modules can be also private as you can add a module in your own MISP installation.
-For further information please see [Contribute](contribute/).
-
-
-## Licenses
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%MISP%2Fmisp-modules.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FMISP%2Fmisp-modules?ref=badge_large)
-
-For further Information see also the [license file](license/).
+- [expansion](./expansion)
+- [export](./export_mod)
+- [import](./import_mod)

documentation/generate_documentation.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+import os
+import json
+
+module_types = ['expansion', 'export_mod', 'import_mod']
+titles = ['Expansion Modules', 'Export Modules', 'Import Modules']
+githublink = 'https://github.com/MISP/misp-modules/tree/main/misp_modules/modules'
+
+
+def generate_doc(module_type, root_path, logo_path='logos'):
+    markdown = []
+    current_path = os.path.join(root_path, 'website', module_type)
+    files = sorted(os.listdir(current_path))
+    githubpath = f'{githublink}/{module_type}'
+    for filename in files:
+        modulename = filename.split('.json')[0]
+        githubref = f'{githubpath}/{modulename}.py'
+        markdown.append(f'\n#### [{modulename}]({githubref})\n')
+        filename = os.path.join(current_path, filename)
+        with open(filename, 'rt') as f:
+            definition = json.loads(f.read())
+        if 'logo' in definition:
+            logo = os.path.join(logo_path, definition.pop('logo'))
+            markdown.append(f"\n<img src={logo} height=60>\n")
+        if 'description' in definition:
+            markdown.append(f"\n{definition.pop('description')}\n")
+        for field, value in sorted(definition.items()):
+            if not value:
+                continue
+            if isinstance(value, list):
+                markdown.append(handle_list(field, value))
+                continue
+            markdown.append(get_single_value(field, value.replace('\n', '\n>')))
+        markdown.append('\n-----\n')
+    return markdown
+
+
+def get_single_value(field, value):
+    return f"- **{field}**:\n>{value}\n"
+
+
+def handle_list(field, values):
+    if len(values) == 1:
+        return get_single_value(field, values[0])
+    values = '\n> - '.join(values)
+    return f"- **{field}**:\n> - {values}\n"
+
+
+def write_doc(root_path):
+    markdown = ["# MISP modules documentation\n"]
+    for _path, title in zip(module_types, titles):
+        markdown.append(f'\n## {title}\n')
+        markdown.extend(generate_doc(_path, root_path))
+    with open('README.md', 'w') as w:
+        w.write(''.join(markdown))
+
+
+def write_docs_for_mkdocs(root_path):
+    for _path, title in zip(module_types, titles):
+        markdown = generate_doc(_path, root_path, logo_path='../logos')
+        with open(os.path.join(root_path, 'mkdocs', f'{_path}.md'), 'w') as w:
+            w.write(''.join(markdown))
+
+
+if __name__ == '__main__':
+    root_path = os.path.dirname(os.path.realpath(__file__))
+    write_doc(root_path)
+    write_docs_for_mkdocs(root_path)

documentation/mkdocs/index.md

@@ -0,0 +1,120 @@
+# Home
+
+[![Build Status](https://travis-ci.org/MISP/misp-modules.svg?branch=master)](https://travis-ci.org/MISP/misp-modules)
+[![Coverage Status](https://coveralls.io/repos/github/MISP/misp-modules/badge.svg?branch=master)](https://coveralls.io/github/MISP/misp-modules?branch=master)
+[![codecov](https://codecov.io/gh/MISP/misp-modules/branch/master/graph/badge.svg)](https://codecov.io/gh/MISP/misp-modules)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%MISP%2Fmisp-modules.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FMISP%2Fmisp-modules?ref=badge_shield)
+
+MISP modules are autonomous modules that can be used for expansion and other services in [MISP](https://github.com/MISP/MISP).
+
+The modules are written in Python 3 following a simple API interface. The objective is to ease the extensions of MISP functionalities
+without modifying core components. The API is available via a simple REST API which is independent from MISP installation or configuration.
+
+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.
+
+
+## Existing MISP modules
+
+### Expansion modules
+
+* [Backscatter.io](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/backscatter_io.py) - a hover and expansion module to expand an IP address with mass-scanning observations.
+* [BGP Ranking](https://github.com/MISP/misp-modules/tree/master/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.
+* [BTC scam check](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/btc_scam_check.py) - An expansion hover module to instantly check if a BTC address has been abused.
+* [BTC transactions](https://github.com/MISP/misp-modules/tree/master/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.
+* [CIRCL Passive DNS](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/circl_passivessl.py) - a hover and expansion module to expand IP addresses with the X.509 certificate seen.
+* [countrycode](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/countrycode.py) - a hover module to tell you what country a URL belongs to.
+* [CrowdStrike Falcon](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/crowdstrike_falcon.py) - an expansion module to expand using CrowdStrike Falcon Intel Indicator API.
+* [CVE](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/cve.py) - a hover module to give more information about a vulnerability (CVE).
+* [CVE advanced](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/cuckoo_submit.py) - A hover module to submit malware sample, url, attachment, domain to Cuckoo Sandbox.
+* [DBL Spamhaus](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/dbl_spamhaus.py) - a hover module to check Spamhaus DBL for a domain name.
+* [DNS](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/dns.py) - a simple module to resolve MISP attributes like hostname and domain to expand IP addresses attributes.
+* [docx-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/docx-enrich.py) - an enrichment module to get text out of Word document into MISP (using free-text parser).
+* [DomainTools](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/domaintools.py) - a hover and expansion module to get information from [DomainTools](http://www.domaintools.com/) whois.
+* [EUPI](https://github.com/MISP/misp-modules/tree/master/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).
+* [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/)
+* [Farsight DNSDB Passive DNS](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/farsight_passivedns.py) - a hover and expansion module to expand hostname and IP addresses with passive DNS information.
+* [GeoIP](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/geoip_country.py) - a hover and expansion module to get GeoIP information from geolite/maxmind.
+* [Greynoise](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/greynoise.py) - a hover to get information from greynoise.
+* [hashdd](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/hashdd.py) - a hover module to check file hashes against [hashdd.com](http://www.hashdd.com) including NSLR dataset.
+* [hibp](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/hibp.py) - a hover module to lookup against Have I Been Pwned?
+* [intel471](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/intel471.py) - an expansion module to get info from [Intel471](https://intel471.com).
+* [IPASN](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/ipasn.py) - a hover and expansion to get the BGP ASN of an IP address.
+* [iprep](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/iprep.py) - an expansion module to get IP reputation from packetmail.net.
+* [Joe Sandbox submit](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_submit.py) - Submit files and URLs to Joe Sandbox.
+* [Joe Sandbox query](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/joesandbox_query.py) - Query Joe Sandbox with the link of an analysis and get the parsed data.
+* [macaddress.io](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/macvendors.py) - a hover module to retrieve mac vendor information.
+* [ocr-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/ocr-enrich.py) - an enrichment module to get OCRized data from images into MISP.
+* [ods-enrich](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/odt-enrich.py) - an enrichment module to get text out of OpenOffice document into MISP (using free-text parser).
+* [onyphe](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/onyphe.py) - a modules to process queries on Onyphe.
+* [onyphe_full](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/onyphe_full.py) - a modules to process full queries on Onyphe.
+* [OTX](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/otx.py) - an expansion module for [OTX](https://otx.alienvault.com/).
+* [passivetotal](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/passivetotal.py) - a [passivetotal](https://www.passivetotal.org/) module that queries a number of different PassiveTotal datasets.
+* [pdf-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/pdf-enrich.py) - an enrichment module to extract text from PDF into MISP (using free-text parser).
+* [pptx-enrich](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/pptx-enrich.py) - an enrichment module to get text out of PowerPoint document into MISP (using free-text parser).
+* [qrcode](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/rbl.py) - a module to get RBL (Real-Time Blackhost List) values from an attribute.
+* [reversedns](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/reversedns.py) - Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.
+* [securitytrails](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/securitytrails.py) - an expansion module for [securitytrails](https://securitytrails.com/).
+* [shodan](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/shodan.py) - a minimal [shodan](https://www.shodan.io/) expansion module.
+* [Sigma queries](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/sigma_syntax_validator.py) - Sigma syntax validator.
+* [sourcecache](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/sourcecache.py) - a module to cache a specific link from a MISP instance.
+* [STIX2 pattern syntax validator](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/stix2_pattern_syntax_validator.py) - a module to check a STIX2 pattern syntax.
+* [ThreatCrowd](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/threatcrowd.py) - an expansion module for [ThreatCrowd](https://www.threatcrowd.org/).
+* [threatminer](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/threatminer.py) - an expansion module to expand from [ThreatMiner](https://www.threatminer.org/).
+* [urlhaus](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/urlhaus.py) - Query urlhaus to get additional data about a domain, hash, hostname, ip or url.
+* [urlscan](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/urlscan.py) - an expansion module to query [urlscan.io](https://urlscan.io).
+* [virustotal](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vmray_submit.py) - a module to submit a sample to VMray.
+* [VulnDB](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vulndb.py) - a module to query [VulnDB](https://www.riskbasedsecurity.com/).
+* [Vulners](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/vulners.py) - an expansion module to expand information about CVEs using Vulners API.
+* [whois](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/whois.py) - a module to query a local instance of [uwhois](https://github.com/rafiot/uwhoisd).
+* [wikidata](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/wiki.py) - a [wikidata](https://www.wikidata.org) expansion module.
+* [xforce](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/xforceexchange.py) - an IBM X-Force Exchange expansion module.
+* [xlsx-enrich](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/yara_query.py) - a module to create YARA rules from single hash attributes.
+* [YARA syntax validator](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/yara_syntax_validator.py) - YARA syntax validator.
+
+### Export modules
+
+* [CEF](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/cef_export.py) module to export Common Event Format (CEF).
+* [Cisco FireSight Manager ACL rule](https://github.com/MISP/misp-modules/tree/master/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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/goamlexport.py) module to export in [GoAML format](http://goaml.unodc.org/goaml/en/index.html).
+* [Lite Export](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/liteexport.py) module to export a lite event.
+* [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.
+* [PDF export](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/pdfexport.py) module to export an event in PDF.
+* [Nexthink query format](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/nexthinkexport.py) module to export in Nexthink query format.
+* [osquery](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/osqueryexport.py) module to export in [osquery](https://osquery.io/) query format.
+* [ThreatConnect](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/threat_connect_export.py) module to export in ThreatConnect CSV format.
+* [ThreatStream](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/export_mod/threatStream_misp_export.py) module to export in ThreatStream format.
+
+### Import modules
+
+* [CSV import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/csvimport.py) Customizable CSV import module.
+* [Cuckoo JSON](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/cuckooimport.py) Cuckoo JSON import.
+* [Email Import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/email_import.py) Email import module for MISP to import basic metadata.
+* [GoAML import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/goamlimport.py) Module to import [GoAML](http://goaml.unodc.org/goaml/en/index.html) XML format.
+* [Joe Sandbox import](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/joe_import.py) Parse data from a Joe Sandbox json report.
+* [OCR](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/ocr.py) Optical Character Recognition (OCR) module for MISP to import attributes from images, scan or faxes.
+* [OpenIOC](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/openiocimport.py) OpenIOC import based on PyMISP library.
+* [ThreatAnalyzer](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/threatanalyzer_import.py) - An import module to process ThreatAnalyzer archive.zip/analysis.json sandbox exports.
+* [VMRay](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/import_mod/vmray_import.py) - An import module to process VMRay export.
+
+
+## How to contribute your own module?
+
+Fork the project, add your module, test it and make a pull-request. Modules can be also private as you can add a module in your own MISP installation.
+For further information please see [Contribute](contribute/).
+
+
+## Licenses
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%MISP%2Fmisp-modules.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FMISP%2Fmisp-modules?ref=badge_large)
+
+For further Information see also the [license file](license/).

documentation/website/expansion/apiosintds.json

@@ -1,8 +1,12 @@
 {
     "description": "On demand query API for OSINT.digitalside.it project.",
-    "requirements": ["The apiosintDS python library to query the OSINT.digitalside.it API."],
+    "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"],
+    "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"
-}
+}

documentation/website/expansion/apivoid.json

@@ -1,9 +1,13 @@
 {
     "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"],
+    "logo": "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/"]
-}
+    "references": [
+        "https://www.apivoid.com/"
+    ]
+}

documentation/website/expansion/assemblyline_query.json

@@ -1,9 +1,13 @@
 {
     "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."],
+    "logo": "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"],
+    "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."
-}
+}