File: index.go

package info (click to toggle)
cosign 2.6.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,184 kB
  • sloc: sh: 229; makefile: 170
file content (154 lines) | stat: -rw-r--r-- 3,972 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
//
// Copyright 2021 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package layout

import (
	"fmt"

	v1 "github.com/google/go-containerregistry/pkg/v1"
	"github.com/google/go-containerregistry/pkg/v1/layout"
	"github.com/sigstore/cosign/v2/pkg/oci"
	"github.com/sigstore/cosign/v2/pkg/oci/signed"
)

const (
	kindAnnotation       = "kind"
	imageAnnotation      = "dev.cosignproject.cosign/image"
	imageIndexAnnotation = "dev.cosignproject.cosign/imageIndex"
	sigsAnnotation       = "dev.cosignproject.cosign/sigs"
	attsAnnotation       = "dev.cosignproject.cosign/atts"
)

// SignedImageIndex provides access to a local index reference, and its signatures.
func SignedImageIndex(path string) (oci.SignedImageIndex, error) {
	p, err := layout.FromPath(path)
	if err != nil {
		return nil, err
	}
	ii, err := p.ImageIndex()
	if err != nil {
		return nil, err
	}
	return &index{
		v1Index: ii,
	}, nil
}

// We alias ImageIndex so that we can inline it without the type
// name colliding with the name of a method it had to implement.
type v1Index v1.ImageIndex

type index struct {
	v1Index
}

var _ oci.SignedImageIndex = (*index)(nil)

// Signatures implements oci.SignedImageIndex
func (i *index) Signatures() (oci.Signatures, error) {
	img, err := i.imageByAnnotation(sigsAnnotation)
	if err != nil {
		return nil, err
	}
	if img == nil {
		return nil, nil
	}
	return &sigs{img}, nil
}

// Attestations implements oci.SignedImageIndex
func (i *index) Attestations() (oci.Signatures, error) {
	img, err := i.imageByAnnotation(attsAnnotation)
	if err != nil {
		return nil, err
	}
	if img == nil {
		return nil, nil
	}
	return &sigs{img}, nil
}

// Attestations implements oci.SignedImage
func (i *index) Attachment(name string) (oci.File, error) { //nolint: revive
	return nil, fmt.Errorf("not yet implemented")
}

// SignedImage implements oci.SignedImageIndex
// if an empty hash is passed in, return the original image that was signed
func (i *index) SignedImage(h v1.Hash) (oci.SignedImage, error) {
	var img v1.Image
	var err error
	if h.String() == ":" {
		img, err = i.imageByAnnotation(imageAnnotation)
	} else {
		img, err = i.Image(h)
	}
	if err != nil {
		return nil, err
	}
	if img == nil {
		return nil, nil
	}
	return signed.Image(img), nil
}

// imageByAnnotation searches through all manifests in the index.json
// and returns the image that has the matching annotation
func (i *index) imageByAnnotation(annotation string) (v1.Image, error) {
	manifest, err := i.IndexManifest()
	if err != nil {
		return nil, err
	}
	for _, m := range manifest.Manifests {
		if val, ok := m.Annotations[kindAnnotation]; ok && val == annotation {
			return i.Image(m.Digest)
		}
	}
	return nil, nil
}

func (i *index) imageIndexByAnnotation(annotation string) (v1.ImageIndex, error) {
	manifest, err := i.IndexManifest()
	if err != nil {
		return nil, err
	}
	for _, m := range manifest.Manifests {
		if val, ok := m.Annotations[kindAnnotation]; ok && val == annotation {
			return i.ImageIndex(m.Digest)
		}
	}
	return nil, nil
}

// SignedImageIndex implements oci.SignedImageIndex
func (i *index) SignedImageIndex(h v1.Hash) (oci.SignedImageIndex, error) {
	var ii v1.ImageIndex
	var err error
	if h.String() == ":" {
		ii, err = i.imageIndexByAnnotation(imageIndexAnnotation)
	} else {
		ii, err = i.ImageIndex(h)
	}
	if err != nil {
		return nil, err
	}
	if ii == nil {
		return nil, nil
	}
	return &index{
		v1Index: ii,
	}, nil
}