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.

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

Fixed: Add section on inventory sidecar files #34

Merged
merged 2 commits into from
Jul 19, 2018
Merged

Conversation

ahankinson
Copy link
Contributor

This PR adds a section on hash sidecar files.

Refs #29

<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

zimeon
zimeon previously approved these changes Jul 18, 2018
awoods
awoods previously approved these changes Jul 18, 2018
@zimeon
Copy link
Contributor

zimeon commented Jul 18, 2018

Is the addition of the filename following parallel with the bagit approach? I don't object to that but it seems unnecessary

@awoods
Copy link
Member

awoods commented Jul 18, 2018

@zimeon : https://tools.ietf.org/html/draft-kunze-bagit-08#section-2.1.3

Additionally,

One or more linear whitespace characters (spaces or tabs) MUST separate CHECKSUM from FILENAME.

@zimeon
Copy link
Contributor

zimeon commented Jul 18, 2018

Yes, I see it there and there it is necessary because the manifest-XYZ.txt file contains checksums for multiple files. However, we have a different naming convention and the checksum for just one file... so it isn't really necessary

@ahankinson
Copy link
Contributor Author

It is also used in the output of shasum:

$>shasum -a 512 CNAME
dba3b3255390e9bda6fcc1f3cc8534a4c9fec4f90478c8e62bfaae73fab5700d524a8fb09d692c41cdfd83ec978a282082b586392325124c7cd5c21cca115599  CNAME

and is also used in software distributions as sidecars, e.g.,

http://www-eu.apache.org/dist/lucene/solr/7.4.0/

(although I'm not sure what the * in the filename means).

@zimeon
Copy link
Contributor

zimeon commented Jul 18, 2018

Thanks @ahankinson - I agree the * is odd but good to see similar use in other places

@ahankinson ahankinson dismissed stale reviews from awoods and zimeon via 569d82f July 19, 2018 09:23
@ahankinson
Copy link
Contributor Author

I updated per #35 so re-review and approval is necessary.

@ahankinson
Copy link
Contributor Author

ahankinson commented Jul 19, 2018

@zimeon This section in the output of the shasum utility explains what the * is for:

The sums are computed as described in FIPS-180-4. When checking, the
input should be a former output of this program. The default mode is to
print a line with checksum, a character indicating type ('*' for binary,
' ' for text, '?' for portable, '^' for BITS), and name for each FILE.

So maybe we also need to decide the mode?

@zimeon
Copy link
Contributor

zimeon commented Jul 19, 2018

Will port your comment above onto #39

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants