Skip to content

Implement BCP 14 #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cyyynthia wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Implement BCP 14 #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fae2cdd
implement BCP 14
cyyynthia Nov 16, 2025
537cb77
stylistic changes to BCP 14 terms
cyyynthia Nov 16, 2025
5e5308d
don't include vscode config in the repo
cyyynthia Nov 16, 2025
e4c319a
fix improper ref in bibliography
cyyynthia Nov 16, 2025
b18f45c
regenerate documents
cyyynthia Nov 16, 2025
a349f1a
link to rfc text directly in bibliography
cyyynthia Nov 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions bdasl.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Big DASL (BDASL)</title>
<link rel="stylesheet" href="spec.css"><link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><rect x=%220%22 y=%220%22 width=%22100%22 height=%22100%22 fill=%22%2300ff75%22></rect></svg>"><meta name="twitter:card" content="summary_large_image"><meta name="twitter:title" property="og:title" content="DASL: Big DASL (BDASL)"><meta name="twitter:description" property="og:description" content="BDASL extends DASL CIDs with a new hash type that works better for large files but isn't available by default in browsers, and therefore not an appropriate option in most situations."><meta name="twitter:image" property="og:image" content="https://dasl.ing/bdasl.png"><meta name="twitter:image:alt" content="Very colourful stripes, so colourful it hurts"><meta name="twitter:url" property="og:url" content="https://dasl.ing/"><meta property="og:site_name" content="DASL"><meta property="og:locale" content="en"><meta name="theme-color" content="#00ff75"></head>
<body><div class="nav-back">A specification of the <a href="/">DASL Project</a>.</div><main><header><h1>Big DASL (BDASL)</h1><table><tbody><tr><th>date</th><td>2025-10-20</td></tr><tr><th>editors</th><td><a href="https://berjon.com/">Robin Berjon</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;<br><a href="https://bumblefudge.com/">Juan Caballero</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;</td></tr><tr><th>issues</th><td><a href="https://github.com/darobin/dasl.ing/issues">list</a>, <a href="https://github.com/darobin/dasl.ing/issues/new">new</a></td></tr><tr><th>abstract</th><td><div id="abstract">
<body><div class="nav-back">A specification of the <a href="/">DASL Project</a>.</div><main><header><h1>Big DASL (BDASL)</h1><table><tbody><tr><th>date</th><td>2025-11-16</td></tr><tr><th>editors</th><td><a href="https://berjon.com/">Robin Berjon</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;<br><a href="https://bumblefudge.com/">Juan Caballero</a> &lt;<a href="mailto:[email protected]">[email protected]</a>&gt;</td></tr><tr><th>issues</th><td><a href="https://github.com/darobin/dasl.ing/issues">list</a>, <a href="https://github.com/darobin/dasl.ing/issues/new">new</a></td></tr><tr><th>abstract</th><td><div id="abstract">
<p>
BDASL extends DASL CIDs with a new hash type that works better for large files but isn't
available by default in browsers, and therefore not an appropriate option in most
Expand All @@ -30,7 +30,7 @@
<section>
<h2>Introduction</h2>
<p>
BDASL extends DASL CIDs by adding BLAKE3 support ([[blake3]). BLAKE3 is a powerful hashing
BDASL extends DASL CIDs by adding BLAKE3 support ([<a href="#ref-blake3" class="ref">blake3</a>]). BLAKE3 is a powerful hashing
framework that works well for progressive verification of large streams. Unfortunately,
it isn't available in browser (and neither is streaming hashing in general) which makes it
inappriopriate for inclusion as the primary hash function in DASL CIDs.
Expand All @@ -40,6 +40,15 @@ <h2>Introduction</h2>
focus on using such CIDs in specific cases in which participants are likely to know how
to handle them.
</p>
<section>
<h3>Terminology</h3>
<p>
The key words "<span class="bcp14">MUST</span>", "<span class="bcp14">MUST NOT</span>", "<span class="bcp14">REQUIRED</span>", "<span class="bcp14">SHALL</span>", "<span class="bcp14">SHALL NOT</span>", "<span class="bcp14">SHOULD</span>",
"<span class="bcp14">SHOULD NOT</span>", "<span class="bcp14">RECOMMENDED</span>", "<span class="bcp14">NOT RECOMMENDED</span>", "<span class="bcp14">MAY</span>", and "<span class="bcp14">OPTIONAL</span>" in this
document are to be interpreted as described in BCP 14 [<a href="#ref-rfc2119" class="ref">rfc2119</a>] [<a href="#ref-rfc8174" class="ref">rfc8174</a>]
when, and only when, they appear in all capitals, as shown here.
</p>
</section>
</section>
<section>
<h2>Parsing BDASL CIDs</h2>
Expand All @@ -48,9 +57,9 @@ <h2>Parsing BDASL CIDs</h2>
</p>
<p>
In the steps to <a href="cid.html#decode-a-cid">decode a CID</a>, the <var>hash type</var>
may also be equal to <code>0x1e</code> (BLAKE3) ([<a href="#ref-blake3" class="ref">blake3</a>]).
<span class="bcp14">MAY</span> also be equal to <code>0x1e</code> (BLAKE3) ([<a href="#ref-blake3" class="ref">blake3</a>]).
</p>
</section>


<section><h2>References</h2><dl><dt id="ref-blake3">[blake3]</dt><dd>J-P. Aumasson, S. Neves, J. O'Connor, Z. Wilcox. <a href="https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html"><cite>The BLAKE3 Hashing Framework</cite></a>. July 2024. URL:&nbsp;<a href="https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html">https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html</a></dd><dt id="ref-cid">[cid]</dt><dd>Robin Berjon &amp; Juan Caballero. <a href="https://dasl.ing/cid.html"><cite>Content IDs (CIDs)</cite></a>. 2025-10-20. URL:&nbsp;<a href="https://dasl.ing/cid.html">https://dasl.ing/cid.html</a></dd></dl></section></main></body></html>
<section><h2>References</h2><dl><dt id="ref-blake3">[blake3]</dt><dd>J-P. Aumasson, S. Neves, J. O'Connor, Z. Wilcox. <a href="https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html"><cite>The BLAKE3 Hashing Framework</cite></a>. July 2024. URL:&nbsp;<a href="https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html">https://www.ietf.org/archive/id/draft-aumasson-blake3-00.html</a></dd><dt id="ref-cid">[cid]</dt><dd>Robin Berjon &amp; Juan Caballero. <a href="https://dasl.ing/cid.html"><cite>Content IDs (CIDs)</cite></a>. 2025-11-16. URL:&nbsp;<a href="https://dasl.ing/cid.html">https://dasl.ing/cid.html</a></dd><dt id="ref-rfc2119">[rfc2119]</dt><dd>S. Bradner. <a href="https://www.rfc-editor.org/rfc/rfc2119"><cite>Key words for use in RFCs to Indicate Requirement Levels</cite></a>. March 1997. URL:&nbsp;<a href="https://www.rfc-editor.org/rfc/rfc2119">https://www.rfc-editor.org/rfc/rfc2119</a></dd><dt id="ref-rfc8174">[rfc8174]</dt><dd>B. Leiba, <a href="https://www.rfc-editor.org/rfc/rfc8174"><cite>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</cite></a>. May 2017. URL:&nbsp;<a href="https://www.rfc-editor.org/rfc/rfc8174">https://www.rfc-editor.org/rfc/rfc8174</a></dd></dl></section></main></body></html>
13 changes: 11 additions & 2 deletions bdasl.src.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<section>
<h2>Introduction</h2>
<p>
BDASL extends DASL CIDs by adding BLAKE3 support ([[blake3]). BLAKE3 is a powerful hashing
BDASL extends DASL CIDs by adding BLAKE3 support ([[blake3]]). BLAKE3 is a powerful hashing
framework that works well for progressive verification of large streams. Unfortunately,
it isn't available in browser (and neither is streaming hashing in general) which makes it
inappriopriate for inclusion as the primary hash function in DASL CIDs.
Expand All @@ -26,6 +26,15 @@ <h2>Introduction</h2>
focus on using such CIDs in specific cases in which participants are likely to know how
to handle them.
</p>
<section>
<h3>Terminology</h3>
<p>
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.
</p>
</section>
</section>
<section>
<h2>Parsing BDASL CIDs</h2>
Expand All @@ -34,7 +43,7 @@ <h2>Parsing BDASL CIDs</h2>
</p>
<p>
In the steps to <a href="cid.html#decode-a-cid">decode a CID</a>, the <var>hash type</var>
may also be equal to <code>0x1e</code> (BLAKE3) ([[blake3]]).
MAY also be equal to <code>0x1e</code> (BLAKE3) ([[blake3]]).
</p>
</section>
</body>
Expand Down
1 change: 1 addition & 0 deletions bibliography.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"manifest": "M. Cáceres, K. Rohde Christiansen, D. González, D. Murphy, C. Liebel. <a href=\"https://www.w3.org/TR/appmanifest/\"><cite>Web Application Manifest</cite></a>. March 2025. URL:&nbsp;<a href=\"https://www.w3.org/TR/appmanifest/\">https://www.w3.org/TR/appmanifest/</a>",
"rfc2119": "S. Bradner. <a href=\"https://www.rfc-editor.org/rfc/rfc2119\"><cite>Key words for use in RFCs to Indicate Requirement Levels</cite></a>. March 1997. URL:&nbsp;<a href=\"https://www.rfc-editor.org/rfc/rfc2119\">https://www.rfc-editor.org/rfc/rfc2119</a>",
"rfc4648": "S. Josefsson. <a href=\"https://www.rfc-editor.org/rfc/rfc4648\"><cite>The Base16, Base32, and Base64 Data Encodings</cite></a>. October 2006. URL:&nbsp;<a href=\"https://www.rfc-editor.org/rfc/rfc4648\">https://www.rfc-editor.org/rfc/rfc4648</a>",
"rfc8174": "B. Leiba, <a href=\"https://www.rfc-editor.org/rfc/rfc8174\"><cite>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</cite></a>. May 2017. URL:&nbsp;<a href=\"https://www.rfc-editor.org/rfc/rfc8174\">https://www.rfc-editor.org/rfc/rfc8174</a>",
"rfc8742": "C. Bormann. <a href=\"https://www.rfc-editor.org/rfc/rfc8742\"><cite>Concise Binary Object Representation (CBOR) Sequences</cite></a>. February 2020. URL:&nbsp;<a href=\"https://www.rfc-editor.org/rfc/rfc8742\">https://www.rfc-editor.org/rfc/rfc8742</a>",
"rfc8949": "C. Bormann, P. Hoffman. <a href=\"https://www.rfc-editor.org/rfc/rfc8949\"><cite>Concise Binary Object Representation (CBOR)</cite></a>. December 2020. URL:&nbsp;<a href=\"https://www.rfc-editor.org/rfc/rfc8949\">https://www.rfc-editor.org/rfc/rfc8949</a>",
"sha256": "National Institute of Standards and Technology, <cite>Secure Hash Algorithm. NIST FIPS 180-2</cite>. August 2002.",
Expand Down
Loading