sigstore / sigstore-go

Go library for Sigstore signing and verification
Apache License 2.0
48 stars 26 forks source link

Extend VerificationResult with all verified data #328

Open codysoyland opened 2 weeks ago

codysoyland commented 2 weeks ago

Description

VerificationResult is the primary output of the verifier, and contains a "summary" of the verification result. Given that sigstore-go is primarily to be consumed by machines, and users of the library may need to have higher-fidelity data structures for post-processing, I would like to have VerificationResult contain more details about the verified data. Specifically:

This will have several follow-on effects to the current public API, adding return data to several functions such as:

I believe that exposing these values from the verifier is important for clients that need data such as the specific transaction log entries that were verified, as there may be untrusted values in the bundle even if it passes the threshold.

The existing VerificationResult serves a role as a simple summary of verification, and we may consider exposing it unchanged as a separate return value, perhaps renaming it to VerificationSummary.

kommendorkapten commented 1 week ago

This sounds like a great proposal! Thanks for putting this together @codysoyland.