Add support for reading and writing Cosign attachments to c/image/docker #1595

mtrmac · 2022-07-06T00:34:31Z

⚠️ Warning: This is write-only code, as in I haven’t read it after myself, and it has no tests yet. Might be completely broken. It really needs an integration test, and interoperability testing.

Note: design decisions:

We can read Cosign data from lookaside
We only write Cosign data to Cosign attachments, never to lookaside; because lookaside is set up by default, that
would be too confusing.
We only use Cosign attachments at all if the user opts in via registries.d, option use-cosign-attachments.

One concern is performance impact of the extra round-trip for large-scale operations like (skopeo sync).

Short-term, a much more worrying is the risk that we probably have the "is this failure just a missing atachment manifest, or a real failure reading it?" heuristic wrong, so without an opt-in, all image reads are going to fail. This might eventually go away after more testing.

~~Depends on unmerged #1594.~~

docker/docker_client.go

mtrmac · 2022-07-07T12:37:26Z

docker/docker_image_dest.go

+	if err != nil {
+		return nil
+	}
+	var ociConfig imgspecv1.Image // Most fields empty by default


TO DO: Only fetch the manifest if we actually have a new signature to add (and if we continue to update the DiffID list).

Is this blocking?

s/Only fetch the manifest/Only fetch the config/; we do need to always fetch the manifest to detect whether we have a fresh attachment to upload (assuming there is at least one Cosign attachment provided to PutSignaturesWithFormat).

mtrmac · 2022-07-07T12:37:53Z

docker/docker_image_dest.go

+		logrus.Debugf("Adding new signature, digest %s", sigDesc.Digest.String())
+	}
+
+	configBlob, err := json.Marshal(ociConfig)


TO DO: Only upload an updated config and manifest if we added at least one new signature.

Is this blocking?

Both are inefficiencies, and affect only users who opted in to use-cosign-attachments, and actually have an attachment to copy.

So, IMHO, it can wait.

Recorded both in #1601 .

It's not actually dealing with the lookaside; just with the configuration. And we are going to introduce more configuration. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

…rageBaseURL This will allow us to only load the configuration once. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

This will allow us to load the configuration and then ask for multiple items. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

This is a bit more repetitive in most callers. The benefit is that we only read the files once per newImageSource, even if there are multiple mirrors. We will also read more items from the config. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

... so that users can choose whether to do the extra manifest lookups, and record signatures. NOTE: This defaults to false. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

…t.fetchManifest Signed-off-by: Miloslav Trmač <mitr@redhat.com>

We need it for writing signatures. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

We are going to need a way to upload to a tag without affecting dockerImageDestination.manifestDigest. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

NOTE design decisions: - We can read Cosign data from lookaside - We ONLY write Cosign data to Cosign attachments, never to lookaside; because lookaside is set up by default, that would be too confusing. - We ONLY use Cosign attachments at all if the user opts in via registries.d. One concern is performance impact of the extra round-trip for large-scale operations like (skopeo sync). Short-term, a much more worrying is the risk that we probably have the "is this failure just a missing atachment manifest, or a real failure reading it?" heuristic wrong, so without an opt-in, _all_ image reads are going to fail. This might eventually go away after more testing. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

mtrmac · 2022-07-07T13:01:39Z

Fixed isManifestUnknown to pass at least against distribution/distribution the implementation
Added documentation of the registries.d addition.

In manual testing, this is now good enough to copy an image between docker and dir, and directly between registries, and the copy is accepted by cosign.

So, calling this ready for review. It could definitely do with more unit tests (at least of the config handling), and integration tests in the Skopeo repo.

mtrmac · 2022-07-07T13:02:52Z

So, calling this ready for review.

Note the most important risk mitigation: The code reading/writing Cosign attachments is opt-in, so it hopefully won’t break any other users.

vrothberg

One concern is performance impact of the extra round-trip
for large-scale operations like (skopeo sync).

Short-term, a much more worrying is the risk that we probably
have the "is this failure just a missing atachment manifest,
or a real failure reading it?" heuristic wrong, so without an
opt-in, all image reads are going to fail. This might eventually
go away after more testing.

Code and design LGTM, nice work!

vrothberg · 2022-07-07T13:43:32Z

Feel free to merge

rhatdan · 2022-07-07T13:57:41Z

LGTM

