-
Notifications
You must be signed in to change notification settings - Fork 82
/
manifest.go
504 lines (477 loc) · 13.6 KB
/
manifest.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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
// Package manifest abstracts the various types of supported manifests.
// Supported types include OCI index and image, and Docker manifest list and manifest.
package manifest
import (
"encoding/json"
"fmt"
"net/http"
"reflect"
"strconv"
"strings"
digest "github.com/opencontainers/go-digest"
"github.com/regclient/regclient/internal/wraperr"
"github.com/regclient/regclient/types"
"github.com/regclient/regclient/types/docker/schema1"
"github.com/regclient/regclient/types/docker/schema2"
v1 "github.com/regclient/regclient/types/oci/v1"
"github.com/regclient/regclient/types/platform"
"github.com/regclient/regclient/types/ref"
)
// Manifest interface is implemented by all supported manifests but
// many calls are only supported by certain underlying media types.
type Manifest interface {
GetConfig() (types.Descriptor, error)
GetDescriptor() types.Descriptor
GetLayers() ([]types.Descriptor, error)
GetManifestList() ([]types.Descriptor, error)
GetOrig() interface{}
GetRef() ref.Ref
IsList() bool
IsSet() bool
MarshalJSON() ([]byte, error)
RawBody() ([]byte, error)
RawHeaders() (http.Header, error)
SetOrig(interface{}) error
GetConfigDigest() (digest.Digest, error) // TODO: deprecate
GetDigest() digest.Digest // TODO: deprecate
GetMediaType() string // TODO: deprecate
GetPlatformDesc(p *platform.Platform) (*types.Descriptor, error) // TODO: deprecate
GetPlatformList() ([]*platform.Platform, error) // TODO: deprecate
GetRateLimit() types.RateLimit // TODO: deprecate
HasRateLimit() bool // TODO: deprecate
}
type manifestConfig struct {
r ref.Ref
desc types.Descriptor
raw []byte
orig interface{}
header http.Header
}
type Opts func(*manifestConfig)
// New creates a new manifest based on provided options
func New(opts ...Opts) (Manifest, error) {
mc := manifestConfig{}
for _, opt := range opts {
opt(&mc)
}
c := common{
r: mc.r,
desc: mc.desc,
rawBody: mc.raw,
rawHeader: mc.header,
}
// extract fields from header where available
if mc.header != nil {
if c.desc.MediaType == "" {
c.desc.MediaType = mc.header.Get("Content-Type")
}
if mc.desc.Size == 0 {
cl, _ := strconv.Atoi(mc.header.Get("Content-Length"))
mc.desc.Size = int64(cl)
}
if c.desc.Digest == "" {
c.desc.Digest, _ = digest.Parse(mc.header.Get("Docker-Content-Digest"))
}
c.setRateLimit(mc.header)
}
if mc.orig != nil {
return fromOrig(c, mc.orig)
}
return fromCommon(c)
}
// WithDesc specifies the descriptor for the manifest
func WithDesc(desc types.Descriptor) Opts {
return func(mc *manifestConfig) {
mc.desc = desc
}
}
// WithHeader provides the headers from the response when pulling the manifest
func WithHeader(header http.Header) Opts {
return func(mc *manifestConfig) {
mc.header = header
}
}
// WithOrig provides the original manifest variable
func WithOrig(orig interface{}) Opts {
return func(mc *manifestConfig) {
mc.orig = orig
}
}
// WithRaw provides the manifest bytes or HTTP response body
func WithRaw(raw []byte) Opts {
return func(mc *manifestConfig) {
mc.raw = raw
}
}
// WithRef provides the reference used to get the manifest
func WithRef(r ref.Ref) Opts {
return func(mc *manifestConfig) {
mc.r = r
}
}
// GetDigest returns the digest from the manifest descriptor
func GetDigest(m Manifest) digest.Digest {
d := m.GetDescriptor()
return d.Digest
}
// GetMediaType returns the media type from the manifest descriptor
func GetMediaType(m Manifest) string {
d := m.GetDescriptor()
return d.MediaType
}
// GetPlatformDesc returns the descriptor for a specific platform from an index
func GetPlatformDesc(m Manifest, p *platform.Platform) (*types.Descriptor, error) {
dl, err := m.GetManifestList()
if err != nil {
return nil, err
}
return getPlatformDesc(p, dl)
}
// GetPlatformList returns the list of platforms from an index
func GetPlatformList(m Manifest) ([]*platform.Platform, error) {
dl, err := m.GetManifestList()
if err != nil {
return nil, err
}
var l []*platform.Platform
for _, d := range dl {
if d.Platform != nil {
l = append(l, d.Platform)
}
}
return l, nil
}
// GetRateLimit returns the current rate limit seen in headers
func GetRateLimit(m Manifest) types.RateLimit {
rl := types.RateLimit{}
header, err := m.RawHeaders()
if err != nil {
return rl
}
// check for rate limit headers
rlLimit := header.Get("RateLimit-Limit")
rlRemain := header.Get("RateLimit-Remaining")
rlReset := header.Get("RateLimit-Reset")
if rlLimit != "" {
lpSplit := strings.Split(rlLimit, ",")
lSplit := strings.Split(lpSplit[0], ";")
rlLimitI, err := strconv.Atoi(lSplit[0])
if err != nil {
rl.Limit = 0
} else {
rl.Limit = rlLimitI
}
if len(lSplit) > 1 {
rl.Policies = lpSplit
} else if len(lpSplit) > 1 {
rl.Policies = lpSplit[1:]
}
}
if rlRemain != "" {
rSplit := strings.Split(rlRemain, ";")
rlRemainI, err := strconv.Atoi(rSplit[0])
if err != nil {
rl.Remain = 0
} else {
rl.Remain = rlRemainI
rl.Set = true
}
}
if rlReset != "" {
rlResetI, err := strconv.Atoi(rlReset)
if err != nil {
rl.Reset = 0
} else {
rl.Reset = rlResetI
}
}
return rl
}
// HasRateLimit indicates whether the rate limit is set and available
func HasRateLimit(m Manifest) bool {
rl := GetRateLimit(m)
return rl.Set
}
func OCIIndexFromAny(orig interface{}) (v1.Index, error) {
ociI := v1.Index{
Versioned: v1.IndexSchemaVersion,
MediaType: types.MediaTypeOCI1ManifestList,
}
switch orig := orig.(type) {
case schema2.ManifestList:
ociI.Manifests = orig.Manifests
case v1.Index:
ociI = orig
default:
return ociI, fmt.Errorf("unable to convert %T to OCI index", orig)
}
return ociI, nil
}
func OCIIndexToAny(ociI v1.Index, origP interface{}) error {
// reflect is used to handle both *interface{} and *Manifest
rv := reflect.ValueOf(origP)
for rv.IsValid() && rv.Type().Kind() == reflect.Ptr {
rv = rv.Elem()
}
if !rv.IsValid() {
return fmt.Errorf("invalid manifest output parameter: %T", origP)
}
if !rv.CanSet() {
return fmt.Errorf("manifest output must be a pointer: %T", origP)
}
origR := rv.Interface()
switch orig := (origR).(type) {
case schema2.ManifestList:
orig.Versioned = schema2.ManifestListSchemaVersion
orig.Manifests = ociI.Manifests
rv.Set(reflect.ValueOf(orig))
case v1.Index:
rv.Set(reflect.ValueOf(ociI))
default:
return fmt.Errorf("unable to convert OCI index to %T", origR)
}
return nil
}
func OCIManifestFromAny(orig interface{}) (v1.Manifest, error) {
ociM := v1.Manifest{
Versioned: v1.ManifestSchemaVersion,
MediaType: types.MediaTypeOCI1Manifest,
}
switch orig := orig.(type) {
case schema2.Manifest:
ociM.Config = orig.Config
ociM.Layers = orig.Layers
case v1.Manifest:
ociM = orig
default:
// TODO: consider supporting Docker schema v1 media types
return ociM, fmt.Errorf("unable to convert %T to OCI image", orig)
}
return ociM, nil
}
func OCIManifestToAny(ociM v1.Manifest, origP interface{}) error {
// reflect is used to handle both *interface{} and *Manifest
rv := reflect.ValueOf(origP)
for rv.IsValid() && rv.Type().Kind() == reflect.Ptr {
rv = rv.Elem()
}
if !rv.IsValid() {
return fmt.Errorf("invalid manifest output parameter: %T", origP)
}
if !rv.CanSet() {
return fmt.Errorf("manifest output must be a pointer: %T", origP)
}
origR := rv.Interface()
switch orig := (origR).(type) {
case schema2.Manifest:
orig.Versioned = schema2.ManifestSchemaVersion
orig.Config = ociM.Config
orig.Layers = ociM.Layers
rv.Set(reflect.ValueOf(orig))
case v1.Manifest:
rv.Set(reflect.ValueOf(ociM))
default:
// Docker schema v1 will not be supported, can't resign, and no need for unsigned
return fmt.Errorf("unable to convert OCI image to %T", origR)
}
return nil
}
// FromOrig creates a new manifest from the original upstream manifest type.
// This method should be used if you are creating a new manifest rather than pulling one from a registry.
func fromOrig(c common, orig interface{}) (Manifest, error) {
var mt string
var m Manifest
origDigest := c.desc.Digest
mj, err := json.Marshal(orig)
if err != nil {
return nil, err
}
c.manifSet = true
if len(c.rawBody) == 0 {
c.rawBody = mj
}
if _, ok := orig.(schema1.SignedManifest); !ok {
c.desc.Digest = digest.FromBytes(mj)
}
if c.desc.Size == 0 {
c.desc.Size = int64(len(mj))
}
// create manifest based on type
switch mOrig := orig.(type) {
case schema1.Manifest:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeDocker1Manifest
m = &docker1Manifest{
common: c,
Manifest: mOrig,
}
case schema1.SignedManifest:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeDocker1ManifestSigned
// recompute digest on the canonical data
c.desc.Digest = digest.FromBytes(mOrig.Canonical)
m = &docker1SignedManifest{
common: c,
SignedManifest: mOrig,
}
case schema2.Manifest:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeDocker2Manifest
m = &docker2Manifest{
common: c,
Manifest: mOrig,
}
case schema2.ManifestList:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeDocker2ManifestList
m = &docker2ManifestList{
common: c,
ManifestList: mOrig,
}
case v1.Manifest:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeOCI1Manifest
m = &oci1Manifest{
common: c,
Manifest: mOrig,
}
case v1.Index:
mt = mOrig.MediaType
c.desc.MediaType = types.MediaTypeOCI1ManifestList
m = &oci1Index{
common: c,
Index: orig.(v1.Index),
}
default:
return nil, fmt.Errorf("unsupported type to convert to a manifest: %T", orig)
}
// verify media type
err = verifyMT(c.desc.MediaType, mt)
if err != nil {
return nil, err
}
// verify digest didn't change
if origDigest != "" && origDigest != c.desc.Digest {
return nil, fmt.Errorf("manifest digest mismatch, expected %s, computed %s", origDigest, c.desc.Digest)
}
return m, nil
}
func fromCommon(c common) (Manifest, error) {
var err error
var m Manifest
var mt string
origDigest := c.desc.Digest
// compute/verify digest
if len(c.rawBody) > 0 {
c.manifSet = true
if c.desc.MediaType != types.MediaTypeDocker1ManifestSigned {
d := digest.FromBytes(c.rawBody)
c.desc.Digest = d
c.desc.Size = int64(len(c.rawBody))
}
}
// extract media type from body if needed
if c.desc.MediaType == "" && len(c.rawBody) > 0 {
mt := struct {
MediaType string `json:"mediaType,omitempty"`
SchemaVersion int `json:"schemaVersion,omitempty"`
Signatures []interface{} `json:"signatures,omitempty"`
}{}
err = json.Unmarshal(c.rawBody, &mt)
if mt.MediaType != "" {
c.desc.MediaType = mt.MediaType
} else if mt.SchemaVersion == 1 && len(mt.Signatures) > 0 {
c.desc.MediaType = types.MediaTypeDocker1ManifestSigned
} else if mt.SchemaVersion == 1 {
c.desc.MediaType = types.MediaTypeDocker1Manifest
}
}
switch c.desc.MediaType {
case types.MediaTypeDocker1Manifest:
var mOrig schema1.Manifest
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
}
m = &docker1Manifest{common: c, Manifest: mOrig}
case types.MediaTypeDocker1ManifestSigned:
var mOrig schema1.SignedManifest
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
d := digest.FromBytes(mOrig.Canonical)
c.desc.Digest = d
c.desc.Size = int64(len(mOrig.Canonical))
}
m = &docker1SignedManifest{common: c, SignedManifest: mOrig}
case types.MediaTypeDocker2Manifest:
var mOrig schema2.Manifest
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
}
m = &docker2Manifest{common: c, Manifest: mOrig}
case types.MediaTypeDocker2ManifestList:
var mOrig schema2.ManifestList
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
}
m = &docker2ManifestList{common: c, ManifestList: mOrig}
case types.MediaTypeOCI1Manifest:
var mOrig v1.Manifest
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
}
m = &oci1Manifest{common: c, Manifest: mOrig}
case types.MediaTypeOCI1ManifestList:
var mOrig v1.Index
if len(c.rawBody) > 0 {
err = json.Unmarshal(c.rawBody, &mOrig)
mt = mOrig.MediaType
}
m = &oci1Index{common: c, Index: mOrig}
default:
return nil, fmt.Errorf("%w: \"%s\"", types.ErrUnsupportedMediaType, c.desc.MediaType)
}
if err != nil {
return nil, fmt.Errorf("error unmarshaling manifest for %s: %w", c.r.CommonName(), err)
}
// verify media type
err = verifyMT(c.desc.MediaType, mt)
if err != nil {
return nil, err
}
// verify digest didn't change
if origDigest != "" && origDigest != c.desc.Digest {
return nil, fmt.Errorf("manifest digest mismatch, expected %s, computed %s", origDigest, c.desc.Digest)
}
return m, nil
}
func verifyMT(expected, received string) error {
if received != "" && expected != received {
return fmt.Errorf("manifest contains an unexpected media type: expected %s, received %s", expected, received)
}
return nil
}
func getPlatformDesc(p *platform.Platform, dl []types.Descriptor) (*types.Descriptor, error) {
if p == nil {
return nil, wraperr.New(fmt.Errorf("invalid input, platform is nil"), types.ErrNotFound)
}
for _, d := range dl {
if d.Platform != nil && platform.Match(*p, *d.Platform) {
return &d, nil
}
}
return nil, wraperr.New(fmt.Errorf("platform not found: %s", *p), types.ErrNotFound)
}
func getPlatformList(dl []types.Descriptor) ([]*platform.Platform, error) {
var l []*platform.Platform
for _, d := range dl {
if d.Platform != nil {
l = append(l, d.Platform)
}
}
return l, nil
}