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
|
// Copyright The Notary Project 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 main
import (
"context"
"errors"
"fmt"
"net"
"github.com/notaryproject/notation-go/log"
notationregistry "github.com/notaryproject/notation-go/registry"
notationauth "github.com/notaryproject/notation/internal/auth"
"github.com/notaryproject/notation/internal/httputil"
"github.com/notaryproject/notation/pkg/configutil"
"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/credentials"
)
// inputType denotes the user input type
type inputType int
const (
inputTypeRegistry inputType = 1 + iota // inputType remote registry
inputTypeOCILayout // inputType oci-layout
)
// getRepository returns a notationregistry.Repository given user input
// type and user input reference
func getRepository(ctx context.Context, inputType inputType, reference string, opts *SecureFlagOpts, forceReferrersTag bool) (notationregistry.Repository, error) {
switch inputType {
case inputTypeRegistry:
return getRemoteRepository(ctx, opts, reference, forceReferrersTag)
case inputTypeOCILayout:
layoutPath, _, err := parseOCILayoutReference(reference)
if err != nil {
return nil, err
}
return notationregistry.NewOCIRepository(layoutPath, notationregistry.RepositoryOptions{})
default:
return nil, errors.New("unsupported input type")
}
}
// getRemoteRepository returns a registry.Repository.
// When forceReferrersTag is true, Notation will always generate an image index
// according to the Referrers tag schema to store signature.
//
// When forceReferrersTag is false, Notation will first try to store the
// signature as a referrer according to the Referrers API. If the Referrers API
// is not supported, fallback to use the referrers tag schema.
// This flag is always FALSE when verify/list/inspect signatures.
//
// References:
// https://github.com/opencontainers/distribution-spec/blob/v1.1.0/spec.md#listing-referrers
// https://github.com/opencontainers/distribution-spec/blob/v1.1.0/spec.md#referrers-tag-schema
func getRemoteRepository(ctx context.Context, opts *SecureFlagOpts, reference string, forceReferrersTag bool) (notationregistry.Repository, error) {
logger := log.GetLogger(ctx)
ref, err := registry.ParseReference(reference)
if err != nil {
return nil, fmt.Errorf("%q: %w. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>", reference, err)
}
if ref.Reference == "" {
return nil, fmt.Errorf("%q: invalid reference: no tag or digest. Expecting <registry>/<repository>:<tag> or <registry>/<repository>@<digest>", reference)
}
// generate notation repository
remoteRepo, err := getRepositoryClient(ctx, opts, ref)
if err != nil {
return nil, err
}
if forceReferrersTag {
logger.Info("The referrers tag schema is always attempted")
if err := remoteRepo.SetReferrersCapability(false); err != nil {
return nil, err
}
} else {
logger.Info("Allowed to access the referrers API, fallback if not supported")
}
return notationregistry.NewRepository(remoteRepo), nil
}
func getRepositoryClient(ctx context.Context, opts *SecureFlagOpts, ref registry.Reference) (*remote.Repository, error) {
authClient, insecureRegistry, err := getAuthClient(ctx, opts, ref, true)
if err != nil {
return nil, err
}
return &remote.Repository{
Client: authClient,
Reference: ref,
PlainHTTP: insecureRegistry,
}, nil
}
func getRegistryLoginClient(ctx context.Context, opts *SecureFlagOpts, serverAddress string) (*remote.Registry, error) {
reg, err := remote.NewRegistry(serverAddress)
if err != nil {
return nil, err
}
reg.Client, reg.PlainHTTP, err = getAuthClient(ctx, opts, reg.Reference, false)
if err != nil {
return nil, err
}
return reg, nil
}
// getAuthClient returns an *auth.Client and a bool indicating if the registry
// is insecure.
//
// If withCredential is true, the returned *auth.Client will have its Credential
// function configured.
//
// If withCredential is false, the returned *auth.Client will have a nil
// Credential function.
func getAuthClient(ctx context.Context, opts *SecureFlagOpts, ref registry.Reference, withCredential bool) (*auth.Client, bool, error) {
var insecureRegistry bool
if opts.InsecureRegistry {
insecureRegistry = opts.InsecureRegistry
} else {
insecureRegistry = configutil.IsRegistryInsecure(ref.Registry)
if !insecureRegistry {
if host, _, _ := net.SplitHostPort(ref.Registry); host == "localhost" {
insecureRegistry = true
}
}
}
// build authClient
authClient := httputil.NewAuthClient(ctx, nil)
if !withCredential {
return authClient, insecureRegistry, nil
}
cred := opts.Credential()
if cred != auth.EmptyCredential {
// use the specified credential
authClient.Credential = auth.StaticCredential(ref.Host(), cred)
} else {
// use saved credentials
credsStore, err := notationauth.NewCredentialsStore()
if err != nil {
return nil, false, fmt.Errorf("failed to get credentials store: %w", err)
}
authClient.Credential = credentials.Credential(credsStore)
}
return authClient, insecureRegistry, nil
}
|