| Internet-Draft | dns+cbor | November 2024 |
| Lenders, et al. | Expires 11 May 2025 | [Page] |
This document specifies a compressed data format of DNS messages using the Concise Binary Object Representation [RFC8949]. The primary purpose is to keep DNS messages small in constrained networks.¶
This note is to be removed before publishing as an RFC.¶
The latest revision of this draft can be found at https://anr-bmbf-pivot.github.io/draft-lenders-dns-cbor/draft-lenders-dns-cbor.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-lenders-dns-cbor/.¶
Discussion of this document takes place on the CBOR Working Group mailing list (mailto:[email protected]), which is archived at https://mailarchive.ietf.org/arch/browse/cbor/. Subscribe at https://www.ietf.org/mailman/listinfo/cbor/.¶
Source for this draft and an issue tracker can be found at https://github.com/anr-bmbf-pivot/draft-lenders-dns-cbor.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any 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 11 May 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
In constrained networks [RFC7228], the link layer may restrict the payload sizes of frames to only a few hundreds bytes. Encrypted DNS resolution, such as DNS over HTTPS (DoH) [RFC8484] or DNS over CoAP (DoC) [I-D.ietf-core-dns-over-coap], may lead to DNS message sizes that exceed this limit, even when implementing header compression such as 6LoWPAN IPHC [RFC6282] or SCHC [RFC8724], [RFC8824].¶
Although adoption layers such as 6LoWPAN [RFC4944] or SCHC [RFC8724] offer fragmentation to comply with small MTUs, fragmentation should be avoided in constrained networks. Fragmentation combined with high packet loss multiplies the likelihood of loss. Hence, a compression format that reduces fragmentation of DNS messages is beneficial.¶
This document specifies a compressed data format for DNS messages using Concise Binary Object Representation (CBOR) [RFC8949] encoding. Additionally, unnecessary or redundant information are stripped off DNS messages. To use the outcome of this specification in DoH and DoC, this document also specifies a Media Type header for DoH and a Content-Format option for DoC.¶
Note, that there is another format that expresses DNS messages in CBOR, C-DNS [RFC8618]. C-DNS is primarily a file format to minimize traces of multiple DNS messages and uses the fact that there are multiple messages to do its compression. Common values such as names or addresses are collected in separate tables which are referenced from the messages, comparable to CBOR-packed [I-D.ietf-cbor-packed]. However, this may add overhead for individual DNS messages.¶
The format described in this document is a transfer format that aims to provide conciseness and compression for individual DNS messages to be sent over the network. This is achieved applying the following objectives:¶
Encoding DNS messages in CBOR (conciseness),¶
Omitting (redundant) fields in DNS queries and responses (conciseness),¶
Providing easy to implement name compression that allows for on-the-fly construction of DNS queries and responses (compression), and¶
Providing optional address and value compression in DNS responses using CBOR-packed [I-D.ietf-cbor-packed] (compression).¶
CBOR types (unsigned integer, byte string, text string, arrays, etc.) are used as defined in [RFC8949].¶
The terms "DNS server", "DNS client", and "(DNS) resolver" are used as defined in [RFC8499].¶
A DNS query is a message that queries DNS information from an upstream DNS resolver. The reply to that is a DNS response.¶
The DNS message format specified in [RFC1035] for DNS over UDP we call "classic DNS format" throughout this document or refer to it by its media type "application/dns-message" as specified in [RFC8484].¶
The term "constrained networks" is used as defined in [RFC7228].¶
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 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
DNS messages are represented as CBOR arrays to minimize overhead. All CBOR items used in this specification are of definite length. CBOR arrays that do not follow the length definitions of this or of follow-up specifications, MUST be silently ignored. CBOR arrays that exceed the message size provided by the transport, MUST be silently ignored. It is assumed that DNS query and DNS response are distinguished message types and that the query can be mapped to the response by the transfer protocol of choice. To define the representation of binary objects we use the Concise Data Definition Language (CDDL) [RFC8610]. For examples, we use the CBOR Extended Diagnostic Notation [I-D.ietf-cbor-edn-literals].¶
dns-message = dns-query / dns-response
If, for any reason, a DNS message cannot be represented in the CBOR format specified in this document, or if unreasonable overehead is introduced, a fallback to another DNS message format, e.g., the classic DNS format specified in [RFC1035], MUST always be possible.¶
Domain names are represented by a sequence of one or more (unicode) text strings.
For instance, "example.org" would be represented as "example","org" in CBOR diagnostic notation.
The root domain "." is represented as an empty string "".
The absence of any label or tag TBDt (see Section 3.1.1 below) means the name is elided.
For the purpose of this document, domain names remain case-insensitive as specified in [RFC1035].¶
The representation of a domain name is defined in Figure 2. A label may either be encoded in ASCII-compatible encoding (ACE) [RFC5891] embedded within UTF-8 encoding of the text strings or plain UTF-8. It is RECOMMENDED to use the encoding with the shorter length in bytes. A decoder MAY identify the ACE encoding by identifying the label as a valid A-label (see [RFC5891]) and MUST assume the label to be encoded in UTF-8 otherwise.¶
This sequence of text strings is supposed to be embedded into a surrounding array, usually the query or resource record.¶
domain-name = ( * label, ? ( #6.TBDt(uint) / label ), ) label = tstr
Names are compressed by pointing to existing labels in the message. CBOR objects are typically decoded depth-first. Whenever we encounter a label we take the value of a counter c as the position of that label. The counter c is then increased.¶
A tag TBDt may follow any sequence of labels, even an empty sequence. This tag TBDt encapsulates an unsigned integer i which points to a label at position i. i MUST be smaller than c. A name then is decoded as any label that then preceded tag TBDt(i) and all labels including and following at position i are appended. This includes any further occurrence of tag TBDt after the referenced label sequence, though the decoding stops after this tag was recursively decoded. Note, that this also may include simple values or tags that reference the packing table with CBOR-packed (see Section 4).¶
For instance, the name "www.example.org" can be encountered twice in the example in Figure 3 (notated in CBOR Extended Diagnostic Notation, see [I-D.ietf-cbor-edn-literals]).¶
[
# AAAA (28, elided) question for "example.org"
[ "example" / c == 0 /, "org" / c == 1 / ],
# Answer section:
[
# "example.org" (elided) CNAME (5) is "www.example.org"
[ 5, "www" / c == 2 /, TBDt(0) / references c == 0 / ],
# "www.example.org" AAAA (28, elided) is 2001:db8::1
[
TBDt(2) / references c == 2 /,
h'20010db8000000000000000000000001'
]
]
]
The pseudo-code for this DNS name suffix extension algorithm can be seen in Figure 4.¶
function decode_name(obj: cbor_obj, cbor_ptr: cbor_major_type): list
{
name: list = []
visited: set = {}
while (typeof(cbor_ptr) in {tstr, tag}):
if typeof(cbor_ptr) == tag:
if cbor_ptr.tag != TBDt:
break
i: uint = cbor_ptr.value
if i-th text string after (depth first) cbor_ptr:
return ERROR("Forward reference not allowed")
cbor_ptr =
jump to i-th text string (depth first) in obj
if cbor_ptr in visited:
return ERROR("Circular reference")
# cbor_ptr should be of type tstr at this point
name.append(cbor_ptr)
visited.add(cbor_ptr)
return name
}
This document specifies the representation of both standard DNS resource records (RRs, see [RFC1035])
and EDNS option pseudo-RRs (see [RFC6891].Also add capability to summarize Resource Record Sets to one array, e.g. ["example","org",3600,1,[b'c0002563', h'c00021ab']]?mlenders
If for any reason, a resource record cannot be represented in the given formats, they can be
represented in their binary wire-format form as a byte string.¶
Further special records, e.g., TSIG can be defined in follow-up specifications and are out of scope of this document.¶
The representation of a DNS resource records is defined in Figure 5.¶
$$dns-rr = rr / #6.141(opt-rr) / bstr
Standard DNS resource records are encoded as CBOR arrays containing 2 or more entries in the following order:¶
An optional name (as text string, see Section 3.1),¶
A TTL (as unsigned integer),¶
An optional record type (as unsigned integer),¶
An optional record class (as unsigned integer), and lastly¶
A record data entry (as byte string, domain name, or array for dedicated record data representation).¶
If the first item of the resource record is a text string, it is the first label of a domain name (see Section 3.1). If the name is elided, the name is derived from the question section of the message. For responses, the question section is either taken from the query (see Section 3.3) or provided with the response see Section 3.4. The query may be derived from the context of the transfer protocol.¶
If the record type is elided, the record type from the question is assumed. If record class is elided, the record class from the question is assumed. When a record class is required to be expressed, the record type MUST also be provided.¶
The byte string format of the record data as a byte string follows the classic DNS format as specified in Section 3.3 [RFC1035] (or other specifications of the respective record type). Note that the CBOR format does not include the RDLENGTH field from the classic format as this value is encoded in the length field of the CBOR header of the byte string.¶
If the record data represents a domain name (e.g., for CNAME or PTR records), the record data MAY be represented as domain name as specified in Section 3.1. This can save 1 byte of data, as the zero byte at the end of the name is not necessary with the CBOR format. Only 1 byte is required to define type and length of each text string representing a label up until a string length of 23 characters, amortizing to the same remaining length as in the name representation in the classic format. This way of representing the record data also means that name compression (see Section 3.1.1) can also be used on it.¶
Depending on the record type, the record data may also be expressed as an array.
Some initial array types are specified below.
Future specifications can extend the definition for $rdata-array in Figure 6.
These extensions mainly serve to expose names to name compression (see Section 3.1.1).
There is an argument to be made for CBOR-structured formats of other record data representations (e.g. DNSKEY or RRSIG), but structuring such records as an array usually adds more overhead than just transferring the byte representation.
As such, structured record data that do not contain names are always to be represented as a byte string.¶
max-uint8 = 0..255 max-uint16 = 0..65535 max-uint32 = 0..4294967295 ttl = max-uint32 rr = [ ? domain-name, ttl: ttl, type-spec-rdata, ] type-spec-rdata = ( ? type-spec, rdata: bstr // ( domain-name ), ) type-spec-rdata //= ( $$structured-ts-rd ) type-spec = ( record-type: max-uint16, ? record-class: max-uint16, )
The record data of RRs with record-type = 6 (SOA) MAY be expressed as an array with at least 7 entries representing the 7 parts of the SOA resource record defined in [RFC1035] in the following order:¶
MNAME as a domain name (see Section 3.1),¶
SERIAL as an unsigned integer,¶
REFRESH as an unsigned integer,¶
RETRY as an unsigned integer,¶
EXPIRE as an unsigned integer,¶
MINIMUM as an unsigned integer, and¶
RNAME as a domain name (see Section 3.1).¶
MNAME and RNAME are put to the beginning and end of the array, respectively, to keep their labels apart.¶
The definition for MX record data can be seen in Figure 7.¶
$$structured-ts-rd //= ( 6, ; record-type = SOA ? 1, ; record-class = IN soa, ) soa = [ domain-name, ; mname serial: max-uint32, refresh: max-uint32, retry: max-uint32, expire: max-uint32, minimum: max-uint32, domain-name, ; rname ]
The record data of RRs with record-type = 15 (MX) MAY be expressed as an array with at least 2 entries representing the 2 parts of the MX resource record defined in [RFC1035] in the following order:¶
PREFERENCE as an unsigned integer and¶
EXCHANGE as a domain name (see Section 3.1).¶
The definition for MX record data can be seen in Figure 8.¶
$$structured-ts-rd //= ( 15, ; record-type = MX ? 1, ; record-class = IN mx, ) mx = [ preference: max-uint16, domain-name, ; exchange ]
The record data of RRs with record-type = 33 (SRV) MAY be expressed as an array with at least 3 entries representing the parts of the SRV resource record defined in [RFC2782] in the following order:¶
Priority as an unsigned integer,¶
an optional Weight as an unsigned integer,¶
Port as an unsigned integer,¶
Target as a domain name (see Section 3.1).¶
If the weight is present or not can be determined by the number of unsigned integers before Target. 2 unsigned integers before the Target mean the weight was elided and defaults to 0. 3 unsigned integers before the Target mean the weight is in the second position of the record data array. The default of 0 was picked, as this is the value domain administrators should pick when there is no server selection to do [RFC2782].¶
The definition for SRV record data can be seen in Figure 9.¶
$$structured-ts-rd //= ( 33, ; record-type = SRV ? 1, ; record-class = IN srv, ) srv = [ priority: max-uint16, ? weight: max-uint16 .default 0, port: max-uint16, domain-name, ; target ]
The record data of RRs with record-type = 64 (SVCB) and record-type = 65 (HTTPS) MAY be expressed as an array with at least 3 entries representing the 3 parts of the SVCB/HTTPS resource record defined in [RFC9460] in the following order:¶
An optional SvcPriority as an unsigned integer,¶
An optional TargetName as a domain name (see Section 3.1), and¶
SvcParams as an array of alternating pairs of SvcParamKey (as unsigned integer) and SvcParamValue (as byte string). The type of SvcParamValue may be extended in future specifications.¶
If the SvcPriority is present can be determined by checking if the record data array starts with an unsigned integer or not. If the array does not start with an unsigned integer, the SvcPriority is elided and defaults to 0, i.e., the record is in AliasMode (see Section 2.4.2 of [RFC9460]). If the array starts with a unsigned integer, it is the SvcPriority.¶
If the TargetName is present can be determined by checking if the record data array has a text string or tag TBDt after the SvcPriority, i.e., if the SvcPriority is elided the array would start with a text string or tag TBDt.
If there is no text string or tag TBDt after the SvcPriority, the TargetName is elided and defaults to the sequence of text strings "" (i.e. the root domain "." in the common name representation defined in Section 2.3.1 of [RFC1035], see Section 3.1) and Section 2.5 of [RFC9460].
If there is a text string or tag TBDt after the SvcPriority, the TargetName is not elided and in the domain name form specified in Section 3.1.¶
The definition for SVCB and HTTPS record data can be seen in Figure 10.¶
$$structured-ts-rd //= ( 64 / 65, ; record-type = SVCB or HTTPS ? 1, ; record-class = IN svcb, ) svcb = [ ? svc-priority: max-uint16 .default 0, ? domain-name, ; target name svc-params: [ *svc-param-pair ], ] svc-param-pair = ( svc-param-key: max-uint16, svc-param-value: $$svc-param-value, ) $$svc-param-value = bstr
The SvcParams are provided as an array rather than a map, as their order needs to be preserved [RFC9460] which can not be guaranteed for maps.¶
EDNS OPT Pseudo-RRs are represented as a CBOR array. To distinguish them from normal standard RRs, they are marked with tag TBD141.¶
Name and record type can be elided as they are always "." and OPT (41), respectively [RFC6891].¶
The UDP payload size may be the first element as an unsigned integer in the array. It MUST be elided if its value is the default value of 512, the maximum allowable size for unextended DNS over UDP (see Sections 2.3.4 and 4.2.1 of [RFC1035]).¶
The next element is a map of the options, with the option code (unsigned integer) as key and the option data (byte string) as value. The type of option data may be extended in future specifications.¶
After that, up to three unsigned integers are following. The first being the extended flags as unsigned integer (implied to be 0 if elided), the second the extended RCODE as an unsigned integer (implied to be 0 if elided), and the third the EDNS version (implied to be 0 if elided). They are dependent on each of their previous elements. If the EDNS version is not elided, both extended flags and extended RCODE MUST not be elided. If the RCODE is not elided the extended flags MUST not be elided.¶
Note that future EDNS versions may require a different format than the one described above.¶
opt-rr = [
? udp-payload-size: max-uint16 .default 512,
options: {* ocode => $$odata },
? opt-rcode-v-flags,
]
ocode = max-uint16
opt-rcode-v-flags = (
flags: max-uint16 .default 0,
? opt-rcode-v,
)
rcode = 0..4095
opt-rcode-v = (
rcode: rcode .default 0,
? version: max-uint8 .default 0,
)
$$odata = bstr
DNS queries are encoded as CBOR arrays containing up to 6 entries in the following order:¶
An optional boolean field,¶
An optional flag field (as unsigned integer),¶
The question section (as array),¶
An optional answer section (as array),¶
An optional authority section (as array), and¶
An optional additional section (as array)¶
If the first item is a boolean and when true, it tells the responding resolver that it MUST include the question section in its response. If that boolean is not present, it is assumed to be false.¶
If the first item of the query is an array, it is the question section, if it is an unsigned integer, it is as flag field and maps to the header flags in [RFC1035] and the "DNS Header Flags" IANA registry including the QR flag and the Opcode.¶
If the flags are elided, the value 0 is assumed.¶
This specification assumes that the DNS messages are sent over a transfer protocol that can map the queries to their responses, e.g., DNS over HTTPS [RFC8484] or DNS over CoAP [I-D.ietf-core-dns-over-coap]. As a consequence, the DNS transaction ID is always elided and the value 0 is assumed.¶
A question record within the question section is encoded as a CBOR array containing the following entries:¶
The queried name (as domain name, see Section 3.1) which MUST not be elided,¶
An optional record type (as unsigned integer), and¶
An optional record class (as unsigned integer)¶
If the record type is elided, record type AAAA as specified in [RFC3596] is assumed.
If the record class is elided, record class IN as specified in [RFC1035] is assumed.
When a record class is required, the record type MUST also be provided.¶
There usually is only one question record [RFC9619], which is why the question section is a flat array and not nested like the other sections. This serves to safe overhead from the additional CBOR array header. In the rare cases when there is more than one question record in the question section, the next question just follows. In this case, for every question but the last, the record type MUST be included, i.e., it is not optional. This way it is ensured that the parser can distinguish each question by looking up the name first.¶
The remainder of the query is either empty or MUST consist of up to three extra arrays.¶
If one extra array is in the query, it encodes the additional section of the query as an array of DNS resource records (see Section 3.2). If two extra arrays are in the query, they encode, in that order, the authority and additional sections of the query each as an array of DNS resource records (see Section 3.2). If three extra arrays are in the query, they encode, in that order, the answer section, the authority, and additional sections of the query each as an array of DNS resource records (see Section 3.2).¶
As such, the highest precedence in elision is given to the answer section, as it only occurs with mDNS to signify Known Answers [RFC6762]. The lowest precedence is given to the additional section, as it may contain EDNS OPT Pseudo-RRs, which are common in queries (see Section 3.2.2).¶
The representation of a DNS query is defined in Figure 12.¶
dns-query = [ ? incl-question: bool .default false, ? flags: max-uint16 .default 0x0000, question-section, ? query-extra-sections, ] question-section = [ * full-question, ? last-question, ] full-question = ( domain-name, type-spec, ) last-question = ( domain-name, ? type-spec, ) query-extra-sections = ( ? answer-section, extra-sections, ) answer-section = [+ $$dns-rr] extra-sections = ( ? authority: [+ $$dns-rr], additional: [+ $$dns-rr], )
A DNS response is encoded as a CBOR array containing up to 5 entries.¶
An optional flag field (as unsigned integer),¶
An optional question section (as array, encoded as described in Section 3.3)¶
The answer section (as array),¶
An optional authority section (as array), and¶
An optional additional section (as array)¶
As for queries, the DNS transaction ID is elided and implied to be 0.¶
If the CBOR array is a response to a query for which the flags indicate that flags are set in the response, they MUST be set accordingly and thus included in the response. If the flags are not included, the flags are implied to be 0x8000 (everything unset except for the QR flag).¶
If the response includes only one array, then the DNS answer section represents an array of one or more DNS Resource Records (see Section 3.2).¶
If the response includes more than 2 arrays, the first entry may be the question section, identified by not being an array of arrays. If it is present, it is followed by the answer section. The question section is encoded as specified in Section 3.3.¶
If the answer section is followed by one extra array, this array is the additional section. Like the answer section, the additional section is represented as an array of one or more DNS Resource Records (see Section 3.2).¶
If the answer section is followed by two extra arrays, the first is the authority section, and the second is the additional section. The authority section is also represented as an array of one or more DNS Resource Records (see Section 3.2).¶
The authority section is given precedence in elision over the additional section, as due to EDNS options or, e.g., CNAME answers that also provide the A/AAAA records. The additional section tends to show up more often than the authority section.¶
dns-response = [ ? flags: max-uint16 .default 0x8000, ? question-section, answer-section, ? extra-sections, ]
If both DNS server and client support CBOR-packed [I-D.ietf-cbor-packed], it MAY be used for further compression in DNS responses. Especially IPv6 addresses, e.g., in AAAA resource records can benefit from straight referencing to compress common address prefixes.¶
A DNS client uses the media type "application/dns+cbor;packed=1" to negotiate (see, e.g., [RFC9110] or [RFC7252], Section 5.5.4) with the DNS server whether the server supports packed CBOR. If it does, it MAY request the response to be in CBOR-packed (media type "application/dns+cbor;packed=1"). The server then SHOULD reply with the response in CBOR-packed, which it also signals with media type "application/dns+cbor;packed=1".¶
The representation of DNS responses in CBOR-packed has the same semantics as for tag TBD113 ([I-D.ietf-cbor-packed], Section 3.1) with the rump being the compressed response. The difference to [I-D.ietf-cbor-packed] is that tag TBD113 is OPTIONAL.¶
Packed compression of queries is not specified, as apart from EDNS(0) (see Section 3.2.2), they only consist of one question most of the time, i.e., there is close to no redundancy.¶
The method of the compressor to construct the packing table, i.e., how the compression is applied, is out of scope of this document. Several potential compression algorithms were evaluated in [TBD].¶
This section records the status of known implementations of the protocol defined by this specification at the time of posting of this Internet-Draft, and is based on a proposal described in [RFC7942]. The description of implementations in this section is intended to assist the IETF in its decision processes in progressing drafts to RFCs. Please note that the listing of any individual implementation here does not imply endorsement by the IETF. Furthermore, no effort has been spent to verify the information presented here that was supplied by IETF contributors. This is not intended as, and must not be construed to be, a catalog of available implementations or their features. Readers are advised to note that other implementations may exist.¶
According to [RFC7942], "this will allow reviewers and working groups to assign due consideration to documents that have the benefit of running code, which may serve as evidence of valuable experimentation and feedback that have made the implemented protocols more mature. It is up to the individual working groups to use this information as they see fit".¶
The authors of this document provide a decoder/encoder implementation of both the unpacked and packed format specified in this document in Python.¶
The authors of this document provide a decoder/encoder implementation of the unpacked format specified in this document for the RIOT operating system. It can only encode queries and decode responses.¶
TODO Security¶
This document registers a media type for the serialization format of DNS messages in CBOR. It follows the procedures specified in [RFC6838].¶
Type name: application¶
Subtype name: dns+cbor¶
Required parameters: None¶
Optional parameters: packed¶
Encoding considerations: Must be encoded as using [RFC8949]. See [TBD-this-spec] for details.¶
Security considerations: See Section 6 of this draft¶
Interoperability considerations: TBD¶
Published specification: [TBD-this-spec]¶
Applications that use this media type: TBD DNS over X systems¶
Fragment Identifier Considerations: TBD¶
Additional information:¶
Deprecated alias names for this type: N/A¶
Magic number(s): N/A¶
File extension(s): dnsc¶
Macintosh file type code(s): none¶
Person & email address to contact for further information: Martine S. Lenders [email protected]¶
Intended usage: COMMON¶
Restrictions on Usage: None?¶
Author: Martine S. Lenders [email protected]¶
Change controller: Martine S. Lenders [email protected]¶
Provisional registrations? No¶
IANA is requested to assign CoAP Content-Format ID for the new DNS message media types in the "CoAP Content-Formats" sub-registry, within the "CoRE Parameters" registry [RFC7252], corresponding the "application/dns+cbor" media type specified in Section 7.1:¶
A DNS query of the record AAAA in class IN for name "example.org" is
represented in CBOR extended diagnostic notation (EDN) (see Section 8 in
[RFC8949] and Appendix G in [RFC8610]) as follows:¶
[["example", "org"]]¶
A query of an A record for the same name is represented as¶
[["example", "org", 1]]¶
A query of ANY record for that name is represented as¶
[["example", "org", 255, 255]]¶
The responses to the examples provided in Appendix A.1 are shown below. We use the CBOR extended diagnostic notation (EDN) (see [I-D.ietf-cbor-edn-literals] and Appendix G in [RFC8610]).¶
To represent an AAAA record with TTL 300 seconds for the IPv6 address 2001:db8::1, a minimal
response to [["example", "org"]] could be¶
[[[300, h'20010db8000000000000000000000001']]]¶
In this case, the name is derived from the query.¶
If the name or the context is required, the following response would also be valid:¶
[[["example", "org", 300, h'20010db8000000000000000000000001']]]¶
If the query can not be mapped to the response for some reason, a response would look like:¶
[["example", "org"], [[300, h'20010db8000000000000000000000001']]]¶
To represent a minimal response of an A record with TTL 3600 seconds for the IPv4 address
192.0.2.1, a minimal response to [["example", "org", 1]] could be¶
[[[300, h'c0000201']]]¶
Note that here also the 1 of record type A can be elided, as this record
type is specified in the question section.¶
Lastly, a response to [["example", "org", 255, 255]] could be¶
[
["example", "org", 12, 1],
[[3600, "_coap", "_udp", "local"]],
[
[3600, 2, "ns1", TBDt(0)],
[3600, 2, "ns2", TBDt(0)]
],
[
[
TBDt(2), 3600, 28,
h'20010db8000000000000000000000001'
],
[
TBDt(2), 3600, 28,
h'20010db8000000000000000000000002'
],
[
TBDt(5), 3600, 28,
h'20010db8000000000000000000000035'
],
[
TBDt(6), 3600, 28,
h'20010db8000000000000000000003535'
]
]
]
¶
This one advertises two local CoAP servers (identified by service name _coap._udp.local) at
2001:db8::1 and 2001:db8::2 and two nameservers for the example.org domain, ns1.example.org at
2001:db8::35 and ns2.example.org at 2001.db8::3535. Each of the transmitted records has a TTL of
3600 seconds.
Note the use of name compression (see Section 3.1.1) in this example.¶
Table 2 shows a comparison between the classic DNS wire format and the application/dns+cbor format. Note that the worst case results typically appear only rarely in DNS. The classic DNS format is preferred in those cases. A key for which configuration was used in which case can be seen in Table 3. Any name label that is longer than 23 bytes adds a name overhead of 1 byte to its CBOR type header.TBD: Also add structured RRs?.mlenders¶
| Item | Classic DNS format [bytes] | application/dns+cbor [bytes] | ||
|---|---|---|---|---|
| best case | realistic worst case | theoretical worst case | ||
| Header (ID & Flags) | 4 | 1 | 4 | 4 |
| Count fields | 2 | 1 | 3 | 3 |
| Question section | 6 + name len. | 2 + name len. | 6 + name len. + name overhead | 9 + name len. + name overhead |
| Standard RR | 12 + name len. + rdata len. | 3 + rdata len. |
14 + name len. + rdata len. + name overhead | 17 + name len. + rdata len. + name overhead |
| Standard RR with name rdata | 12 + name len. + rdata len. | 4 + TBDt len. | 14 + name len. + rdata len. + name overheads | 16 + name len. + rdata len. + name overheads |
| EDNS Opt Pseudo-RR | 11 + options | 2 + options | 6 + options | 14 + options |
| EDNS Option | 4 + value len. | 2 + value len. | 4 + value len. | 6 + value len. |
| Item | application/dns+cbor configuration | ||
|---|---|---|---|
| best case | realistic worst case | theoretical worst case | |
| Header (ID & Flags) | Flags elided | QR, Opcode, AA, TC, or RD are set | QR, Opcode, AA, TC, or RD are set |
| Count fields | Encoded in CBOR array header | Encoded in CBOR array header, >255 records in section |
Encoded in CBOR array header, >255 records in section |
| Question section | Class, type, and name elided | Type > 255, label len. > 23 |
Type > 255, Class > 255, label len. > 23 |
| Standard RR | Class, type, and name elided, rdata len. < 24 |
Type > 255, label len. > 23 rdata len. > 255 |
Type > 255, Class > 255, label len. > 23 rdata len. > 255 |
| Standard RR with name rdata | Class, type, and name elided, TBDt(i) with i < 24 |
Type > 255, label len. > 23 name uncompressed |
Type > 255, Class > 255, label len. > 23 name uncompressed |
| EDNS Opt Pseudo-RR | All EDNS(0) fields elided | Rcode < 24, DO flag set, |
UDP payload len. > 255 Rcode > 255 Version > 255 DO flag set |
| EDNS Option | Code < 24 Length < 24 |
Code < 24 Length > 255 |
Code > 255 Length > 255 |
Clarify why question section was designed the way it is¶
Add answer section to queries for Known Answers in mDNS¶
Express names as sequence of labels¶
Provide dedicated types for more structured RDATA¶
Add RFC1035-like name compression¶
Add switching boolean to query message to explicitly have question present in response¶
Make EDNS options a map¶
Update examples and comparison table in appendices¶
Update implementation section¶
Add Appendix B with comparison to classic DNS wire format¶
"wire format" -> "classic DNS wire format"¶
Fixes wording and spelling mistakes¶
Fix Section 7.2.1 title¶
Amend for capability to carry more than one question¶
Hint at future of name compression in later draft versions¶
Use canonical name for CBOR-packed¶
Add Discussion section and note on compression¶
TODO acknowledge.¶