copy.Image can now copy non-image OCI artifacts. Added support for sigstore signatures: they (and related cosign attachments) can be copied along with images after opt-in in registries.d. Signatures can be created by copy.Image and enforced via policy.json (currently with public/private key pairs only). Now requires Go 1.17. GPGMe now must be new enough to be visible via pkg-config. github.com/pkg/errors is no longer used; that might affect caller-observable error types (in particular, errors.{As,Is} might need to be used instead of pkg/errors.Cause). Changes default paths on FreeBSD. - Remove unused Makefile variables - Config files should live in /usr/local on FreeBSD - docker: validate received parts - Use go env to fetch the go path - docker: add workaround for CloudFront - Improve errors messages when image missing from list - Stop calling gpgme-config - Fix codespell errors - Make sure github.com/opencontainers/runc >= 1.1.2 is used - Cirrus: use Ubuntu 22.04 LTS - Merge pull request containers#1576 from mtrmac/private-image - Merge pull request containers#1577 from mtrmac/mocks - Merge pull request containers#1571 from mtrmac/go1.17 - Merge pull request containers#1578 from mtrmac/sourced-image-struct - Fix error on parallel multiple image pullings with additionallayerstore - Merge pull request containers#1579 from mtrmac/copy-layers-refactor - Reject OCI artifacts in manifest.OCI1.ImageID - Reject OCI artifacts in manifest.OCI1.Inspect - Refuse to convert non-image OCI artifacts to Docker formats - Reject OCI artifacts in image.manifestOCI1.OCIConfig - Introduce SourcedImage.CanChangeLayerCompression, use it in copy.Image - Use an updated CI image - Use strings.ReplaceAll instead of strings.Replace(..., -1) - Move the main helper removal case to the main path on RemoveAllAuthentication - Merge pull request containers#1588 from mtrmac/pkg_errors - Merge pull request containers#1589 from mtrmac/private-dest-impls - Merge pull request containers#1590 from mtrmac/private-src-impls - Merge pull request containers#1592 from mtrmac/blobcache-wrap-private - Use "io.ReadAll" instead of "os.ReadAll" - Merge pull request containers#1596 from mtrmac/cosign-payload - Generalize copy.Image to be able to copy signatures with any format - Merge pull request containers#1593 from mtrmac/cosign-sigs - Introduce signature.Cosign as a format - Add use-cosign-attachments to registries.d/*.yaml - Add support for reading and writing Cosign attachments, incl. signatures - Merge pull request containers#1595 from mtrmac/cosign-docker - Add support for creating Cosign signatures - Fix a long-standing incorrect comment - Fix JSON syntax in the policy.json(5) man page - Correctly decode Cosign-generated payloads - Add Cosign verification support - s/sigstore/lookaside/g in comments and documentation - Refer to lookasideStorage instead of signatureStorage in code - Add lookaside and lookaside-staging, hide sigstore and sigstore-staging - Merge pull request containers#1605 from mtrmac/sigstore - Fix a typo in error messages - Remove a copy&pasted test entry - Add context to some test failures - Use more valid data in TestPRSignedByIsSignatureAuthorAccepted - Generalize keyPath/keyData exclusivity checks - Remove repetition in tests - Accept multiple keyrings in newEphemeralGPGSigningMechanism - Allow accepting multiple GPG keyrings via signedBy.keyPaths - Switch to golang native error wrapping - Point out use-sigstore-registries in sigstoreSigned documentation - Use .pub extension for public keys in sigstoreSigned examples - copy: print copy info once when writer==io.Discard - Silence a "potentially unused parameter" warning - Read signatures from UnparsedImage instead of ImageSource directly - Consolidate reading messages, and checking for support, into a helper - build(deps): bump github.com/containers/storage from 1.40.0 to 1.40.2 - build(deps): bump github.com/docker/docker - build(deps): bump github.com/klauspost/compress from 1.15.2 to 1.15.3 - build(deps): bump github.com/klauspost/compress from 1.15.3 to 1.15.4 - build(deps): bump github.com/docker/docker - build(deps): bump github.com/proglottis/gpgme from 0.1.1 to 0.1.2 - build(deps): bump github.com/vbauerster/mpb/v7 from 7.4.1 to 7.4.2 - build(deps): bump github.com/imdario/mergo from 0.3.12 to 0.3.13 - build(deps): bump github.com/klauspost/compress from 1.15.4 to 1.15.5 - build(deps): bump github.com/sylabs/sif/v2 from 2.7.0 to 2.7.1 - build(deps): bump github.com/klauspost/compress from 1.15.5 to 1.15.6 - build(deps): bump github.com/stretchr/testify from 1.7.1 to 1.7.2 - build(deps): bump github.com/docker/docker - build(deps): bump github.com/stretchr/testify from 1.7.2 to 1.7.4 - build(deps): bump github.com/stretchr/testify from 1.7.4 to 1.7.5 - build(deps): bump github.com/stretchr/testify from 1.7.5 to 1.8.0 - build(deps): bump github.com/klauspost/compress from 1.15.6 to 1.15.7 - build(deps): bump github.com/proglottis/gpgme from 0.1.2 to 0.1.3 - build(deps): bump github.com/klauspost/compress from 1.15.7 to 1.15.8 - build(deps): bump github.com/sirupsen/logrus from 1.8.1 to 1.9.0 - build(deps): bump github.com/theupdateframework/go-tuf - build(deps): bump github.com/BurntSushi/toml from 1.1.0 to 1.2.0 Signed-off-by: Miloslav Trmač <mitr@redhat.com>

