Something went wrong. Try again.
This repository has no description
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139<!doctype html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Content IDs (CIDs)</title> </head> <body> <div id="abstract"> <p> DASL CIDs are a simple structured identifier format for content addressing. They encapsulate a hash with enough metadata to be extensible (to add new hash types in the future) and to indicate whether they are pointing to raw bytes or to structured data. </p> </div> <section> <h2>Introduction</h2> <p> DASL CIDs are a simple structured identifier format for content addressing. They encapsulate a hash with enough metadata to be extensible (to add new hash types in the future) and to indicate whether they are pointing to raw bytes or to structured data. If you're simply using DASL CIDs as identifiers, you can almost certainly just use the string as an opaque ID and worry no further. </p> <p> A DASL CID can be represented as a string or as an array of bytes. If you wish to understand the internals of a CID, it has the following structure: </p> <ol> <li> A <code>b</code> prefix (only in string form). This is an extensibility point for future CID encodings other than the current base32 to be supported. (Currently this is the only one.) </li> <li> A version number, which is currently always 1. </li> <li> A content codec, which is a flag indicating whether it is pointing to structured or raw data. </li> <li> A hash type, that is always SHA-256 ([[sha256]]). </li> <li> A hash size, that is always 32 (<code>0x20</code>). </li> <li> A digest, which is the hash of the content being identified. </li> </ol> </section> <section> <h2>Parsing CIDs</h2> <p> Use the following steps to <dfn>parse a string-encoded CID</dfn>, i.e. translate it to a bytestring: </p> <ol> <li>Accept a string <var>CID</var>.</li> <li>Remove the first character from <var>CID</var> and store it in <var>prefix</var>.</li> <li>If <var>prefix</var> is not equal to <code>b</code>, throw an error.</li> <li> Decode the rest of <var>CID</var> using <a href="https://datatracker.ietf.org/doc/html/rfc4648#section-6">the base32 algorithm from RFC4648</a> with a lowercase alphabet and store the result in <var>CID bytes</var> ([[rfc4648]]). </li> <li>This results in <var>CID bytes</var>, which can be used to <a>decode a CID</a>.</li> </ol> <p> Use the following steps to <dfn>decode a CID</dfn>: </p> <ol> <li>Accept an array of bytes <var>CID bytes</var>.</li> <li> Remove the first byte in <var>CID bytes</var> and store it in <var>version</var>. </li> <li>If <var>version</var> is not equal to <code>1</code>, throw an error.</li> <li> Remove the next byte in <var>CID bytes</var> and store it in <var>codec</var>. </li> <li> If <var>codec</var> is not equal to <code>0x55</code> (raw) or <code>0x71</code> (DRISL), throw an error ([[drisl]]). </li> <li> Remove the next byte in <var>CID bytes</var> and store it in <var>hash type</var>. </li> <li> If <var>hash type</var> is not equal to <code>0x12</code> (SHA-256), throw an error ([[sha256]]). </li> <li> Read one byte from <var>CID bytes</var> and store it in <var>hash size</var>. If <var>hash size</var> is any value other than 32 (<code>0x20</code>) , throw an error. </li> <li> Read 32 bytes from <var>CID bytes</var> and store them in <var>digest</var>. If there were fewer than 32 bytes left in <var>CID bytes</var>, throw an error. </li> <li> Return <var>version</var>, <var>codec</var>, <var>hash type</var>, <var>hash size</var>, and <var>digest</var>. </li> </ol> </section> <section> <h2>Relationship to IPFS</h2> <p> You don't need to understand IPFS in order to use DASL. This section is for informational purposes only. </p> <p> DASL CIDs are a strict subset of <a href="https://docs.ipfs.tech/concepts/content-addressing/">IPFS CIDs</a> with the following properties: </p> <ul> <li>Only modern CIDv1 CIDs are used, not legacy CIDv0.</li> <li> Only the lowercase base32 multibase encoding (the <code>b</code> prefix) is used for human-readable (and subdomain-usable) string encoding. </li> <li> Only the <code>raw</code> binary multicodec (0x55) and <code>dag-cbor</code> multicodec (0x71), with the latter used only for [[drisl]]-conformant DAGs of CBOR objects. </li> <li>Only SHA-256 (0x12) for the hash function .</li> <li> The CID isn't the boss of anyone, but the expectation is that, regardless of size, resources <em>should not</em> be "chunked" into a DAG or Merkle tree (as historically done with UnixFS canonicalization in IPFS systems) but rather hashed in their entirety and content-addressed directly. That being said, a DASL CID can point to a piece of [[drisl]] metadata that describes this kind of chunking, if needed. (A separate specification may be added for that.) </li> <li> This set of options has the added advantage that all the aforementioned single-byte prefixes require no additional varint processing or byte-fiddling. </li> </ul> </section> </body></html>