From 9679fed7b52f3add84ff3bd5981a50b8fe20a7ac Mon Sep 17 00:00:00 2001 From: chrisr3d Date: Thu, 19 Dec 2019 09:24:16 +0100 Subject: [PATCH] add: Documentation for the new API Void module --- README.md | 1 + doc/README.md | 20 ++++++++++++++++++++ doc/expansion/apivoid.json | 9 +++++++++ 3 files changed, 30 insertions(+) create mode 100644 doc/expansion/apivoid.json diff --git a/README.md b/README.md index 38ab966..d0296a8 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj ### Expansion modules * [apiosintDS](misp_modules/modules/expansion/apiosintds.py) - a hover and expansion module to query the OSINT.digitalside.it API. +* [API Void](misp_modules/modules/expansion/apivoid.py) - an expansion and hover module to query API Void with a domain attribute. * [AssemblyLine submit](misp_modules/modules/expansion/assemblyline_submit.py) - an expansion module to submit samples and urls to AssemblyLine. * [AssemblyLine query](misp_modules/modules/expansion/assemblyline_query.py) - an expansion module to query AssemblyLine and parse the full submission report. * [Backscatter.io](misp_modules/modules/expansion/backscatter_io.py) - a hover and expansion module to expand an IP address with mass-scanning observations. diff --git a/doc/README.md b/doc/README.md index eb5e89d..64df950 100644 --- a/doc/README.md +++ b/doc/README.md @@ -22,6 +22,26 @@ On demand query API for OSINT.digitalside.it project. ----- +#### [apivoid](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/apivoid.py) + + + +Module to query APIVoid with some domain attributes. +- **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. +- **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](https://github.com/MISP/misp-modules/tree/master/misp_modules/modules/expansion/assemblyline_query.py) diff --git a/doc/expansion/apivoid.json b/doc/expansion/apivoid.json new file mode 100644 index 0000000..2173d5b --- /dev/null +++ b/doc/expansion/apivoid.json @@ -0,0 +1,9 @@ +{ + "description": "Module to query APIVoid with some domain attributes.", + "logo": "logos/apivoid.png", + "requirements": ["A valid APIVoid API key with enough credits to proceed 2 queries"], + "input": "A domain attribute.", + "output": "DNS records and SSL certificates related to the domain.", + "features": "This module takes a domain name and queries API Void to get the related DNS records and the SSL certificates. It returns then those pieces of data as MISP objects that can be added to the event.\n\nTo make it work, a valid API key and enough credits to proceed 2 queries (0.06 + 0.07 credits) are required.", + "references": ["https://www.apivoid.com/"] +}