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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
|
//go:build debian_no_fulcio
// +build debian_no_fulcio
package internal
import (
"encoding/base64"
"encoding/json"
"errors"
"os"
"testing"
"time"
"github.com/containers/image/v5/internal/signature"
"github.com/containers/image/v5/version"
digest "github.com/opencontainers/go-digest"
"github.com/sigstore/sigstore/pkg/cryptoutils"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// A short-hand way to get a JSON object field value or panic. No error handling done, we know
// what we are working with, a panic in a test is good enough, and fitting test cases on a single line
// is a priority.
func x(m mSA, fields ...string) mSA {
for _, field := range fields {
// Not .(mSA) because type assertion of an unnamed type to a named type always fails (the types
// are not "identical"), but the assignment is fine because they are "assignable".
m = m[field].(map[string]any)
}
return m
}
func TestNewUntrustedSigstorePayload(t *testing.T) {
timeBefore := time.Now()
sig := NewUntrustedSigstorePayload(TestImageManifestDigest, TestImageSignatureReference)
assert.Equal(t, TestImageManifestDigest, sig.untrustedDockerManifestDigest)
assert.Equal(t, TestImageSignatureReference, sig.untrustedDockerReference)
require.NotNil(t, sig.untrustedCreatorID)
assert.Equal(t, "containers/image "+version.Version, *sig.untrustedCreatorID)
require.NotNil(t, sig.untrustedTimestamp)
timeAfter := time.Now()
assert.True(t, timeBefore.Unix() <= *sig.untrustedTimestamp)
assert.True(t, *sig.untrustedTimestamp <= timeAfter.Unix())
}
func TestUntrustedSigstorePayloadMarshalJSON(t *testing.T) {
// Empty string values
s := NewUntrustedSigstorePayload("", "_")
_, err := s.MarshalJSON()
assert.Error(t, err)
s = NewUntrustedSigstorePayload("_", "")
_, err = s.MarshalJSON()
assert.Error(t, err)
// Success
// Use intermediate variables for these values so that we can take their addresses.
creatorID := "CREATOR"
timestamp := int64(1484683104)
for _, c := range []struct {
input UntrustedSigstorePayload
expected string
}{
{
UntrustedSigstorePayload{
untrustedDockerManifestDigest: "digest!@#",
untrustedDockerReference: "reference#@!",
untrustedCreatorID: &creatorID,
untrustedTimestamp: ×tamp,
},
"{\"critical\":{\"identity\":{\"docker-reference\":\"reference#@!\"},\"image\":{\"docker-manifest-digest\":\"digest!@#\"},\"type\":\"cosign container image signature\"},\"optional\":{\"creator\":\"CREATOR\",\"timestamp\":1484683104}}",
},
{
UntrustedSigstorePayload{
untrustedDockerManifestDigest: "digest!@#",
untrustedDockerReference: "reference#@!",
},
"{\"critical\":{\"identity\":{\"docker-reference\":\"reference#@!\"},\"image\":{\"docker-manifest-digest\":\"digest!@#\"},\"type\":\"cosign container image signature\"},\"optional\":{}}",
},
} {
marshaled, err := c.input.MarshalJSON()
require.NoError(t, err)
assert.Equal(t, []byte(c.expected), marshaled)
// Also call MarshalJSON through the JSON package.
marshaled, err = json.Marshal(c.input)
assert.NoError(t, err)
assert.Equal(t, []byte(c.expected), marshaled)
}
}
// Verify that input can be unmarshaled as an UntrustedSigstorePayload.
func successfullyUnmarshalUntrustedSigstorePayload(t *testing.T, input []byte) UntrustedSigstorePayload {
var s UntrustedSigstorePayload
err := json.Unmarshal(input, &s)
require.NoError(t, err, string(input))
return s
}
// Verify that input can't be unmarshaled as an UntrustedSigstorePayload.
func assertUnmarshalUntrustedSigstorePayloadFails(t *testing.T, input []byte) {
var s UntrustedSigstorePayload
err := json.Unmarshal(input, &s)
assert.Error(t, err, string(input))
}
func TestUntrustedSigstorePayloadUnmarshalJSON(t *testing.T) {
// Invalid input. Note that json.Unmarshal is guaranteed to validate input before calling our
// UnmarshalJSON implementation; so test that first, then test our error handling for completeness.
assertUnmarshalUntrustedSigstorePayloadFails(t, []byte("&"))
var s UntrustedSigstorePayload
err := s.UnmarshalJSON([]byte("&"))
assert.Error(t, err)
// Not an object
assertUnmarshalUntrustedSigstorePayloadFails(t, []byte("1"))
// Start with a valid JSON.
validSig := NewUntrustedSigstorePayload("digest!@#", "reference#@!")
validJSON, err := validSig.MarshalJSON()
require.NoError(t, err)
// Success
s = successfullyUnmarshalUntrustedSigstorePayload(t, validJSON)
assert.Equal(t, validSig, s)
// A /usr/bin/cosign-generated payload is handled correctly
s = successfullyUnmarshalUntrustedSigstorePayload(t, []byte(`{"critical":{"identity":{"docker-reference":"192.168.64.2:5000/cosign-signed-multi"},"image":{"docker-manifest-digest":"sha256:43955d6857268cc948ae9b370b221091057de83c4962da0826f9a2bdc9bd6b44"},"type":"cosign container image signature"},"optional":null}`))
assert.Equal(t, UntrustedSigstorePayload{
untrustedDockerManifestDigest: "sha256:43955d6857268cc948ae9b370b221091057de83c4962da0826f9a2bdc9bd6b44",
untrustedDockerReference: "192.168.64.2:5000/cosign-signed-multi",
untrustedCreatorID: nil,
untrustedTimestamp: nil,
}, s)
// Various ways to corrupt the JSON
breakFns := []func(mSA){
// A top-level field is missing
func(v mSA) { delete(v, "critical") },
func(v mSA) { delete(v, "optional") },
// Extra top-level sub-object
func(v mSA) { v["unexpected"] = 1 },
// "critical" not an object
func(v mSA) { v["critical"] = 1 },
// "optional" not an object
func(v mSA) { v["optional"] = 1 },
// A field of "critical" is missing
func(v mSA) { delete(x(v, "critical"), "type") },
func(v mSA) { delete(x(v, "critical"), "image") },
func(v mSA) { delete(x(v, "critical"), "identity") },
// Extra field of "critical"
func(v mSA) { x(v, "critical")["unexpected"] = 1 },
// Invalid "type"
func(v mSA) { x(v, "critical")["type"] = 1 },
func(v mSA) { x(v, "critical")["type"] = "unexpected" },
// Invalid "image" object
func(v mSA) { x(v, "critical")["image"] = 1 },
func(v mSA) { delete(x(v, "critical", "image"), "docker-manifest-digest") },
func(v mSA) { x(v, "critical", "image")["unexpected"] = 1 },
// Invalid "docker-manifest-digest"
func(v mSA) { x(v, "critical", "image")["docker-manifest-digest"] = 1 },
// Invalid "identity" object
func(v mSA) { x(v, "critical")["identity"] = 1 },
func(v mSA) { delete(x(v, "critical", "identity"), "docker-reference") },
func(v mSA) { x(v, "critical", "identity")["unexpected"] = 1 },
// Invalid "docker-reference"
func(v mSA) { x(v, "critical", "identity")["docker-reference"] = 1 },
// Invalid "creator"
func(v mSA) { x(v, "optional")["creator"] = 1 },
// Invalid "timestamp"
func(v mSA) { x(v, "optional")["timestamp"] = "unexpected" },
func(v mSA) { x(v, "optional")["timestamp"] = 0.5 }, // Fractional input
}
for _, fn := range breakFns {
testJSON := modifiedJSON(t, validJSON, fn)
assertUnmarshalUntrustedSigstorePayloadFails(t, testJSON)
}
// Modifications to unrecognized fields in "optional" are allowed and ignored
allowedModificationFns := []func(mSA){
// Add an optional field
func(v mSA) { x(v, "optional")["unexpected"] = 1 },
}
for _, fn := range allowedModificationFns {
testJSON := modifiedJSON(t, validJSON, fn)
s := successfullyUnmarshalUntrustedSigstorePayload(t, testJSON)
assert.Equal(t, validSig, s)
}
// Optional fields can be missing
validSig = UntrustedSigstorePayload{
untrustedDockerManifestDigest: "digest!@#",
untrustedDockerReference: "reference#@!",
untrustedCreatorID: nil,
untrustedTimestamp: nil,
}
validJSON, err = validSig.MarshalJSON()
require.NoError(t, err)
s = successfullyUnmarshalUntrustedSigstorePayload(t, validJSON)
assert.Equal(t, validSig, s)
}
func TestVerifySigstorePayload(t *testing.T) {
publicKeyPEM, err := os.ReadFile("./testdata/cosign.pub")
require.NoError(t, err)
publicKey, err := cryptoutils.UnmarshalPEMToPublicKey(publicKeyPEM)
require.NoError(t, err)
type acceptanceData struct {
signedDockerReference string
signedDockerManifestDigest digest.Digest
}
var wanted, recorded acceptanceData
// recordingRules are a plausible SigstorePayloadAcceptanceRules implementations, but equally
// importantly record that we are passing the correct values to the rule callbacks.
recordingRules := SigstorePayloadAcceptanceRules{
ValidateSignedDockerReference: func(signedDockerReference string) error {
recorded.signedDockerReference = signedDockerReference
if signedDockerReference != wanted.signedDockerReference {
return errors.New("signedDockerReference mismatch")
}
return nil
},
ValidateSignedDockerManifestDigest: func(signedDockerManifestDigest digest.Digest) error {
recorded.signedDockerManifestDigest = signedDockerManifestDigest
if signedDockerManifestDigest != wanted.signedDockerManifestDigest {
return errors.New("signedDockerManifestDigest mismatch")
}
return nil
},
}
sigBlob, err := os.ReadFile("./testdata/valid.signature")
require.NoError(t, err)
genericSig, err := signature.FromBlob(sigBlob)
require.NoError(t, err)
sigstoreSig, ok := genericSig.(signature.Sigstore)
require.True(t, ok)
cryptoBase64Sig, ok := sigstoreSig.UntrustedAnnotations()[signature.SigstoreSignatureAnnotationKey]
require.True(t, ok)
signatureData := acceptanceData{
signedDockerReference: TestSigstoreSignatureReference,
signedDockerManifestDigest: TestSigstoreManifestDigest,
}
// Successful verification
wanted = signatureData
recorded = acceptanceData{}
res, err := VerifySigstorePayload(publicKey, sigstoreSig.UntrustedPayload(), cryptoBase64Sig, recordingRules)
require.NoError(t, err)
assert.Equal(t, res, &UntrustedSigstorePayload{
untrustedDockerManifestDigest: TestSigstoreManifestDigest,
untrustedDockerReference: TestSigstoreSignatureReference,
untrustedCreatorID: nil,
untrustedTimestamp: nil,
})
assert.Equal(t, signatureData, recorded)
// For extra paranoia, test that we return a nil signature object on error.
// Invalid verifier
recorded = acceptanceData{}
invalidPublicKey := struct{}{} // crypto.PublicKey is, for some reason, just an any, so this is acceptable.
res, err = VerifySigstorePayload(invalidPublicKey, sigstoreSig.UntrustedPayload(), cryptoBase64Sig, recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{}, recorded)
// Invalid base64 encoding
for _, invalidBase64Sig := range []string{
"&", // Invalid base64 characters
cryptoBase64Sig + "=", // Extra padding
cryptoBase64Sig[:len(cryptoBase64Sig)-1], // Truncated base64 data
} {
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, sigstoreSig.UntrustedPayload(), invalidBase64Sig, recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{}, recorded)
}
// Invalid signature
validSignatureBytes, err := base64.StdEncoding.DecodeString(cryptoBase64Sig)
require.NoError(t, err)
for _, invalidSig := range [][]byte{
{}, // Empty signature
[]byte("invalid signature"),
append(validSignatureBytes, validSignatureBytes...),
} {
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, sigstoreSig.UntrustedPayload(), base64.StdEncoding.EncodeToString(invalidSig), recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{}, recorded)
}
// Valid signature of non-JSON
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, []byte("&"), "MEUCIARnnxZQPALBfqkB4aNAYXad79Qs6VehcrgIeZ8p7I2FAiEAzq2HXwXlz1iJeh+ucUR3L0zpjynQk6Rk0+/gXYp49RU=", recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{}, recorded)
// Valid signature of an unacceptable JSON
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, []byte("{}"), "MEUCIQDkySOBGxastVP0+koTA33NH5hXjwosFau4rxTPN6g48QIgb7eWKkGqfEpHMM3aT4xiqyP/170jEkdFuciuwN4mux4=", recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{}, recorded)
// Valid signature with a wrong manifest digest: asked for signedDockerManifestDigest
wanted = signatureData
wanted.signedDockerManifestDigest = "invalid digest"
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, sigstoreSig.UntrustedPayload(), cryptoBase64Sig, recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, acceptanceData{
signedDockerManifestDigest: signatureData.signedDockerManifestDigest,
}, recorded)
// Valid signature with a wrong image reference
wanted = signatureData
wanted.signedDockerReference = "unexpected docker reference"
recorded = acceptanceData{}
res, err = VerifySigstorePayload(publicKey, sigstoreSig.UntrustedPayload(), cryptoBase64Sig, recordingRules)
assert.Error(t, err)
assert.Nil(t, res)
assert.Equal(t, signatureData, recorded)
}
|