Skip to content

Commit

Permalink
Script updating gh-pages from 9e24213. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
ID Bot committed Jun 18, 2024
1 parent 0c02afa commit 9591101
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 15 deletions.
50 changes: 40 additions & 10 deletions svcb-docpath/draft-ietf-core-dns-over-coap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1155,7 +1155,12 @@ <h2 id="name-copyright-notice">
<p id="section-toc.1-1.2.1" class="keepWithNext"><a href="#section-2" class="auto internal xref">2</a>.  <a href="#name-terminology" class="internal xref">Terminology</a></p>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3">
<p id="section-toc.1-1.3.1" class="keepWithNext"><a href="#section-3" class="auto internal xref">3</a>.  <a href="#name-selection-of-a-doc-server" class="internal xref">Selection of a DoC Server</a></p>
<p id="section-toc.1-1.3.1"><a href="#section-3" class="auto internal xref">3</a>.  <a href="#name-selection-of-a-doc-server" class="internal xref">Selection of a DoC Server</a></p>
<ul class="compact toc ulBare ulEmpty">
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.3.2.1">
<p id="section-toc.1-1.3.2.1.1" class="keepWithNext"><a href="#section-3.1" class="auto internal xref">3.1</a>.  <a href="#name-discovery-using-svcb-resour" class="internal xref">Discovery using SVCB Resource Records or DNR</a></p>
</li>
</ul>
</li>
<li class="compact toc ulBare ulEmpty" id="section-toc.1-1.4">
<p id="section-toc.1-1.4.1"><a href="#section-4" class="auto internal xref">4</a>.  <a href="#name-basic-message-exchange" class="internal xref">Basic Message Exchange</a></p>
Expand Down Expand Up @@ -1449,29 +1454,50 @@ <h2 id="name-selection-of-a-doc-server">
<p id="section-3-2">When discovering the DNS resource through a link mechanism that allows describing a resource type
(e.g., the Resource Type Attribute in <span>[<a href="#RFC6690" class="cite xref">RFC6690</a>]</span>), the resource type "core.dns" can be
used to identify a generic DNS resolver that is available to the client.<a href="#section-3-2" class="pilcrow"></a></p>
<p id="section-3-3">A DoC server can also be discovered using SVCB Resource Records (RR) <span>[<a href="#RFC9460" class="cite xref">RFC9460</a>]</span>, <span>[<a href="#RFC9461" class="cite xref">RFC9461</a>]</span> or DNR
<p id="section-3-3">While there is no path specified for the DoC resource, it is <span class="bcp14">RECOMMENDED</span> to use the root path "/"
to keep the CoAP requests small.<a href="#section-3-3" class="pilcrow"></a></p>
<div id="discovery-using-svcb-resource-records-or-dnr">
<section id="section-3.1">
<h3 id="name-discovery-using-svcb-resour">
<a href="#section-3.1" class="section-number selfRef">3.1. </a><a href="#name-discovery-using-svcb-resour" class="section-name selfRef">Discovery using SVCB Resource Records or DNR</a>
</h3>
<p id="section-3.1-1">A DoC server can also be discovered using SVCB Resource Records (RR) <span>[<a href="#RFC9460" class="cite xref">RFC9460</a>]</span>, <span>[<a href="#RFC9461" class="cite xref">RFC9461</a>]</span> or DNR
Service Parameters <span>[<a href="#RFC9463" class="cite xref">RFC9463</a>]</span>.
[TBD: draft-lenders-core-coap-dtls-svcb] provides solutions
to discover CoAP over (D)TLS servers using the "alpn" SvcParam. This document specifies "docpath" as
a single-valued SvcParamKey whose value <span class="bcp14">MUST</span> be a CBOR sequence of 0 or more text strings (see
<span>[<a href="#RFC8949" class="cite xref">RFC8949</a>]</span>), delimited by length (in total octets) for the the SvcParamValue field. If the
SvcParamValue ends within a CBOR text string, the SVCB RR <span class="bcp14">MUST</span> be considered as malformed.
As a text format, e.g., in DNS zone files, the CBOR diagnostic notation (see <span><a href="https://rfc-editor.org/rfc/rfc8949#section-8" class="relref">Section 8</a> of [<a href="#RFC8949" class="cite xref">RFC8949</a>]</span>)
of that CBOR sequence can be used.<a href="#section-3-3" class="pilcrow"></a></p>
<p id="section-3-4">Note, that this specifically does not surround the text string sequence with a CBOR array or similar
of that CBOR sequence can be used.<a href="#section-3.1-1" class="pilcrow"></a></p>
<p id="section-3.1-2">Note, that this specifically does not surround the text string sequence with a CBOR array or similar
CBOR data item. This path format was chosen to coincide with the path representation in CRIs
(<span>[<a href="#I-D.ietf-core-href" class="cite xref">I-D.ietf-core-href</a>]</span>). Furthermore, it is easily transferable into a sequence of CoAP Uri-Path options by
mapping the initial byte of any present CBOR text string (see <span>[<a href="#RFC8949" class="cite xref">RFC8949</a>], <a href="https://rfc-editor.org/rfc/rfc8949#section-3" class="relref">Section 3</a></span>) into the Option
Delta and Option Length of the CoAP option, provided these CBOR text strings are all of a length
between 0 and 12 octets (see <span>[<a href="#RFC7252" class="cite xref">RFC7252</a>], <a href="https://rfc-editor.org/rfc/rfc7252#section-3.1" class="relref">Section 3.1</a></span>). Likewise, it can be transfered into a URI
path-abempty form (see <span>[<a href="#RFC3986" class="cite xref">RFC3986</a>], <a href="https://rfc-editor.org/rfc/rfc3986#section-3.3" class="relref">Section 3.3</a></span>) by replacing the initial byte of any present CBOR text
string with the "/" character, provided these CBOR text strings are all of a length lesser than 24
octets.<a href="#section-3-4" class="pilcrow"></a></p>
<p id="section-3-5">To use the service binding from a SVCB RR, the DoC client <span class="bcp14">MUST</span> send any DoC request to the CoAP
resource identifier constructed from the SvcParams including "docpath" as described in [TBD:
draft-lenders-core-coap-dtls-svcb].<a href="#section-3-5" class="pilcrow"></a></p>
<p id="section-3-6">While there is no path specified for the DoC resource, it is <span class="bcp14">RECOMMENDED</span> to use the root path "/"
to keep the CoAP requests small.<a href="#section-3-6" class="pilcrow"></a></p>
octets.<a href="#section-3.1-2" class="pilcrow"></a></p>
<p id="section-3.1-3">To use the service binding from a SVCB RR, the DoC client <span class="bcp14">MUST</span> send any DoC request to the CoAP
resource identifier constructed from the SvcParams including "docpath". A rough construction
algorithm could be as follows.
- If the "alpn" SvcParam value for the service is "coap", construct a CoAP request for CoAP over TCP,
if it is "co", construct one for CoAP over DTLS.
- The destination address for the request should be taken from additional information about the
target, e.g. from an AAAA record associated to the target or from am "ipv6hint" SvcParam value,
or, as a fallback, by querying an address for the queried host name of the SVCB record.
- The destination port for the address is taken from the "port" SvcParam value, if present.
Otherwise, take the default port of the CoAP transport.
- Set the queried host name of SVCB record in the URI-Host option.
- For each element in the CBOR sequence of the "docpath" SvcParam value, add a Uri-Path option to
the request.
- If a "port" SvcParam value is provided or if a port was queried, and if either differs from either
the default port of the transport or the destination port selected above, set that port in the
URI-Port option.<a href="#section-3.1-3" class="pilcrow"></a></p>
<p id="section-3.1-4">A more generalized construction algorithm can be found in <span>[<a href="#I-D.ietf-core-transport-indication" class="cite xref">I-D.ietf-core-transport-indication</a>]</span>.<a href="#section-3.1-4" class="pilcrow"></a></p>
</section>
</div>
</section>
</div>
<div id="basic-message-exchange">
Expand Down Expand Up @@ -1948,6 +1974,10 @@ <h3 id="name-informative-references">
<dd>
<span class="refAuthor">Bormann, C.</span> and <span class="refAuthor">H. Birkholz</span>, <span class="refTitle">"Constrained Resource Identifiers"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-core-href-15</span>, <time datetime="2024-04-21" class="refDate">21 April 2024</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-ietf-core-href-15">https://datatracker.ietf.org/doc/html/draft-ietf-core-href-15</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="I-D.ietf-core-transport-indication">[I-D.ietf-core-transport-indication]</dt>
<dd>
<span class="refAuthor">Amsüss, C.</span> and <span class="refAuthor">M. S. Lenders</span>, <span class="refTitle">"CoAP Transport Indication"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-ietf-core-transport-indication-05</span>, <time datetime="2024-03-18" class="refDate">18 March 2024</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-ietf-core-transport-indication-05">https://datatracker.ietf.org/doc/html/draft-ietf-core-transport-indication-05</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC3986">[RFC3986]</dt>
<dd>
<span class="refAuthor">Berners-Lee, T.</span>, <span class="refAuthor">Fielding, R.</span>, and <span class="refAuthor">L. Masinter</span>, <span class="refTitle">"Uniform Resource Identifier (URI): Generic Syntax"</span>, <span class="seriesInfo">STD 66</span>, <span class="seriesInfo">RFC 3986</span>, <span class="seriesInfo">DOI 10.17487/RFC3986</span>, <time datetime="2005-01" class="refDate">January 2005</time>, <span>&lt;<a href="https://www.rfc-editor.org/rfc/rfc3986">https://www.rfc-editor.org/rfc/rfc3986</a>&gt;</span>. </dd>
Expand Down
37 changes: 32 additions & 5 deletions svcb-docpath/draft-ietf-core-dns-over-coap.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Table of Contents
1. Introduction
2. Terminology
3. Selection of a DoC Server
3.1. Discovery using SVCB Resource Records or DNR
4. Basic Message Exchange
4.1. The "application/dns-message" Content-Format
4.2. DNS Queries in CoAP Requests
Expand Down Expand Up @@ -215,6 +216,11 @@ Table of Contents
in [RFC6690]), the resource type "core.dns" can be used to identify a
generic DNS resolver that is available to the client.