mtrmac changed the title ~~Add support for reading and writing Cosign attachments, to c/image/docker~~ Add support for reading and writing Cosign attachments to c/image/docker Jul 6, 2022

mtrmac mentioned this pull request Jul 6, 2022

DO NOT MERGE IRRESPONSIBLE: Cosign integration #1599

Closed

mtrmac force-pushed the cosign-docker branch 5 times, most recently from f5363f9 to 1e5089f Compare July 7, 2022 11:55

mtrmac commented Jul 7, 2022

View reviewed changes

docker/docker_client.go Show resolved Hide resolved

mtrmac commented Jul 7, 2022

View reviewed changes

mtrmac added 9 commits July 7, 2022 14:39

Rename docker/lookaside.go to docker/registries_d.go

39f9517

It's not actually dealing with the lookaside; just with the configuration. And we are going to introduce more configuration. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Split registryConfiguration.signatureStorageBaseURL from SignatureSto…

e5ba223

…rageBaseURL This will allow us to only load the configuration once. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Split loadRegistryConfiguration from SignatureStorageBaseURL

8b63771

This will allow us to load the configuration and then ask for multiple items. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Add use-cosign-attachments to registries.d/*.yaml

4efefd6

... so that users can choose whether to do the extra manifest lookups, and record signatures. NOTE: This defaults to false. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Make most of dockerImageSource.fetchManifest available in dockerClien…

4cb9873

…t.fetchManifest Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Move most of dockerImageSource.GetBlob to dockerClient.getBlob

6140722

We need it for writing signatures. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

Split dockerImageDestination.uploadManifest from PutManifest

a3f8f97

We are going to need a way to upload to a tag without affecting dockerImageDestination.manifestDigest. Signed-off-by: Miloslav Trmač <mitr@redhat.com>

mtrmac force-pushed the cosign-docker branch from 1e5089f to 68d7040 Compare July 7, 2022 12:57

mtrmac marked this pull request as ready for review July 7, 2022 13:01

vrothberg reviewed Jul 7, 2022

View reviewed changes

rhatdan merged commit f6bf95d into containers:main Jul 7, 2022

mtrmac deleted the cosign-docker branch July 7, 2022 14:13

mtrmac mentioned this pull request Jul 7, 2022

Sigstore technical debt #1601

Open

16 tasks

This was referenced Jul 18, 2022

Sigstore technical debt containers/skopeo#1704

Open

Consider adding a SystemContext override for use-sigstore-attachments #1575

Open

mtrmac mentioned this pull request Jul 21, 2022

v5.22.0 #1619

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for reading and writing Cosign attachments to c/image/docker #1595

Add support for reading and writing Cosign attachments to c/image/docker #1595

mtrmac commented Jul 6, 2022 •

edited

mtrmac Jul 7, 2022

vrothberg Jul 7, 2022

mtrmac Jul 7, 2022

mtrmac Jul 7, 2022

vrothberg Jul 7, 2022

mtrmac Jul 7, 2022

mtrmac Jul 7, 2022

mtrmac commented Jul 7, 2022

mtrmac commented Jul 7, 2022 •

edited

vrothberg left a comment •

edited

vrothberg commented Jul 7, 2022

rhatdan commented Jul 7, 2022

Add support for reading and writing Cosign attachments to c/image/docker #1595

Add support for reading and writing Cosign attachments to c/image/docker #1595

Conversation

mtrmac commented Jul 6, 2022 • edited

mtrmac Jul 7, 2022

Choose a reason for hiding this comment

vrothberg Jul 7, 2022

Choose a reason for hiding this comment

mtrmac Jul 7, 2022

Choose a reason for hiding this comment

mtrmac Jul 7, 2022

Choose a reason for hiding this comment

vrothberg Jul 7, 2022

Choose a reason for hiding this comment

mtrmac Jul 7, 2022

Choose a reason for hiding this comment

mtrmac Jul 7, 2022

Choose a reason for hiding this comment

mtrmac commented Jul 7, 2022

mtrmac commented Jul 7, 2022 • edited

vrothberg left a comment • edited

Choose a reason for hiding this comment

vrothberg commented Jul 7, 2022

rhatdan commented Jul 7, 2022

mtrmac commented Jul 6, 2022 •

edited

mtrmac commented Jul 7, 2022 •

edited

vrothberg left a comment •

edited