add: Documentation for the new API Void module

pull/360/head
chrisr3d 3 years ago
parent 0d3e61dc4d
commit 9679fed7b5
No known key found for this signature in database
GPG Key ID: 6BBED1B63A6D639F
  1. 1
      README.md
  2. 20
      doc/README.md
  3. 9
      doc/expansion/apivoid.json

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

@ -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)
<img src=logos/apivoid.png height=60>
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)
<img src=logos/assemblyline.png height=60>

@ -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/"]
}
Loading…
Cancel
Save