-
Notifications
You must be signed in to change notification settings - Fork 18
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
Add UTF-8 encoding option to the envelope document and proto. #64
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This probably needs a version bump and a note about backwards compatibility.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for all the editing suggestions!
Regarding versioning, I don't think it is originally versioned; and also there is no field defined in the envelope to reflect versions. I guess we will need to add a version field in the envelope, don't we?
Assuming we embrace Semantic Versioning, do we start (current) from 1.0 and bump to 1.1?
Or start from 0.1 and bump to 1.0, like in-toto? But the latter is a major version bump...
Or maybe start from 0.1 and bump to 0.2, to keep this a minor version bump?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I meant versioning of the spec itself. It's currently v1.0. I lean towards calling this v1.1 rather than v2.0 since the signature is still backwards compatible and contains the string DSSEv1
. Then again, I could be convinced to call it v2.0 since newly created envelopes would be unreadable by old clients.
I personally don't think a version number is needed in the envelope. Instead of going by version, you can go by what fields are present. A v1.1/v2.0 envelope with payload
looks just the same as v1.0. I worry that a version
field will lead to unnecessary incompatibility or worse, bugs or vulnerabilities.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for clarifying. I bumped up the version in envelope.md and added the "change history" section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarkLodato Not sure that a version field would lead to vulnerabilities: at least, I don't see why that is necessarily more insecure than conditionally parsing fields. At least a version field would give you an unauthenticated hint you don't need to blindly trust, but for which you know you need to double-check by looking for other, expected fields.
b6ec4d4
to
102f943
Compare
Signed-off-by: Zhenyu (Adam) Wu <[email protected]> Co-authored-by: Mark Lodato <[email protected]>
5a32c7e
to
9d40eed
Compare
For issues #63