-
Notifications
You must be signed in to change notification settings - Fork 545
/
registry.go
195 lines (165 loc) · 6.42 KB
/
registry.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
// Copyright 2021 The Sigstore 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 options
import (
"context"
"crypto/tls"
"errors"
"fmt"
"io"
"net/http"
ecr "github.com/awslabs/amazon-ecr-credential-helper/ecr-login"
"github.com/chrismellard/docker-credential-acr-env/pkg/credhelper"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/google/go-containerregistry/pkg/authn/github"
"github.com/google/go-containerregistry/pkg/name"
"github.com/google/go-containerregistry/pkg/v1/google"
"github.com/google/go-containerregistry/pkg/v1/remote"
alibabaacr "github.com/mozillazg/docker-credential-acr-helper/pkg/credhelper"
ociremote "github.com/sigstore/cosign/v2/pkg/oci/remote"
"github.com/spf13/cobra"
)
// Keychain is an alias of authn.Keychain to expose this configuration option to consumers of this lib
type Keychain = authn.Keychain
// RegistryOptions is the wrapper for the registry options.
type RegistryOptions struct {
AllowInsecure bool
AllowHTTPRegistry bool
KubernetesKeychain bool
RefOpts ReferenceOptions
Keychain Keychain
AuthConfig authn.AuthConfig
// RegistryClientOpts allows overriding the result of GetRegistryClientOpts.
RegistryClientOpts []remote.Option
}
var _ Interface = (*RegistryOptions)(nil)
// AddFlags implements Interface
func (o *RegistryOptions) AddFlags(cmd *cobra.Command) {
cmd.Flags().BoolVar(&o.AllowInsecure, "allow-insecure-registry", false,
"whether to allow insecure connections to registries (e.g., with expired or self-signed TLS certificates). Don't use this for anything but testing")
cmd.Flags().BoolVar(&o.AllowHTTPRegistry, "allow-http-registry", false,
"whether to allow using HTTP protocol while connecting to registries. Don't use this for anything but testing")
cmd.Flags().BoolVar(&o.KubernetesKeychain, "k8s-keychain", false,
"whether to use the kubernetes keychain instead of the default keychain (supports workload identity).")
cmd.Flags().StringVar(&o.AuthConfig.Username, "registry-username", "",
"registry basic auth username")
cmd.Flags().StringVar(&o.AuthConfig.Password, "registry-password", "",
"registry basic auth password")
cmd.Flags().StringVar(&o.AuthConfig.RegistryToken, "registry-token", "",
"registry bearer auth token")
o.RefOpts.AddFlags(cmd)
}
func (o *RegistryOptions) ClientOpts(ctx context.Context) ([]ociremote.Option, error) {
opts := []ociremote.Option{ociremote.WithRemoteOptions(o.GetRegistryClientOpts(ctx)...)}
if o.RefOpts.TagPrefix != "" {
opts = append(opts, ociremote.WithPrefix(o.RefOpts.TagPrefix))
}
targetRepoOverride, err := ociremote.GetEnvTargetRepository()
if err != nil {
return nil, err
}
if (targetRepoOverride != name.Repository{}) {
opts = append(opts, ociremote.WithTargetRepository(targetRepoOverride))
}
return opts, nil
}
func (o *RegistryOptions) NameOptions() []name.Option {
var nameOpts []name.Option
if o.AllowHTTPRegistry {
nameOpts = append(nameOpts, name.Insecure)
}
return nameOpts
}
func (o *RegistryOptions) GetRegistryClientOpts(ctx context.Context) []remote.Option {
if o.RegistryClientOpts != nil {
ropts := o.RegistryClientOpts
ropts = append(ropts, remote.WithContext(ctx))
return ropts
}
opts := []remote.Option{
remote.WithContext(ctx),
remote.WithUserAgent(UserAgent()),
}
switch {
case o.Keychain != nil:
opts = append(opts, remote.WithAuthFromKeychain(o.Keychain))
case o.KubernetesKeychain:
kc := authn.NewMultiKeychain(
authn.DefaultKeychain,
google.Keychain,
authn.NewKeychainFromHelper(ecr.NewECRHelper(ecr.WithLogger(io.Discard))),
authn.NewKeychainFromHelper(credhelper.NewACRCredentialsHelper()),
authn.NewKeychainFromHelper(alibabaacr.NewACRHelper().WithLoggerOut(io.Discard)),
github.Keychain,
)
opts = append(opts, remote.WithAuthFromKeychain(kc))
case o.AuthConfig.Username != "" && o.AuthConfig.Password != "":
opts = append(opts, remote.WithAuth(&authn.Basic{Username: o.AuthConfig.Username, Password: o.AuthConfig.Password}))
case o.AuthConfig.RegistryToken != "":
opts = append(opts, remote.WithAuth(&authn.Bearer{Token: o.AuthConfig.RegistryToken}))
default:
opts = append(opts, remote.WithAuthFromKeychain(authn.DefaultKeychain))
}
if o.AllowInsecure {
opts = append(opts, remote.WithTransport(&http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}})) // #nosec G402
}
// Reuse a remote.Pusher and a remote.Puller for all operations that use these opts.
// This allows us to avoid re-authenticating for everying remote.Function we call,
// which speeds things up a whole lot.
pusher, err := remote.NewPusher(opts...)
if err == nil {
opts = append(opts, remote.Reuse(pusher))
}
puller, err := remote.NewPuller(opts...)
if err == nil {
opts = append(opts, remote.Reuse(puller))
}
return opts
}
type RegistryReferrersMode string
const (
RegistryReferrersModeLegacy RegistryReferrersMode = "legacy"
RegistryReferrersModeOCI11 RegistryReferrersMode = "oci-1-1"
)
func (e *RegistryReferrersMode) String() string {
return string(*e)
}
func (e *RegistryReferrersMode) Set(v string) error {
switch v {
case "legacy":
*e = RegistryReferrersMode(v)
return nil
case "oci-1-1":
if !EnableExperimental() {
return fmt.Errorf(`in order to use mode "%s", you must set COSIGN_EXPERIMENTAL=1`, v)
}
*e = RegistryReferrersMode(v)
return nil
default:
return errors.New(`must be one of "legacy", "oci-1-1"`)
}
}
func (e *RegistryReferrersMode) Type() string {
return "registryReferrersMode"
}
// RegistryExperimentalOptions is the wrapper for the registry experimental options.
type RegistryExperimentalOptions struct {
RegistryReferrersMode RegistryReferrersMode
}
var _ Interface = (*RegistryExperimentalOptions)(nil)
// AddFlags implements Interface
func (o *RegistryExperimentalOptions) AddFlags(cmd *cobra.Command) {
cmd.Flags().Var(&o.RegistryReferrersMode, "registry-referrers-mode",
"mode for fetching references from the registry. allowed: legacy, oci-1-1")
}