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
|
package resolver
import (
"context"
"fmt"
"net/http"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/containerd/containerd/images"
"github.com/containerd/containerd/remotes"
"github.com/containerd/containerd/remotes/docker"
distreference "github.com/distribution/reference"
"github.com/moby/buildkit/session"
"github.com/moby/buildkit/solver/pb"
log "github.com/moby/buildkit/util/bklog"
"github.com/moby/buildkit/version"
ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
)
// DefaultPool is the default shared resolver pool instance
var DefaultPool = NewPool()
// Pool is a cache of recently used resolvers
type Pool struct {
mu sync.Mutex
m map[string]*authHandlerNS
}
// NewPool creates a new pool for caching resolvers
func NewPool() *Pool {
p := &Pool{
m: map[string]*authHandlerNS{},
}
time.AfterFunc(5*time.Minute, p.gc)
return p
}
func (p *Pool) gc() {
p.mu.Lock()
defer p.mu.Unlock()
for k, ns := range p.m {
ns.muHandlers.Lock()
for key, h := range ns.handlers {
if time.Since(h.lastUsed) < 10*time.Minute {
continue
}
parts := strings.SplitN(key, "/", 2)
if len(parts) != 2 {
delete(ns.handlers, key)
continue
}
c, err := ns.sm.Get(context.TODO(), parts[1], true)
if c == nil || err != nil {
delete(ns.handlers, key)
}
}
if len(ns.handlers) == 0 {
delete(p.m, k)
}
ns.muHandlers.Unlock()
}
time.AfterFunc(5*time.Minute, p.gc)
}
// Clear deletes currently cached items. This may be called on config changes for example.
func (p *Pool) Clear() {
p.mu.Lock()
defer p.mu.Unlock()
p.m = map[string]*authHandlerNS{}
}
// GetResolver gets a resolver for a specified scope from the pool
func (p *Pool) GetResolver(hosts docker.RegistryHosts, ref, scope string, sm *session.Manager, g session.Group) *Resolver {
name := ref
named, err := distreference.ParseNormalizedNamed(ref)
if err == nil {
name = named.Name()
}
var key string
if strings.Contains(scope, "push") {
// When scope includes "push", index the authHandlerNS cache by session
// id(s) as well to prevent tokens with potential write access to third
// party registries from leaking between client sessions. The key will end
// up looking something like:
// 'wujskoey891qc5cv1edd3yj3p::repository:foo/bar::pull,push'
key = fmt.Sprintf("%s::%s::%s", strings.Join(session.AllSessionIDs(g), ":"), name, scope)
} else {
// The authHandlerNS is not isolated for pull-only scopes since LLB
// verticies from pulls all end up in the cache anyway and all
// requests/clients have access to the same cache
key = fmt.Sprintf("%s::%s", name, scope)
}
p.mu.Lock()
defer p.mu.Unlock()
h, ok := p.m[key]
if !ok {
h = newAuthHandlerNS(sm)
p.m[key] = h
}
log.G(context.TODO()).WithFields(logrus.Fields{
"name": name,
"scope": scope,
"key": key,
"cached": ok,
}).Debugf("checked for cached auth handler namespace")
return newResolver(hosts, h, sm, g)
}
func newResolver(hosts docker.RegistryHosts, handler *authHandlerNS, sm *session.Manager, g session.Group) *Resolver {
if hosts == nil {
hosts = docker.ConfigureDefaultRegistries(
docker.WithClient(newDefaultClient()),
docker.WithPlainHTTP(docker.MatchLocalhost),
)
}
r := &Resolver{
hosts: hosts,
sm: sm,
g: g,
handler: handler,
}
headers := http.Header{}
headers.Set("User-Agent", version.UserAgent())
r.Resolver = docker.NewResolver(docker.ResolverOptions{
Hosts: r.HostsFunc,
Headers: headers,
})
return r
}
// Resolver is a wrapper around remotes.Resolver
type Resolver struct {
remotes.Resolver
hosts docker.RegistryHosts
sm *session.Manager
g session.Group
handler *authHandlerNS
auth *dockerAuthorizer
is images.Store
mode ResolveMode
}
// HostsFunc implements registry configuration of this Resolver
func (r *Resolver) HostsFunc(host string) ([]docker.RegistryHost, error) {
return func(domain string) ([]docker.RegistryHost, error) {
v, err := r.handler.g.Do(context.TODO(), domain, func(ctx context.Context) ([]docker.RegistryHost, error) {
// long lock not needed because flightcontrol.Do
r.handler.muHosts.Lock()
v, ok := r.handler.hosts[domain]
r.handler.muHosts.Unlock()
if ok {
return v, nil
}
res, err := r.hosts(domain)
if err != nil {
return nil, err
}
r.handler.muHosts.Lock()
r.handler.hosts[domain] = res
r.handler.muHosts.Unlock()
return res, nil
})
if err != nil || v == nil {
return nil, err
}
if len(v) == 0 {
return nil, nil
}
// make a copy so authorizer is set on unique instance
res := make([]docker.RegistryHost, len(v))
copy(res, v)
auth := newDockerAuthorizer(res[0].Client, r.handler, r.sm, r.g)
for i := range res {
res[i].Authorizer = auth
}
return res, nil
}(host)
}
// WithSession returns a new resolver that works with new session group
func (r *Resolver) WithSession(s session.Group) *Resolver {
r2 := *r
r2.auth = nil
r2.g = s
r2.Resolver = docker.NewResolver(docker.ResolverOptions{
Hosts: r2.HostsFunc, // this refers to the newly-configured session so we need to recreate the resolver.
})
return &r2
}
// WithImageStore returns new resolver that can also resolve from local images store
func (r *Resolver) WithImageStore(is images.Store, mode ResolveMode) *Resolver {
r2 := *r
r2.Resolver = r.Resolver
r2.is = is
r2.mode = mode
return &r2
}
// Fetcher returns a new fetcher for the provided reference.
func (r *Resolver) Fetcher(ctx context.Context, ref string) (remotes.Fetcher, error) {
if atomic.LoadInt64(&r.handler.counter) == 0 {
r.Resolve(ctx, ref)
}
return r.Resolver.Fetcher(ctx, ref)
}
// Resolve attempts to resolve the reference into a name and descriptor.
func (r *Resolver) Resolve(ctx context.Context, ref string) (string, ocispecs.Descriptor, error) {
if r.mode == ResolveModePreferLocal && r.is != nil {
if img, err := r.is.Get(ctx, ref); err == nil {
return ref, img.Target, nil
}
}
n, desc, err := r.Resolver.Resolve(ctx, ref)
if err == nil {
atomic.AddInt64(&r.handler.counter, 1)
return n, desc, nil
}
if r.mode == ResolveModeDefault && r.is != nil {
if img, err := r.is.Get(ctx, ref); err == nil {
return ref, img.Target, nil
}
}
return "", ocispecs.Descriptor{}, err
}
type ResolveMode int
const (
ResolveModeDefault ResolveMode = iota
ResolveModeForcePull
ResolveModePreferLocal
)
func (r ResolveMode) String() string {
switch r {
case ResolveModeDefault:
return pb.AttrImageResolveModeDefault
case ResolveModeForcePull:
return pb.AttrImageResolveModeForcePull
case ResolveModePreferLocal:
return pb.AttrImageResolveModePreferLocal
default:
return ""
}
}
func ParseImageResolveMode(v string) (ResolveMode, error) {
switch v {
case pb.AttrImageResolveModeDefault, "":
return ResolveModeDefault, nil
case pb.AttrImageResolveModeForcePull:
return ResolveModeForcePull, nil
case pb.AttrImageResolveModePreferLocal:
return ResolveModePreferLocal, nil
default:
return 0, errors.Errorf("invalid resolvemode: %s", v)
}
}
|