Expansion Modules

Abuse IPDB ¶

AbuseIPDB MISP expansion module [source code]

features:
config:
- api_key
- max_age_in_days
- abuse_threshold

OSINT DigitalSide ¶

On demand query API for OSINT.digitalside.it project. [source code]

features:

The module simply queries the API of OSINT.digitalside.it with a domain, ip, url or hash attribute.

The 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.

Furthermore, it is possible to cache the urls and hashes collected over the last 7 days by OSINT.digitalside.it
config:
- STIX2_details
- import_related
- cache
- cache_directory
- cache_timeout_h
- local_directory
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
requirements:

The apiosintDS python library to query the OSINT.digitalside.it API.

APIVoid ¶

Module to query APIVoid with some domain attributes. [source code]

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.

To make it work, a valid API key and enough credits to proceed 2 queries (0.06 + 0.07 credits) are required.
config:

apikey
input:

A domain attribute.
output:

DNS records and SSL certificates related to the domain.
references:

https://www.apivoid.com/
requirements:

A valid APIVoid API key with enough credits to proceed 2 queries

AssemblyLine Query ¶

A module tu query the AssemblyLine API with a submission ID to get the submission report and parse it. [source code]

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.

The 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.

Some more data may be parsed in the future.
config:
- apiurl
- user_id
- apikey
- password
- verifyssl
input:

Link of an AssemblyLine submission report.
output:

MISP attributes & objects parsed from the AssemblyLine submission.
references:

https://www.cyber.gc.ca/en/assemblyline
requirements:

assemblyline_client: Python library to query the AssemblyLine rest API.

AssemblyLine Submit ¶

A module to submit samples and URLs to AssemblyLine for advanced analysis, and return the link of the submission. [source code]

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.

If the sample or url is correctly submitted, you get then the link of the submission.
config:
- apiurl
- user_id
- apikey
- password
- verifyssl
input:

Sample, or url to submit to AssemblyLine.
output:

Link of the report generated in AssemblyLine.
references:

https://www.cyber.gc.ca/en/assemblyline
requirements:

assemblyline_client: Python library to query the AssemblyLine rest API.

Backscatter.io ¶

Backscatter.io module to bring mass-scanning observations into MISP. [source code]

features:

The module takes a source or destination IP address as input and displays the information known by backscatter.io.
config:

api_key
input:

IP addresses.
output:

Text containing a history of the IP addresses especially on scanning based on backscatter.io information .
references:

https://pypi.org/project/backscatter/
requirements:

backscatter python library

BTC Scam Check ¶

An expansion hover module to query a special dns blacklist to check if a bitcoin address has been abused. [source code]

features:

The module queries a dns blacklist directly with the bitcoin address and get a response if the address has been abused.
input:

btc address attribute.
output:

Text to indicate if the BTC address has been abused.
references:

https://btcblack.it/
requirements:

dnspython3: dns python library

BTC Steroids ¶

An expansion hover module to get a blockchain balance from a BTC address in MISP. [source code]

features:
input:

btc address attribute.
output:

Text to describe the blockchain balance and the transactions related to the btc address in input.

Censys Enrich ¶

An expansion module to enrich attributes in MISP by quering the censys.io API [source code]

features:

This module takes an IP, hostname or a certificate fingerprint and attempts to enrich it by querying the Censys API.
config:
- api_id
- api_secret
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
requirements:

API credentials to censys.io

CIRCL Passive DNS ¶

Module to access CIRCL Passive DNS. [source code]

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.

To make it work a username and a password are thus required to authenticate to the CIRCL Passive DNS API.
config:
- username
- password
input:

Hostname, domain, or ip-address attribute.
ouput:

Passive DNS objects related to the input attribute.
references:
- https://www.circl.lu/services/passive-dns/
- https://datatracker.ietf.org/doc/draft-dulaunoy-dnsop-passive-dns-cof/
requirements:
- pypdns: Passive DNS python library
- A CIRCL passive DNS account with username & password

CIRCL Passive SSL ¶

Modules to access CIRCL Passive SSL. [source code]

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.

To make it work a username and a password are required to authenticate to the CIRCL Passive SSL API.
config:
- username
- password
input:

IP address attribute.
output:

x509 certificate objects seen by the IP address(es).
references:

https://www.circl.lu/services/passive-ssl/
requirements:
- pypssl: Passive SSL python library
- A CIRCL passive SSL account with username & password

ClaamAV ¶

Submit file to ClamAV [source code]

features:
config:

connection

Cluster25 Expand ¶

Module to query Cluster25 CTI. [source code]

features:

This module takes a MISP attribute value as input to query the Cluster25CTI API. The result is then mapped into compatible MISP Objects and relative attributes.
config:
- api_id
- apikey
- base_url
input:

An Indicator value of type included in the following list: - domain - email-src - email-dst - filename - md5 - sha1 - sha256 - ip-src - ip-dst - url - vulnerability - btc - xmr ja3-fingerprint-md5
output:

A series of c25 MISP Objects with colletion of attributes mapped from Cluster25 CTI query result.
references:
requirements:

A Cluster25 API access (API id & key)

Country Code ¶

Module to expand country codes. [source code]

features:

The module takes a domain or a hostname as input, and returns the country it belongs to.

For non country domains, a list of the most common possible extensions is used.
input:

Hostname or domain attribute.
output:

Text with the country code the input belongs to.

CPE Lookup ¶

An expansion module to query the CVE search API with a cpe code to get its related vulnerabilities. [source code]

features:

The module takes a cpe attribute as input and queries the CVE search API to get its related vulnerabilities.
The list of vulnerabilities is then parsed and returned as vulnerability objects.

Users can use their own CVE search API url by defining a value to the custom_API_URL parameter. If no custom API url is given, the default vulnerability.circl.lu api url is used.

In order to limit the amount of data returned by CVE serach, users can also the limit parameter. With the limit set, the API returns only the requested number of vulnerabilities, sorted from the highest cvss score to the lowest one.
config:
- custom_API_URL
- limit
input:

CPE attribute.
output:

The vulnerabilities related to the CPE.
references:

https://vulnerability.circl.lu/api/

CrowdSec CTI ¶

Module to access CrowdSec CTI API. [source code]

features:

This module enables IP lookup from CrowdSec CTI API. It provides information about the IP, such as what kind of attacks it has been participant of as seen by CrowdSec's network. It also includes enrichment by CrowdSec like background noise score, aggressivity over time etc.
config:
- api_key
- add_reputation_tag
- add_behavior_tag
- add_classification_tag
- add_mitre_technique_tag
- add_cve_tag
input:

An IP address.
output:

IP Lookup information from CrowdSec CTI API
references:
requirements:

A CrowdSec CTI API key. Get yours by following https://docs.crowdsec.net/docs/cti_api/getting_started/#getting-an-api-key

CrowdStrike Falcon ¶

Module to query CrowdStrike Falcon. [source code]

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.

Please note that composite attributes composed by at least one of the input types mentionned below (domains, IPs, hostnames) are also supported.
config:
- api_id
- apikey
input:

A MISP attribute included in the following list: - domain - email-attachment - email-dst - email-reply-to - email-src - email-subject - filename - hostname - ip-src - ip-dst - md5 - mutex - regkey - sha1 - sha256 - uri - url - user-agent - whois-registrant-email - x509-fingerprint-md5
output:

MISP attributes mapped after the CrowdStrike API has been queried, included in the following list: - hostname - email-src - email-subject - filename - md5 - sha1 - sha256 - ip-dst - ip-dst - mutex - regkey - url - user-agent - x509-fingerprint-md5
references:

https://www.crowdstrike.com/products/crowdstrike-falcon-faq/
requirements:

A CrowdStrike API access (API id & key)

Cuckoo Submit ¶

Submit files and URLs to Cuckoo Sandbox [source code]

features:

The module takes a malware-sample, attachment, url or domain and submits it to Cuckoo Sandbox. The returned task id can be used to retrieve results when the analysis completed.
config:
- api_url
- api_key
input:

A malware-sample or attachment for files. A url or domain for URLs.
output:

A text field containing 'Cuckoo task id: '
references:
- https://cuckoosandbox.org/
- https://cuckoo.sh/docs/
requirements:

Access to a Cuckoo Sandbox API and an API key if the API requires it. (api_url and api_key)

CVE Lookup ¶

An expansion hover module to expand information about CVE id. [source code]

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.
config:

custom_API
input:

Vulnerability attribute.
output:

Text giving information about the CVE related to the Vulnerability.
references:
- https://vulnerability.circl.lu/
- https://cve.mitre.org/

CVE Advanced Lookup ¶

An expansion module to query the CIRCL CVE search API for more information about a vulnerability (CVE). [source code]

features:

The module takes a vulnerability attribute as input and queries the CIRCL CVE search API to gather additional information.

The result of the query is then parsed to return additional information about the vulnerability, like its cvss score or some references, as well as the potential related weaknesses and attack patterns.

The vulnerability additional data is returned in a vulnerability MISP object, and the related additional information are put into weakness and attack-pattern MISP objects.
config:

custom_API
input:

Vulnerability attribute.
output:

Additional information about the vulnerability, such as its cvss score, some references, or the related weaknesses and attack patterns.
references:
- https://vulnerability.circl.lu
- https://cve/mitre.org/

Cytomic Orion Lookup ¶

An expansion module to enrich attributes in MISP by quering the Cytomic Orion API [source code]

features:

This module takes an MD5 hash and searches for occurrences of this hash in the Cytomic Orion database. Returns observed files and machines.
config:
- api_url
- token_url
- clientid
- clientsecret
- clientsecret
- username
- password
- upload_timeframe
- upload_tag
- delete_tag
- upload_ttlDays
- upload_threat_level_id
- limit_upload_events
- limit_upload_attributes
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/
requirements:

Access (license) to Cytomic Orion

DBL Spamhaus Lookup ¶

Checks Spamhaus DBL for a domain name. [source code]

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.

DBL 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.

Please note that composite MISP attributes containing domain or hostname are supported as well.
input:

Domain or hostname attribute.
output:

Information about the nature of the input.
references:

https://www.spamhaus.org/faq/section/Spamhaus%20DBL
requirements:

dnspython3: DNS python3 library

DNS Resolver ¶

Simple DNS expansion service to resolve IP address from MISP attributes [source code]

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.

The 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).

Please note that composite MISP attributes containing domain or hostname are supported as well.
config:

nameserver
input:

Domain or hostname attribute.
output:

IP address resolving the input.
requirements:

dnspython3: DNS python3 library

DOCX Enrich ¶

Module to extract freetext from a .docx document. [source code]

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.
input:

Attachment attribute containing a .docx document.
output:

Text and freetext parsed from the document.
requirements:

docx python library

DomainTools Lookup ¶

DomainTools MISP expansion module. [source code]

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.

Please note that composite attributes composed by at least one of the input types mentionned below (domains, IPs, hostnames) are also supported.
config:
- username
- api_key
input:

A MISP attribute included in the following list: - domain - hostname - email-src - email-dst - target-email - whois-registrant-email - whois-registrant-name - whois-registrant-phone - ip-src - ip-dst
output:

MISP attributes mapped after the Domaintools API has been queried, included in the following list: - whois-registrant-email - whois-registrant-phone - whois-registrant-name - whois-registrar - whois-creation-date - text - domain
references:

https://www.domaintools.com/
requirements:
- Domaintools python library
- A Domaintools API access (username & apikey)

EQL Query Generator ¶

EQL query generation for a MISP attribute. [source code]

features:

This module adds a new attribute to a MISP event containing an EQL query for a network or file attribute.
input:

A filename or ip attribute.
output:

Attribute containing EQL for a network or file attribute.
references:

https://eql.readthedocs.io/en/latest/

EUPI Lookup ¶

