adulau/pdns-qof
1
0
Fork 0
mirror of https://github.com/adulau/pdns-qof.git synced 2024-11-22 18:17:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'master' of github.com:adulau/pdns-qof

Browse source 
Conflicts:
	i-d/pdns-qof.xml
This commit is contained in:
Alexandre Dulaunoy 2013-04-02 17:47:53 +02:00
commit 240fcf3a3f
2 changed files with 675 additions and 560 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

420
i-d/pdns-qof.txt
View file

@ -4,10 +4,11 @@
Internet Engineering Task Force Dulaunoy Internet Engineering Task Force Dulaunoy
Internet-Draft CIRCL Internet-Draft CIRCL
Intended status: Informational Kaplan Intended status: Informational Kaplan
Expires: July 5, 2013 CERT.at Expires: July 15, 2013 CERT.at
Vixie
ISC
January 2013 January 2013
Passive DNS - Common Output Format Passive DNS - Common Output Format
draft-ietf-dulaunoy-kaplan-pdns-cof-01 draft-ietf-dulaunoy-kaplan-pdns-cof-01
@ -19,99 +20,55 @@ Abstract
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any This Internet-Draft will expire on July 15, 2013.
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Copyright Notice
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Copyright (c) 2013 IETF Trust and the persons identified as the
and may be updated, replaced, or obsoleted by other documents at any document authors. All rights reserved.
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on July 5, 2013.
Dulaunoy & Kaplan Expires July 5, 2013 [Page 1]
Internet-Draft Abbreviated Title January 2013
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (http://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 3 1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
2. Limitation . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Limitation . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3. Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3.1. Output Format . . . . . . . . . . . . . . . . . . . . . . 4 3.1. Output Format . . . . . . . . . . . . . . . . . . . . . . 3
3.1.1. Whois Human Readable . . . . . . . . . . . . . . . . . 4 3.1.1. JSON . . . . . . . . . . . . . . . . . . . . . . . . . 3
3.1.2. JSON . . . . . . . . . . . . . . . . . . . . . . . . . 4 4. Mandatory Fields . . . . . . . . . . . . . . . . . . . . . . . 3
3.1.3. Bind format . . . . . . . . . . . . . . . . . . . . . 5 4.1. rrname . . . . . . . . . . . . . . . . . . . . . . . . . . 3
4. Mandatory Fields . . . . . . . . . . . . . . . . . . . . . . . 5 4.2. rrtype . . . . . . . . . . . . . . . . . . . . . . . . . . 3
4.1. rrname . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.3. rdata . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4.2. rrtype . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.4. time_first . . . . . . . . . . . . . . . . . . . . . . . . 4
4.3. rdata . . . . . . . . . . . . . . . . . . . . . . . . . . 5 4.5. time_last . . . . . . . . . . . . . . . . . . . . . . . . 4
4.4. time_first . . . . . . . . . . . . . . . . . . . . . . . . 6 5. Optional Fields . . . . . . . . . . . . . . . . . . . . . . . 4
4.5. time_last . . . . . . . . . . . . . . . . . . . . . . . . 6 5.1. count . . . . . . . . . . . . . . . . . . . . . . . . . . 4
5. Optional Fields . . . . . . . . . . . . . . . . . . . . . . . 6 5.2. bailiwick . . . . . . . . . . . . . . . . . . . . . . . . 4
5.1. sensor_id . . . . . . . . . . . . . . . . . . . . . . . . 6
5.2. count . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5.3. ttl . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5.4. bailiwick . . . . . . . . . . . . . . . . . . . . . . . . 6
5.5. class . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6. Extended Fields . . . . . . . . . . . . . . . . . . . . . . . 7
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 7
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
9. Security Considerations . . . . . . . . . . . . . . . . . . . 7
10. References . . . . . . . . . . . . . . . . . . . . . . . . . . 7
10.1. Normative References . . . . . . . . . . . . . . . . . . . 7
10.2. Informative References . . . . . . . . . . . . . . . . . . 8
Appendix A. Additional Stuff . . . . . . . . . . . . . . . . . . 8
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 8
Intellectual Property and Copyright Statements . . . . . . . . . . 10
Dulaunoy, Kaplan & Vixie info [Page 1]
Dulaunoy & Kaplan Expires July 5, 2013 [Page 2]
Internet-Draft Abbreviated Title January 2013 Internet-Draft Abbreviated Title January 2013
6. Additional Fields . . . . . . . . . . . . . . . . . . . . . . 4
6.1. x-sensor_id . . . . . . . . . . . . . . . . . . . . . . . 5
7. Extended Fields . . . . . . . . . . . . . . . . . . . . . . . 5
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 5
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 5
10. Security Considerations . . . . . . . . . . . . . . . . . . . 5
11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 5
11.1. Normative References . . . . . . . . . . . . . . . . . . 5
11.2. Informative References . . . . . . . . . . . . . . . . . 5
Appendix A. Additional Stuff . . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 6
1. Introduction 1. Introduction
@ -133,11 +90,10 @@ Internet-Draft Abbreviated Title January 2013
simple key-value structure. The benefit of having a consistent simple key-value structure. The benefit of having a consistent
Passive DNS output format is that multiple client implementations can Passive DNS output format is that multiple client implementations can
query different servers without having to have a separate parser for query different servers without having to have a separate parser for
each individual server. each individual server. [http://code.google.com/p/passive-dns-query-
[http://code.google.com/p/passive-dns-query-tool/] currently tool/] currently implements multiple parsers due to a lack of
implements multiple parsers due to a lack of standardization. The standardization. The document does not describe the protocol (e.g.
document does not describe the protocol (e.g. whois, HTTP REST or whois, HTTP REST or XMPP) used to query the Passive DNS.
XMPP) used to query the Passive DNS.
1.1. Requirements Language 1.1. Requirements Language
@ -145,32 +101,25 @@ Internet-Draft Abbreviated Title January 2013
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [RFC2119]. document are to be interpreted as described in RFC 2119 [RFC2119].
2. Limitation 2. Limitation
As a Passive DNS can include protection mechanisms for their As a Passive DNS can include protection mechanisms for their
operation, results might be different due to those protection operation, results might be different due to those protection
measures. These mechanisms filter out DNS answers if they fail some measures. These mechanisms filter out DNS answers if they fail some
criteria. The bailiwick algorithm (c.f. criteria. The bailiwick algorithm (c.f. http://www.isc.org/files/
http://www.isc.org/files/passive_dns_hardening_handout.pdf) protects passive_dns_hardening_handout.pdf) protects the Passive DNS Database
the Passive DNS Database from cache poisoning attacks [ref: Dan from cache poisoning attacks [ref: Dan Kaminsky]. Another
Kaminsky]. Another limitiation that clients querying the database limitiation that clients querying the database need to be aware of is
need to be aware of is that each query simply gets an snapshot-answer that each query simply gets an snapshot-answer of the time of
of the time of querying. Clients MUST NOT rely on consistent querying. Clients MUST NOT rely on consistent answers.
answers.
3. Format
Dulaunoy, Kaplan & Vixie info [Page 2]
Dulaunoy & Kaplan Expires July 5, 2013 [Page 3]
Internet-Draft Abbreviated Title January 2013 Internet-Draft Abbreviated Title January 2013
3. Format
A field is composed a key followed by a value separated by the single A field is composed a key followed by a value separated by the single
':' character and a space before the value. The format is based on ':' character and a space before the value. The format is based on
the initial work done by Florian Weimer and the RIPE whois format the initial work done by Florian Weimer and the RIPE whois format
@ -196,35 +145,11 @@ Internet-Draft Abbreviated Title January 2013
file output format. XXX FIXME: how does the client select which file output format. XXX FIXME: how does the client select which
answer format he wants? XXX answer format he wants? XXX
3.1.1. Whois Human Readable 3.1.1. JSON
This output format originates with the original design of BFK's
passive DNS server implementation. The intent is to be be human
readable. Every implementation MUST support the Whois human readable
format.
A sample output using the Whois format:
rrname: www.foo.be
rrtype: AAAA
rdata: 2001:6f8:202:2df::2
time_first: 2010-07-26 13:04:01
time_last: 2012-02-06 09:59:00
count: 87
3.1.2. JSON
The intent of this output format is to be easily parseable by The intent of this output format is to be easily parseable by
scripts. Every implementation SHOULD support the JSON output format. scripts. Every implementation SHOULD support the JSON output format.
Dulaunoy & Kaplan Expires July 5, 2013 [Page 4]
Internet-Draft Abbreviated Title January 2013
A sample output using the JSON format: A sample output using the JSON format:
... (list of )... ... (list of )...
@ -235,13 +160,6 @@ Internet-Draft Abbreviated Title January 2013
"time_last": "2013-02-05 17:34:03" } "time_last": "2013-02-05 17:34:03" }
... (separated by newline)... ... (separated by newline)...
3.1.3. Bind format
A sample output using the Bind format:
google-public-dns-a.google.com. IN A 8.8.8.8
4. Mandatory Fields 4. Mandatory Fields
Implementation MUST support all the mandatory fields. Implementation MUST support all the mandatory fields.
@ -255,6 +173,14 @@ Internet-Draft Abbreviated Title January 2013
4.2. rrtype 4.2. rrtype
Dulaunoy, Kaplan & Vixie info [Page 3]
Internet-Draft Abbreviated Title January 2013
This field returns the resource record type as seen by the passive This field returns the resource record type as seen by the passive
DNS. The key is rrtype and the value is in the interpreted record DNS. The key is rrtype and the value is in the interpreted record
type. If the value cannot be interpreted the decimal value is type. If the value cannot be interpreted the decimal value is
@ -265,7 +191,7 @@ Internet-Draft Abbreviated Title January 2013
PTR, SOA, TXT, DNAME, NS, SRV, RP, NAPTR, HINFO, A6 A client MUST be 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 able to understand these textual rtype values. In addition, a client
MUST be able to handle a decimal value (as mentioned above) as MUST be able to handle a decimal value (as mentioned above) as
answer. answer. XXX reference to RFC 3597.XXX
4.3. rdata 4.3. rdata
@ -273,87 +199,71 @@ Internet-Draft Abbreviated Title January 2013
this is to be interpreted as string. Depending on the rtype, this this is to be interpreted as string. Depending on the rtype, this
can be an IPv4 or IPv6 address, a domain name (as in the case of can be an IPv4 or IPv6 address, a domain name (as in the case of
CNAMEs), an SPF record, etc. A client MUST be able to interpret any CNAMEs), an SPF record, etc. A client MUST be able to interpret any
Dulaunoy & Kaplan Expires July 5, 2013 [Page 5]
Internet-Draft Abbreviated Title January 2013
value which is legal as the right hand side in a DNS zone file RFC value which is legal as the right hand side in a DNS zone file RFC
1035 [RFC1035] and RFC 1034 [RFC1034]. 1035 [RFC1035] and RFC 1034 [RFC1034]. XXX reference to RFC 3597.XXX
4.4. time_first 4.4. time_first
This field returns the first time that the record / unique tuple This field returns the first time that the record / unique tuple
(rrname, rrtype, rdata) has been seen by the passive DNS. The date (rrname, rrtype, rdata) has been seen by the passive DNS. The date is
is expressed in ISO 8601 and UTC. expressed in seconds (decimal ascii) since 1st of January 1970 (unix
timestamp). The time zone MUST be UTC.
4.5. time_last 4.5. time_last
This field returns the last time that the unique tuple (rrname, This field returns the last time that the unique tuple (rrname,
rrtype, rdata) record has been seen by the passive DNS. The date is rrtype, rdata) record has been seen by the passive DNS. The date is
expressed in ISO 8601 and UTC. XXXX.
5. Optional Fields 5. Optional Fields
Implementation SHOULD support one or more field. Implementation SHOULD support one or more field.
5.1. sensor_id 5.1. count
This field returns the sensor information where the record was seen. Specifies how many answers were received with the set of answers
The sensor_id is expressed in a decimal value. (i.e. same data). The number of requests is expressed as a decimal
value.
5.2. count 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.
Specifies how many authoritative answers were received with the set 5.2. bailiwick
of answers (i.e. same data) over all sensors. The number of requests
is expressed as a decimal value.
5.3. ttl The bailiwick is the best estimate of the apex of the zone where this
data is authoritative. String.
the TTL as specified in RFC 1035 [RFC1035] as a decimal value. 6. Additional Fields
5.4. bailiwick
XXX FIXME: input from ISC needed
5.5. class
the class as specified in RFC 1035 [RFC1035]. Valid values are IN,
HS (for HESIOD), CH (for CHAOS). May be omitted, the default
assumption that a client should make is IN.
Dulaunoy, Kaplan & Vixie info [Page 4]
Dulaunoy & Kaplan Expires July 5, 2013 [Page 6]
Internet-Draft Abbreviated Title January 2013 Internet-Draft Abbreviated Title January 2013
6. Extended Fields Implementations MAY support the following fields:
6.1. x-sensor_id
This field returns the sensor information where the record was seen.
The sensor_id is an opaque byte string as defined by RFC5001 (XXX
ref))
7. Extended Fields
An x- prefixed key means that is an extension and a non-standard An x- prefixed key means that is an extension and a non-standard
field defined by the implementation of the passive DNS. field defined by the implementation of the passive DNS.
8. Acknowledgements
7. Acknowledgements
Thanks to the Passive DNS developers who contributed to the document. Thanks to the Passive DNS developers who contributed to the document.
9. IANA Considerations
8. IANA Considerations
This memo includes no request to IANA. This memo includes no request to IANA.
10. Security Considerations
9. Security Considerations
In some cases, Passive DNS output might contain confidential In some cases, Passive DNS output might contain confidential
information and its access might be restricted. When an user is information and its access might be restricted. When an user is
@ -368,10 +278,9 @@ Internet-Draft Abbreviated Title January 2013
All drafts are required to have a security considerations section. All drafts are required to have a security considerations section.
See RFC 3552 [RFC3552] for a guide. See RFC 3552 [RFC3552] for a guide.
11. References
10. References 11.1. Normative References
10.1. Normative References
[RFC1034] Mockapetris, P., "Domain names - concepts and facilities", [RFC1034] Mockapetris, P., "Domain names - concepts and facilities",
STD 13, RFC 1034, November 1987. STD 13, RFC 1034, November 1987.
@ -385,41 +294,36 @@ Internet-Draft Abbreviated Title January 2013
[RFC4627] Crockford, D., "The application/json Media Type for [RFC4627] Crockford, D., "The application/json Media Type for
JavaScript Object Notation (JSON)", RFC 4627, July 2006. JavaScript Object Notation (JSON)", RFC 4627, July 2006.
[min_ref] authSurName, authInitials, "Minimal Reference", 2006.
11.2. Informative References
Dulaunoy, Kaplan & Vixie info [Page 5]
Dulaunoy & Kaplan Expires July 5, 2013 [Page 7]
Internet-Draft Abbreviated Title January 2013 Internet-Draft Abbreviated Title January 2013
[min_ref] authSurName, authInitials., "Minimal Reference", 2006.
10.2. Informative References
[DOMINATION] [DOMINATION]
Mad Dominators, Inc., "Ultimate Plan for Taking Over the Mad Dominators, Inc., "Ultimate Plan for Taking Over the
World", 1984, <http://www.example.com/dominator.html>. World", 1984, <http://www.example.com/dominator.html>.
[I-D.narten-iana-considerations-rfc2434bis] [I-D.narten-iana-considerations-rfc2434bis]
Narten, T. and H. Alvestrand, "Guidelines for Writing an Narten, T and H Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", IANA Considerations Section in RFCs", Internet-Draft
draft-narten-iana-considerations-rfc2434bis-09 (work in draft-narten-iana-considerations-rfc2434bis-09, March
progress), March 2008. 2008.
[RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629, [RFC2629] Rose, M.T., "Writing I-Ds and RFCs using XML", RFC 2629,
June 1999. June 1999.
[RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC
Text on Security Considerations", BCP 72, RFC 3552, Text on Security Considerations", BCP 72, RFC 3552, July
July 2003. 2003.
Appendix A. Additional Stuff Appendix A. Additional Stuff
This becomes an Appendix. This becomes an Appendix.
Authors' Addresses Authors' Addresses
Alexandre Dulaunoy Alexandre Dulaunoy
@ -433,22 +337,6 @@ Authors' Addresses
URI: http://www.circl.lu/ URI: http://www.circl.lu/
Dulaunoy & Kaplan Expires July 5, 2013 [Page 8]
Internet-Draft Abbreviated Title January 2013
Leon Aaron Kaplan Leon Aaron Kaplan
CERT.at CERT.at
Karlsplatz 1/2/9 Karlsplatz 1/2/9
@ -460,101 +348,15 @@ Internet-Draft Abbreviated Title January 2013
URI: http://www.cert.at/ URI: http://www.cert.at/
Paul Vixie
ISC
Email: vixie@isc.org
URI: http://www.isc.org/
Dulaunoy, Kaplan & Vixie info [Page 6]
Dulaunoy & Kaplan Expires July 5, 2013 [Page 9]
Internet-Draft Abbreviated Title January 2013
Full Copyright Statement
Copyright (C) The IETF Trust (2013).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Dulaunoy & Kaplan Expires July 5, 2013 [Page 10]

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

@ -1,3 +1,4 @@
<<<<<<< HEAD
<?xml version="1.0" encoding="US-ASCII"?> <?xml version="1.0" encoding="US-ASCII"?>
<!-- This template is for creating an Internet Draft using xml2rfc, <!-- This template is for creating an Internet Draft using xml2rfc,
which is available here: http://xml.resource.org. --> which is available here: http://xml.resource.org. -->
@ -332,3 +333,315 @@ v05 2007-03-10 EBD Added preamble to C program example to tell about ABNF and
images. Removed meta-characters from comments (causes problems). --> images. Removed meta-characters from comments (causes problems). -->
</back> </back>
</rfc> </rfc>
=======
<?xml version="1.0" encoding="US-ASCII"?>
<!-- This template is for creating an Internet Draft using xml2rfc,
which is available here: http://xml.resource.org. -->
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!-- One method to get references from the online citation libraries.
There has to be one entity for each item to be referenced.
An alternate method (rfc include) is described in the references. -->
<!ENTITY RFC2119 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml">
<!ENTITY RFC2629 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.2629.xml">
<!ENTITY RFC3552 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.3552.xml">
<!ENTITY RFC1035 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1035.xml">
<!ENTITY RFC1034 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.1034.xml">
<!ENTITY RFC4627 SYSTEM "http://xml.resource.org/public/rfc/bibxml/reference.RFC.4627.xml">
<!ENTITY I-D.narten-iana-considerations-rfc2434bis SYSTEM "http://xml.resource.org/public/rfc/bibxml3/reference.I-D.narten-iana-considerations-rfc2434bis.xml">
]>
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<!-- used by XSLT processors -->
<!-- For a complete list and description of processing instructions (PIs),
please see http://xml.resource.org/authoring/README.html. -->
<!-- Below are generally applicable Processing Instructions (PIs) that most I-Ds might want to use.
(Here they are set differently than their defaults in xml2rfc v1.32) -->
<?rfc strict="yes" ?>
<!-- give errors regarding ID-nits and DTD validation -->
<!-- control the table of contents (ToC) -->
<?rfc toc="yes"?>
<!-- generate a ToC -->
<?rfc tocdepth="4"?>
<!-- the number of levels of subsections in ToC. default: 3 -->
<!-- control references -->
<?rfc symrefs="yes"?>
<!-- use symbolic references tags, i.e, [RFC2119] instead of [1] -->
<?rfc sortrefs="yes" ?>
<!-- sort the reference entries alphabetically -->
<!-- control vertical white space
(using these PIs as follows is recommended by the RFC Editor) -->
<?rfc compact="yes" ?>
<!-- do not start each main section on a new page -->
<?rfc subcompact="no" ?>
<!-- keep one blank line between list items -->
<!-- end of list of popular I-D processing instructions -->
<rfc category="info" docName="draft-ietf-dulaunoy-kaplan-pdns-cof-01" ipr="full3978">
<!-- category values: std, bcp, info, exp, and historic
ipr values: full3667, noModification3667, noDerivatives3667
you can add the attributes updates="NNNN" and obsoletes="NNNN"
they will automatically be output with "(if approved)" -->
<!-- ***** FRONT MATTER ***** -->
<front>
<title abbrev="Abbreviated Title">Passive DNS - Common Output Format</title>
<author fullname="Alexandre Dulaunoy" initials=""
surname="Dulaunoy">
<organization>CIRCL</organization>
<address>
<postal>
<street>41, avenue de la gare</street>
<city>Luxembourg</city>
<region></region>
<code>L-1611</code>
<country>LU</country>
</postal>
<phone>(+352) 247 88444</phone>
<email>alexandre.dulaunoy@circl.lu</email>
<uri>http://www.circl.lu/</uri>
<!-- uri and facsimile elements may also be added -->
</address>
</author>
<author fullname="Leon Aaron Kaplan" initials=""
surname="Kaplan">
<organization>CERT.at</organization>
<address>
<postal>
<street>Karlsplatz 1/2/9</street>
<city>Vienna</city>
<region></region>
<code>A-1010</code>
<country>AT</country>
</postal>
<phone>+43 1 5056416 78</phone>
<email>kaplan@cert.at</email>
<uri>http://www.cert.at/</uri>
</address>
</author>
<author fullname="Paul Vixie" initials=""
surname="Vixie">
<organization>ISC</organization>
<address>
<postal>
<street></street>
<city></city>
<region></region>
<code></code>
<country></country>
</postal>
<phone></phone>
<email>vixie@isc.org</email>
<uri>/</uri>
<date month="January" year="2013" />
<area>General</area>
<workgroup>Internet Engineering Task Force</workgroup>
<keyword>dns</keyword>
<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>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>Passive DNS is a technique described by Florian Weimer in 2005 in Passive DNS replication, F Weimer - 17th Annual FIRST Conference on Computer Security. Since then multiple Passive DNS implementations evolved over time. Users of these Passive DNS servers query a server (often via Whois [Ref: WHOIS]), parse the results and process them in other applications.</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 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.
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. [http://code.google.com/p/passive-dns-query-tool/] currently implements multiple parsers due to a lack of standardization.
The document does not describe the protocol (e.g. whois, HTTP REST or XMPP) used to query the Passive DNS.
</t>
<section title="Requirements Language">
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in <xref
target="RFC2119">RFC 2119</xref>.</t>
</section>
</section>
<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 bailiwick algorithm (c.f. http://www.isc.org/files/passive_dns_hardening_handout.pdf) protects the Passive DNS Database from cache poisoning attacks [ref: Dan Kaminsky].
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.
</t>
</section>
<section title="Format">
<t>A field is composed a key followed by a value separated by the single ':' character and a space before the value. The format is based on the initial work done by Florian Weimer and the RIPE whois format (ref:http://www.enyo.de/fw/software/dnslogger/whois.html). The order of the fields is not significant for the same resource type. That measn, the same name tuple plus timing information identifies a unique answer per server.</t>
<figure><preamble>A sample output using the common format:</preamble><artwork><![CDATA[
rrname: www.foo.be
rrtype: AAAA
rdata: 2001:6f8:202:2df::2
time_first: 2010-07-26 13:04:01
time_last: 2012-02-06 09:59:00
count: 87
]]></artwork></figure>
<section title="Output Format">
<t>
Depending on the clients request, there might be one of three different answers from the server: Whois (human readable) output format (key-value), <xref target="RFC4627">JSON</xref> output and optionally Bind zone file output format. XXX FIXME: how does the client select which answer format he wants? XXX
</t>
<section title="JSON">
<t>The intent of this output format is to be easily parseable by scripts. Every implementation SHOULD support the JSON output format.</t>
<figure><preamble>A sample output using the JSON format:</preamble><artwork><![CDATA[
... (list of )...
{ "count": 97167,
"time_first": "2010-06-25 17:07:02",
"rrtype": "A", "rrname": "google-public-dns-a.google.com.",
"rdata": "8.8.8.8",
"time_last": "2013-02-05 17:34:03" }
... (separated by newline)...
]]></artwork></figure>
</section>
</section>
</section>
<section title="Mandatory Fields">
<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>
<section title="rrname">
<t>This field returns the name of the queried resource.</t>
</section>
<section title="rrtype">
<t>This field returns the resource record type as seen by the passive DNS. The key is rrtype and the value is in the interpreted record type. If the value cannot be interpreted the
decimal value is returned.
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
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.
XXX reference to RFC 3597.XXX
</t>
</section>
<section title="rdata">
<t>This field returns the data of the queried resource. In general, this is to be interpreted as string. Depending on the rtype, this can be an IPv4 or IPv6 address, a domain name (as in the case of CNAMEs), an SPF record, etc. A client MUST be able to interpret any value which is legal as the right hand side in a DNS zone file <xref target="RFC1035">RFC 1035</xref> and <xref target="RFC1034">RFC 1034</xref>.</t>
XXX reference to RFC 3597.XXX
</section>
<section title="time_first">
<t>This field returns the first time that the record / unique tuple (rrname, rrtype, rdata) has been seen by the passive DNS. The date is expressed in seconds (decimal ascii) since 1st of January 1970 (unix timestamp). The time zone MUST be UTC.</t>
</section>
<section title="time_last">
<t>This field returns the last time that the unique tuple (rrname, rrtype, rdata) record has been seen by the passive DNS. The date is XXXX.</t>
</section>
</section>
<section title="Optional Fields">
<t>Implementation SHOULD support one or more field.</t>
<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 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 title="bailiwick">
<t>The bailiwick is the best estimate of the apex of the zone where this data is authoritative. String.</t>
</section>
</section>
<section title="Additional Fields">
<t>Implementations MAY support the following fields:</t>
<section title="x-sensor_id">
<t>This field returns the sensor information where the record was seen. The sensor_id is an opaque byte string as defined by RFC5001 (XXX ref))</t>
</section>
</section>
<!-- This PI places the pagebreak correctly (before the section title) in the text output. -->
<?rfc needLines="8" ?>
<section anchor="Acknowledgements" title="Acknowledgements">
<t>Thanks to the Passive DNS developers who contributed to the document.</t>
</section>
<!-- Possibly a 'Contributors' section ... -->
<section anchor="IANA" title="IANA Considerations">
<t>This memo includes no request to IANA.</t>
</section>
<section anchor="Security" title="Security Considerations">
<t>In some cases, Passive DNS output might contain confidential information and its access might be restricted. When an user is querying multiple Passive DNS and aggregating the data, the sensitivity of the data must be considered.</t>
</section>
</middle>
<!-- *****BACK MATTER ***** -->
<back>
<!-- References split into informative and normative -->
<!-- There are 2 ways to insert reference entries from the citation libraries:
1. define an ENTITY at the top, and use "ampersand character"RFC2629; here (as shown)
2. simply use a PI "less than character"?rfc include="reference.RFC.2119.xml"?> here
(for I-Ds: include="reference.I-D.narten-iana-considerations-rfc2434bis.xml")
Both are cited textually in the same manner: by using xref elements.
If you use the PI option, xml2rfc will, by default, try to find included files in the same
directory as the including file. You can also define the XML_LIBRARY environment variable
with a value containing a set of directories to search. These can be either in the local
filing system or remote ones accessed by http (http://domain/dir/... ).-->
<references title="Normative References">
<!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?-->
&RFC2119;
&RFC1035;
&RFC1034;
&RFC4627;
<reference anchor="min_ref">
<!-- the following is the minimum to make xml2rfc happy -->
<front>
<title>Minimal Reference</title>
<author initials="authInitials" surname="authSurName">
<organization></organization>
</author>
<date year="2006" />
</front>
</reference>
</references>
<references title="Informative References">
<!-- Here we use entities that we defined at the beginning. -->
&RFC2629;
&RFC3552;
&I-D.narten-iana-considerations-rfc2434bis;
</references>
<section anchor="app-additional" title="Additional Stuff">
<t>This becomes an Appendix.</t>
</section>
<!-- Change Log
v00 2006-03-15 EBD Initial version
v01 2006-04-03 EBD Moved PI location back to position 1 -
v3.1 of XMLmind is better with them at this location.
v02 2007-03-07 AH removed extraneous nested_list attribute,
other minor corrections
v03 2007-03-09 EBD Added comments on null IANA sections and fixed heading capitalization.
Modified comments around figure to reflect non-implementation of
figure indent control. Put in reference using anchor="DOMINATION".
Fixed up the date specification comments to reflect current truth.
v04 2007-03-09 AH Major changes: shortened discussion of PIs,
added discussion of rfc include.
v05 2007-03-10 EBD Added preamble to C program example to tell about ABNF and alternative
images. Removed meta-characters from comments (causes problems). -->
</back>
</rfc>
>>>>>>> 2e196fca5fdab1f3fcf417f256fffbb56dfc4288