Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy-up of SBOM layer supplements #3312

Merged
merged 2 commits into from
Nov 24, 2022
Merged

Tidy-up of SBOM layer supplements #3312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0479d0c
sbom: fixup tests with invalid sboms
jedevc Nov 24, 2022
b059bed
exporter: prefer early exit with badly formatted sbom
jedevc Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7613,7 +7613,7 @@ cat <<EOF > $BUILDKIT_SCAN_DESTINATION/spdx.json
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"success": false}
"predicate": {"name": "fallback"}
}
EOF
`
Expand Down Expand Up @@ -7681,7 +7681,7 @@ EOF
// build attestations
if attest {
st = llb.Scratch().
File(llb.Mkfile("/result.spdx", 0600, []byte(`{"success": true}`)))
File(llb.Mkfile("/result.spdx", 0600, []byte(`{"name": "frontend"}`)))
def, err = st.Marshal(ctx)
if err != nil {
return nil, err
Expand Down Expand Up @@ -7769,7 +7769,7 @@ EOF
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Equal(t, map[string]interface{}{"success": true}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "frontend"})

// test the specified fallback scanner
target = registry + "/buildkit/testsbom3:latest"
Expand Down Expand Up @@ -7801,7 +7801,7 @@ EOF
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Equal(t, map[string]interface{}{"success": false}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "fallback"})

// test the builtin frontend scanner and the specified fallback scanner together
target = registry + "/buildkit/testsbom3:latest"
Expand Down Expand Up @@ -7833,7 +7833,7 @@ EOF
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Equal(t, map[string]interface{}{"success": true}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "frontend"})
}

func testSBOMScanSingleRef(t *testing.T, sb integration.Sandbox) {
Expand Down Expand Up @@ -7887,7 +7887,7 @@ cat <<EOF > $BUILDKIT_SCAN_DESTINATION/spdx.json
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"success": false}
"predicate": {"name": "fallback"}
}
EOF
`
Expand Down Expand Up @@ -7987,7 +7987,7 @@ EOF
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Equal(t, map[string]interface{}{"success": false}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "fallback"})
}

func testMultipleCacheExports(t *testing.T, sb integration.Sandbox) {
Expand Down
64 changes: 33 additions & 31 deletions exporter/containerimage/attestations.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,48 +41,50 @@ func supplementSBOM(ctx context.Context, s session.Group, target cache.Immutable
}

doc, err := decodeSPDX(content)
if err == nil {
layers, err := newFileLayerFinder(target, targetRemote)
if err != nil {
return att, err
if err != nil {
return att, err
}

layers, err := newFileLayerFinder(target, targetRemote)
if err != nil {
return att, err
}
modifyFile := func(f *spdx.File2_2) error {
if f.FileComment != "" {
// Skip over files that already have a comment - since the data is
// unstructured, we can't correctly overwrite this field without
// possibly breaking some scanner functionality.
return nil
}
modifyFile := func(f *spdx.File2_2) error {
if f.FileComment != "" {
// Skip over files that already have a comment - since the data is
// unstructured, we can't correctly overwrite this field without
// possibly breaking some scanner functionality.
return nil
}

_, desc, err := layers.find(ctx, s, f.FileName)
if err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return err
}
return nil
_, desc, err := layers.find(ctx, s, f.FileName)
if err != nil {
if !errors.Is(err, fs.ErrNotExist) {
return err
}
f.FileComment = fmt.Sprintf("layerID: %s", desc.Digest.String())
return nil
}
for _, f := range doc.UnpackagedFiles {
f.FileComment = fmt.Sprintf("layerID: %s", desc.Digest.String())
return nil
}
for _, f := range doc.UnpackagedFiles {
if err := modifyFile(f); err != nil {
return att, err
}
}
for _, p := range doc.Packages {
for _, f := range p.Files {
if err := modifyFile(f); err != nil {
return att, err
}
}
for _, p := range doc.Packages {
for _, f := range p.Files {
if err := modifyFile(f); err != nil {
return att, err
}
}
}
}

doc.CreationInfo.CreatorTools = append(doc.CreationInfo.CreatorTools, "buildkit-"+version.Version)
doc.CreationInfo.CreatorTools = append(doc.CreationInfo.CreatorTools, "buildkit-"+version.Version)

content, err = encodeSPDX(doc)
if err != nil {
return att, err
}
content, err = encodeSPDX(doc)
if err != nil {
return att, err
}

return result.Attestation{
Expand Down
19 changes: 9 additions & 10 deletions frontend/dockerfile/dockerfile_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6079,7 +6079,7 @@ COPY <<-"EOF" /scan.sh
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"success": true}
"predicate": {"name": "sbom-scan"}
}
BUNDLE
EOF
Expand Down Expand Up @@ -6158,7 +6158,7 @@ EOF
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Equal(t, map[string]interface{}{"success": true}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "sbom-scan"})
}

func testSBOMScannerArgs(t *testing.T, sb integration.Sandbox) {
Expand All @@ -6184,7 +6184,7 @@ COPY <<-"EOF" /scan.sh
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"core": true}
"predicate": {"name": "core"}
}
BUNDLE
if [ "${BUILDKIT_SCAN_SOURCE_EXTRAS}" ]; then
Expand All @@ -6193,7 +6193,7 @@ COPY <<-"EOF" /scan.sh
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"extra": true}
"predicate": {"name": "extra"}
}
BUNDLE
done
Expand Down Expand Up @@ -6273,11 +6273,10 @@ FROM base
require.NotNil(t, img)

att := imgs.Find("unknown/unknown")
extraCount := 0
require.Equal(t, 1, len(att.LayersRaw))
var attest intoto.Statement
require.NoError(t, json.Unmarshal(att.LayersRaw[0], &attest))
require.Equal(t, map[string]interface{}{"core": true}, attest.Predicate)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "core"})

dockerfile = []byte(`
ARG BUILDKIT_SBOM_SCAN_CONTEXT=true
Expand Down Expand Up @@ -6339,15 +6338,15 @@ ARG BUILDKIT_SBOM_SCAN_STAGE=true

att = imgs.Find("unknown/unknown")
require.Equal(t, 4, len(att.LayersRaw))
extraCount = 0
extraCount := 0
for _, l := range att.LayersRaw {
var attest intoto.Statement
require.NoError(t, json.Unmarshal(l, &attest))
att := attest.Predicate.(map[string]interface{})
switch {
case att["extra"] == true:
switch att["name"] {
case "core":
case "extra":
extraCount++
case att["core"] == true:
default:
require.Fail(t, "unexpected attestation", "%v", att)
}
Expand Down