/
signable.go
404 lines (346 loc) · 12.6 KB
/
signable.go
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
/*
Copyright 2020 The Tekton 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 artifacts
import (
"context"
_ "crypto/sha256" // Recommended by go-digest.
_ "crypto/sha512" // Recommended by go-digest.
"fmt"
"regexp"
"strings"
"github.com/google/go-containerregistry/pkg/name"
"github.com/in-toto/in-toto-golang/in_toto/slsa_provenance/common"
"github.com/opencontainers/go-digest"
"github.com/opentracing/opentracing-go/log"
"github.com/tektoncd/chains/internal/backport"
"github.com/tektoncd/chains/pkg/chains/objects"
"github.com/tektoncd/chains/pkg/config"
v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
"k8s.io/apimachinery/pkg/util/sets"
"knative.dev/pkg/logging"
)
const (
ArtifactsInputsResultName = "ARTIFACT_INPUTS"
ArtifactsOutputsResultName = "ARTIFACT_OUTPUTS"
OCIScheme = "oci://"
GitSchemePrefix = "git+"
)
var (
Sha1Regexp *regexp.Regexp = regexp.MustCompile(`^[a-f0-9]{40}$`)
)
type Signable interface {
ExtractObjects(ctx context.Context, obj objects.TektonObject) []interface{}
StorageBackend(cfg config.Config) sets.Set[string]
Signer(cfg config.Config) string
PayloadFormat(cfg config.Config) config.PayloadType
// FullKey returns the full identifier for a signable artifact.
// - For OCI artifact, it is the full representation in the format of `<NAME>@sha256:<DIGEST>`.
// - For TaskRun/PipelineRun artifact, it is `<GROUP>-<VERSION>-<KIND>-<UID>`
FullKey(interface{}) string
// ShortKey returns the short version of an artifact identifier.
// - For OCI artifact, it is first 12 chars of the image digest.
// - For TaskRun/PipelineRun artifact, it is `<KIND>-<UID>`.
ShortKey(interface{}) string
Type() string
Enabled(cfg config.Config) bool
}
type TaskRunArtifact struct{}
var _ Signable = &TaskRunArtifact{}
func (ta *TaskRunArtifact) ShortKey(obj interface{}) string {
tro := obj.(*objects.TaskRunObjectV1)
return "taskrun-" + string(tro.UID)
}
func (ta *TaskRunArtifact) FullKey(obj interface{}) string {
tro := obj.(*objects.TaskRunObjectV1)
gvk := tro.GetGroupVersionKind()
return fmt.Sprintf("%s-%s-%s-%s", gvk.Group, gvk.Version, gvk.Kind, tro.UID)
}
func (ta *TaskRunArtifact) ExtractObjects(ctx context.Context, obj objects.TektonObject) []interface{} {
return []interface{}{obj}
}
func (ta *TaskRunArtifact) Type() string {
return "tekton"
}
func (ta *TaskRunArtifact) StorageBackend(cfg config.Config) sets.Set[string] {
return cfg.Artifacts.TaskRuns.StorageBackend
}
func (ta *TaskRunArtifact) PayloadFormat(cfg config.Config) config.PayloadType {
return config.PayloadType(cfg.Artifacts.TaskRuns.Format)
}
func (ta *TaskRunArtifact) Signer(cfg config.Config) string {
return cfg.Artifacts.TaskRuns.Signer
}
func (ta *TaskRunArtifact) Enabled(cfg config.Config) bool {
return cfg.Artifacts.TaskRuns.Enabled()
}
type PipelineRunArtifact struct{}
var _ Signable = &PipelineRunArtifact{}
func (pa *PipelineRunArtifact) ShortKey(obj interface{}) string {
pro := obj.(*objects.PipelineRunObjectV1)
return "pipelinerun-" + string(pro.UID)
}
func (pa *PipelineRunArtifact) FullKey(obj interface{}) string {
pro := obj.(*objects.PipelineRunObjectV1)
gvk := pro.GetGroupVersionKind()
return fmt.Sprintf("%s-%s-%s-%s", gvk.Group, gvk.Version, gvk.Kind, pro.UID)
}
func (pa *PipelineRunArtifact) ExtractObjects(ctx context.Context, obj objects.TektonObject) []interface{} {
return []interface{}{obj}
}
func (pa *PipelineRunArtifact) Type() string {
// TODO: Is this right?
return "tekton-pipeline-run"
}
func (pa *PipelineRunArtifact) StorageBackend(cfg config.Config) sets.Set[string] {
return cfg.Artifacts.PipelineRuns.StorageBackend
}
func (pa *PipelineRunArtifact) PayloadFormat(cfg config.Config) config.PayloadType {
return config.PayloadType(cfg.Artifacts.PipelineRuns.Format)
}
func (pa *PipelineRunArtifact) Signer(cfg config.Config) string {
return cfg.Artifacts.PipelineRuns.Signer
}
func (pa *PipelineRunArtifact) Enabled(cfg config.Config) bool {
return cfg.Artifacts.PipelineRuns.Enabled()
}
type OCIArtifact struct{}
var _ Signable = &OCIArtifact{}
type image struct {
url string
digest string
}
func (oa *OCIArtifact) ExtractObjects(ctx context.Context, obj objects.TektonObject) []interface{} {
objs := []interface{}{}
// TODO: Not applicable to PipelineRuns, should look into a better way to separate this out
if trV1, ok := obj.GetObject().(*v1.TaskRun); ok {
trV1Beta1 := &v1beta1.TaskRun{} //nolint:staticcheck
if err := trV1Beta1.ConvertFrom(ctx, trV1); err == nil {
imageResourceNames := map[string]*image{}
if trV1Beta1.Status.TaskSpec != nil && trV1Beta1.Status.TaskSpec.Resources != nil { //nolint:staticcheck
for _, output := range trV1Beta1.Status.TaskSpec.Resources.Outputs { //nolint:staticcheck
if output.Type == backport.PipelineResourceTypeImage {
imageResourceNames[output.Name] = &image{}
}
}
}
for _, rr := range trV1Beta1.Status.ResourcesResult {
img, ok := imageResourceNames[rr.ResourceName]
if !ok {
continue
}
// We have a result for an image!
if rr.Key == "url" {
img.url = rr.Value
} else if rr.Key == "digest" {
img.digest = rr.Value
}
}
for _, image := range imageResourceNames {
dgst, err := name.NewDigest(fmt.Sprintf("%s@%s", image.url, image.digest))
if err != nil {
log.Error(err)
continue
}
objs = append(objs, dgst)
}
}
}
// Now check TaskResults
resultImages := ExtractOCIImagesFromResults(ctx, obj)
objs = append(objs, resultImages...)
return objs
}
func ExtractOCIImagesFromResults(ctx context.Context, obj objects.TektonObject) []interface{} {
logger := logging.FromContext(ctx)
objs := []interface{}{}
extractor := structuredSignableExtractor{
uriSuffix: "IMAGE_URL",
digestSuffix: "IMAGE_DIGEST",
isValid: hasImageRequirements,
}
for _, s := range extractor.extract(ctx, obj) {
dgst, err := name.NewDigest(fmt.Sprintf("%s@%s", s.URI, s.Digest))
if err != nil {
logger.Errorf("error getting digest: %v", err)
continue
}
objs = append(objs, dgst)
}
// look for a comma separated list of images
for _, key := range obj.GetResults() {
if key.Name != "IMAGES" {
continue
}
imgs := strings.FieldsFunc(key.Value.StringVal, split)
for _, img := range imgs {
trimmed := strings.TrimSpace(img)
if trimmed == "" {
continue
}
dgst, err := name.NewDigest(trimmed)
if err != nil {
logger.Errorf("error getting digest for img %s: %v", trimmed, err)
continue
}
objs = append(objs, dgst)
}
}
return objs
}
// ExtractSignableTargetFromResults extracts signable targets that aim to generate intoto provenance as materials within TaskRun results and store them as StructuredSignable.
func ExtractSignableTargetFromResults(ctx context.Context, obj objects.TektonObject) []StructuredSignable {
logger := logging.FromContext(ctx)
extractor := structuredSignableExtractor{
uriSuffix: "ARTIFACT_URI",
digestSuffix: "ARTIFACT_DIGEST",
isValid: func(s StructuredSignable) bool {
if !hasImageRequirements(s) {
return false
}
if _, _, err := ParseDigest(s.Digest); err != nil {
logger.Errorf("error getting digest %s: %v", s.Digest, err)
return false
}
return true
},
}
return extractor.extract(ctx, obj)
}
// FullRef returns the full reference of the signable artifact in the format of URI@DIGEST
func (s *StructuredSignable) FullRef() string {
return fmt.Sprintf("%s@%s", s.URI, s.Digest)
}
// RetrieveMaterialsFromStructuredResults retrieves structured results from Tekton Object, and convert them into materials.
func RetrieveMaterialsFromStructuredResults(ctx context.Context, obj objects.TektonObject, categoryMarker string) []common.ProvenanceMaterial {
logger := logging.FromContext(ctx)
// Retrieve structured provenance for inputs.
mats := []common.ProvenanceMaterial{}
ssts := ExtractStructuredTargetFromResults(ctx, obj, ArtifactsInputsResultName)
for _, s := range ssts {
alg, digest, err := ParseDigest(s.Digest)
if err != nil {
logger.Debugf("Digest for %s not in the right format: %s, %v", s.URI, s.Digest, err)
continue
}
mats = append(mats, common.ProvenanceMaterial{
URI: s.URI,
Digest: map[string]string{alg: digest},
})
}
return mats
}
// ExtractStructuredTargetFromResults extracts structured signable targets aim to generate intoto provenance as materials within TaskRun results and store them as StructuredSignable.
// categoryMarker categorizes signable targets into inputs and outputs.
func ExtractStructuredTargetFromResults(ctx context.Context, obj objects.TektonObject, categoryMarker string) []*StructuredSignable {
logger := logging.FromContext(ctx)
objs := []*StructuredSignable{}
if categoryMarker != ArtifactsInputsResultName && categoryMarker != ArtifactsOutputsResultName {
return objs
}
// TODO(#592): support structured results using Run
results := []objects.Result{}
for _, res := range obj.GetResults() {
results = append(results, objects.Result{
Name: res.Name,
Value: res.Value,
})
}
for _, res := range results {
if strings.HasSuffix(res.Name, categoryMarker) {
valid, err := isStructuredResult(res, categoryMarker)
if err != nil {
logger.Debugf("ExtractStructuredTargetFromResults: %v", err)
}
if valid {
logger.Debugf("Extracted Structured data from Result %s, %s", res.Value.ObjectVal["uri"], res.Value.ObjectVal["digest"])
objs = append(objs, &StructuredSignable{URI: res.Value.ObjectVal["uri"], Digest: res.Value.ObjectVal["digest"]})
}
}
}
return objs
}
func isStructuredResult(res objects.Result, categoryMarker string) (bool, error) {
if !strings.HasSuffix(res.Name, categoryMarker) {
return false, nil
}
if res.Value.ObjectVal == nil {
return false, fmt.Errorf("%s should be an object: %v", res.Name, res.Value.ObjectVal)
}
if res.Value.ObjectVal["uri"] == "" {
return false, fmt.Errorf("%s should have uri field: %v", res.Name, res.Value.ObjectVal)
}
if res.Value.ObjectVal["digest"] == "" {
return false, fmt.Errorf("%s should have digest field: %v", res.Name, res.Value.ObjectVal)
}
if _, _, err := ParseDigest(res.Value.ObjectVal["digest"]); err != nil {
return false, fmt.Errorf("error getting digest %s: %v", res.Value.ObjectVal["digest"], err)
}
return true, nil
}
// ParseDigest parses the digest string and returns the algorithm and hex section of the digest.
func ParseDigest(dig string) (algo_string string, hex string, err error) {
parts := strings.Split(dig, ":")
if len(parts) != 2 {
return "", "", fmt.Errorf("digest string %s, not in the format of <algorithm>:<digest>", dig)
}
algo_string = strings.ToLower(strings.TrimSpace(parts[0]))
algo := digest.Algorithm(algo_string)
hex = strings.TrimSpace(parts[1])
switch {
case algo.Available():
if err := algo.Validate(hex); err != nil {
return "", "", err
}
case algo_string == "sha1":
// Version 1.0.0, which is the released version, of go_digest does not support SHA1,
// hence this has to be handled differently.
if !Sha1Regexp.MatchString(hex) {
return "", "", fmt.Errorf("sha1 digest %s does not match regexp %s", dig, Sha1Regexp.String())
}
default:
return "", "", fmt.Errorf("unsupported digest algorithm: %s", dig)
}
return algo_string, hex, nil
}
// split allows IMAGES to be separated either by commas (for backwards compatibility)
// or by newlines
func split(r rune) bool {
return r == '\n' || r == ','
}
func (oa *OCIArtifact) Type() string {
return "oci"
}
func (oa *OCIArtifact) StorageBackend(cfg config.Config) sets.Set[string] {
return cfg.Artifacts.OCI.StorageBackend
}
func (oa *OCIArtifact) PayloadFormat(cfg config.Config) config.PayloadType {
return config.PayloadType(cfg.Artifacts.OCI.Format)
}
func (oa *OCIArtifact) Signer(cfg config.Config) string {
return cfg.Artifacts.OCI.Signer
}
func (oa *OCIArtifact) ShortKey(obj interface{}) string {
v := obj.(name.Digest)
return strings.TrimPrefix(v.DigestStr(), "sha256:")[:12]
}
func (oa *OCIArtifact) FullKey(obj interface{}) string {
v := obj.(name.Digest)
return v.Name()
}
func (oa *OCIArtifact) Enabled(cfg config.Config) bool {
return cfg.Artifacts.OCI.Enabled()
}
func hasImageRequirements(s StructuredSignable) bool {
return s.URI != "" && s.Digest != ""
}