From 4119e094aa6e1a946819122ce61c557bc0c9aad1 Mon Sep 17 00:00:00 2001 From: chrisr3d Date: Thu, 5 Nov 2020 13:06:08 +0100 Subject: [PATCH] chg: [doc] Updated the farsight_passivedns module documentation --- doc/README.md | 11 ++++++++--- doc/expansion/farsight_passivedns.json | 6 +++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/README.md b/doc/README.md index f2acc42..3b2bceb 100644 --- a/doc/README.md +++ b/doc/README.md @@ -505,13 +505,18 @@ A module to query the Phishing Initiative service (https://phishing-initiative.l Module to access Farsight DNSDB Passive DNS. - **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. +>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). - **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. +>Passive-dns objects, resulting from the query on the Farsight Passive DNS API. - **references**: ->https://www.farsightsecurity.com/ +>https://www.farsightsecurity.com/, https://docs.dnsdb.info/dnsdb-api/ - **requirements**: >An access to the Farsight Passive DNS API (apikey) diff --git a/doc/expansion/farsight_passivedns.json b/doc/expansion/farsight_passivedns.json index 2c1bf05..2dbc64e 100644 --- a/doc/expansion/farsight_passivedns.json +++ b/doc/expansion/farsight_passivedns.json @@ -3,7 +3,7 @@ "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." + "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/"], + "features": "This module takes a domain, hostname or IP address MISP attribute as input to query the Farsight Passive DNS API.\n The results of rdata and rrset lookups are then returned and parsed into passive-dns objects.\n\nAn API key is required to submit queries to the API.\n It is also possible to define a custom server URL, and to set a limit of results to get.\n 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)." }