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
|
//
// 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 remote
import (
"fmt"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/google/go-containerregistry/pkg/name"
"github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/sigstore/cosign/v2/pkg/cosign/env"
)
const (
SignatureTagSuffix = "sig"
SBOMTagSuffix = "sbom"
AttestationTagSuffix = "att"
CustomTagPrefix = ""
RepoOverrideEnvKey = "COSIGN_REPOSITORY"
)
// Option is a functional option for remote operations.
type Option func(*options)
type options struct {
SignatureSuffix string
AttestationSuffix string
SBOMSuffix string
TagPrefix string
TargetRepository name.Repository
ROpt []remote.Option
NameOpts []name.Option
OriginalOptions []Option
}
var defaultOptions = []remote.Option{
remote.WithAuthFromKeychain(authn.DefaultKeychain),
// TODO(mattmoor): Incorporate user agent.
}
func makeOptions(target name.Repository, opts ...Option) *options {
o := &options{
SignatureSuffix: SignatureTagSuffix,
AttestationSuffix: AttestationTagSuffix,
SBOMSuffix: SBOMTagSuffix,
TagPrefix: CustomTagPrefix,
TargetRepository: target,
ROpt: defaultOptions,
// Keep the original options around for things that want
// to call something that takes options!
OriginalOptions: opts,
}
for _, option := range opts {
option(o)
}
return o
}
// WithPrefix is a functional option for overriding the default
// tag prefix.
func WithPrefix(prefix string) Option {
return func(o *options) {
o.TagPrefix = prefix
}
}
// WithSignatureSuffix is a functional option for overriding the default
// signature tag suffix.
func WithSignatureSuffix(suffix string) Option {
return func(o *options) {
o.SignatureSuffix = suffix
}
}
// WithAttestationSuffix is a functional option for overriding the default
// attestation tag suffix.
func WithAttestationSuffix(suffix string) Option {
return func(o *options) {
o.AttestationSuffix = suffix
}
}
// WithSBOMSuffix is a functional option for overriding the default
// SBOM tag suffix.
func WithSBOMSuffix(suffix string) Option {
return func(o *options) {
o.SBOMSuffix = suffix
}
}
// WithRemoteOptions is a functional option for overriding the default
// remote options passed to GGCR.
func WithRemoteOptions(opts ...remote.Option) Option {
return func(o *options) {
o.ROpt = opts
}
}
// WithMoreRemoteOptions is a functional option for adding to the default
// remote options already specified
func WithMoreRemoteOptions(opts ...remote.Option) Option {
return func(o *options) {
o.ROpt = append(o.ROpt, opts...)
}
}
// WithTargetRepository is a functional option for overriding the default
// target repository hosting the signature and attestation tags.
func WithTargetRepository(repo name.Repository) Option {
return func(o *options) {
o.TargetRepository = repo
}
}
// GetEnvTargetRepository returns the Repository specified by
// `os.Getenv(RepoOverrideEnvKey)`, or the empty value if not set.
// Returns an error if the value is set but cannot be parsed.
func GetEnvTargetRepository() (name.Repository, error) {
if ro := env.Getenv(env.VariableRepository); ro != "" {
repo, err := name.NewRepository(ro)
if err != nil {
return name.Repository{}, fmt.Errorf("parsing $"+RepoOverrideEnvKey+": %w", err)
}
return repo, nil
}
return name.Repository{}, nil
}
// WithNameOptions is a functional option for overriding the default
// name options passed to GGCR.
func WithNameOptions(opts ...name.Option) Option {
return func(o *options) {
o.NameOpts = opts
}
}
|