Add support for new bundle specification for attesting/verifying OCI image attestations #3889

codysoyland · 2024-09-25T19:31:43Z

Summary

This PR adds support for the new Cosign Bundle Specification in cosign attest and cosign verify-attestation.

Related: #3139

To test, run the following (replacing MY_IDENTITY, MY_ISSUER, MY_TRUSTED_ROOT and MY_IMAGE as needed -- trusted root is optional). Note that the new OCI support requires passing --new-bundle-format into both commands.

go run ./cmd/cosign attest --predicate my-predicate.json --new-bundle-format MY_IMAGE
go run ./cmd/cosign verify-attestation --certificate-identity MY_IDENTITY --certificate-oidc-issuer MY_ISSUER --new-bundle-format --trusted-root=MY_TRUSTED_ROOT MY_IMAGE

Full example (using crane, but can instead use docker tag/docker push):

make cosign
docker run -d -p 5050:5000 ghcr.io/project-zot/zot-linux-arm64:latest
crane copy busybox:latest localhost:5050/busybox
echo '{"foo": "bar"}' > predicate.json
./cosign attest --predicate predicate.json --new-bundle-format localhost:5050/busybox:latest
# Dex workflow, assuming GitHub as provider
./cosign verify-attestation [email protected] --certificate-oidc-issuer=https://github.com/login/oauth --new-bundle-format localhost:5050/busybox:latest

To show that it uses the OCI 1.1 referrers API, you can use oras:

oras discover localhost:5050/busybox:latest
Discovered 1 artifact referencing latest
Digest: sha256:db142d433cdde11f10ae479dbf92f3b13d693fd1c91053da9979728cceb1dc68

Artifact Type                                   Digest
application/vnd.dev.sigstore.bundle.v0.3+json   sha256:3fb46d845fe437667a6b3ed45d2b11dea11c43f8fbe76dd642eb71de2a9b8b77

Release Note

Documentation

codecov · 2024-11-06T20:12:07Z

Codecov Report

Attention: Patch coverage is 1.20482% with 328 lines in your changes missing coverage. Please review.

Project coverage is 36.11%. Comparing base (2ef6022) to head (6d7fbf2).
Report is 299 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/cosign/verify.go	0.00%	102 Missing ⚠️
pkg/oci/remote/write.go	0.00%	92 Missing ⚠️
cmd/cosign/cli/verify/verify_attestation.go	0.00%	34 Missing ⚠️
cmd/cosign/cli/attest/attest.go	0.00%	32 Missing ⚠️
pkg/oci/remote/signatures.go	0.00%	31 Missing ⚠️
cmd/cosign/cli/attest/common.go	0.00%	10 Missing ⚠️
cmd/cosign/cli/options/verify.go	0.00%	7 Missing ⚠️
cmd/cosign/cli/verify/verify.go	0.00%	7 Missing ⚠️
cmd/cosign/cli/attest/attest_blob.go	14.28%	6 Missing ⚠️
cmd/cosign/cli/verify.go	0.00%	4 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3889      +/-   ##
==========================================
- Coverage   40.10%   36.11%   -3.99%     
==========================================
  Files         155      210      +55     
  Lines       10044    13634    +3590     
==========================================
+ Hits         4028     4924     +896     
- Misses       5530     8092    +2562     
- Partials      486      618     +132

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

cmd/cosign/cli/attest/attest.go

cmd/cosign/cli/attest/common.go

cmd/cosign/cli/options/verify.go

cmd/cosign/cli/verify/verify_attestation.go

pkg/cosign/verify.go

cmurphy · 2024-12-10T19:39:00Z

pkg/cosign/verify.go

+	// Wrap TrustedMaterial
+	vTrustedMaterial := &verifyTrustedMaterial{TrustedMaterial: co.TrustedMaterial}
+
+	// If TrustedMaterial is not set, fetch it from TUF (TODO: should this even be done? Old verifier requires co.RootCerts to be set)


If they haven't set --trusted-root then they could be using other flags or relying on the TUF v1 setup which might be pointed to something other than the public good instance. I understand that this is only meant to be called when --new-bundle-format is set but I'm worried that this would be surprising behavior if the PGI trusted root is used while the cached TUF metadata is pointed somewhere else.

pkg/cosign/verify.go

cmurphy · 2024-12-10T20:12:24Z

pkg/cosign/verify.go

+	}
+
+	for _, verified := range bundlesVerified {
+		atLeastOneBundleVerified = atLeastOneBundleVerified || verified


Could you clarify why it's okay for only one bundle to be verified?

This logic was copied from

cosign/pkg/cosign/verify.go

Line 1054 in 737c83c

func VerifyImageAttestation(ctx context.Context, atts oci.Signatures, h v1.Hash, co *CheckOpts) (checkedAttestations []oci.Signature, bundleVerified bool, err error) {

, but I renamed bundleVerified to atLeastOneBundleVerified so it's more clear. The effect is that if there are multiple bundles associated with an image, verification will succeed if at least one of them is verified.

I can write a comment about this if it helps!

pkg/oci/remote/referrers.go

cmurphy · 2024-12-10T21:41:08Z

test/e2e_test.go

@@ -361,7 +377,7 @@ func attestVerify(t *testing.T, predicateType, attestation, goodCue, badCue stri
 	}

 	// Now attest the image
-	ko := options.KeyOpts{KeyRef: privKeyPath, PassFunc: passFunc}
+	ko := options.KeyOpts{KeyRef: privKeyPath, PassFunc: passFunc, NewBundleFormat: newBundleFormat}


Maybe out of scope for this PR but a note for the future, this is setting NewBundleFormat without setting TrustedRootPath, which means the TrustedMaterial will default to using PGI. We're trying to avoid making external network calls to live services. The only reason that isn't a problem here is because this test is using a local key pair and is not uploading to Rekor, so it doesn't matter what verification material is used. But a useful test in the future might be to have this use ephemeral keys from Fulcio (localhost:5555) and upload the entry to Rekor (localhost:3000) so that the full verification path with a locally generated trust root could be tested.

pkg/cosign/verify.go

pkg/cosign/verify_bundle.go

codysoyland · 2025-01-24T22:00:36Z

I rebased and squashed all commits into one as there have been a couple of items refactored into separate PRs (#4006 and #4013) and this ongoing PR was getting a bit messy.

I still need to finish #4013 and rebase this one again, at which point I will be ready for another review pass.

Thanks everyone who has been patiently reviewing and helping me iterate on this!

Signed-off-by: Cody Soyland <[email protected]>

codysoyland · 2025-02-07T20:15:30Z

cmd/cosign/cli/options/verify.go

-	NewBundleFormat bool
-	TrustedRootPath string


Note these have moved to CommonVerifyOptions

codysoyland · 2025-02-07T20:23:45Z

This has been rebased again and is ready for review.

codysoyland force-pushed the verify-attestation-bundle-spec branch from 4af8cc0 to e509ec5 Compare November 1, 2024 20:41

codysoyland mentioned this pull request Nov 5, 2024

Representation of Container Image Signature Bundles as OCI Artifacts #3927

Open

This was referenced Nov 6, 2024

Add support for new bundle specification in cosign attest #3888

Closed

Upgrade to TUF v2 client #3844

Open

codysoyland force-pushed the verify-attestation-bundle-spec branch from af5093d to 524f558 Compare November 22, 2024 16:44

codysoyland marked this pull request as ready for review November 22, 2024 19:55

codysoyland changed the title ~~Add support for new bundle specification in cosign verify-attestation~~ Add support for new bundle specification for attesting/verifying OCI image attestations Nov 22, 2024

malancas reviewed Dec 6, 2024

View reviewed changes

codysoyland mentioned this pull request Dec 10, 2024

Add support for Sigstore Bundle Spec sigstore/policy-controller#1725

Draft

codysoyland requested a review from a team as a code owner December 10, 2024 20:08

cmurphy reviewed Dec 10, 2024

View reviewed changes

This was referenced Dec 12, 2024

Publish image attestations freedomofpress/dangerzone#1017

Draft

Implement independent container updates freedomofpress/dangerzone#1006

Open

codysoyland mentioned this pull request Dec 17, 2024

Attaching the signature artifact to the Image artifact #3935

Open

codysoyland commented Dec 18, 2024

View reviewed changes

pkg/cosign/verify_bundle.go Outdated Show resolved Hide resolved

This was referenced Jan 10, 2025

Add UseSignedTimestamps to CheckOpts, refactor TSA options #4006

Merged

Refactor verifyNewBundle into library function #4013

Merged

codysoyland force-pushed the verify-attestation-bundle-spec branch from 2c27fc5 to 1602cc1 Compare January 24, 2025 21:38

almet mentioned this pull request Jan 30, 2025

Add attestations to images freedomofpress/dangerzone#1063

Closed

codysoyland added 2 commits February 7, 2025 14:11

Add support for new bundle specification for container images

ae2b3ba

Signed-off-by: Cody Soyland <[email protected]>

Move new bundle options to CommonVerifyOptions

6d7fbf2

Signed-off-by: Cody Soyland <[email protected]>

codysoyland force-pushed the verify-attestation-bundle-spec branch from 1602cc1 to 6d7fbf2 Compare February 7, 2025 19:21

codysoyland commented Feb 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for new bundle specification for attesting/verifying OCI image attestations #3889

Add support for new bundle specification for attesting/verifying OCI image attestations #3889

codysoyland commented Sep 25, 2024 •

edited

Loading

codecov bot commented Nov 6, 2024 •

edited

Loading

cmurphy Dec 10, 2024

cmurphy Dec 10, 2024

codysoyland Feb 7, 2025

cmurphy Dec 10, 2024

codysoyland commented Jan 24, 2025

codysoyland Feb 7, 2025

codysoyland commented Feb 7, 2025 •

edited

Loading

Add support for new bundle specification for attesting/verifying OCI image attestations #3889

Are you sure you want to change the base?

Add support for new bundle specification for attesting/verifying OCI image attestations #3889

Conversation

codysoyland commented Sep 25, 2024 • edited Loading

Summary

Release Note

Documentation

codecov bot commented Nov 6, 2024 • edited Loading

Codecov Report

cmurphy Dec 10, 2024

Choose a reason for hiding this comment

cmurphy Dec 10, 2024

Choose a reason for hiding this comment

codysoyland Feb 7, 2025

Choose a reason for hiding this comment

cmurphy Dec 10, 2024

Choose a reason for hiding this comment

codysoyland commented Jan 24, 2025

codysoyland Feb 7, 2025

Choose a reason for hiding this comment

codysoyland commented Feb 7, 2025 • edited Loading

codysoyland commented Sep 25, 2024 •

edited

Loading

codecov bot commented Nov 6, 2024 •

edited

Loading

codysoyland commented Feb 7, 2025 •

edited

Loading