adulau/pdns-qof
1
0
Fork 0
mirror of https://github.com/adulau/pdns-qof.git synced 2024-10-06 06:21:41 +00:00
Code Issues Projects Releases Packages Wiki Activity

typos , clarifying a few sentences

Browse source
This commit is contained in:
Aaron Kaplan 2013-12-25 14:41:55 +01:00
parent aa427d9fe1
commit 79561883df
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
i-d/pdns-qof.xml
View file

@ -130,7 +130,7 @@
<abstract> <abstract>
<t>This document describes the output format used between Passive DNS query interface. The output format description includes also a common meaning per Passive DNS system.</t> <t>This document describes the output format used between Passive DNS query interfaces. The output format description includes also a common meaning per Passive DNS system.</t>
</abstract> </abstract>
</front> </front>
@ -140,11 +140,11 @@
<t> <t>
There are multiple implementation of Passive DNS software. Users of passive DNS query each implementation and aggregate the results for their search. This document describes the output format of three Passive DNS Systems (<xref target="DNSDB"/>,<xref target="PDNSCERTAT"/> and <xref target="PDNSCIRCL"/>) which are in use today and which already share a nearly identical output format. There are multiple implementation of Passive DNS software. Users of passive DNS query each implementation and aggregate the results for their search. This document describes the output format of three Passive DNS Systems (<xref target="DNSDB"/>,<xref target="PDNSCERTAT"/> and <xref target="PDNSCIRCL"/>) which are in use today and which already share a nearly identical output format.
As the format and the meaning of output fields from each Passive DNS need to be consistent, we propose in this document a solution to commonly name each field along with their corresponding interpretation. The format format is following a simple key-value structure in <xref target="RFC4627">JSON</xref> format. As the format and the meaning of output fields from each Passive DNS need to be consistent, we propose in this document a solution to commonly name each field along with their corresponding interpretation. The format is following a simple key-value structure in <xref target="RFC4627">JSON</xref> format.
The benefit of having a consistent Passive DNS output format is that multiple client implementations can query different servers without having to have a separate parser for each The benefit of having a consistent Passive DNS output format is that multiple client implementations can query different servers without having to have a separate parser for each
individual server. <xref target="PDNSCLIENT">passivedns-client</xref>currently implements multiple parsers due to a lack of standardization. individual server. <xref target="PDNSCLIENT">passivedns-client</xref>currently implements multiple parsers due to a lack of standardization.
The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</xref>, HTTP <xref target="REST">REST</xref>) nor the query format used to query the Passive DNS. Neither does this document describe "pre-recursor" Passive DNS Systems. The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</xref>, HTTP <xref target="REST">REST</xref>) nor the query format used to query the Passive DNS. Neither does this document describe "pre-recursor" Passive DNS Systems. Both of these are separate topics and deserve their own RFC document.
</t> </t>
<section title="Requirements Language"> <section title="Requirements Language">
@ -158,7 +158,7 @@ The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</
<section title="Limitation"> <section title="Limitation">
<t> As a Passive DNS can include protection mechanisms for their operation, results might be different due to those protection measures. These mechanisms filter out DNS answers if they fail some criteria. The <xref target="BAILIWICK">bailiwick algorithm</xref> protects the Passive DNS Database from <xref target="CACHEPOISONING">cache poisoning attacks</xref>. <t> As a Passive DNS can include protection mechanisms for their operation, results might be different due to those protection measures. These mechanisms filter out DNS answers if they fail some criteria. The <xref target="BAILIWICK">bailiwick algorithm</xref> protects the Passive DNS Database from <xref target="CACHEPOISONING">cache poisoning attacks</xref>.
Another limitiation that clients querying the database need to be aware of is that each query simply gets an snapshot-answer of the time of querying. Clients MUST NOT rely on consistent answers. Another limitiation that clients querying the database need to be aware of is that each query simply gets an snapshot-answer of the time of querying. Clients MUST NOT rely on consistent answers. Not must they assume that answers must be identical across multiple Passive DNS Servers.
</t> </t>
</section> </section>
<section title="Common Output Format"> <section title="Common Output Format">
@ -177,7 +177,7 @@ The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</
</section> </section>
<section title="Mandatory Fields"> <section title="Mandatory Fields">
<t>Implementation MUST support all the mandatory fields.</t> <t>Implementation MUST support all the mandatory fields.</t>
<t>The tuple (rrtype,rrname,rdata) will always be unique within one answer per server.</t> <t>The tuple (rrname,rrtype,rdata) will always be unique within one answer per server.</t>
<section title="rrname"> <section title="rrname">
<t>This field returns the name of the queried resource.</t> <t>This field returns the name of the queried resource.</t>
</section> </section>
@ -186,7 +186,7 @@ The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</
decimal value is returned following the principle of transparency as described in <xref target="RFC3597">RFC 3597</xref>. decimal value is returned following the principle of transparency as described in <xref target="RFC3597">RFC 3597</xref>.
The resource record type can be any values as described by IANA in the DNS parameters document in the section 'DNS Label types' (http://www.iana.org/assignments/dns-parameters). The resource record type can be any values as described by IANA in the DNS parameters document in the section 'DNS Label types' (http://www.iana.org/assignments/dns-parameters).
Currently known and supported textual descritptions of rrtypes are: A, AAAA, CNAME, PTR, SOA, TXT, DNAME, NS, SRV, RP, NAPTR, HINFO, A6 Currently known and supported textual descriptions of rrtypes are: A, AAAA, CNAME, PTR, SOA, TXT, DNAME, NS, SRV, RP, NAPTR, HINFO, A6.
A client MUST be able to understand these textual rtype values. In addition, a client MUST be able to handle a decimal value (as mentioned above) as answer. A client MUST be able to understand these textual rtype values. In addition, a client MUST be able to handle a decimal value (as mentioned above) as answer.
</t> </t>
</section> </section>
@ -201,9 +201,9 @@ The document does not describe the protocol (e.g. <xref target="RFC3912">WHOIS</
</section> </section>
</section> </section>
<section title="Optional Fields"> <section title="Optional Fields">
<t>Implementation SHOULD support one or more field.</t> <t>Implementations SHOULD support one or more field.</t>
<section title="count"> <section title="count">
<t>Specifies how many answers were received with the set of answers (i.e. same data). The number of requests is expressed as a decimal value.</t> <t>Specifies how many authoritative DNS answers were received at the Passive DNS Server's collectors with the set of answers (i.e. same data). The number of requests is expressed as a decimal value.</t>
<t>Specifies the number of times this particular event denoted by the other type fields has been seen in the given time interval (between time_last and time_first). Decimal number.</t> <t>Specifies the number of times this particular event denoted by the other type fields has been seen in the given time interval (between time_last and time_first). Decimal number.</t>
</section> </section>
<section title="bailiwick"> <section title="bailiwick">