DNS Error Reporting

Introduction When an authoritative server serves a stale DNSSEC-signed zone, the cryptographic signatures over the resource record sets (RRsets) may have lapsed. A validating resolver will fail to validate these resource records. Similarly, when there is a mismatch between the Delegation Signer (DS) records at a parent zone and the key signing key at the child zone, a validating resolver will fail to authenticate records in the child zone. These are two of several failure scenarios that may go unnoticed for some time by the operator of a zone. Today, there is no direct relationship between operators of validating resolvers and authoritative servers. Outages are often noticed indirectly by end users, and reported via E-Mail or social media (if reported at all). When records fail to validate, there is no facility to report this failure in an automated way. If there is any indication that an error or warning has happened, it may be buried in log files of the resolver or not logged at all. This document describes a method that can be used by validating resolvers to report DNSSEC validation errors in an automated way. It allows an authoritative server to announce a monitoring agent where validating resolvers can report issues if those resolvers are configured to do so. The burden to report a failure falls on the validating resolver. It is important that the effort needed to report failure is low, with minimal impact to its main functions. To accomplish this goal, the DNS itself is utilized to report the error.

Requirements Notation The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here.

Terminology DNS Terminology used in this document is from BCP 219 , with these additions:

Reporting resolver:: In the context of this document, "reporting resolver" is used as a shorthand for a validating resolver that supports DNS error reporting.
Report query:: The DNS query used to report an error is called a report query. A report query is for a DNS TXT resource record type. The content of the error report is encoded in the QNAME of a DNS request to the monitoring agent.
Monitoring agent:: An authoritative server that receives and responds to report queries. This facility is indicated by a domain name, referred to as the agent domain.
Agent domain:: A domain name which is returned in the DNS Error Reporting EDNS0 option that indicates where DNS resolvers can send error reports.

Overview An authoritative server indicates support for DNS error reporting by including an EDNS0 Report-Channel option with OPTION-CODE [TBD] and the agent domain in the response. The agent domain is a fully qualified, uncompressed domain name in DNS wire format. The authoritative server MUST NOT include this option in the response if the configured agent domain is empty, or is the null label (which would indicate the DNS root). The authoritative server includes the EDNS0 Report-Channel option unsolicited. That is, the option is included in a response despite the EDNS0 Report-Channel option being absent in the request. If the authoritative server has indicated support for DNS error reporting and there is an issue that can be reported via extended DNS errors, the reporting resolver encodes the error report in the QNAME of the report query. The reporting resolver builds this QNAME by concatenating the _er label, the QTYPE, the QNAME that resulted in failure, the extended error code (as described in ), the label "_er" again, and the agent domain. See the example in . Note that a regular RCODE is not included because the RCODE is not relevant to the extended error code. The resulting report query is sent as a standard DNS query for a TXT DNS resource record type by the reporting resolver. The report query will ultimately arrive at the monitoring agent. A response is returned by the monitoring agent, which in turn can be cached by the reporting resolver. This caching is essential. It dampens the number of report queries sent by a reporting resolver for the same problem, that is, once per TTL. However, certain optimizations such as and may reduce the number of error report queries as well. This document gives no guidance on the content of the TXT resource record RDATA for this record.

Managing Caching Optimizations The reporting resolver may utilize various caching optimizations that inhibit subsequent error reporting to the same monitoring agent. If the monitoring agent were to respond with NXDOMAIN (name error), says that any name at or below that domain should be considered unreachable, and negative caching would prohibit subsequent queries for anything at or below that domain for a period of time, depending on the negative TTL . Since the monitoring agent may not know the contents of all the zones for which it acts as a monitoring agent, the monitoring agent MUST NOT respond with NXDOMAIN for domains it is monitoring because that could inhibit subsequent queries. One method to avoid NXDOMAIN is to use a wildcard domain name in the zone for the agent domain. When the agent domain is signed, a resolver may use aggressive negative caching (described in ). This optimization makes use of NSEC and NSEC3 (without opt-out) records and allows the resolver to do the wildcard synthesis. When this happens, the resolver does not send subsequent queries because it will be able to synthesize a response from previously cached material. A solution is to avoid DNSSEC for the agent domain. Signing the agent domain will incur an additional burden on the reporting resolver, as it has to validate the response. However, this response has no utility to the reporting resolver other than dampening the query load for error reports. The agent domain SHOULD NOT be signed.

Example A query for "broken.test.", type A, is sent by a reporting resolver. The domain "test." is hosted on a set of authoritative servers. One of these authoritative servers serves a stale version of the "test." zone. This authoritative server has an agent domain configured: "a01.agent-domain.example.". The authoritative server with the stale "test." zone receives the request for "broken.test". It returns a response that includes the EDNS0 Report-Channel option with the domain name "a01.agent-domain.example.". The reporting resolver is unable to validate the "broken.test" RRSet for type 1 (an A record), due to an RRSIG record with an expired signature. The reporting resolver constructs the QNAME "_er.1.broken.test.7._er.a01.agent-domain.example." and resolves it. This QNAME indicates extended DNS error 7 occurred while trying to validate "broken.test." type 1 record. When this query is received at the monitoring agent (the operators of the authoritative server for a01.agent-domain.example), the agent can determine the "test." zone contained an expired signature record (extended error 7) for type A for the domain name "broken.test.". The monitoring agent can contact the operators of "test." to fix the issue.

