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>
98 lines
2.9 KiB
Go
98 lines
2.9 KiB
Go
package goodkey
|
|
|
|
import (
|
|
"crypto"
|
|
"crypto/sha256"
|
|
"encoding/base64"
|
|
"encoding/hex"
|
|
"errors"
|
|
"io/ioutil"
|
|
|
|
"github.com/letsencrypt/boulder/core"
|
|
|
|
yaml "gopkg.in/yaml.v2"
|
|
)
|
|
|
|
// blockedKeys is a type for maintaining a map of SHA256 hashes
|
|
// of SubjectPublicKeyInfo's that should be considered blocked.
|
|
// blockedKeys are created by using loadBlockedKeysList.
|
|
type blockedKeys map[core.Sha256Digest]bool
|
|
|
|
var ErrWrongDecodedSize = errors.New("not enough bytes decoded for sha256 hash")
|
|
|
|
// blocked checks if the given public key is considered administratively
|
|
// blocked based on a SHA256 hash of the SubjectPublicKeyInfo.
|
|
// Important: blocked should not be called except on a blockedKeys instance
|
|
// returned from loadBlockedKeysList.
|
|
// function should not be used until after `loadBlockedKeysList` has returned.
|
|
func (b blockedKeys) blocked(key crypto.PublicKey) (bool, error) {
|
|
hash, err := core.KeyDigest(key)
|
|
if err != nil {
|
|
// the bool result should be ignored when err is != nil but to be on the
|
|
// paranoid side return true anyway so that a key we can't compute the
|
|
// digest for will always be blocked even if a caller foolishly discards the
|
|
// err result.
|
|
return true, err
|
|
}
|
|
return b[hash], nil
|
|
}
|
|
|
|
// loadBlockedKeysList creates a blockedKeys object that can be used to check if
|
|
// a key is blocked. It creates a lookup map from a list of
|
|
// SHA256 hashes of SubjectPublicKeyInfo's in the input YAML file
|
|
// with the expected format:
|
|
//
|
|
// ```
|
|
// blocked:
|
|
// - cuwGhNNI6nfob5aqY90e7BleU6l7rfxku4X3UTJ3Z7M=
|
|
// <snipped>
|
|
// - Qebc1V3SkX3izkYRGNJilm9Bcuvf0oox4U2Rn+b4JOE=
|
|
// ```
|
|
//
|
|
// If no hashes are found in the input YAML an error is returned.
|
|
func loadBlockedKeysList(filename string) (*blockedKeys, error) {
|
|
yamlBytes, err := ioutil.ReadFile(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var list struct {
|
|
BlockedHashes []string `yaml:"blocked"`
|
|
BlockedHashesHex []string `yaml:"blockedHashesHex"`
|
|
}
|
|
err = yaml.Unmarshal(yamlBytes, &list)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if len(list.BlockedHashes) == 0 && len(list.BlockedHashesHex) == 0 {
|
|
return nil, errors.New("no blocked hashes in YAML")
|
|
}
|
|
|
|
blockedKeys := make(blockedKeys, len(list.BlockedHashes)+len(list.BlockedHashesHex))
|
|
for _, b64Hash := range list.BlockedHashes {
|
|
decoded, err := base64.StdEncoding.DecodeString(b64Hash)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(decoded) != sha256.Size {
|
|
return nil, ErrWrongDecodedSize
|
|
}
|
|
var sha256Digest core.Sha256Digest
|
|
copy(sha256Digest[:], decoded[0:sha256.Size])
|
|
blockedKeys[sha256Digest] = true
|
|
}
|
|
for _, hexHash := range list.BlockedHashesHex {
|
|
decoded, err := hex.DecodeString(hexHash)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(decoded) != sha256.Size {
|
|
return nil, ErrWrongDecodedSize
|
|
}
|
|
var sha256Digest core.Sha256Digest
|
|
copy(sha256Digest[:], decoded[0:sha256.Size])
|
|
blockedKeys[sha256Digest] = true
|
|
}
|
|
return &blockedKeys, nil
|
|
}
|