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.

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

Added way to configure SBOM scanner #5372

Merged
merged 1 commit into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
76 changes: 75 additions & 1 deletion client/client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9213,7 +9213,13 @@ cat <<EOF > $BUILDKIT_SCAN_DESTINATION/spdx.json
{
"_type": "https://in-toto.io/Statement/v0.1",
"predicateType": "https://spdx.dev/Document",
"predicate": {"name": "fallback"}
"predicate": {
"name": "fallback",
"extraParams": {
"ARG1": "$BUILDKIT_SCAN_ARG1",
"ARG2": "$BUILDKIT_SCAN_ARG2"
}
}
}
EOF
`
Expand Down Expand Up @@ -9436,6 +9442,74 @@ EOF
require.Equal(t, "https://in-toto.io/Statement/v0.1", attest.Type)
require.Equal(t, intoto.PredicateSPDX, attest.PredicateType)
require.Subset(t, attest.Predicate, map[string]interface{}{"name": "frontend"})

// test configuring the scanner (simple)
target = registry + "/buildkit/testsbom4:latest"
_, err = c.Build(sb.Context(), SolveOpt{
FrontendAttrs: map[string]string{
"attest:sbom": "generator=" + scannerTarget + ",ARG1=foo,ARG2=bar",
},
Exports: []ExportEntry{
{
Type: ExporterImage,
Attrs: map[string]string{
"name": target,
"push": "true",
},
},
},
}, "", makeTargetFrontend(false), nil)
require.NoError(t, err)

desc, provider, err = contentutil.ProviderFromRef(target)
require.NoError(t, err)

imgs, err = testutil.ReadImages(sb.Context(), provider, desc)
require.NoError(t, err)
require.Equal(t, 2, len(imgs.Images))

att = imgs.Find("unknown/unknown")
attest = intoto.Statement{}
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.Subset(t, attest.Predicate, map[string]interface{}{
"extraParams": map[string]interface{}{"ARG1": "foo", "ARG2": "bar"},
})

// test configuring the scanner (complex)
target = registry + "/buildkit/testsbom4:latest"
_, err = c.Build(sb.Context(), SolveOpt{
FrontendAttrs: map[string]string{
"attest:sbom": "\"generator=" + scannerTarget + "\",\"ARG1=foo\",\"ARG2=hello,world\"",
},
Exports: []ExportEntry{
{
Type: ExporterImage,
Attrs: map[string]string{
"name": target,
"push": "true",
},
},
},
}, "", makeTargetFrontend(false), nil)
require.NoError(t, err)

desc, provider, err = contentutil.ProviderFromRef(target)
require.NoError(t, err)

imgs, err = testutil.ReadImages(sb.Context(), provider, desc)
require.NoError(t, err)
require.Equal(t, 2, len(imgs.Images))

att = imgs.Find("unknown/unknown")
attest = intoto.Statement{}
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.Subset(t, attest.Predicate, map[string]interface{}{
"extraParams": map[string]interface{}{"ARG1": "foo", "ARG2": "hello,world"},
})
}

func testSBOMScanSingleRef(t *testing.T, sb integration.Sandbox) {
Expand Down
25 changes: 16 additions & 9 deletions control/control.go
Original file line number Diff line number Diff line change
Expand Up @@ -460,15 +460,22 @@ func (c *Controller) Solve(ctx context.Context, req *controlapi.SolveRequest) (*
var procs []llbsolver.Processor

if attrs, ok := attests["sbom"]; ok {
src := attrs["generator"]
if src == "" {
return nil, errors.Errorf("sbom generator cannot be empty")
}
ref, err := reference.ParseNormalizedNamed(src)
if err != nil {
return nil, errors.Wrapf(err, "failed to parse sbom generator %s", src)
var ref reference.Named
params := make(map[string]string)
for k, v := range attrs {
if k == "generator" {
if v == "" {
return nil, errors.Errorf("sbom generator cannot be empty")
}
ref, err = reference.ParseNormalizedNamed(v)
if err != nil {
return nil, errors.Wrapf(err, "failed to parse sbom generator %s", v)
}
ref = reference.TagNameOnly(ref)
} else {
params[k] = v
}
}
ref = reference.TagNameOnly(ref)

useCache := true
if v, ok := req.FrontendAttrs["no-cache"]; ok && v == "" {
Expand All @@ -480,7 +487,7 @@ func (c *Controller) Solve(ctx context.Context, req *controlapi.SolveRequest) (*
resolveMode = v
}

procs = append(procs, proc.SBOMProcessor(ref.String(), useCache, resolveMode))
procs = append(procs, proc.SBOMProcessor(ref.String(), useCache, resolveMode, params))
}

if attrs, ok := attests["provenance"]; ok {
Expand Down
66 changes: 66 additions & 0 deletions frontend/attestations/parse_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package attestations

import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestParse(t *testing.T) {
for _, tc := range []struct {
name string
values map[string]string
expected map[string]map[string]string
}{
{
name: "simple",
values: map[string]string{
"attest:sbom": "generator=docker.io/foo/bar",
"attest:provenance": "mode=max",
},
expected: map[string]map[string]string{
"sbom": {
"generator": "docker.io/foo/bar",
},
"provenance": {
"mode": "max",
},
},
},
{
name: "extra params",
values: map[string]string{
"attest:sbom": "generator=docker.io/foo/bar,param1=foo,param2=bar",
},
expected: map[string]map[string]string{
"sbom": {
"generator": "docker.io/foo/bar",
"param1": "foo",
"param2": "bar",
},
},
},
{
name: "extra params (complex)",
values: map[string]string{
"attest:sbom": "\"generator=docker.io/foo/bar\",\"param1=foo\",\"param2=bar\",\"param3=abc,def\"",
},
expected: map[string]map[string]string{
"sbom": {
"generator": "docker.io/foo/bar",
"param1": "foo",
"param2": "bar",
"param3": "abc,def",
},
},
},
} {
t.Run(tc.name, func(t *testing.T) {
attests, err := Parse(tc.values)
require.NoError(t, err)
_ = attests
assert.Equal(t, tc.expected, attests)
})
}
}
6 changes: 5 additions & 1 deletion frontend/attestations/sbom/sbom.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const (
// attestation.
type Scanner func(ctx context.Context, name string, ref llb.State, extras map[string]llb.State, opts ...llb.ConstraintsOpt) (result.Attestation[*llb.State], error)

func CreateSBOMScanner(ctx context.Context, resolver sourceresolver.MetaResolver, scanner string, resolveOpt sourceresolver.Opt) (Scanner, error) {
func CreateSBOMScanner(ctx context.Context, resolver sourceresolver.MetaResolver, scanner string, resolveOpt sourceresolver.Opt, params map[string]string) (Scanner, error) {
if scanner == "" {
return nil, nil
}
Expand Down Expand Up @@ -66,6 +66,10 @@ func CreateSBOMScanner(ctx context.Context, resolver sourceresolver.MetaResolver
env = append(env, "BUILDKIT_SCAN_SOURCE_EXTRAS="+path.Join(srcDir, "extras/"))
}

for k, v := range params {
env = append(env, "BUILDKIT_SCAN_"+k+"="+v)
}

runOpts := []llb.RunOption{
llb.WithCustomName(fmt.Sprintf("[%s] generating sbom using %s", name, scanner)),
}
Expand Down
2 changes: 1 addition & 1 deletion frontend/dockerfile/builder/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ func Build(ctx context.Context, c client.Client) (_ *client.Result, err error) {
ImageOpt: &sourceresolver.ResolveImageOpt{
ResolveMode: opts["image-resolve-mode"],
},
})
}, bc.SBOM.Parameters)
if err != nil {
return nil, err
}
Expand Down
28 changes: 19 additions & 9 deletions frontend/dockerui/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ type Client struct {
}

type SBOM struct {
Generator string
Generator string
Parameters map[string]string
}

type Source struct {
Expand Down Expand Up @@ -257,17 +258,26 @@ func (bc *Client) init() error {
return err
}
if attrs, ok := attests[attestations.KeyTypeSbom]; ok {
src, ok := attrs["generator"]
if !ok {
return errors.Errorf("sbom scanner cannot be empty")
params := make(map[string]string)
var ref reference.Named
for k, v := range attrs {
if k == "generator" {
ref, err = reference.ParseNormalizedNamed(v)
if err != nil {
return errors.Wrapf(err, "failed to parse sbom scanner %s", v)
}
ref = reference.TagNameOnly(ref)
} else {
params[k] = v
}
}
ref, err := reference.ParseNormalizedNamed(src)
if err != nil {
return errors.Wrapf(err, "failed to parse sbom scanner %s", src)
if ref == nil {
return errors.Errorf("sbom scanner cannot be empty")
}
ref = reference.TagNameOnly(ref)

bc.SBOM = &SBOM{
Generator: ref.String(),
Generator: ref.String(),
Parameters: params,
}
}

Expand Down
4 changes: 2 additions & 2 deletions solver/llbsolver/proc/sbom.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"github.com/pkg/errors"
)

func SBOMProcessor(scannerRef string, useCache bool, resolveMode string) llbsolver.Processor {
func SBOMProcessor(scannerRef string, useCache bool, resolveMode string, params map[string]string) llbsolver.Processor {
return func(ctx context.Context, res *llbsolver.Result, s *llbsolver.Solver, j *solver.Job, usage *resources.SysSampler) (*llbsolver.Result, error) {
// skip sbom generation if we already have an sbom
if sbom.HasSBOM(res.Result) {
Expand All @@ -35,7 +35,7 @@ func SBOMProcessor(scannerRef string, useCache bool, resolveMode string) llbsolv
ImageOpt: &sourceresolver.ResolveImageOpt{
ResolveMode: resolveMode,
},
})
}, params)
if err != nil {
return nil, err
}
Expand Down
Loading