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

Remove VerificationMaterials (take 2) #937

Merged
merged 33 commits into from
Apr 2, 2024
Merged

Conversation

woodruffw
Copy link
Member

@woodruffw woodruffw commented Mar 14, 2024

Very WIP, still thinking this through.

TODO:

  • Bring the coverage back up a bit.
  • This changeset currently reverts our protections against Rekor entry confusion; I need to reintroduce those.
  • CHANGELOG entries

Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw added component:verification Core verification functionality component:api Public APIs labels Mar 14, 2024
@woodruffw woodruffw added this to the 3.0 milestone Mar 14, 2024
@woodruffw woodruffw self-assigned this Mar 14, 2024
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw
Copy link
Member Author

woodruffw commented Mar 14, 2024

To summarize, roughly:

  • VerificationMaterials is now entirely gone: APIs that took it now take a sigstore.verify.Bundle instead, which is a wrapper around the protobuf_specs-defined Bundle type.
  • We now require an inclusion proof, full stop. This removes a bunch of special-casing around "detached" materials and older bundle types, and removes the need to test those edge cases.
  • Bundles are now always verified offline.
  • Detached materials are now always verified online. Passing --offline with detached inputs causes an error.
  • We now generate "v3" bundles by default. This might be worth reverting, not sure.

Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
This is a mess.

Signed-off-by: William Woodruff <william@trailofbits.com>
_make_bundle is just _from_parts with a bit of specialization.

Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw
Copy link
Member Author

Conformance failures here are caused by a dep mismatch: sigstore/sigstore-conformance#132

Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Also adds tlog consistency checking.

Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
This is essentially a single helper that should live under `LogEntry`.

Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw mentioned this pull request Mar 15, 2024
3 tasks
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw marked this pull request as ready for review March 15, 2024 22:05
@woodruffw woodruffw requested a review from jku March 18, 2024 16:56
@woodruffw
Copy link
Member Author

This is a pretty chunky PR, so apologies in advance 😅

…erials-2

Signed-off-by: William Woodruff <william@trailofbits.com>
jku
jku previously approved these changes Apr 2, 2024
Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

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

Looks good, I have no design complaints: This seems like a logical simplification.

The code comments are very minor so approving as is.

CHANGELOG.md Outdated Show resolved Hide resolved
sigstore/verify/models.py Outdated Show resolved Hide resolved
sigstore/verify/models.py Outdated Show resolved Hide resolved
Signed-off-by: William Woodruff <william@trailofbits.com>
Signed-off-by: William Woodruff <william@trailofbits.com>
@woodruffw woodruffw merged commit dc4aa82 into main Apr 2, 2024
25 checks passed
@woodruffw woodruffw deleted the ww/rm-verificationmaterials-2 branch April 2, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:api Public APIs component:verification Core verification functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants