Split specification.md into three separate files. #23
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the specification did not cleanly separate the (required) protocol from the (optional) encoding, and it also contained a lot of supplemental background material. Now the protocol, encoding (envelope), and background are three separate files. This should hopefully make the spec easier to use.
adityasaky
reviewed
Mar 18, 2021
Co-authored-by: Aditya Sirish <[email protected]>
adityasaky
approved these changes
Mar 18, 2021
lukpueh
requested changes
Mar 23, 2021
There was a problem hiding this comment.
Thanks for cleaning this up, @MarkLodato. Except for one typo this looks good to me. Feel free to address any of the other comments as you see fit.
| Specifications for: | ||
|
|
||
| * [Protocol](protocol.md) (*required*) | ||
| * [Data structure](envelope.md), a.k.a. "Envelope" (*recommended*) |
There was a problem hiding this comment.
💯 for "Envelope" instead of "Wrapper". The latter always had a different connotation for me.
protocol.md
Outdated
| To verify: | ||
|
|
||
| - Receive and decode SERIALIZED_BODY, PAYLOAD_TYPE, SIGNATURE, and KEYID. | ||
| Reject if decoding fails. |
There was a problem hiding this comment.
Minor nit: Maybe also point to the envelope document here.
There was a problem hiding this comment.
Done. Please check the wording.
- Fix typos. - Add TODO to update "current" to "legacy" whenever TUF/in-toto switch to this. - Add "Why not existing TUF/in-toto" to README. - Clean up references to the JSON envelope in protocol.md.
lukpueh
approved these changes
Mar 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, the specification did not cleanly separate the (required)
protocol from the (optional) encoding, and it also contained a lot of
supplemental background material.
Now the protocol, encoding (envelope), and background are three separate
files. This should hopefully make the spec easier to use.