A module to query the Phishing Initiative service (https://phishing-initiative.lu). [source code]

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.

Please note that composite attributes containing domain or hostname are also supported.
config:
- 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
requirements:
- pyeupi: eupi python library
- An access to the Phishing Initiative API (apikey & url)

URL Components Extractor ¶

Extract URL components [source code]

features:

Farsight DNSDB Lookup ¶

Module to access Farsight DNSDB Passive DNS. [source code]

features:

This module takes a domain, hostname or IP address MISP attribute as input to query the Farsight Passive DNS API. The results of rdata and rrset lookups are then returned and parsed into passive-dns objects.

An API key is required to submit queries to the API. It is also possible to define a custom server URL, and to set a limit of results to get. This limit is set for each lookup, which means we can have an up to the limit number of passive-dns objects resulting from an rdata query about an IP address, but an up to the limit number of passive-dns objects for each lookup queries about a domain or a hostname (== twice the limit).
config:
- apikey
- server
- limit
- flex_queries
input:

A domain, hostname or IP address MISP attribute.
output:

Passive-dns objects, resulting from the query on the Farsight Passive DNS API.
references:
- https://www.farsightsecurity.com/
- https://docs.dnsdb.info/dnsdb-api/
requirements:

An access to the Farsight Passive DNS API (apikey)

GeoIP ASN Lookup ¶

Query a local copy of the Maxmind Geolite ASN database (MMDB format) [source code]

features:

The module takes an IP address attribute as input and queries a local copy of the Maxmind's Geolite database to get information about the related AS number.
config:

local_geolite_db
descrption:

An expansion module to query a local copy of Maxmind's Geolite database with an IP address, in order to get information about its related AS number.
input:

An IP address MISP attribute.
output:

Text containing information about the AS number of the IP address.
references:

https://www.maxmind.com/en/home
requirements:

A local copy of Maxmind's Geolite database

GeoIP City Lookup ¶

An expansion module to query a local copy of Maxmind's Geolite database with an IP address, in order to get information about the city where it is located. [source code]

features:

The module takes an IP address attribute as input and queries a local copy of the Maxmind's Geolite database to get information about the city where this IP address is located.
config:

local_geolite_db
input:

An IP address MISP attribute.
output:

Text containing information about the city where the IP address is located.
references:

https://www.maxmind.com/en/home
requirements:

A local copy of Maxmind's Geolite database

GeoIP Country Lookup ¶

Query a local copy of Maxminds Geolite database, updated for MMDB format [source code]

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.

Please note that composite attributes domain|ip are also supported.
config:

local_geolite_db
input:

An IP address MISP Attribute.
output:

Text containing information about the location of the IP address.
references:

https://www.maxmind.com/en/home
requirements:

A local copy of Maxmind's Geolite database

Google Safe Browsing Lookup ¶

Google safe browsing expansion module [source code]

features:
config:

api_key

Google Search ¶

An expansion hover module to expand google search information about an URL [source code]

features:

The module takes an url as input to query the Google search API. The result of the query is then return as raw text.
input:

An url attribute.
output:

Text containing the result of a Google search on the input url.
references:

https://github.com/abenassi/Google-Search-API
requirements:

The python Google Search API library

Google Threat Intelligence Lookup ¶

An expansion module to have the observable's threat score assessed by Google Threat Intelligence. [source code]

features:

GTI assessment for the given observable, this include information about level of severity, a clear verdict (malicious, suspicious, undetected and benign) and additional information provided by the Mandiant expertise combined with the VirusTotal database.

Output example screeshot
config:
- apikey
- event_limit
- proxy_host
- proxy_port
- proxy_username
- proxy_password
input:

A domain, hash (md5, sha1, sha256 or sha512), hostname or IP address attribute.
output:

Text fields containing the threat score, the severity, the verdict and the threat label of the observable inspected.
references:
- https://www.virustotal.com/
- https://gtidocs.virustotal.com/reference
requirements:

An access to the Google Threat Intelligence API (apikey), with a high request rate limit.

GreyNoise Lookup ¶

Module to query IP and CVE information from GreyNoise [source code]

features:

This module supports: 1) Query an IP from GreyNoise to see if it is internet background noise or a common business service 2) Query a CVE from GreyNoise to see the total number of internet scanners looking for the CVE in the last 7 days.
config:
- api_key
- api_type
input:

An IP address or CVE ID
output:

IP Lookup information or CVE scanning profile for past 7 days
references:
requirements:

A Greynoise API key. Both Enterprise (Paid) and Community (Free) API keys are supported, however Community API users will only be able to perform IP lookups.

Hashdd Lookup ¶

A hover module to check hashes against hashdd.com including NSLR dataset. [source code]

features:

This module takes a hash attribute as input to check its known level, using the hashdd API. This information is then displayed.
input:

A hash MISP attribute (md5).
output:

Text describing the known level of the hash in the hashdd databases.
references:

https://hashdd.com/

CIRCL Hashlookup Lookup ¶

An expansion module to query the CIRCL hashlookup services to find it if a hash is part of a known set such as NSRL. [source code]

features:

The module takes file hashes as input such as a MD5 or SHA1. It queries the public CIRCL.lu hashlookup service and return all the hits if the hashes are known in an existing dataset. The module can be configured with a custom hashlookup url if required. The module can be used an hover module but also an expansion model to add related MISP objects.
config:

custom_API
input:

File hashes (MD5, SHA1)
output:

Object with the filename associated hashes if the hash is part of a known set.
references:

https://www.circl.lu/services/hashlookup/

Have I Been Pwned Lookup ¶

Module to access haveibeenpwned.com API. [source code]

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.
config:

api_key
input:

An email address
output:

Additional information about the email address.
references:

https://haveibeenpwned.com/

HTML to Markdown ¶

Expansion module to fetch the html content from an url and convert it into markdown. [source code]

features:

The module take an URL as input and the HTML content is fetched from it. This content is then converted into markdown that is returned as text.
input:

URL attribute.
output:

Markdown content converted from the HTML fetched from the url.
requirements:

The markdownify python library

HYAS Insight integration to MISP provides direct, high volume access to HYAS Insight data. It enables investigators and analysts to understand and defend against cyber adversaries and their infrastructure. [source code]

features:

This Module takes the IP Address, Domain, URL, Email, Phone Number, MD5, SHA1, Sha256, SHA512 MISP Attributes as input to query the HYAS Insight API. The results of the HYAS Insight API are than are then returned and parsed into Hyas Insight Objects.

An API key is required to submit queries to the HYAS Insight API.
config:

apikey
input:

A MISP attribute of type IP Address(ip-src, ip-dst), Domain(hostname, domain), Email Address(email, email-src, email-dst, target-email, whois-registrant-email), Phone Number(phone-number, whois-registrant-phone), MDS(md5, x509-fingerprint-md5, ja3-fingerprint-md5, hassh-md5, hasshserver-md5), SHA1(sha1, x509-fingerprint-sha1), SHA256(sha256, x509-fingerprint-sha256), SHA512(sha512)
output:

Hyas Insight objects, resulting from the query on the HYAS Insight API.
references:

https://www.hyas.com/hyas-insight/
requirements:

A HYAS Insight API Key.

Intel471 Lookup ¶

Module to access Intel 471 [source code]

features:

The module uses the Intel471 python library to query the Intel471 API with the value of the input attribute. The result of the query is then returned as freetext so the Freetext import parses it.
config:
- email
- authkey
descrption:

An expansion module to query Intel471 in order to get additional information about a domain, ip address, email address, url or hash.
input:

A MISP attribute whose type is included in the following list: - hostname - domain - url - ip-src - ip-dst - email-src - email-dst - target-email - whois-registrant-email - whois-registrant-name - md5 - sha1 - sha256
output:

Freetext
references:

https://public.intel471.com/
requirements:

The intel471 python library

IP2Location.io Lookup ¶

An expansion module to query IP2Location.io to gather more information on a given IP address. [source code]

features:

The module takes an IP address attribute as input and queries the IP2Location.io API.
Free plan user will get the basic geolocation informaiton, and different subsription plan will get more information on the IP address. Refer to pricing page for more information on data available for each plan.

More information on the responses content is available in the documentation.
config:

key
input:

IP address attribute.
output:

Additional information on the IP address, such as geolocation, proxy and so on. Refer to the Response Format section in https://www.ip2location.io/ip2location-documentation to find out the full format of the data returned.
references:

https://www.ip2location.io/ip2location-documentation
requirements:

An IP2Location.io token

IPASN-History Lookup ¶

