-
Notifications
You must be signed in to change notification settings - Fork 56
/
oras.go
485 lines (419 loc) · 17.9 KB
/
oras.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
/*
Copyright The Ratify 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 oras
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
paths "path/filepath"
"time"
oci "github.com/opencontainers/image-spec/specs-go/v1"
"oras.land/oras-go/v2/content"
ocitarget "oras.land/oras-go/v2/content/oci"
"oras.land/oras-go/v2/errdef"
"oras.land/oras-go/v2/registry"
"oras.land/oras-go/v2/registry/remote"
"oras.land/oras-go/v2/registry/remote/auth"
"oras.land/oras-go/v2/registry/remote/errcode"
"oras.land/oras-go/v2/registry/remote/retry"
ratifyconfig "github.com/deislabs/ratify/config"
re "github.com/deislabs/ratify/errors"
"github.com/deislabs/ratify/internal/logger"
"github.com/deislabs/ratify/internal/version"
"github.com/deislabs/ratify/pkg/cache"
"github.com/deislabs/ratify/pkg/common"
"github.com/deislabs/ratify/pkg/common/oras/authprovider"
_ "github.com/deislabs/ratify/pkg/common/oras/authprovider/aws" // register aws auth provider
_ "github.com/deislabs/ratify/pkg/common/oras/authprovider/azure" // register azure auth provider
commonutils "github.com/deislabs/ratify/pkg/common/utils"
"github.com/deislabs/ratify/pkg/homedir"
"github.com/deislabs/ratify/pkg/metrics"
"github.com/deislabs/ratify/pkg/ocispecs"
"github.com/deislabs/ratify/pkg/referrerstore"
"github.com/deislabs/ratify/pkg/referrerstore/config"
"github.com/deislabs/ratify/pkg/referrerstore/factory"
"github.com/opencontainers/go-digest"
)
const (
HTTPMaxIdleConns = 100
HTTPMaxConnsPerHost = 100
HTTPMaxIdleConnsPerHost = 100
HTTPRetryMax = 5
HTTPRetryDurationMinimum time.Duration = 200 * time.Millisecond
HTTPRetryDurationMax time.Duration = 1750 * time.Millisecond
)
const (
storeName = "oras"
defaultLocalCachePath = "local_oras_cache"
dockerConfigFileName = "config.json"
ratifyUserAgent = "ratify"
)
var logOpt = logger.Option{ComponentType: logger.ReferrerStore}
// OrasStoreConf describes the configuration of ORAS store
type OrasStoreConf struct { //nolint:revive // ignore linter to have unique type name
Name string `json:"name"`
UseHTTP bool `json:"useHttp,omitempty"`
CosignEnabled bool `json:"cosignEnabled,omitempty"`
AuthProvider authprovider.AuthProviderConfig `json:"authProvider,omitempty"`
LocalCachePath string `json:"localCachePath,omitempty"`
}
type orasStoreFactory struct{}
type orasStore struct {
config *OrasStoreConf
rawConfig config.StoreConfig
localCache content.Storage
authProvider authprovider.AuthProvider
httpClient *http.Client
httpClientInsecure *http.Client
createRepository func(ctx context.Context, store *orasStore, targetRef common.Reference) (registry.Repository, error)
}
func init() {
factory.Register(storeName, &orasStoreFactory{})
}
func (s *orasStoreFactory) Create(version string, storeConfig config.StorePluginConfig) (referrerstore.ReferrerStore, error) {
storeBase, err := createBaseStore(version, storeConfig)
if err != nil {
return nil, err
}
if cache.GetCacheProvider() == nil {
return storeBase, nil
}
cacheConf, err := toCacheConfig(storeBase.GetConfig().Store)
if err != nil {
return nil, re.ErrorCodeConfigInvalid.WithError(err).WithComponentType(re.ReferrerStore)
}
if !cacheConf.Enabled {
return storeBase, nil
}
return createCachedStore(storeBase, cacheConf)
}
func createBaseStore(version string, storeConfig config.StorePluginConfig) (*orasStore, error) {
conf := OrasStoreConf{}
storeConfigBytes, err := json.Marshal(storeConfig)
if err != nil {
return nil, re.ErrorCodeConfigInvalid.WithError(err).WithComponentType(re.ReferrerStore)
}
if err := json.Unmarshal(storeConfigBytes, &conf); err != nil {
return nil, re.ErrorCodeConfigInvalid.NewError(re.ReferrerStore, "", re.EmptyLink, err, "failed to parse oras store configuration", re.HideStackTrace)
}
authenticationProvider, err := authprovider.CreateAuthProviderFromConfig(conf.AuthProvider)
if err != nil {
return nil, re.ErrorCodePluginInitFailure.NewError(re.ReferrerStore, "", re.EmptyLink, err, "failed to create auth provider from configuration", re.HideStackTrace)
}
// Set up the local cache where content will land when we pull
if conf.LocalCachePath == "" {
conf.LocalCachePath = paths.Join(homedir.Get(), ratifyconfig.ConfigFileDir, defaultLocalCachePath)
}
localRegistry, err := ocitarget.New(conf.LocalCachePath)
if err != nil {
return nil, re.ErrorCodePluginInitFailure.WithError(err).WithComponentType(re.ReferrerStore).WithDetail(fmt.Sprintf("could not create local oras cache at path: %s", conf.LocalCachePath))
}
var customPredicate retry.Predicate = func(resp *http.Response, err error) (bool, error) {
host := ""
if resp != nil {
if resp.Request != nil && resp.Request.URL != nil {
host = resp.Request.URL.Host
}
metrics.ReportRegistryRequestCount(resp.Request.Context(), resp.StatusCode, host)
}
return retry.DefaultPredicate(resp, err)
}
customRetryPolicy := func() retry.Policy {
return &retry.GenericPolicy{
Retryable: customPredicate,
Backoff: retry.DefaultBackoff,
MinWait: HTTPRetryDurationMinimum,
MaxWait: HTTPRetryDurationMax,
MaxRetry: HTTPRetryMax,
}
}
// define the http client for TLS enabled
secureTransport := http.DefaultTransport.(*http.Transport).Clone()
secureTransport.MaxIdleConns = HTTPMaxIdleConns
secureTransport.MaxConnsPerHost = HTTPMaxConnsPerHost
secureTransport.MaxIdleConnsPerHost = HTTPMaxIdleConnsPerHost
secureRetryTransport := retry.NewTransport(secureTransport)
secureRetryTransport.Policy = customRetryPolicy
// define the http client for TLS disabled
insecureTransport := http.DefaultTransport.(*http.Transport).Clone()
insecureTransport.MaxIdleConns = HTTPMaxIdleConns
insecureTransport.MaxConnsPerHost = HTTPMaxConnsPerHost
insecureTransport.MaxIdleConnsPerHost = HTTPMaxIdleConnsPerHost
// #nosec G402
insecureTransport.TLSClientConfig = &tls.Config{
InsecureSkipVerify: true,
}
insecureRetryTransport := retry.NewTransport(insecureTransport)
insecureRetryTransport.Policy = customRetryPolicy
return &orasStore{config: &conf,
rawConfig: config.StoreConfig{Version: version, Store: storeConfig},
localCache: localRegistry,
authProvider: authenticationProvider,
httpClient: &http.Client{Transport: secureRetryTransport},
httpClientInsecure: &http.Client{Transport: insecureRetryTransport},
createRepository: createDefaultRepository}, nil
}
func (store *orasStore) Name() string {
return storeName
}
func (store *orasStore) GetConfig() *config.StoreConfig {
return &store.rawConfig
}
func (store *orasStore) ListReferrers(ctx context.Context, subjectReference common.Reference, _ []string, _ string, subjectDesc *ocispecs.SubjectDescriptor) (referrerstore.ListReferrersResult, error) {
repository, err := store.createRepository(ctx, store, subjectReference)
if err != nil {
return referrerstore.ListReferrersResult{}, re.ErrorCodeCreateRepositoryFailure.WithError(err).WithComponentType(re.ReferrerStore)
}
// resolve subject descriptor if not provided
var resolvedSubjectDesc *ocispecs.SubjectDescriptor
if subjectDesc != nil {
resolvedSubjectDesc = subjectDesc
} else {
if resolvedSubjectDesc, err = store.GetSubjectDescriptor(ctx, subjectReference); err != nil {
evictOnError(ctx, err, subjectReference.Original)
return referrerstore.ListReferrersResult{}, err
}
}
// find all referrers referencing subject descriptor
artifactTypeFilter := ""
var referrerDescriptors []oci.Descriptor
if err := repository.Referrers(ctx, resolvedSubjectDesc.Descriptor, artifactTypeFilter, func(referrers []oci.Descriptor) error {
referrerDescriptors = append(referrerDescriptors, referrers...)
return nil
}); err != nil && !errors.Is(err, errdef.ErrNotFound) {
evictOnError(ctx, err, subjectReference.Original)
return referrerstore.ListReferrersResult{}, err
}
// convert artifact descriptors to oci descriptor with artifact type
referrers := []ocispecs.ReferenceDescriptor{}
for _, referrer := range referrerDescriptors {
referrers = append(referrers, OciDescriptorToReferenceDescriptor(referrer))
}
if store.config.CosignEnabled {
// add cosign descriptor if exists
cosignReferences, err := getCosignReferences(ctx, subjectReference, repository)
if err != nil {
return referrerstore.ListReferrersResult{}, err
}
if cosignReferences != nil {
referrers = append(referrers, *cosignReferences...)
}
}
return referrerstore.ListReferrersResult{Referrers: referrers}, nil
}
func (store *orasStore) GetBlobContent(ctx context.Context, subjectReference common.Reference, digest digest.Digest) ([]byte, error) {
var err error
repository, err := store.createRepository(ctx, store, subjectReference)
if err != nil {
return nil, err
}
// create a dummy Descriptor to check the local store cache
blobDescriptor := oci.Descriptor{
Digest: digest,
Size: 0, // dummy size value
}
// check if blob exists in local ORAS cache
isCached, err := store.localCache.Exists(ctx, blobDescriptor)
if err != nil {
return nil, err
}
metrics.ReportBlobCacheCount(ctx, isCached)
if !isCached {
// generate the reference path with digest
ref := fmt.Sprintf("%s@%s", subjectReference.Path, digest)
// fetch blob content from remote repository
blobDesc, rc, err := repository.Blobs().FetchReference(ctx, ref)
if err != nil {
evictOnError(ctx, err, subjectReference.Original)
return nil, err
}
// push fetched content to local ORAS cache
orasExistsExpectedError := fmt.Errorf("%s: %s: %w", blobDesc.Digest, blobDesc.MediaType, errdef.ErrAlreadyExists)
err = store.localCache.Push(ctx, blobDesc, rc)
if err != nil && err.Error() != orasExistsExpectedError.Error() {
return nil, err
}
}
return store.getRawContentFromCache(ctx, blobDescriptor)
}
func (store *orasStore) GetReferenceManifest(ctx context.Context, subjectReference common.Reference, referenceDesc ocispecs.ReferenceDescriptor) (ocispecs.ReferenceManifest, error) {
repository, err := store.createRepository(ctx, store, subjectReference)
if err != nil {
return ocispecs.ReferenceManifest{}, re.ErrorCodeCreateRepositoryFailure.NewError(re.ReferrerStore, storeName, re.EmptyLink, err, nil, re.HideStackTrace)
}
var manifestBytes []byte
// check if manifest exists in local ORAS cache
isCached, err := store.localCache.Exists(ctx, referenceDesc.Descriptor)
if err != nil {
return ocispecs.ReferenceManifest{}, err
}
metrics.ReportBlobCacheCount(ctx, isCached)
if !isCached {
// fetch manifest content from repository
manifestReader, err := repository.Fetch(ctx, referenceDesc.Descriptor)
if err != nil {
evictOnError(ctx, err, subjectReference.Original)
return ocispecs.ReferenceManifest{}, re.ErrorCodeRepositoryOperationFailure.NewError(re.ReferrerStore, storeName, re.EmptyLink, err, nil, re.HideStackTrace)
}
manifestBytes, err = io.ReadAll(manifestReader)
if err != nil {
return ocispecs.ReferenceManifest{}, re.ErrorCodeManifestInvalid.WithError(err).WithPluginName(storeName).WithComponentType(re.ReferrerStore)
}
// push fetched manifest to local ORAS cache
orasExistsExpectedError := fmt.Errorf("%s: %s: %w", referenceDesc.Descriptor.Digest, referenceDesc.Descriptor.MediaType, errdef.ErrAlreadyExists)
err = store.localCache.Push(ctx, referenceDesc.Descriptor, bytes.NewReader(manifestBytes))
if err != nil && err.Error() != orasExistsExpectedError.Error() {
return ocispecs.ReferenceManifest{}, err
}
} else {
manifestBytes, err = store.getRawContentFromCache(ctx, referenceDesc.Descriptor)
if err != nil {
return ocispecs.ReferenceManifest{}, err
}
}
referenceManifest := ocispecs.ReferenceManifest{}
// marshal manifest bytes into reference manifest descriptor
if referenceDesc.Descriptor.MediaType == oci.MediaTypeImageManifest {
var imageManifest oci.Manifest
if err := json.Unmarshal(manifestBytes, &imageManifest); err != nil {
return ocispecs.ReferenceManifest{}, re.ErrorCodeDataDecodingFailure.WithError(err).WithComponentType(re.ReferrerStore)
}
referenceManifest = commonutils.OciManifestToReferenceManifest(imageManifest)
} else if referenceDesc.Descriptor.MediaType == ocispecs.MediaTypeArtifactManifest {
if err := json.Unmarshal(manifestBytes, &referenceManifest); err != nil {
return ocispecs.ReferenceManifest{}, re.ErrorCodeDataDecodingFailure.WithError(err).WithComponentType(re.ReferrerStore)
}
} else {
return ocispecs.ReferenceManifest{}, fmt.Errorf("unsupported manifest media type: %s", referenceDesc.Descriptor.MediaType)
}
return referenceManifest, nil
}
func (store *orasStore) GetSubjectDescriptor(ctx context.Context, subjectReference common.Reference) (*ocispecs.SubjectDescriptor, error) {
repository, err := store.createRepository(ctx, store, subjectReference)
if err != nil {
return nil, re.ErrorCodeCreateRepositoryFailure.WithError(err).WithComponentType(re.ReferrerStore).WithPluginName(storeName)
}
desc, err := repository.Resolve(ctx, subjectReference.Original)
if err != nil {
evictOnError(ctx, err, subjectReference.Original)
return nil, re.ErrorCodeRepositoryOperationFailure.WithError(err).WithPluginName(storeName)
}
return &ocispecs.SubjectDescriptor{Descriptor: desc}, nil
}
// evict from cache on non retry-able errors including 401 and 403
func evictOnError(ctx context.Context, err error, subjectReference string) {
cacheProvider := cache.GetCacheProvider()
// if cache provider is not enabled, return
if cacheProvider == nil {
return
}
var ec *errcode.ErrorResponse
if errors.As(err, &ec) && (ec.StatusCode == http.StatusForbidden || ec.StatusCode == http.StatusUnauthorized) {
artifactRef, err := registry.ParseReference(subjectReference)
if err != nil {
logger.GetLogger(ctx, logOpt).Warnf("failed to evict credential from cache for %s: %v", subjectReference, err)
}
cacheProvider.Delete(ctx, fmt.Sprintf(cache.CacheKeyOrasAuth, artifactRef.Registry))
}
}
func createDefaultRepository(ctx context.Context, store *orasStore, targetRef common.Reference) (registry.Repository, error) {
if store.authProvider == nil || !store.authProvider.Enabled(ctx) {
return nil, fmt.Errorf("auth provider not properly enabled")
}
artifactRef, err := registry.ParseReference(targetRef.Original)
if err != nil {
return nil, err
}
var authConfig authprovider.AuthConfig
cacheProvider := cache.GetCacheProvider()
var cacheResponse string
found := false
cacheHit := false
if cacheProvider != nil {
cacheResponse, found = cacheProvider.Get(ctx, fmt.Sprintf(cache.CacheKeyOrasAuth, artifactRef.Registry))
}
if cacheResponse != "" && found {
if err := json.Unmarshal([]byte(cacheResponse), &authConfig); err != nil {
logger.GetLogger(ctx, logOpt).Warn(re.ErrorCodeDataDecodingFailure.NewError(re.Cache, "", re.EmptyLink, err, fmt.Sprintf("failed to unmarshal auth config cache value: %s", cacheResponse), re.HideStackTrace))
} else {
logger.GetLogger(ctx, logOpt).Debug("auth cache hit")
cacheHit = true
}
}
if !cacheHit {
logger.GetLogger(ctx, logOpt).Debug("auth cache miss")
authConfig, err = store.authProvider.Provide(ctx, targetRef.Original)
if err != nil {
logger.GetLogger(ctx, logOpt).Warnf("auth provider failed with err, %v", err)
logger.GetLogger(ctx, logOpt).Debug("attempting to use anonymous credentials")
} else if authConfig == (authprovider.AuthConfig{}) {
logger.GetLogger(ctx, logOpt).Debug("no credentials found, attempting to use anonymous credentials")
} else {
if cacheProvider != nil {
success := cacheProvider.SetWithTTL(ctx, fmt.Sprintf(cache.CacheKeyOrasAuth, artifactRef.Registry), authConfig, time.Until(authConfig.ExpiresOn))
if !success {
logger.GetLogger(ctx, logOpt).Warn(re.ErrorCodeCacheNotSet.WithComponentType(re.Cache).WithDetail(fmt.Sprintf("failed to set auth cache for %s", artifactRef.Registry)))
}
}
}
}
// create new ORAS repository target to the image/repository reference
repository, err := remote.NewRepository(targetRef.Original)
if err != nil {
return nil, err
}
// set the provider to return the resolved credentials
credentialProvider := func(ctx context.Context, registry string) (auth.Credential, error) {
if authConfig.Username != "" || authConfig.Password != "" || authConfig.IdentityToken != "" {
return auth.Credential{
Username: authConfig.Username,
Password: authConfig.Password,
RefreshToken: authConfig.IdentityToken,
}, nil
}
return auth.EmptyCredential, nil
}
// set the repository client credentials
repoClient := &auth.Client{
Client: store.httpClient,
Header: http.Header{},
Cache: auth.NewCache(),
Credential: credentialProvider,
}
repoClient.SetUserAgent(version.UserAgent)
repoClient.Header = logger.SetTraceIDHeader(ctx, repoClient.Header)
// enable insecure if specified in config
if isInsecureRegistry(targetRef.Original, store.config) {
repoClient.Client = store.httpClientInsecure
}
repository.Client = repoClient
// enable plain HTTP if specified in config
repository.PlainHTTP = store.config.UseHTTP
return repository, nil
}
func (store *orasStore) getRawContentFromCache(ctx context.Context, descriptor oci.Descriptor) ([]byte, error) {
reader, err := store.localCache.Fetch(ctx, descriptor)
if err != nil {
return nil, err
}
buf, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
return buf, nil
}