Skip to content
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

Jump to bottom

Fixed: Add section on inventory sidecar files #34

Merged
merged 2 commits into from
Jul 19, 2018
Merged

Fixed: Add section on inventory sidecar files #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
851cfeb
Fixed: Add section on inventory sidecar files
ahankinson Jul 18, 2018
569d82f
Fixed: Update language per RFC2119
ahankinson Jul 19, 2018
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
15 changes: 15 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,21 @@ <h2>Basic Structure</h2>
<h2>Digest Algorithm Choice</h2>
</section>

<section id='digest-sidecar-file'>
<h2>Digest Sidecar File</h2>
<p>
Every occurrence of an inventory file MUST have an accompanying sidecar file stating its checksum. This sidecar file must be of the form <pre>inventory.jsonld.HASHALG</pre>, where <pre>HASHALG</pre> follows the chosen hashing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a canonical list of hash algorithms we can reference?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments on #21 -- I think the answer is a bit tricky but we will need to define the list, hopefully by reference to one or more other specs. I would suggest we merge this and solve that as a separate problem

algorithm for the object. An example might be <pre>inventory.jsonld.sha512</pre>.
</p>
<p>
The digest sidecar file MUST contain the hash of the inventory file. This MUST follow the format <pre>CHECKSUM inventory.jsonld</pre>; that is, the hash of the inventory file, a single space, and the name of the file being checksummed.
</p>
<p>
The hash of the inventory MUST be computed only after all changes to the inventory
have been made, so this sidecar file SHOULD be created as the last step in the versioning process.
</p>
</section>

<section id='object-manifest'>
<h2>Object Manifest</h2>
</section>
Expand Down