Module to query an IP ASN history service (https://github.com/D4-project/IPASN-History). [source code]

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.
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
requirements:

pyipasnhistory: Python library to access IPASN-history instance

IPInfo.io Lookup ¶

An expansion module to query ipinfo.io to gather more information on a given IP address. [source code]

features:

The module takes an IP address attribute as input and queries the ipinfo.io API.
The geolocation information on the IP address is always returned.

Depending on the subscription plan, the API returns different pieces of information then: - With a basic plan (free) you get the AS number and the AS organisation name concatenated in the org field. - With a paid subscription, the AS information is returned in the asn field with additional AS information, and depending on which plan the user has, you can also get information on the privacy method used to protect the IP address, the related domains, or the point of contact related to the IP address in case of an abuse.

More information on the responses content is available in the documentation.
config:

token
input:

IP address attribute.
output:

Additional information on the IP address, like its geolocation, the autonomous system it is included in, and the related domain(s).
references:

https://ipinfo.io/developers
requirements:

An ipinfo.io token

IPQualityScore Lookup ¶

IPQualityScore MISP Expansion Module for IP reputation, Email Validation, Phone Number Validation, Malicious Domain and Malicious URL Scanner. [source code]

features:

This Module takes the IP Address, Domain, URL, Email and Phone Number MISP Attributes as input to query the IPQualityScore API. The results of the IPQualityScore API are than returned as IPQS Fraud and Risk Scoring Object. The object contains a copy of the enriched attribute with added tags presenting the verdict based on fraud score,risk score and other attributes from IPQualityScore.
config:

apikey
input:

A MISP attribute of type IP Address(ip-src, ip-dst), Domain(hostname, domain), URL(url, uri), Email Address(email, email-src, email-dst, target-email, whois-registrant-email) and Phone Number(phone-number, whois-registrant-phone).
output:

IPQualityScore object, resulting from the query on the IPQualityScore API.
references:

https://www.ipqualityscore.com/
requirements:

A IPQualityScore API Key.

IPRep Lookup ¶

Module to query IPRep data for IP addresses. [source code]

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.
config:

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
requirements:

An access to the packetmail API (apikey)

Ninja Template Rendering ¶

Render the template with the data passed [source code]

features:

Joe Sandbox Import ¶

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. [source code]

features:

Module using the new format of modules able to return attributes and objects.

The module returns the same results as the import module joe_import taking directly the json report as input.

Even 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.

To make it work you will need to fill the 'apikey' configuration with your Joe Sandbox API key and provide a valid link as input.
config:
- apiurl
- apikey
- import_executable
- import_mitre_attack
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/
requirements:

jbxapi: Joe Sandbox API python3 library

Joe Sandbox Submit ¶

A module to submit files or URLs to Joe Sandbox for an advanced analysis, and return the link of the submission. [source code]

features:

The module requires a Joe Sandbox API key to submit files or URL, and returns the link of the submitted analysis.

It 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 directly on this submission link.
config:
- apiurl
- apikey
- accept-tac
- report-cache
- systems
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/
requirements:

jbxapi: Joe Sandbox API python3 library

Lastline Lookup ¶

Deprecation notice: this module will be deprecated by December 2021, please use vmware_nsx module.

Query Lastline with an analysis link and parse the report into MISP attributes and objects. [source code]

features:

The module requires a Lastline Portal username and password. The module uses the new format and it is able to return MISP attributes and objects. The module returns the same results as the lastline_import import module.
config:
- username
- password
- verify_ssl
input:

Link to a Lastline analysis.
output:

MISP attributes and objects parsed from the analysis report.
references:

https://www.lastline.com

Lastline Submit ¶

Deprecation notice: this module will be deprecated by December 2021, please use vmware_nsx module.

Module to submit a file or URL to Lastline. [source code]

features:

The module requires a Lastline Analysis api_token and key. When the analysis is completed, it is possible to import the generated report by feeding the analysis link to the lastline_query module.
config:
- url
- api_token
- key
input:

File or URL to submit to Lastline.
output:

Link to the report generated by Lastline.
references:

https://www.lastline.com

Macaddress.io Lookup ¶

MISP hover module for macaddress.io [source code]

features:

This module takes a MAC address attribute as input and queries macaddress.io for additional information.

This information contains data about: - MAC address details - Vendor details - Block details
config:

api_key
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
requirements:
- maclookup: macaddress.io python library
- An access to the macaddress.io API (apikey)

Macvendors Lookup ¶

Module to access Macvendors API. [source code]

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.
config:

user-agent
input:

A MAC address.
output:

Additional information about the MAC address.
references:
- https://macvendors.com/
- https://macvendors.com/api

MalShare Upload ¶

Module to push malware samples to MalShare [source code]

config:

malshare_apikey
requirements:

requests library

Malware Bazaar Lookup ¶

Query Malware Bazaar to get additional information about the input hash. [source code]

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.

The module is using the new format of modules able to return object since the result is one or multiple MISP object(s).
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/

McAfee MVISION Insights Lookup ¶

Lookup McAfee MVISION Insights Details [source code]

features:
config:
- api_key
- client_id
- client_secret

GeoIP Enrichment ¶

A hover and expansion module to enrich an ip with geolocation and ASN information from an mmdb server instance, such as CIRCL's ip.circl.lu. [source code]

features:

The module takes an IP address related attribute as input. It queries the public CIRCL.lu mmdb-server instance, available at ip.circl.lu, by default. The module can be configured with a custom mmdb server url if required. It is also possible to filter results on 1 db_source by configuring db_source_filter.
config:
- custom_API
- db_source_filter
input:

An IP address attribute (for example ip-src or ip-src|port).
output:

Geolocation and asn objects.
references:
- https://data.public.lu/fr/datasets/geo-open-ip-address-geolocation-per-country-in-mmdb-format/
- https://github.com/adulau/mmdb-server

MWDB Submit ¶

Module to push malware samples to a MWDB instance [source code]

features:

An expansion module to push malware samples to a MWDB (https://github.com/CERT-Polska/mwdb-core) instance. This module does not push samples to a sandbox. This can be achieved via Karton (connected to the MWDB). Does: * Upload of attachment or malware sample to MWDB * Tags of events and/or attributes are added to MWDB. * Comment of the MISP attribute is added to MWDB. * A link back to the MISP event is added to MWDB via the MWDB attribute. * A link to the MWDB attribute is added as an enrichted attribute to the MISP event.
config:
- mwdb_apikey
- mwdb_url
- mwdb_misp_attribute
- mwdb_public
- include_tags_event
- include_tags_attribute
input:

Attachment or malware sample
output:

Link attribute that points to the sample at the MWDB instane
requirements:
- mwdblib installed (pip install mwdblib) ; * (optional) keys.py file to add tags of events/attributes to MWDB * (optional) MWDB attribute created for the link back to MISP (defined in mwdb_misp_attribute)

OCR Enrich ¶

Module to process some optical character recognition on pictures. [source code]

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.
input:

A picture attachment.
output:

Text and freetext fetched from the input picture.
requirements:

cv2: The OpenCV python library.

ODS Enrich ¶

Module to extract freetext from a .ods document. [source code]

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.
input:

Attachment attribute containing a .ods document.
output:

Text and freetext parsed from the document.
requirements:
- ezodf: Python package to create/manipulate OpenDocumentFormat files.
- pandas_ods_reader: Python library to read in ODS files.

ODT Enrich ¶

Module to extract freetext from a .odt document. [source code]

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.
input:

Attachment attribute containing a .odt document.
output:

Text and freetext parsed from the document.
requirements:

ODT reader python library.

Onyphe Lookup ¶

Module to process a query on Onyphe. [source code]

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.
config:

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
requirements:
- onyphe python library
- An access to the Onyphe API (apikey)

Onyphe Full Lookup ¶

Module to process a full query on Onyphe. [source code]

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.

The 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.
config:

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
requirements:
- onyphe python library
- An access to the Onyphe API (apikey)

AlienVault OTX Lookup ¶

Module to get information from AlienVault OTX. [source code]

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.
config:

apikey
input:

A MISP attribute included in the following list: - hostname - domain - ip-src - ip-dst - md5 - sha1 - sha256 - sha512
output:

MISP attributes mapped from the result of the query on OTX, included in the following list: - domain - ip-src - ip-dst - text - md5 - sha1 - sha256 - sha512 - email
references:

https://www.alienvault.com/open-threat-exchange
requirements:

An access to the OTX API (apikey)

Passive SSH Enrichment ¶

An expansion module to enrich, SSH key fingerprints and IP addresses with information collected by passive-ssh [source code]

features:
config:
- custom_api_url
- api_user
- api_key

PassiveTotal Lookup ¶

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 [source code]

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
config:
- username
- api_key
input:

A MISP attribute included in the following list: - hostname - domain - ip-src - ip-dst - x509-fingerprint-sha1 - email-src - email-dst - target-email - whois-registrant-email - whois-registrant-phone - text - whois-registrant-name - whois-registrar - whois-creation-date
output:

MISP attributes mapped from the result of the query on PassiveTotal, included in the following list: - hostname - domain - ip-src - ip-dst - x509-fingerprint-sha1 - email-src - email-dst - target-email - whois-registrant-email - whois-registrant-phone - text - whois-registrant-name - whois-registrar - whois-creation-date - md5 - sha1 - sha256 - link
references:

https://www.passivetotal.org/register
requirements:
- Passivetotal python library
- An access to the PassiveTotal API (apikey)

PDF Enrich ¶

Module to extract freetext from a PDF document. [source code]

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.
input:

Attachment attribute containing a PDF document.
output:

Text and freetext parsed from the document.
requirements:

pdftotext: Python library to extract text from PDF.

PPTX Enrich ¶

Module to extract freetext from a .pptx document. [source code]

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.
input:

Attachment attribute containing a .pptx document.
output:

Text and freetext parsed from the document.
requirements:

pptx: Python library to read PowerPoint files.

Qintel QSentry Lookup ¶

A hover and expansion module which queries Qintel QSentry for ip reputation data [source code]

features:

This module takes an ip-address (ip-src or ip-dst) attribute as input, and queries the Qintel QSentry API to retrieve ip reputation data
config:
- token
- remote
input:

ip address attribute
ouput:

Objects containing the enriched IP, threat tags, last seen attributes and associated Autonomous System information
references:

https://www.qintel.com/products/qsentry/
requirements:

A Qintel API token

QR Code Decode ¶

Module to decode QR codes. [source code]

features:

The module reads the QR code and returns the related address, which can be an URL or a bitcoin address.
input:

A QR code stored as attachment attribute.
output:

The URL or bitcoin address the QR code is pointing to.
requirements:
- cv2: The OpenCV python library.
- pyzbar: Python library to read QR codes.

RandomcoinDB Lookup ¶

Module to access the ransomcoinDB (see https://ransomcoindb.concinnity-risks.com) [source code]

features:

The module takes either a hash attribute or a btc attribute as input to query the ransomcoinDB API for some additional data.

If the input is a btc address, we will get the associated hashes returned in a file MISP object. If we query ransomcoinDB with a hash, the response contains the associated btc addresses returned as single MISP btc attributes.
config:

api-key
descrption:

Module to access the ransomcoinDB with a hash or btc address attribute and get the associated btc address of hashes.
input:

A hash (md5, sha1 or sha256) or btc attribute.
output:

Hashes associated to a btc address or btc addresses associated to a hash.
references:

https://ransomcoindb.concinnity-risks.com
requirements:

A ransomcoinDB API key.

Real-time Blackhost Lists Lookup ¶

Module to check an IPv4 address against known RBLs. [source code]

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.

We display then all the information we get from those different sources.
config:

timeout
input:

IP address attribute.
output:

Text with additional data from Real-time Blackhost Lists about the IP address.
references:

RBLs list
requirements:

dnspython3: DNS python3 library

Recorded Future Enrich ¶

Module to enrich attributes with threat intelligence from Recorded Future. [source code]

features:

Enrich an attribute to add a custom enrichment object to the event. The object contains a copy of the enriched attribute with added tags presenting risk score and triggered risk rules from Recorded Future. Malware and Threat Actors related to the enriched indicator in Recorded Future is matched against MISP's galaxy clusters and applied as galaxy tags. The custom enrichment object also includes a list of related indicators from Recorded Future (IP's, domains, hashes, URL's and vulnerabilities) added as additional attributes.
config:
- token
- proxy_host
- proxy_port
- proxy_username
- proxy_password
input:

A MISP attribute of one of the following types: ip, ip-src, ip-dst, domain, hostname, md5, sha1, sha256, uri, url, vulnerability, weakness.
output:

A MISP object containing a copy of the enriched attribute with added tags from Recorded Future and a list of new attributes related to the enriched attribute.
references:

https://www.recordedfuture.com/
requirements:

A Recorded Future API token.

Reverse DNS ¶

Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes. [source code]

features:

The module takes an IP address as input and tries to find the hostname this IP address is resolved into.

The 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).

Please note that composite MISP attributes containing IP addresses are supported as well.
config:

nameserver
input:

An IP address attribute.
output:

Hostname attribute the input is resolved into.
requirements:

DNS python library

SecurityTrails Lookup ¶

An expansion modules for SecurityTrails. [source code]

features:

The module takes a domain, hostname or IP address attribute as input and queries the SecurityTrails API with it.

Multiple parsing operations are then processed on the result of the query to extract a much information as possible.

From this data extracted are then mapped MISP attributes.
config:

apikey
input:

A domain, hostname or IP address attribute.
output:

MISP attributes resulting from the query on SecurityTrails API, included in the following list: - hostname - domain - ip-src - ip-dst - dns-soa-email - whois-registrant-email - whois-registrant-phone - whois-registrant-name - whois-registrar - whois-creation-date - domain
references:

https://securitytrails.com/
requirements:
- dnstrails python library
- An access to the SecurityTrails API (apikey)

Shodan Lookup ¶

Module to query on Shodan. [source code]

features:

The module takes an IP address as input and queries the Shodan API to get some additional data about it.
config:

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/
requirements:
- shodan python library
- An access to the Shodan API (apikey)

Sigma Rule Converter ¶

An expansion hover module to display the result of sigma queries. [source code]

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.
input:

A Sigma attribute.
output:

Text displaying results of queries on the Sigma attribute.
references:

https://github.com/Neo23x0/sigma/wiki
requirements:

Sigma python library

Sigma Syntax Validator ¶

An expansion hover module to perform a syntax check on sigma rules. [source code]

features:

This module takes a Sigma rule attribute as input and performs a syntax check on it.

It displays then that the rule is valid if it is the case, and the error related to the rule otherwise.
input:

A Sigma attribute.
output:

Text describing the validity of the Sigma rule.
references:

https://github.com/Neo23x0/sigma/wiki
requirements:
- Sigma python library
- Yaml python library

SigMF Expansion ¶

Expands a SigMF Recording object into a SigMF Expanded Recording object, extracts a SigMF archive into a SigMF Recording object. [source code]

features:

Socialscan Lookup ¶

A hover module to get information on the availability of an email address or username on some online platforms. [source code]

features:

The module takes an email address or username as input and check its availability on some online platforms. The results for each platform are then returned to see if the email address or the username is used, available or if there is an issue with it.
input:

An email address or usename attribute.
output:

Text containing information about the availability of an email address or a username in some online platforms.
references:

https://github.com/iojw/socialscan
requirements:

The socialscan python library

SophosLabs Intelix Lookup ¶

An expansion module to query the Sophoslabs intelix API to get additional information about an ip address, url, domain or sha256 attribute. [source code]

features:

The module takes an ip address, url, domain or sha256 attribute and queries the SophosLabs Intelix API with the attribute value. The result of this query is a SophosLabs Intelix hash report, or an ip or url lookup, that is then parsed and returned in a MISP object.
config:
- client_id
- client_secret
input:

An ip address, url, domain or sha256 attribute.
output:

SophosLabs Intelix report and lookup objects
references:

https://aws.amazon.com/marketplace/pp/B07SLZPMCS
requirements:

A client_id and client_secret pair to authenticate to the SophosLabs Intelix API

URL Archiver ¶

Module to cache web pages of analysis reports, OSINT sources. The module returns a link of the cached page. [source code]

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.
config:

archivepath
input:

A link or url attribute.
output:

A malware-sample attribute describing the cached page.
references:

https://github.com/adulau/url_archiver
requirements:

urlarchiver: python library to fetch and archive URL on the file-system

Stairwell Lookup ¶

Module to query the Stairwell API to get additional information about the input hash attribute [source code]

features:

The module takes a hash attribute as input and queries Stariwell's API to fetch additional data about it. The result, if the payload is observed in Stariwell, is a file object describing the file the input hash is related to.
config:

apikey
input:

A hash attribute (md5, sha1, sha256).
output:

File object related to the input attribute found on Stairwell platform.
references:
- https://stairwell.com
- https://docs.stairwell.com
requirements:

Access to Stairwell platform (apikey)

STIX2 Pattern Syntax Validator ¶

An expansion hover module to perform a syntax check on stix2 patterns. [source code]

features:

This module takes a STIX2 pattern attribute as input and performs a syntax check on it.

It displays then that the rule is valid if it is the case, and the error related to the rule otherwise.
input:

A STIX2 pattern attribute.
output:

Text describing the validity of the STIX2 pattern.
references:

STIX2.0 patterning specifications
requirements:

stix2patterns python library

ThreatCrowd Lookup ¶

Module to get information from ThreatCrowd. [source code]

features:

This module takes a MISP attribute as input and queries ThreatCrowd with it.

The result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute.
input:

A MISP attribute included in the following list: - hostname - domain - ip-src - ip-dst - md5 - sha1 - sha256 - sha512 - whois-registrant-email
output:

MISP attributes mapped from the result of the query on ThreatCrowd, included in the following list: - domain - ip-src - ip-dst - text - md5 - sha1 - sha256 - sha512 - hostname - whois-registrant-email
references:

https://www.threatcrowd.org/

ThreadFox Lookup ¶

Module to search for an IOC on ThreatFox by abuse.ch. [source code]

features:

ThreatMiner Lookup ¶

Module to get information from ThreatMiner. [source code]

features:

This module takes a MISP attribute as input and queries ThreatMiner with it.

The result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute.
input:

A MISP attribute included in the following list: - hostname - domain - ip-src - ip-dst - md5 - sha1 - sha256 - sha512
output:

MISP attributes mapped from the result of the query on ThreatMiner, included in the following list: - domain - ip-src - ip-dst - text - md5 - sha1 - sha256 - sha512 - ssdeep - authentihash - filename - whois-registrant-email - url - link
references:

https://www.threatminer.org/

Triage Submit ¶

Module to submit samples to tria.ge [source code]

config:
- apikey
- url_mode

TruSTAR Enrich ¶

Module to get enrich indicators with TruSTAR. [source code]

features:

This module enriches MISP attributes with scoring and metadata from TruSTAR.

The TruSTAR indicator summary is appended to the attributes along with links to any associated reports.
config:
- user_api_key
- user_api_secret
- enclave_ids
input:

Any of the following MISP attributes: - btc - domain - email-src - filename - hostname - ip-src - ip-dst - md5 - sha1 - sha256 - 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

URLhaus Lookup ¶

Query of the URLhaus API to get additional information about the input attribute. [source code]

features:

Module using the new format of modules able to return attributes and objects.

The 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.
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/

URLScan Lookup ¶

An expansion module to query urlscan.io. [source code]

features:

This module takes a MISP attribute as input and queries urlscan.io with it.

The result of this query is then parsed and some data is mapped into MISP attributes in order to enrich the input attribute.
config:

apikey
input:

A domain, hostname or url attribute.
output:

MISP attributes mapped from the result of the query on urlscan.io.
references:

https://urlscan.io/
requirements:

An access to the urlscan.io API

VARIoT db Lookup ¶

An expansion module to query the VARIoT db API for more information about a vulnerability. [source code]

features:

The module takes a vulnerability attribute as input and queries que VARIoT db API to gather additional information.

The vuln endpoint is queried first to look for additional information about the vulnerability itself.

The exploits endpoint is also queried then to look for the information of the potential related exploits, which are parsed and added to the results using the exploit object template.
config:

API_key
input:

Vulnerability attribute.
output:

Additional information about the vulnerability, as it is stored on the VARIoT db, about the vulnerability itself, and the potential related exploits.
references:

https://www.variotdbs.pl/
requirements:

A VARIoT db API key (if you do not want to be limited to 100 queries / day)

VirusTotal v3 Lookup ¶

Enrich observables with the VirusTotal v3 API [source code]

features:

New format of modules able to return attributes and objects.

A module to take a MISP attribute as input and query the VirusTotal API to get additional data about it.

Compared to the standard VirusTotal expansion module, this module is made for advanced parsing of VirusTotal report, with a recursive analysis of the elements found after the first request.

Thus, 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.
config:
- apikey
- event_limit
- proxy_host
- proxy_port
- proxy_username
- proxy_password
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://docs.virustotal.com/reference/overview
requirements:

An access to the VirusTotal API (apikey), with a high request rate limit.

VirusTotal Public API Lookup ¶

Enrich observables with the VirusTotal v3 public API [source code]

features:

New format of modules able to return attributes and objects.

A module to take a MISP attribute as input and query the VirusTotal API to get additional data about it.

Compared to the more advanced VirusTotal expansion module, this module is made for VirusTotal users who have a low request rate limit.

Thus, it only queries the API once and returns the results that is parsed into MISP attributes and objects.
config:
- apikey
- proxy_host
- proxy_port
- proxy_username
- proxy_password
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://docs.virustotal.com/reference/overview
requirements:

An access to the VirusTotal API (apikey)

VirusTotal Upload ¶

Module to push malware samples to VirusTotal [source code]

config:

virustotal_apikey
requirements:

requests library

VMRay Submit ¶

Module to submit a sample to VMRay. [source code]

features:

This module takes an attachment or malware-sample attribute as input to query the VMRay API.

The sample contained within the attribute in then enriched with data from VMRay mapped into MISP attributes.
config:
- apikey
- url
- shareable
- do_not_reanalyze
- do_not_include_vmrayjobids
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: - text - sha1 - sha256 - md5 - link
references:

https://www.vmray.com/
requirements:

An access to the VMRay API (apikey & url)

VMware NSX Defender Enrich ¶

Module to enrich a file or URL with VMware NSX Defender. [source code]

features:

This module takes an IoC such as file hash, file attachment, malware-sample or url as input to query VMware NSX Defender.

The IoC is then enriched with data from VMware NSX Defender.
config:
- analysis_url
- analysis_verify_ssl
- analysis_key
- analysis_api_token
- vt_key
- misp_url
- misp_verify_ssl
- misp_key
input:

File hash, attachment or URL to be enriched with VMware NSX Defender.
output:

Objects and tags generated by VMware NSX Defender.
references:

https://www.vmware.com
requirements:

The module requires a VMware NSX Defender Analysis api_token and key.

VulnDB Lookup ¶

Module to query VulnDB (RiskBasedSecurity.com). [source code]

features:

This module takes a vulnerability attribute as input and queries VulnDB in order to get some additional data about it.

The 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.
config:
- apikey
- apisecret
- discard_dates
- discard_external_references
- discard_cvss
- discard_productinformation
- discard_classification
- discard_cpe
input:

A vulnerability attribute.
output:

Additional data enriching the CVE input, fetched from VulnDB.
references:

https://vulndb.cyberriskanalytics.com/
requirements:

An access to the VulnDB API (apikey, apisecret)

Vulnerability Lookup ¶

An expansion module to query Vulnerability Lookup [source code]

features:

Vulners Lookup ¶

An expansion hover module to expand information about CVE id using Vulners API. [source code]

features:

This module takes a vulnerability attribute as input and queries the Vulners API in order to get some additional data about it.

The API then returns details about the vulnerability.
config:

apikey
input:

A vulnerability attribute.
output:

Text giving additional information about the CVE in input.
references:

https://vulners.com/
requirements:
- Vulners python library
- An access to the Vulners API

Vysion Enrich ¶

Module to enrich the information by making use of the Vysion API. [source code]

features:

This module gets correlated information from Byron Labs' dark web intelligence database. With this you will get several objects containing information related to, for example, an organization victim of a ransomware attack.
config:
- apikey
- event_limit
- proxy_host
- proxy_port
- proxy_username
- proxy_password
input:

company(target-org), country, info, BTC, XMR and DASH address.
output:

MISP objects containing title, link to our webapp and TOR, i2p or clearnet URLs.
references:
requirements:
- Vysion python library
- Vysion API Key

Whois Lookup ¶

Module to query a local instance of uwhois (https://github.com/rafiot/uwhoisd). [source code]

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).
config:
- server
- port
input:

A domain or IP address attribute.
output:

Text describing the result of a whois request for the input value.
references:

https://github.com/Lookyloo/uwhoisd
requirements:

uwhois: A whois python library

WhoisFreaks Lookup ¶

An expansion module for https://whoisfreaks.com/ that will provide an enriched analysis of the provided domain, including WHOIS and DNS information. [source code]

features:

The module takes a domain as input and queries the Whoisfreaks API with it.

Some parsing operations are then processed on the result of the query to extract as much information as possible.

After this we map the extracted data to MISP attributes.
config:

apikey
input:

A domain whose Data is required
output:

MISP attributes resulting from the query on Whoisfreaks API, included in the following list: - domain - dns-soa-email - whois-registrant-email - whois-registrant-phone - whois-registrant-name - whois-registrar - whois-creation-date - domain
references:

https://whoisfreaks.com/
requirements:

An access to the Whoisfreaks API_KEY

Wikidata Lookup ¶

An expansion hover module to extract information from Wikidata to have additional information about particular term for analysis. [source code]

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.
input:

Text attribute.
output:

Text attribute.
references:

https://www.wikidata.org
requirements:

SPARQLWrapper python library

IBM X-Force Exchange Lookup ¶

An expansion module for IBM X-Force Exchange. [source code]

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.
config:
- apikey
- apipassword
input:

A MISP attribute included in the following list: - ip-src - ip-dst - vulnerability - md5 - sha1 - sha256
output:

MISP attributes mapped from the result of the query on X-Force Exchange.
references:

https://exchange.xforce.ibmcloud.com/
requirements:

An access to the X-Force API (apikey)

XLXS Enrich ¶

Module to extract freetext from a .xlsx document. [source code]

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.
input:

Attachment attribute containing a .xlsx document.
output:

Text and freetext parsed from the document.
requirements:

pandas: Python library to perform data analysis, time series and statistics.

YARA Rule Generator ¶

jj [source code]

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. Both 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
require_standard_format:

True
requirements:

yara-python python library

YARA Syntax Validator ¶

An expansion hover module to perform a syntax check on if yara rules are valid or not. [source code]

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.
input:

YARA rule attribute.
output:

Text to inform users if their rule is valid.
references:

http://virustotal.github.io/yara/
requirements:

yara_python python library

Yeti Lookup ¶

Module to process a query on Yeti. [source code]

features:

This module add context and links between observables using yeti
config:
- apikey
- url
input:

A domain, hostname,IP, sha256,sha1, md5, url of MISP attribute.
output:

MISP attributes and objects fetched from the Yeti instances.
references:
- https://github.com/yeti-platform/yeti
- https://github.com/sebdraven/pyeti
requirements:
- pyeti
- API key