fix(oci): bad parse oci_ref when used with custom registry
This commit is contained in:
@@ -56,6 +56,12 @@ var defaultClientID = "oras-go"
|
||||
|
||||
// StaticCredential specifies static credentials for the given host.
|
||||
func StaticCredential(registry string, cred Credential) func(context.Context, string) (Credential, error) {
|
||||
if registry == "docker.io" {
|
||||
// it is expected that traffic targeting "docker.io" will be redirected
|
||||
// to "registry-1.docker.io"
|
||||
// reference: https://github.com/moby/moby/blob/v24.0.0-beta.2/registry/config.go#L25-L48
|
||||
registry = "registry-1.docker.io"
|
||||
}
|
||||
return func(_ context.Context, target string) (Credential, error) {
|
||||
if target == registry {
|
||||
return cred, nil
|
||||
|
@@ -20,6 +20,7 @@ import (
|
||||
|
||||
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
"oras.land/oras-go/v2/internal/docker"
|
||||
"oras.land/oras-go/v2/internal/spec"
|
||||
)
|
||||
|
||||
// defaultManifestMediaTypes contains the default set of manifests media types.
|
||||
@@ -28,7 +29,7 @@ var defaultManifestMediaTypes = []string{
|
||||
docker.MediaTypeManifestList,
|
||||
ocispec.MediaTypeImageManifest,
|
||||
ocispec.MediaTypeImageIndex,
|
||||
ocispec.MediaTypeArtifactManifest,
|
||||
spec.MediaTypeArtifactManifest,
|
||||
}
|
||||
|
||||
// defaultManifestAcceptHeader is the default set in the `Accept` header for
|
||||
|
@@ -22,6 +22,7 @@ import (
|
||||
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
"oras.land/oras-go/v2/content"
|
||||
"oras.land/oras-go/v2/internal/descriptor"
|
||||
"oras.land/oras-go/v2/internal/spec"
|
||||
)
|
||||
|
||||
// zeroDigest represents a digest that consists of zeros. zeroDigest is used
|
||||
@@ -68,6 +69,38 @@ var (
|
||||
errNoReferrerUpdate = errors.New("no referrer update")
|
||||
)
|
||||
|
||||
const (
|
||||
// opDeleteReferrersIndex represents the operation for deleting a
|
||||
// referrers index.
|
||||
opDeleteReferrersIndex = "DeleteReferrersIndex"
|
||||
)
|
||||
|
||||
// ReferrersError records an error and the operation and the subject descriptor.
|
||||
type ReferrersError struct {
|
||||
// Op represents the failing operation.
|
||||
Op string
|
||||
// Subject is the descriptor of referenced artifact.
|
||||
Subject ocispec.Descriptor
|
||||
// Err is the entity of referrers error.
|
||||
Err error
|
||||
}
|
||||
|
||||
// Error returns error msg of IgnorableError.
|
||||
func (e *ReferrersError) Error() string {
|
||||
return e.Err.Error()
|
||||
}
|
||||
|
||||
// Unwrap returns the inner error of IgnorableError.
|
||||
func (e *ReferrersError) Unwrap() error {
|
||||
return errors.Unwrap(e.Err)
|
||||
}
|
||||
|
||||
// IsIndexDelete tells if e is kind of error related to referrers
|
||||
// index deletion.
|
||||
func (e *ReferrersError) IsReferrersIndexDelete() bool {
|
||||
return e.Op == opDeleteReferrersIndex
|
||||
}
|
||||
|
||||
// buildReferrersTag builds the referrers tag for the given manifest descriptor.
|
||||
// Format: <algorithm>-<digest>
|
||||
// Reference: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#unavailable-referrers-api
|
||||
@@ -80,7 +113,7 @@ func buildReferrersTag(desc ocispec.Descriptor) string {
|
||||
// isReferrersFilterApplied checks annotations to see if requested is in the
|
||||
// applied filter list.
|
||||
func isReferrersFilterApplied(annotations map[string]string, requested string) bool {
|
||||
applied := annotations[ocispec.AnnotationReferrersFiltersApplied]
|
||||
applied := annotations[spec.AnnotationReferrersFiltersApplied]
|
||||
if applied == "" || requested == "" {
|
||||
return false
|
||||
}
|
||||
|
@@ -39,6 +39,7 @@ import (
|
||||
"oras.land/oras-go/v2/internal/ioutil"
|
||||
"oras.land/oras-go/v2/internal/registryutil"
|
||||
"oras.land/oras-go/v2/internal/slices"
|
||||
"oras.land/oras-go/v2/internal/spec"
|
||||
"oras.land/oras-go/v2/internal/syncutil"
|
||||
"oras.land/oras-go/v2/registry"
|
||||
"oras.land/oras-go/v2/registry/remote/auth"
|
||||
@@ -213,6 +214,19 @@ func (r *Repository) Push(ctx context.Context, expected ocispec.Descriptor, cont
|
||||
return r.blobStore(expected).Push(ctx, expected, content)
|
||||
}
|
||||
|
||||
// Mount makes the blob with the given digest in fromRepo
|
||||
// available in the repository signified by the receiver.
|
||||
//
|
||||
// This avoids the need to pull content down from fromRepo only to push it to r.
|
||||
//
|
||||
// If the registry does not implement mounting, getContent will be used to get the
|
||||
// content to push. If getContent is nil, the content will be pulled from the source
|
||||
// repository. If getContent returns an error, it will be wrapped inside the error
|
||||
// returned from Mount.
|
||||
func (r *Repository) Mount(ctx context.Context, desc ocispec.Descriptor, fromRepo string, getContent func() (io.ReadCloser, error)) error {
|
||||
return r.Blobs().(registry.Mounter).Mount(ctx, desc, fromRepo, getContent)
|
||||
}
|
||||
|
||||
// Exists returns true if the described content exists.
|
||||
func (r *Repository) Exists(ctx context.Context, target ocispec.Descriptor) (bool, error) {
|
||||
return r.blobStore(target).Exists(ctx, target)
|
||||
@@ -659,6 +673,73 @@ func (s *blobStore) Fetch(ctx context.Context, target ocispec.Descriptor) (rc io
|
||||
}
|
||||
}
|
||||
|
||||
// Mount mounts the given descriptor from fromRepo into s.
|
||||
func (s *blobStore) Mount(ctx context.Context, desc ocispec.Descriptor, fromRepo string, getContent func() (io.ReadCloser, error)) error {
|
||||
// pushing usually requires both pull and push actions.
|
||||
// Reference: https://github.com/distribution/distribution/blob/v2.7.1/registry/handlers/app.go#L921-L930
|
||||
ctx = registryutil.WithScopeHint(ctx, s.repo.Reference, auth.ActionPull, auth.ActionPush)
|
||||
|
||||
// We also need pull access to the source repo.
|
||||
fromRef := s.repo.Reference
|
||||
fromRef.Repository = fromRepo
|
||||
ctx = registryutil.WithScopeHint(ctx, fromRef, auth.ActionPull)
|
||||
|
||||
url := buildRepositoryBlobMountURL(s.repo.PlainHTTP, s.repo.Reference, desc.Digest, fromRepo)
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
resp, err := s.repo.client().Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if resp.StatusCode == http.StatusCreated {
|
||||
defer resp.Body.Close()
|
||||
// Check the server seems to be behaving.
|
||||
return verifyContentDigest(resp, desc.Digest)
|
||||
}
|
||||
if resp.StatusCode != http.StatusAccepted {
|
||||
defer resp.Body.Close()
|
||||
return errutil.ParseErrorResponse(resp)
|
||||
}
|
||||
resp.Body.Close()
|
||||
// From the [spec]:
|
||||
//
|
||||
// "If a registry does not support cross-repository mounting
|
||||
// or is unable to mount the requested blob,
|
||||
// it SHOULD return a 202.
|
||||
// This indicates that the upload session has begun
|
||||
// and that the client MAY proceed with the upload."
|
||||
//
|
||||
// So we need to get the content from somewhere in order to
|
||||
// push it. If the caller has provided a getContent function, we
|
||||
// can use that, otherwise pull the content from the source repository.
|
||||
//
|
||||
// [spec]: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#mounting-a-blob-from-another-repository
|
||||
|
||||
var r io.ReadCloser
|
||||
if getContent != nil {
|
||||
r, err = getContent()
|
||||
} else {
|
||||
r, err = s.sibling(fromRepo).Fetch(ctx, desc)
|
||||
}
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot read source blob: %w", err)
|
||||
}
|
||||
defer r.Close()
|
||||
return s.completePushAfterInitialPost(ctx, req, resp, desc, r)
|
||||
}
|
||||
|
||||
// sibling returns a blob store for another repository in the same
|
||||
// registry.
|
||||
func (s *blobStore) sibling(otherRepoName string) *blobStore {
|
||||
otherRepo := *s.repo
|
||||
otherRepo.Reference.Repository = otherRepoName
|
||||
return &blobStore{
|
||||
repo: &otherRepo,
|
||||
}
|
||||
}
|
||||
|
||||
// Push pushes the content, matching the expected descriptor.
|
||||
// Existing content is not checked by Push() to minimize the number of out-going
|
||||
// requests.
|
||||
@@ -679,11 +760,8 @@ func (s *blobStore) Push(ctx context.Context, expected ocispec.Descriptor, conte
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
reqHostname := req.URL.Hostname()
|
||||
reqPort := req.URL.Port()
|
||||
|
||||
client := s.repo.client()
|
||||
resp, err := client.Do(req)
|
||||
resp, err := s.repo.client().Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -693,7 +771,15 @@ func (s *blobStore) Push(ctx context.Context, expected ocispec.Descriptor, conte
|
||||
return errutil.ParseErrorResponse(resp)
|
||||
}
|
||||
resp.Body.Close()
|
||||
return s.completePushAfterInitialPost(ctx, req, resp, expected, content)
|
||||
}
|
||||
|
||||
// completePushAfterInitialPost implements step 2 of the push protocol. This can be invoked either by
|
||||
// Push or by Mount when the receiving repository does not implement the
|
||||
// mount endpoint.
|
||||
func (s *blobStore) completePushAfterInitialPost(ctx context.Context, req *http.Request, resp *http.Response, expected ocispec.Descriptor, content io.Reader) error {
|
||||
reqHostname := req.URL.Hostname()
|
||||
reqPort := req.URL.Port()
|
||||
// monolithic upload
|
||||
location, err := resp.Location()
|
||||
if err != nil {
|
||||
@@ -710,7 +796,7 @@ func (s *blobStore) Push(ctx context.Context, expected ocispec.Descriptor, conte
|
||||
if reqPort == "443" && locationHostname == reqHostname && locationPort == "" {
|
||||
location.Host = locationHostname + ":" + reqPort
|
||||
}
|
||||
url = location.String()
|
||||
url := location.String()
|
||||
req, err = http.NewRequestWithContext(ctx, http.MethodPut, url, content)
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -730,7 +816,7 @@ func (s *blobStore) Push(ctx context.Context, expected ocispec.Descriptor, conte
|
||||
if auth := resp.Request.Header.Get("Authorization"); auth != "" {
|
||||
req.Header.Set("Authorization", auth)
|
||||
}
|
||||
resp, err = client.Do(req)
|
||||
resp, err = s.repo.client().Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
@@ -946,7 +1032,7 @@ func (s *manifestStore) Delete(ctx context.Context, target ocispec.Descriptor) e
|
||||
// deleteWithIndexing removes the manifest content identified by the descriptor,
|
||||
// and indexes referrers for the manifest when needed.
|
||||
func (s *manifestStore) deleteWithIndexing(ctx context.Context, target ocispec.Descriptor) error {
|
||||
if target.MediaType == ocispec.MediaTypeArtifactManifest || target.MediaType == ocispec.MediaTypeImageManifest {
|
||||
if target.MediaType == spec.MediaTypeArtifactManifest || target.MediaType == ocispec.MediaTypeImageManifest {
|
||||
if state := s.repo.loadReferrersState(); state == referrersStateSupported {
|
||||
// referrers API is available, no client-side indexing needed
|
||||
return s.repo.delete(ctx, target, true)
|
||||
@@ -1155,7 +1241,7 @@ func (s *manifestStore) push(ctx context.Context, expected ocispec.Descriptor, c
|
||||
// and indexes referrers for the manifest when needed.
|
||||
func (s *manifestStore) pushWithIndexing(ctx context.Context, expected ocispec.Descriptor, r io.Reader, reference string) error {
|
||||
switch expected.MediaType {
|
||||
case ocispec.MediaTypeArtifactManifest, ocispec.MediaTypeImageManifest:
|
||||
case spec.MediaTypeArtifactManifest, ocispec.MediaTypeImageManifest:
|
||||
if state := s.repo.loadReferrersState(); state == referrersStateSupported {
|
||||
// referrers API is available, no client-side indexing needed
|
||||
return s.push(ctx, expected, r, reference)
|
||||
@@ -1183,8 +1269,8 @@ func (s *manifestStore) pushWithIndexing(ctx context.Context, expected ocispec.D
|
||||
func (s *manifestStore) indexReferrersForPush(ctx context.Context, desc ocispec.Descriptor, manifestJSON []byte) error {
|
||||
var subject ocispec.Descriptor
|
||||
switch desc.MediaType {
|
||||
case ocispec.MediaTypeArtifactManifest:
|
||||
var manifest ocispec.Artifact
|
||||
case spec.MediaTypeArtifactManifest:
|
||||
var manifest spec.Artifact
|
||||
if err := json.Unmarshal(manifestJSON, &manifest); err != nil {
|
||||
return fmt.Errorf("failed to decode manifest: %s: %s: %w", desc.Digest, desc.MediaType, err)
|
||||
}
|
||||
@@ -1271,7 +1357,11 @@ func (s *manifestStore) updateReferrersIndex(ctx context.Context, subject ocispe
|
||||
// 4. delete the dangling original referrers index
|
||||
if !skipDelete {
|
||||
if err := s.repo.delete(ctx, oldIndexDesc, true); err != nil {
|
||||
return fmt.Errorf("failed to delete dangling referrers index %s for referrers tag %s: %w", oldIndexDesc.Digest.String(), referrersTag, err)
|
||||
return &ReferrersError{
|
||||
Op: opDeleteReferrersIndex,
|
||||
Err: fmt.Errorf("failed to delete dangling referrers index %s for referrers tag %s: %w", oldIndexDesc.Digest.String(), referrersTag, err),
|
||||
Subject: subject,
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
|
@@ -20,6 +20,7 @@ import (
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
"github.com/opencontainers/go-digest"
|
||||
"oras.land/oras-go/v2/registry"
|
||||
)
|
||||
|
||||
@@ -87,6 +88,17 @@ func buildRepositoryBlobUploadURL(plainHTTP bool, ref registry.Reference) string
|
||||
return buildRepositoryBaseURL(plainHTTP, ref) + "/blobs/uploads/"
|
||||
}
|
||||
|
||||
// buildRepositoryBlobMountURLbuilds the URL for cross-repository mounting.
|
||||
// Format: <scheme>://<registry>/v2/<repository>/blobs/uploads/?mount=<digest>&from=<other_repository>
|
||||
// Reference: https://docs.docker.com/registry/spec/api/#blob
|
||||
func buildRepositoryBlobMountURL(plainHTTP bool, ref registry.Reference, d digest.Digest, fromRepo string) string {
|
||||
return fmt.Sprintf("%s?mount=%s&from=%s",
|
||||
buildRepositoryBlobUploadURL(plainHTTP, ref),
|
||||
d,
|
||||
fromRepo,
|
||||
)
|
||||
}
|
||||
|
||||
// buildReferrersURL builds the URL for querying the Referrers API.
|
||||
// Format: <scheme>://<registry>/v2/<repository>/referrers/<digest>?artifactType=<artifactType>
|
||||
// Reference: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#listing-referrers
|
||||
|
@@ -107,6 +107,19 @@ type TagLister interface {
|
||||
Tags(ctx context.Context, last string, fn func(tags []string) error) error
|
||||
}
|
||||
|
||||
// Mounter allows cross-repository blob mounts.
|
||||
// For backward compatibility reasons, this is not implemented by
|
||||
// BlobStore: use a type assertion to check availability.
|
||||
type Mounter interface {
|
||||
// Mount makes the blob with the given descriptor in fromRepo
|
||||
// available in the repository signified by the receiver.
|
||||
Mount(ctx context.Context,
|
||||
desc ocispec.Descriptor,
|
||||
fromRepo string,
|
||||
getContent func() (io.ReadCloser, error),
|
||||
) error
|
||||
}
|
||||
|
||||
// Tags lists the tags available in the repository.
|
||||
func Tags(ctx context.Context, repo TagLister) ([]string, error) {
|
||||
var res []string
|
||||
|
Reference in New Issue
Block a user