Version 5.22 introduced a new option to /etc/containers/policy.json called
keyPaths, see
https://github.com/containers/image/pull/1609
EL9 immediately took advantage of this new feature and started using it, see
04645c4a84
This quickly became an issue in our code: The go library (containers/image)
parses the configuration file very strictly and refuses to create a client
when policy.json with an unknown key is present on the filesystem. As we
used 5.21.1 that doesn't know the new key, our unit tests started to
failing when containers-common was present.
Reproducer:
podman run --pull=always --rm -it centos:stream9
dnf install -y dnf-plugins-core
dnf config-manager --set-enabled crb
dnf install -y gpgme-devel libassuan-devel krb5-devel golang git-core
git clone https://github.com/osbuild/osbuild-composer
cd osbuild-composer
# install the new containers-common and run the test
dnf install -y https://kojihub.stream.centos.org/kojifiles/packages/containers-common/1/44.el9/x86_64/containers-common-1-44.el9.x86_64.rpm
go test -count 1 ./...
# this returns:
--- FAIL: TestClientResolve (0.00s)
client_test.go:31:
Error Trace: client_test.go:31
Error: Received unexpected error:
Unknown key "keyPaths"
invalid policy in "/etc/containers/policy.json"
github.com/containers/image/v5/signature.NewPolicyFromFile
/osbuild-composer/vendor/github.com/containers/image/v5/signature/policy_config.go:88
github.com/osbuild/osbuild-composer/internal/container.NewClient
/osbuild-composer/internal/container/client.go:123
github.com/osbuild/osbuild-composer/internal/container_test.TestClientResolve
/osbuild-composer/internal/container/client_test.go:29
testing.tRunner
/usr/lib/golang/src/testing/testing.go:1439
runtime.goexit
/usr/lib/golang/src/runtime/asm_amd64.s:1571
Test: TestClientResolve
client_test.go:32:
Error Trace: client_test.go:32
Error: Expected value not to be nil.
Test: TestClientResolve
When run with an older containers-common, it succeeds:
dnf install -y https://kojihub.stream.centos.org/kojifiles/packages/containers-common/1/40.el9/x86_64/containers-common-1-40.el9.x86_64.rpm
go test -count 1 ./...
PASS
To sum it up, I had to upgrade github.com/containers/image/v5 to v5.22.0.
Unfortunately, this wasn't so simple, see
go get github.com/containers/image/v5@latest
go: github.com/containers/image/v5@v5.22.0 requires
github.com/letsencrypt/boulder@v0.0.0-20220331220046-b23ab962616e requires
github.com/honeycombio/beeline-go@v1.1.1 requires
github.com/gobuffalo/pop/v5@v5.3.1 requires
github.com/mattn/go-sqlite3@v2.0.3+incompatible: reading github.com/mattn/go-sqlite3/go.mod at revision v2.0.3: unknown revision v2.0.3
It turns out that github.com/mattn/go-sqlite3@v2.0.3+incompatible has been
recently retracted https://github.com/mattn/go-sqlite3/pull/998 and this
broke a ton of packages depending on it. I was able to fix it by adding
exclude github.com/mattn/go-sqlite3 v2.0.3+incompatible
to our go.mod, see
https://github.com/mattn/go-sqlite3/issues/975#issuecomment-955661657
After adding it,
go get github.com/containers/image/v5@latest
succeeded and tools/prepare-source.sh took care of the rest.
Signed-off-by: Ondřej Budai <ondrej@budai.cz>
136 lines
3.7 KiB
Go
136 lines
3.7 KiB
Go
// Copyright 2018 Google LLC All Rights Reserved.
|
|
//
|
|
// 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 name
|
|
|
|
import (
|
|
"net"
|
|
"net/url"
|
|
"regexp"
|
|
"strings"
|
|
)
|
|
|
|
// Detect more complex forms of local references.
|
|
var reLocal = regexp.MustCompile(`.*\.local(?:host)?(?::\d{1,5})?$`)
|
|
|
|
// Detect the loopback IP (127.0.0.1)
|
|
var reLoopback = regexp.MustCompile(regexp.QuoteMeta("127.0.0.1"))
|
|
|
|
// Detect the loopback IPV6 (::1)
|
|
var reipv6Loopback = regexp.MustCompile(regexp.QuoteMeta("::1"))
|
|
|
|
// Registry stores a docker registry name in a structured form.
|
|
type Registry struct {
|
|
insecure bool
|
|
registry string
|
|
}
|
|
|
|
// RegistryStr returns the registry component of the Registry.
|
|
func (r Registry) RegistryStr() string {
|
|
return r.registry
|
|
}
|
|
|
|
// Name returns the name from which the Registry was derived.
|
|
func (r Registry) Name() string {
|
|
return r.RegistryStr()
|
|
}
|
|
|
|
func (r Registry) String() string {
|
|
return r.Name()
|
|
}
|
|
|
|
// Scope returns the scope required to access the registry.
|
|
func (r Registry) Scope(string) string {
|
|
// The only resource under 'registry' is 'catalog'. http://goo.gl/N9cN9Z
|
|
return "registry:catalog:*"
|
|
}
|
|
|
|
func (r Registry) isRFC1918() bool {
|
|
ipStr := strings.Split(r.Name(), ":")[0]
|
|
ip := net.ParseIP(ipStr)
|
|
if ip == nil {
|
|
return false
|
|
}
|
|
for _, cidr := range []string{"10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"} {
|
|
_, block, _ := net.ParseCIDR(cidr)
|
|
if block.Contains(ip) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Scheme returns https scheme for all the endpoints except localhost or when explicitly defined.
|
|
func (r Registry) Scheme() string {
|
|
if r.insecure {
|
|
return "http"
|
|
}
|
|
if r.isRFC1918() {
|
|
return "http"
|
|
}
|
|
if strings.HasPrefix(r.Name(), "localhost:") {
|
|
return "http"
|
|
}
|
|
if reLocal.MatchString(r.Name()) {
|
|
return "http"
|
|
}
|
|
if reLoopback.MatchString(r.Name()) {
|
|
return "http"
|
|
}
|
|
if reipv6Loopback.MatchString(r.Name()) {
|
|
return "http"
|
|
}
|
|
return "https"
|
|
}
|
|
|
|
func checkRegistry(name string) error {
|
|
// Per RFC 3986, registries (authorities) are required to be prefixed with "//"
|
|
// url.Host == hostname[:port] == authority
|
|
if url, err := url.Parse("//" + name); err != nil || url.Host != name {
|
|
return newErrBadName("registries must be valid RFC 3986 URI authorities: %s", name)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// NewRegistry returns a Registry based on the given name.
|
|
// Strict validation requires explicit, valid RFC 3986 URI authorities to be given.
|
|
func NewRegistry(name string, opts ...Option) (Registry, error) {
|
|
opt := makeOptions(opts...)
|
|
if opt.strict && len(name) == 0 {
|
|
return Registry{}, newErrBadName("strict validation requires the registry to be explicitly defined")
|
|
}
|
|
|
|
if err := checkRegistry(name); err != nil {
|
|
return Registry{}, err
|
|
}
|
|
|
|
if name == "" {
|
|
name = opt.defaultRegistry
|
|
}
|
|
// Rewrite "docker.io" to "index.docker.io".
|
|
// See: https://github.com/google/go-containerregistry/issues/68
|
|
if name == defaultRegistryAlias {
|
|
name = DefaultRegistry
|
|
}
|
|
|
|
return Registry{registry: name, insecure: opt.insecure}, nil
|
|
}
|
|
|
|
// NewInsecureRegistry returns an Insecure Registry based on the given name.
|
|
//
|
|
// Deprecated: Use the Insecure Option with NewRegistry instead.
|
|
func NewInsecureRegistry(name string, opts ...Option) (Registry, error) {
|
|
opts = append(opts, Insecure)
|
|
return NewRegistry(name, opts...)
|
|
}
|