include skipped signatures in VerificationResult #237
Closed
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
Addresses sigstore#48. Instead of just ignoring the signatures the trust bundle couldn't verify, we want to pass this information back to the caller. To avoid API changes, in order to detect the unsinged entries, for each signature type, we loop through all available signatures and mark the ones the weren't verified. Signed-off-by: Gustavo Rangel <[email protected]>
cmurphy
reviewed
Jul 22, 2024
There was a problem hiding this comment.
Ideally, I would return the unverified signatures from here (TSA) and here (logs). However, this would require me to change the signature of exported functions, which I'm not sure if I should.
This library is pre-1.0, and this issue is one of several that are slotted to be addressed before the 1.0 in case there are any breaking changes, so if it is a better solution to change the function signature, please go for it. Also, please mention the breaking changes in the Release Note section of the PR description.
Could you add some unit tests?
Could you update the example serialized result in the docs?
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.
Summary
Solves #48.
Ideally, I would return the unverified signatures from here (TSA) and here (logs). However, this would require me to change the signature of exported functions, which I'm not sure if I should.
To avoid this, for each signature type, I've created a function that loops through all available signatures and mark the ones that weren't verified.
Additionally, I couldn't find a reliable way to address this comment since the timestamp-authority package doesn't generate distinct errors for different failure cases. We would have to parse the error strings which I consider a weak approach because they're easily changed as code base evolves. Also, this would likely require changes to the API of exported functions, which, again, I'm not sure if it's desirable.
Release Note
NONE
Documentation
No documentation update required