While there is no path specified for the DoC resource, it is
RECOMMENDED to use the root path "/" to keep the CoAP requests small.

3.1. Discovery using SVCB Resource Records or DNR

A DoC server can also be discovered using SVCB Resource Records (RR)
[RFC9460], [RFC9461] or DNR Service Parameters [RFC9463]. [TBD:
draft-lenders-core-coap-dtls-svcb] provides solutions to discover
Expand Down Expand Up @@ -243,11 +249,25 @@ Table of Contents

To use the service binding from a SVCB RR, the DoC client MUST send
any DoC request to the CoAP resource identifier constructed from the
SvcParams including "docpath" as described in [TBD: draft-lenders-
core-coap-dtls-svcb].

While there is no path specified for the DoC resource, it is
RECOMMENDED to use the root path "/" to keep the CoAP requests small.
SvcParams including "docpath". A rough construction algorithm could
be as follows. - If the "alpn" SvcParam value for the service is
"coap", construct a CoAP request for CoAP over TCP, if it is "co",
construct one for CoAP over DTLS. - The destination address for the
request should be taken from additional information about the target,
e.g. from an AAAA record associated to the target or from am
"ipv6hint" SvcParam value, or, as a fallback, by querying an address
for the queried host name of the SVCB record. - The destination port
for the address is taken from the "port" SvcParam value, if present.
Otherwise, take the default port of the CoAP transport. - Set the
queried host name of SVCB record in the URI-Host option. - For each
element in the CBOR sequence of the "docpath" SvcParam value, add a
Uri-Path option to the request. - If a "port" SvcParam value is
provided or if a port was queried, and if either differs from either
the default port of the transport or the destination port selected
above, set that port in the URI-Port option.

A more generalized construction algorithm can be found in
[I-D.ietf-core-transport-indication].

4. Basic Message Exchange

Expand Down Expand Up @@ -646,6 +666,13 @@ Table of Contents
<https://datatracker.ietf.org/doc/html/draft-ietf-core-
href-15>.

[I-D.ietf-core-transport-indication]
Amsüss, C. and M. S. Lenders, "CoAP Transport Indication",
Work in Progress, Internet-Draft, draft-ietf-core-
transport-indication-05, 18 March 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-core-
transport-indication-05>.

[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
Expand Down

0 comments on commit 9591101

Please sign in to comment.