aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpukkamustard <pukkamustard@posteo.net>2020-12-30 11:31:50 +0100
committerpukkamustard <pukkamustard@posteo.net>2020-12-30 11:31:50 +0100
commit6d2f3f19c9a870015ac601e54fd39eb353401917 (patch)
treeac5a757bbbc2fdbac68cb511e0e9183d019dca25
parent6cf83aabbec833f15d6d7619c1c5aa96bb9d3733 (diff)
doc/eris.adoc: Add CBOR tag
-rw-r--r--doc/eris.adoc17
-rw-r--r--public/index.html50
2 files changed, 63 insertions, 4 deletions
diff --git a/doc/eris.adoc b/doc/eris.adoc
index 187be1c..944bc23 100644
--- a/doc/eris.adoc
+++ b/doc/eris.adoc
@@ -352,6 +352,10 @@ The initial field (block size) also encodes the ERIS version. Future versions of
Note that using a single byte to encode the level limits the size of content that can be encoded with ERIS. However, the size of the largest encodable content is approximately 1e300 TiB, which seems to be sufficient for any conceivable practical applications (including an index of all atoms in the universe).
+==== CBOR Tag
+
+The CBOR tag `276` is assigned for a ERIS binary read capability (see <<_cbor_tags_registry>>). This allows efficient references to ERIS encoded content from CBOR.
+
=== URN
A read-capability can be encoded as an URN: `urn:erisx2:BASE32-READ-CAPABILITY`, where `BASE32-READ-CAPABILITY` is the unpadded Base32 <<RFC4648>> encoding of the read capability.
@@ -489,6 +493,17 @@ A list of known implementations that satisify the test vectors:
Further implementations are https://hg.sr.ht/~arnebab/wisperis/[Wisp], https://gitlab.com/openengiadina/js-eris[JavaScript] (needs to be updated to this version of the encoding) and https://gitlab.com/public.dream/dromedar/ocaml-eris[OCaml].
+== IANA Considerations
+
+=== CBOR Tags Registry
+
+This specification requires the assignment of a CBOR tag for a binary ERIS read capability. The tags should be added to the CBOR Tags Registry as defined in RFC7049 <<RFC7049>> (TODO: change to "is added" when added).
+
+|===
+| Tag | Data Item | Semantics
+| 276 | byte string | ERIS binary read capability (see <<_binary_encoding_of_read_capability>>)
+|===
+
== Acknowledgments
Thanks to Cory Slep, Arne Babenhauserheide, Serge Wroclawski, Christopher Lemmer Webber, Christian Grothoff, Natacha, Hellekin, Nemael, TG, Devan, Emery, Arie, Allen and many others for the discussions, suggestions and support.
@@ -522,6 +537,7 @@ This work is licensed under a http://creativecommons.org/licenses/by-sa/4.0/[Cre
- [[[RFC2119]]] S. Bradner, https://tools.ietf.org/html/rfc2119[Key words for use in RFCs to Indicate Requirement Levels], 1997.
- [[[RFC4648]]] S. Josefsson, https://tools.ietf.org/html/rfc4648[The Base16, Base32, and Base64 Data Encodings], 2006.
+- [[[RFC7049]]] C. Bormann & P. Hoffman. https://tools.ietf.org/html/rfc7049[Concise Binary Object Representation (CBOR)], 2013.
- [[[RFC7693]]] M-J. Saarinen and J-P. Aumasson, https://tools.ietf.org/html/rfc7693[The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC)], 2015.
- [[[RFC8439]]] Nir and Langley, https://tools.ietf.org/html/rfc8439[ChaCha20 and Poly1305 for IETF Protocols], 2018.
- [[[RFC8141]]] Saint-Andre, Filament and Klensin, https://tools.ietf.org/html/rfc8141[Uniform Resource Names (URNs)], 2017.
@@ -540,4 +556,3 @@ This work is licensed under a http://creativecommons.org/licenses/by-sa/4.0/[Cre
- [[[RFC7927]]] Kutscher et. al. https://tools.ietf.org/html/rfc7927[Information-Centric Networking (ICN) Research Challenges], 2016.
- [[[Zooko2008]]] Zooko Wilcox-O'Hearn. https://tahoe-lafs.org/hacktahoelafs/drew_perttula.html[Drew Perttula and Attacks on Convergent Encryption], 2008.
-// - [[[RFC7049]]] C. Bormann & P. Hoffman. https://tools.ietf.org/html/rfc7049[Concise Binary Object Representation (CBOR)], 2013.
diff --git a/public/index.html b/public/index.html
index 919882b..40e36a6 100644
--- a/public/index.html
+++ b/public/index.html
@@ -480,7 +480,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
</ul>
</li>
<li><a href="#_implementations">5. Implementations</a></li>
-<li><a href="#_acknowledgments">6. Acknowledgments</a></li>
+<li><a href="#_iana_considerations">6. IANA Considerations</a>
+<ul class="sectlevel2">
+<li><a href="#_cbor_tags_registry">6.1. CBOR Tags Registry</a></li>
+</ul>
+</li>
+<li><a href="#_acknowledgments">7. Acknowledgments</a></li>
<li><a href="#_changelog">Changelog</a></li>
<li><a href="#_copyright">Copyright</a></li>
<li><a href="#_references">References</a>
@@ -1468,6 +1473,12 @@ ERIS-Decode(BLOCK-SIZE, LEVEL, ROOT-REFERENCE, ROOT-KEY):
<div class="paragraph">
<p>Note that using a single byte to encode the level limits the size of content that can be encoded with ERIS. However, the size of the largest encodable content is approximately 1e300 TiB, which seems to be sufficient for any conceivable practical applications (including an index of all atoms in the universe).</p>
</div>
+<div class="sect3">
+<h4 id="_cbor_tag"><a class="anchor" href="#_cbor_tag"></a>2.6.1. CBOR Tag</h4>
+<div class="paragraph">
+<p>The CBOR tag <code>276</code> is assigned for a ERIS binary read capability (see <a href="#_cbor_tags_registry">Section 6.1</a>). This allows efficient references to ERIS encoded content from CBOR.</p>
+</div>
+</div>
</div>
<div class="sect2">
<h3 id="_urn"><a class="anchor" href="#_urn"></a>2.7. URN</h3>
@@ -1795,7 +1806,37 @@ ERIS-Decode(BLOCK-SIZE, LEVEL, ROOT-REFERENCE, ROOT-KEY):
</div>
</div>
<div class="sect1">
-<h2 id="_acknowledgments"><a class="anchor" href="#_acknowledgments"></a>6. Acknowledgments</h2>
+<h2 id="_iana_considerations"><a class="anchor" href="#_iana_considerations"></a>6. IANA Considerations</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_cbor_tags_registry"><a class="anchor" href="#_cbor_tags_registry"></a>6.1. CBOR Tags Registry</h3>
+<div class="paragraph">
+<p>This specification requires the assignment of a CBOR tag for a binary ERIS read capability. The tags should be added to the CBOR Tags Registry as defined in RFC7049 <a href="#RFC7049">[RFC7049]</a> (TODO: change to "is added" when added).</p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Tag</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Data Item</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Semantics</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">276</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">byte string</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ERIS binary read capability (see <a href="#_binary_encoding_of_read_capability">Section 2.6</a>)</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_acknowledgments"><a class="anchor" href="#_acknowledgments"></a>7. Acknowledgments</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Thanks to Cory Slep, Arne Babenhauserheide, Serge Wroclawski, Christopher Lemmer Webber, Christian Grothoff, Natacha, Hellekin, Nemael, TG, Devan, Emery, Arie, Allen and many others for the discussions, suggestions and support.</p>
@@ -1843,6 +1884,9 @@ ERIS-Decode(BLOCK-SIZE, LEVEL, ROOT-REFERENCE, ROOT-KEY):
<p><a id="RFC4648"></a>[RFC4648] S. Josefsson, <a href="https://tools.ietf.org/html/rfc4648">The Base16, Base32, and Base64 Data Encodings</a>, 2006.</p>
</li>
<li>
+<p><a id="RFC7049"></a>[RFC7049] C. Bormann &amp; P. Hoffman. <a href="https://tools.ietf.org/html/rfc7049">Concise Binary Object Representation (CBOR)</a>, 2013.</p>
+</li>
+<li>
<p><a id="RFC7693"></a>[RFC7693] M-J. Saarinen and J-P. Aumasson, <a href="https://tools.ietf.org/html/rfc7693">The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC)</a>, 2015.</p>
</li>
<li>
@@ -1905,7 +1949,7 @@ ERIS-Decode(BLOCK-SIZE, LEVEL, ROOT-REFERENCE, ROOT-KEY):
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2020-12-13 17:56:58 +0100
+Last updated 2020-12-30 11:30:55 +0100
</div>
</div>
</body>