| 1 |
// Package signaturediscovery contains functionalities to discover container image signatures. |
| 2 |
package signaturediscovery |
| 3 |
|
| 4 |
import ( |
| 5 |
"context" |
| 6 |
"fmt" |
| 7 |
|
| 8 |
"github.com/containerd/containerd" |
| 9 |
"github.com/containerd/containerd/content" |
| 10 |
"github.com/containerd/containerd/images" |
| 11 |
"github.com/containerd/containerd/remotes" |
| 12 |
"github.com/google/go-tpm-tools/verifier/oci" |
| 13 |
"github.com/google/go-tpm-tools/verifier/oci/cosign" |
| 14 |
v1 "github.com/opencontainers/image-spec/specs-go/v1" |
| 15 |
) |
| 16 |
|
| 17 |
const signatureTagSuffix = "sig" |
| 18 |
|
| 19 |
type ( |
| 20 |
remoteResolverFetcher func(context.Context) (remotes.Resolver, error) |
| 21 |
imageFetcher func(context.Context, string, ...containerd.RemoteOpt) (containerd.Image, error) |
| 22 |
) |
| 23 |
|
| 24 |
// Fetcher discovers and fetches OCI signatures from the target repository. |
| 25 |
type Fetcher interface { |
| 26 |
FetchImageSignatures(ctx context.Context, targetRepository string) ([]oci.Signature, error) |
| 27 |
} |
| 28 |
|
| 29 |
// Client is a wrapper of containerd.Client to interact with signed image manifest. |
| 30 |
type Client struct { |
| 31 |
OriginalImageDesc v1.Descriptor |
| 32 |
refreshResolver remoteResolverFetcher |
| 33 |
imageFetcher imageFetcher |
| 34 |
} |
| 35 |
|
| 36 |
// New creates a new client that implements Fetcher interface. |
| 37 |
func New(originalImageDesc v1.Descriptor, resolverFetcher remoteResolverFetcher, imageFetcher imageFetcher) Fetcher { |
| 38 |
return &Client{ |
| 39 |
OriginalImageDesc: originalImageDesc, |
| 40 |
refreshResolver: resolverFetcher, |
| 41 |
imageFetcher: imageFetcher, |
| 42 |
} |
| 43 |
} |
| 44 |
|
| 45 |
// FetchSignedImageManifest fetches a signed image manifest using a tag-based discovery mechanism. |
| 46 |
func (c *Client) FetchSignedImageManifest(ctx context.Context, targetRepository string) (v1.Manifest, error) { |
| 47 |
image, err := c.pullSignatureImage(ctx, targetRepository) |
| 48 |
if err != nil { |
| 49 |
return v1.Manifest{}, err |
| 50 |
} |
| 51 |
return getManifest(ctx, image) |
| 52 |
} |
| 53 |
|
| 54 |
// FetchImageSignatures returns a list of valid image signatures associated with the target OCI image. |
| 55 |
func (c *Client) FetchImageSignatures(ctx context.Context, targetRepository string) ([]oci.Signature, error) { |
| 56 |
image, err := c.pullSignatureImage(ctx, targetRepository) |
| 57 |
if err != nil { |
| 58 |
return nil, err |
| 59 |
} |
| 60 |
manifest, err := getManifest(ctx, image) |
| 61 |
if err != nil { |
| 62 |
return nil, err |
| 63 |
} |
| 64 |
signatures := make([]oci.Signature, 0, len(manifest.Layers)) |
| 65 |
for _, layer := range manifest.Layers { |
| 66 |
blob, err := content.ReadBlob(ctx, image.ContentStore(), layer) |
| 67 |
if err != nil { |
| 68 |
return nil, err |
| 69 |
} |
| 70 |
sig := &cosign.Sig{ |
| 71 |
Layer: layer, |
| 72 |
Blob: blob, |
| 73 |
SourceRepo: targetRepository, |
| 74 |
} |
| 75 |
signatures = append(signatures, sig) |
| 76 |
} |
| 77 |
return signatures, nil |
| 78 |
} |
| 79 |
|
| 80 |
func (c *Client) pullSignatureImage(ctx context.Context, signatureRepository string) (containerd.Image, error) { |
| 81 |
signatureImageRef := fmt.Sprint(signatureRepository, ":", formatSigTag(c.OriginalImageDesc)) |
| 82 |
|
| 83 |
// Pull signature image from a public repository. |
| 84 |
if c.refreshResolver == nil { |
| 85 |
return c.imageFetcher(ctx, signatureImageRef) |
| 86 |
} |
| 87 |
|
| 88 |
// Refresh resolver before pulling container image. |
| 89 |
resolver, err := c.refreshResolver(ctx) |
| 90 |
if err == nil { |
| 91 |
return c.imageFetcher(ctx, signatureImageRef, containerd.WithResolver(resolver)) |
| 92 |
} |
| 93 |
return nil, fmt.Errorf("failed to refresh remote resolver before pulling container image: %v", err) |
| 94 |
} |
| 95 |
|
| 96 |
// formatSigTag turns image digests into tags with signatureTagSuffix: |
| 97 |
// sha256:9ecc53c2 -> sha256-9ecc53c2.sig |
| 98 |
func formatSigTag(imageDesc v1.Descriptor) string { |
| 99 |
digest := imageDesc.Digest |
| 100 |
return fmt.Sprint(digest.Algorithm(), "-", digest.Encoded(), ".", signatureTagSuffix) |
| 101 |
} |
| 102 |
|
| 103 |
func getManifest(ctx context.Context, image containerd.Image) (v1.Manifest, error) { |
| 104 |
cs := image.ContentStore() |
| 105 |
manifest, err := images.Manifest(ctx, cs, image.Target(), image.Platform()) |
| 106 |
if err != nil { |
| 107 |
return v1.Manifest{}, err |
| 108 |
} |
| 109 |
return manifest, nil |
| 110 |
} |