EDNS0 Option Specification This method uses an EDNS0 option to indicate the agent domain in DNS responses. The option is structured as follows:

Field definition details:

OPTION-CODE:: 2 octets; an EDNS0 code that is used in an EDNS0 option to indicate support for error reporting. The name for this EDNS0 option code is Report-Channel.
OPTION-LENGTH:: 2-octets; contains the length of the AGENT DOMAIN field in octets.
AGENT DOMAIN:: A fully qualified domain name in uncompressed DNS wire format.

DNS error reporting specification The various errors that a reporting resolver may encounter are listed in . Note that not all listed errors may be supported by the reporting resolver. This document does not specify what is or is not an error. The DNS class is not specified in the error report.

Reporting Resolver Specification The reporting resolver MUST NOT use DNS error reporting to report a failure in resolving the report query. The EDNS0 Report-Channel option MUST NOT be included in queries. The reporting resolver MUST NOT use DNS error reporting if the authoritative server returned an empty agent domain field in the EDNS0 Report-Channel option. The reporting resolver SHOULD send error reports over TCP or SHOULD use DNS COOKIEs . This makes it hard to falsify the source address.

Constructing the Report Query The QNAME for the report query is constructed by concatenating the following elements: A label containing the string "_er". The QTYPE that was used in the query that resulted in the extended DNS error, presented as a decimal value, in a single DNS label. The list of non-null labels representing the query name which is the subject of the DNS error report. The extended DNS error, presented as a decimal value, in a single DNS label. A label containing the string "_er". The agent domain. The agent domain as received in the EDNS0 Report-Channel option set by the authoritative server. If the report query QNAME exceeds 255 octets, it MUST NOT be sent. The "_er" labels allow the monitoring agent to differentiate between the agent domain and the faulty query name. When the specified agent domain is empty, or a null label (despite being not allowed in this specification), the report query will have "_er" as a top-level domain as a result and not the original query. The purpose of the first "_er" label is to indicate that a complete report query has been received, instead of a shorter report query due to query minimization.

Authoritative server specification The authoritative server MUST NOT include more than one EDNS0 Report-Channel option in a response. The authoritative server includes the EDNS0 Report-Channel option unsolicited in responses. There is no requirement that the EDNS0 Report-Channel option is present in queries.

Monitoring agent specification It is RECOMMENDED that the authoritative server for the agent domain replies with a positive response (i.e. not NODATA or NXDOMAIN) containing a TXT record. The monitoring agent SHOULD respond to queries received over UDP that have no DNS COOKIE set with a response that has the truncation bit (TC bit) set to challenge the resolver to re-query over TCP.

Choosing an agent domain It is RECOMMENDED that the agent domain be kept relatively short to allow for a longer QNAME in the report query.

IANA Considerations IANA is requested to assign the following DNS EDNS0 option code registry:

IANA is requested to assign the following Underscored and Globally Scoped DNS Node Name registry:

Security considerations Use of DNS error reporting may expose local configuration mistakes in the reporting resolver, such as stale DNSSEC trust anchors to the monitoring agent. DNS error reporting SHOULD be done using DNS query name minimization to improve privacy. DNS error reporting is done without any authentication between the reporting resolver and the authoritative server of the agent domain. Resolvers that send error reports SHOULD send these over TCP or SHOULD use DNS COOKIEs . This makes it hard to falsify the source address. The monitoring agent SHOULD respond to queries received over UDP that have no DNS COOKIE set with a response that has the truncation bit (TC bit) set to challenge the resolver to re-query over TCP. Well known addresses of reporting resolvers can provide a higher level of confidence in the error reports, and potentially enable more automated processing of these reports. Monitoring agents that receive error reports over UDP should consider that the source of the reports and the reports itself may be false. The method described in this document will cause additional queries by the reporting resolver to authoritative servers in order to resolve the report query. This method can be abused by intentionally deploying broken zones with agent domains that are delegated to victims. This is particularly effective when DNS requests that trigger error messages are sent through open resolvers or widely distributed network monitoring systems that perform distributed queries from around the globe. An adversary may create massive error report flooding to camouflage an attack.

Acknowledgements This document is based on an idea by Roy Arends and David Conrad. The authors would like to thank Peter van Dijk, Stephane Bortzmeyer, Shane Kerr, Vladimir Cunat, Paul Hoffman, Philip Homburg, Mark Andrews, Libor Peltan, Matthijs Mekking, Willem Toorop, Tom Carpay, Dick Franks, Ben Schwartz, Yaron Sheffer, Viktor Dukhovni, Wes Hardaker, James Gannon, Tim Wicinski, Warren Kumari, Gorry Fairhurst, Benno Overeinder and Petr Spacek for their contributions.