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

Add support for passing different SignerVerifier LoadOptions #4050

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

ret2libc
Copy link

@ret2libc ret2libc commented Feb 6, 2025

Summary

This is a preparation PR for #3271 and it splits some changes required to completely add support for ed25519ph, with the idea of helping the reviewers. It was split from #3479 .

Release Note

  • Adds functions SignerFromKeyOptsWithSVOpts, LoadPrivateKeyWithOpts, ValidateAndUnpackCertWithOpts, VerifyImageSignaturesWithOpts, VerifyLocalImageSignaturesWithOpts, VerifyBlobSignatureWithOpts, VerifyImageSignatureWithOpts, VerifyImageAttestationsWithOpts, VerifyLocalImageAttestationsWithOpts, VerifyBlobAttestationWithOpts, VerifyImageAttestationWithOpts, VerifierForKeyRefWithOpts, LoadPublicKeyRawWithOpts, SignerVerifierFromKeyRefWithOpts, PublicKeyFromKeyRefWithOpts.

Documentation

With recent sigstore, we introduced signature.LoadVerifierWithOpts (and other versions for Signer, SignerVerifier). Adding support for ed25519ph would require passing some options around, however cosign is still using signature.LoadVerifier. This PR prepares the cosign codebase to accept LoadOptions and pass them around, without actually changing (yet) any behaviour.

Doing that required adding a lot of *WithOpts functions to avoid breaking other users who may rely on those exported functions. Please let me know if that's a good approach.

Once this is done, we can work on a smaller PR that actually adds supports for ed25519ph and pass the correct extra LoadOptions around.

@ret2libc ret2libc requested review from a team as code owners February 6, 2025 16:19
@ret2libc
Copy link
Author

ret2libc commented Feb 6, 2025

cc @haydentherapper

Copy link

codecov bot commented Feb 7, 2025

Codecov Report

Attention: Patch coverage is 60.44776% with 53 lines in your changes missing coverage. Please review.

Project coverage is 36.94%. Comparing base (2ef6022) to head (753bfc0).
Report is 308 commits behind head on main.

Files with missing lines Patch % Lines
pkg/cosign/verify.go 66.23% 26 Missing ⚠️
pkg/signature/keys.go 63.63% 8 Missing ⚠️
cmd/cosign/cli/sign/sign.go 40.00% 6 Missing ⚠️
cmd/cosign/cli/verify/verify.go 0.00% 4 Missing ⚠️
cmd/cosign/cli/verify/verify_attestation.go 0.00% 4 Missing ⚠️
test/cert_utils.go 40.00% 2 Missing and 1 partial ⚠️
cmd/cosign/cli/attest/attest.go 0.00% 1 Missing ⚠️
cmd/cosign/cli/verify/verify_blob_attestation.go 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4050      +/-   ##
==========================================
- Coverage   40.10%   36.94%   -3.16%     
==========================================
  Files         155      210      +55     
  Lines       10044    13411    +3367     
==========================================
+ Hits         4028     4955     +927     
- Misses       5530     7837    +2307     
- Partials      486      619     +133     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ret2libc ret2libc marked this pull request as draft February 7, 2025 17:14
@ret2libc
Copy link
Author

ret2libc commented Feb 7, 2025

I'm going to add a few tests to this.

Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
@ret2libc ret2libc marked this pull request as ready for review February 11, 2025 11:03
Signed-off-by: Riccardo Schirone <riccardo.schirone@trailofbits.com>
@ret2libc ret2libc marked this pull request as draft February 13, 2025 11:02
@haydentherapper
Copy link
Contributor

What do you think about limiting this to code under the --new-bundle-format flag, where VerifyBundle is called? Then most changes only need to occur in sigstore-go, we won't have to be concerned about unexpectedly breakages for current users, and we know the code will carry on to cosign 3.x.

@ret2libc
Copy link
Author

What do you think about limiting this to code under the --new-bundle-format flag, where VerifyBundle is called? Then most changes only need to occur in sigstore-go, we won't have to be concerned about unexpectedly breakages for current users, and we know the code will carry on to cosign 3.x.

Sounds good, but we still want to modify the "sign"/"sign-blob" flow, don't we? At least to test the signing process through cosign and then the verification process in the new bundle format, correct?

@haydentherapper
Copy link
Contributor

The sign-blob flow, yes, where we also use the new-bundle-format flag. We don’t have to include sign at the moment since we don’t yet support the new bundle format.

Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

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

Reviewed this for the Fulcio PR. This LGTM and I realize my comment about sign-blob isn't immediately relevant as we need to make all these changes first.

Algorithm: swag.String(models.HashedrekordV001SchemaDataHashAlgorithmSha256),
needs to be updated as well.

@haydentherapper
Copy link
Contributor

If we do the Fulcio change to accept ecdsa-p384-sha-384 and ecdsa-p521-sha-512, I'd add an end-to-end test that verifies signing and verification with these keys. You can generate a key, import it into the Cosign key format, then sign with IssueCertificate:true.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants