Add --platform flag to cosign sbom download #1975

puerco · 2022-06-08T00:36:07Z

Summary

This PR adds a --platform flag to cosign sbom download . When downloading an SBOM from a multiarch index, the new flag lets the user specify the SBOM of one of the images listed in the index.

When trying to download an SBOM from an inbox that does not have one attached, cosign will now present the user with the available architectures:

This multiarch image does not have an SBOM attached at the index level.
Try using --platform with one of the following architectures:
 linux/amd64, linux/arm/v5, linux/arm/v7, linux/arm64/v8, linux/386, linux/mips64le, 
 linux/ppc64le, linux/s390x, windows/amd64:10.0.20348.707, windows/amd64:10.0.17763.2928

Error: no SBOM found attached to image index

Ticket Link

Fixes #1086

/cc @jdolitsky @imjasonh @mattmoor

Release Note

- New `--platform` flag  enables downloading a specific sbom from a multi-arch image
- Improved handling of error messages when a multiarch index does not have an sbom attached

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

This commit implements the --platform flag of `cosign sbom download` that allows the user to fetch an sbom for a specific arch. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

codecov-commenter · 2022-06-08T00:38:41Z

Codecov Report

Merging #1975 (b2f9054) into main (5f302b1) will decrease coverage by 6.01%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main    #1975      +/-   ##
==========================================
- Coverage   34.71%   28.69%   -6.02%     
==========================================
  Files         153      133      -20     
  Lines       10037     8092    -1945     
==========================================
- Hits         3484     2322    -1162     
+ Misses       6166     5463     -703     
+ Partials      387      307      -80

Impacted Files	Coverage Δ
cmd/cosign/cli/download.go	`0.00% <0.00%> (ø)`
cmd/cosign/cli/options/download.go	`0.00% <0.00%> (ø)`
pkg/oci/remote/image.go	`73.68% <0.00%> (ø)`
pkg/policy/attestation.go	`38.63% <0.00%> (-4.41%)`	⬇️
pkg/cosign/verify.go	`29.70% <0.00%> (-3.08%)`	⬇️
cmd/cosign/cli/verify/verify_blob.go	`10.03% <0.00%> (-0.26%)`	⬇️
pkg/cosign/tuf/testutils.go	`0.00% <0.00%> (ø)`
cmd/cosign/cli/verify/verify.go	`0.00% <0.00%> (ø)`
pkg/cosign/kubernetes/client.go	`0.00% <0.00%> (ø)`
cmd/cosign/cli/options/predicate.go	`0.00% <0.00%> (ø)`
... and 28 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5f302b1...b2f9054. Read the comment docs.

imjasonh · 2022-06-08T13:40:39Z

So, I think we can proceed with this, and we'll be better off than we are today, but I think we might want to think about all the crazy ways people may expect to use this.

The main problem is that there may be multiple matching platforms, e.g.,:

--platform=linux matches all Linux manifests, of which there might be many, but there may only be one.
--platform=linux/arm matches linux/arm/v5 and linux/arm/v7 (this is pretty common, I think distroless supports both of these, but some images might not), and
getting into maximum crazy mode, --platform=windows/amd64:10.0.17763 matches Windows on x86_64, with the OS version 10.0.17763 (corresponding to Windows 10 (1809)), of which there may be multiple patch releases of, e.g., 10.0.17763.2928, 10.0.17763.1312, etc.

In this case I think we should probably handle multiple matching platforms with an error, since we don't know which one to download (and we shouldn't download multiple). The problem is that --platform=linux/arm will match multiple platforms, and --platform=windows/amd64:10.0.17763 won't exactly match any platform.

I'd suggest testing this out against ghcr.io/google/ko, which has attached SBOMs, and has the linux/arm/v5 and linux/arm/v7 issue, and two Windows platforms (though Windows images won't have SBOMs due to ko-build/ko#535)

imjasonh · 2022-06-08T13:41:19Z

This conversation is making me want to finally provide a method in ggcr to filter manifests by platform, encoding all this bonkers crazy logic.

This commit modifies the --platform flag in cosign download to improve the handling of platform strings and matching. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

This commit refactors the platforms logic to its own image and improves the user help when there is no sbom at the index level. cosign will now show the user which platforms are available to use with --platform. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Add single image with platform case and update args in calls to download functions Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco · 2022-06-09T01:24:58Z

OK, I've improved the platform parsing by following the way ko does it. It should now be ready to go, PTAL!

Here is a sample of the new platform handling

❯ cosign  download sbom ghcr.io/google/ko
WARNING: Downloading SBOMs this way does not ensure its authenticity. If you want to ensure a tamper-proof SBOM, download it using 'cosign download attestation <image uri>' or verify its signature.

This multiarch image does not have an SBOM attached at the index level.
Try using --platform with one of the following architectures:
 linux/amd64, linux/arm/v5, linux/arm/v7, linux/arm64/v8, linux/386, linux/mips64le, linux/ppc64le, linux/s390x, windows/amd64:10.0.20348.707, windows/amd64:10.0.17763.2928

Error: no SBOM found attached to image index
main.go:52: error during command execution: no SBOM found attached to image index
exit status 1


❯ cosign download sbom --platform=linux/arm ghcr.io/google/ko
WARNING: Downloading SBOMs this way does not ensure its authenticity. If you want to ensure a tamper-proof SBOM, download it using 'cosign download attestation <image uri>' or verify its signature.
Error: platform spec matches more than one image architecture: linux/arm/v5, linux/arm/v7
main.go:52: error during command execution: platform spec matches more than one image architecture: linux/arm/v5, linux/arm/v7
exit status 1

❯ cosign download sbom --platform=linux/arm/v7 ghcr.io/google/ko
WARNING: Downloading SBOMs this way does not ensure its authenticity. If you want to ensure a tamper-proof SBOM, download it using 'cosign download attestation <image uri>' or verify its signature.
Found SBOM of media type: text/spdx
SPDXVersion: SPDX-2.2
// rest of sbom....

cmd/cosign/cli/download/sbom.go

imjasonh · 2022-06-09T20:02:05Z

test/e2e_test.go

@@ -944,7 +949,7 @@ func TestAttachSBOM(t *testing.T) {
 	// Upload it!
 	must(attach.SBOMCmd(ctx, options.RegistryOptions{}, "./testdata/bom-go-mod.spdx", "spdx", imgName), t)


Should attach also take a platform? 🤔

OK, I'll add --platform to cosign attach sbom in a follow-up

Refacor listing platform to a method of platformList Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

imjasonh · 2022-06-10T16:24:33Z

cmd/cosign/cli/download/sbom.go

+	return strings.Join(r, ", ")
+}
+
+func SBOMCmd(


(not blocking) It looks like the []string return value is only ever read in test/e2e_test.go, and never in the actual CLI command. Is that right?

Maybe we should just have this return error alone, and refactor tests to not rely on the []string return value.

Yes, I agree. I think the command was meant to return more than one sbom but it is short-circuited to spit out the one sbom. We should discuss if it will be returning more than one SBOM and decide how to change this. I think the logic to download the SBOMs (and the rest) should me moved away from the CLI to a more general package.

imjasonh · 2022-06-10T16:26:10Z

cmd/cosign/cli/download/sbom.go

+}
+
+func findSignedImage(ctx context.Context, sii oci.SignedImageIndex, iDigest v1.Hash) (se oci.SignedEntity, err error) {
+	if err := walk.SignedEntity(ctx, sii, func(ctx context.Context, e oci.SignedEntity) error {


sii.SignedImage(iDigest) should do the same, without making you write the walk logic yourself. Let me know if that doesn't work for some reason.

Yay thanks for the tip @imjasonh 🎉 I pushed another commit dropping the function and switching to SignedImage()

This commit drops the findSignedImage() function in favor of the SignedImge() function of the OCI package. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco added 3 commits June 6, 2022 16:43

Add --platform option to download sbom

5e2ef3c

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Const not found error and humanize not found err

8b01b2a

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Download specified sbom with --platform

9e71e2a

This commit implements the --platform flag of `cosign sbom download` that allows the user to fetch an sbom for a specific arch. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco added 4 commits June 8, 2022 18:32

Update platform string handling

692f393

This commit modifies the --platform flag in cosign download to improve the handling of platform strings and matching. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Add sbom platform cases to e2e

67df61c

Add single image with platform case and update args in calls to download functions Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

Update cosign download doc

f0afd0d

Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco force-pushed the sbom-download-platform branch from 61d4163 to f0afd0d Compare June 9, 2022 01:05

puerco changed the title ~~WIP cosign sbom download --platform~~ Add --platform flag to cosign sbom download Jun 9, 2022

imjasonh reviewed Jun 9, 2022

View reviewed changes

Add platformList.String method

b2f9054

Refacor listing platform to a method of platformList Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

imjasonh previously approved these changes Jun 10, 2022

View reviewed changes

Drop manual walk of signed index

342c3ad

This commit drops the findSignedImage() function in favor of the SignedImge() function of the OCI package. Signed-off-by: Adolfo García Veytia (Puerco) <puerco@chainguard.dev>

puerco dismissed imjasonh’s stale review via 342c3ad June 10, 2022 22:12

dlorenc approved these changes Jun 10, 2022

View reviewed changes

dlorenc merged commit ec590b7 into sigstore:main Jun 11, 2022

github-actions bot added this to the v1.10.0 milestone Jun 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add --platform flag to cosign sbom download #1975

Add --platform flag to cosign sbom download #1975

puerco commented Jun 8, 2022 •

edited

Loading

codecov-commenter commented Jun 8, 2022 •

edited

Loading

imjasonh commented Jun 8, 2022

imjasonh commented Jun 8, 2022

puerco commented Jun 9, 2022

imjasonh Jun 9, 2022

puerco Jun 9, 2022 •

edited

Loading

imjasonh Jun 10, 2022

puerco Jun 10, 2022

imjasonh Jun 10, 2022

puerco Jun 10, 2022

		@@ -944,7 +949,7 @@ func TestAttachSBOM(t *testing.T) {
		// Upload it!
		must(attach.SBOMCmd(ctx, options.RegistryOptions{}, "./testdata/bom-go-mod.spdx", "spdx", imgName), t)

Add --platform flag to cosign sbom download #1975

Add --platform flag to cosign sbom download #1975

Conversation

puerco commented Jun 8, 2022 • edited Loading

Summary

Ticket Link

Release Note

codecov-commenter commented Jun 8, 2022 • edited Loading

Codecov Report

imjasonh commented Jun 8, 2022

imjasonh commented Jun 8, 2022

puerco commented Jun 9, 2022

imjasonh Jun 9, 2022

Choose a reason for hiding this comment

puerco Jun 9, 2022 • edited Loading

Choose a reason for hiding this comment

imjasonh Jun 10, 2022

Choose a reason for hiding this comment

puerco Jun 10, 2022

Choose a reason for hiding this comment

imjasonh Jun 10, 2022

Choose a reason for hiding this comment

puerco Jun 10, 2022

Choose a reason for hiding this comment

puerco commented Jun 8, 2022 •

edited

Loading

codecov-commenter commented Jun 8, 2022 •

edited

Loading

puerco Jun 9, 2022 •

edited

Loading