Skip to content

fix: #23915 podman build is not parsing sbom command line arguments #25647

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
20 changes: 20 additions & 0 deletions cmd/podman/common/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"io"
"os"
"path/filepath"
"slices"
"strings"
"syscall"
"time"
Expand Down Expand Up @@ -514,6 +515,24 @@ func buildFlagsWrapperToOptions(c *cobra.Command, contextDir string, flags *Buil
}
}

var sbomScanOptions []buildahDefine.SBOMScanOptions
if c.Flag("sbom").Changed || c.Flag("sbom-scanner-command").Changed || c.Flag("sbom-scanner-image").Changed || c.Flag("sbom-image-output").Changed || c.Flag("sbom-merge-strategy").Changed || c.Flag("sbom-output").Changed || c.Flag("sbom-image-output").Changed || c.Flag("sbom-purl-output").Changed || c.Flag("sbom-image-purl-output").Changed {
sbomScanOption, err := parse.SBOMScanOptions(c)
if err != nil {
return nil, err
}
if !slices.Contains(sbomScanOption.ContextDir, contextDir) {
sbomScanOption.ContextDir = append(sbomScanOption.ContextDir, contextDir)
}
for _, abc := range additionalBuildContext {
if !abc.IsURL && !abc.IsImage {
sbomScanOption.ContextDir = append(sbomScanOption.ContextDir, abc.Value)
}
}
sbomScanOption.PullPolicy = pullPolicy
sbomScanOptions = append(sbomScanOptions, *sbomScanOption)
}

opts := buildahDefine.BuildOptions{
AddCapabilities: flags.CapAdd,
AdditionalTags: tags,
Expand Down Expand Up @@ -570,6 +589,7 @@ func buildFlagsWrapperToOptions(c *cobra.Command, contextDir string, flags *Buil
Runtime: podmanConfig.RuntimePath,
RuntimeArgs: runtimeFlags,
RusageLogFile: flags.RusageLogFile,
SBOMScanOptions: sbomScanOptions,
SignBy: flags.SignBy,
SignaturePolicyPath: flags.SignaturePolicy,
Squash: flags.Squash,
Expand Down
49 changes: 49 additions & 0 deletions pkg/api/handlers/compat/images_build.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"net/http"
"os"
"path/filepath"
"slices"
"strconv"
"strings"
"syscall"
Expand Down Expand Up @@ -171,6 +172,13 @@ func BuildImage(w http.ResponseWriter, r *http.Request) {
UnsetEnvs []string `schema:"unsetenv"`
UnsetLabels []string `schema:"unsetlabel"`
Volumes []string `schema:"volume"`
SBOMOutput string `schema:"sbom-output"`
SBOMPURLOutput string `schema:"sbom-purl-output"`
ImageSBOMOutput string `schema:"sbom-image-output"`
ImageSBOMPURLOutput string `schema:"sbom-image-purl-output"`
ImageSBOM string `schema:"sbom-scanner-image"`
SBOMCommands string `schema:"sbom-scanner-command"`
SBOMMergeStrategy string `schema:"sbom-merge-strategy"`
}{
Dockerfile: "Dockerfile",
IdentityLabel: true,
Expand Down Expand Up @@ -693,6 +701,46 @@ func BuildImage(w http.ResponseWriter, r *http.Request) {
}
}

var sbomScanOptions []buildahDefine.SBOMScanOptions
if query.ImageSBOM != "" ||
query.SBOMOutput != "" ||
query.ImageSBOMOutput != "" ||
query.SBOMPURLOutput != "" ||
query.ImageSBOMPURLOutput != "" ||
query.SBOMCommands != "" ||
query.SBOMMergeStrategy != "" {
sbomScanOption := &buildahDefine.SBOMScanOptions{
SBOMOutput: query.SBOMOutput,
PURLOutput: query.SBOMPURLOutput,
ImageSBOMOutput: query.ImageSBOMOutput,
ImagePURLOutput: query.ImageSBOMPURLOutput,
Image: query.ImageSBOM,
MergeStrategy: buildahDefine.SBOMMergeStrategy(query.SBOMMergeStrategy),
PullPolicy: pullPolicy,
}

if _, found := r.URL.Query()["sbom-scanner-command"]; found {
var m = []string{}
if err := json.Unmarshal([]byte(query.SBOMCommands), &m); err != nil {
utils.BadRequest(w, "sbom-scanner-command", query.SBOMCommands, err)
return
}
sbomScanOption.Commands = m
}

if !slices.Contains(sbomScanOption.ContextDir, contextDirectory) {
sbomScanOption.ContextDir = append(sbomScanOption.ContextDir, contextDirectory)
}

for _, abc := range additionalBuildContexts {
if !abc.IsURL && !abc.IsImage {
sbomScanOption.ContextDir = append(sbomScanOption.ContextDir, abc.Value)
}
}

sbomScanOptions = append(sbomScanOptions, *sbomScanOption)
}

buildOptions := buildahDefine.BuildOptions{
AddCapabilities: addCaps,
AdditionalBuildContexts: additionalBuildContexts,
Expand Down Expand Up @@ -772,6 +820,7 @@ func BuildImage(w http.ResponseWriter, r *http.Request) {
Target: query.Target,
UnsetEnvs: query.UnsetEnvs,
UnsetLabels: query.UnsetLabels,
SBOMScanOptions: sbomScanOptions,
}

platforms := query.Platform
Expand Down
36 changes: 36 additions & 0 deletions pkg/bindings/images/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,42 @@ func Build(ctx context.Context, containerFiles []string, options types.BuildOpti
stdout = options.Out
}

if len(options.SBOMScanOptions) > 0 {
for _, sbomScanOpts := range options.SBOMScanOptions {
if sbomScanOpts.SBOMOutput != "" {
params.Set("sbom-output", sbomScanOpts.SBOMOutput)
}

if sbomScanOpts.PURLOutput != "" {
params.Set("sbom-purl-output", sbomScanOpts.PURLOutput)
}

if sbomScanOpts.ImageSBOMOutput != "" {
params.Set("sbom-image-output", sbomScanOpts.ImageSBOMOutput)
}

if sbomScanOpts.ImagePURLOutput != "" {
params.Set("sbom-image-purl-output", sbomScanOpts.ImagePURLOutput)
}

if sbomScanOpts.Image != "" {
params.Set("sbom-scanner-image", sbomScanOpts.Image)
}

if commands := sbomScanOpts.Commands; len(commands) > 0 {
c, err := jsoniter.MarshalToString(commands)
if err != nil {
return nil, err
}
params.Add("sbom-scanner-command", c)
}

if sbomScanOpts.MergeStrategy != "" {
params.Set("sbom-merge-strategy", string(sbomScanOpts.MergeStrategy))
}
}
}

contextDir, err = filepath.Abs(options.ContextDirectory)
if err != nil {
logrus.Errorf("Cannot find absolute path of %v: %v", options.ContextDirectory, err)
Expand Down
23 changes: 23 additions & 0 deletions test/e2e/build_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ package integration

import (
"bytes"
"errors"
"fmt"
"io/fs"
"os"
"os/exec"
"path/filepath"
Expand Down Expand Up @@ -972,4 +974,25 @@ RUN ls /dev/test1`, CITEST_IMAGE)
session.WaitWithDefaultTimeout()
Expect(session).Should(ExitWithError(1, `building at STEP "RUN --mount=type=cache,target=/test,z cat /test/world": while running runtime: exit status 1`))
})
It("podman build with sbom flags", func() {
podmanTest.AddImageToRWStore(ALPINE)

podmanTest.PodmanExitCleanly("build", "-t", "sbom-img", "--sbom-output=localsbom.txt", "--sbom-purl-output=localpurl.txt", "--sbom-image-output=/tmp/sbom.txt", "--sbom-image-purl-output=/tmp/purl.txt",
"--sbom-scanner-image=alpine", "--sbom-scanner-command=/bin/sh -c 'echo SCANNED ROOT {ROOTFS} > {OUTPUT}'", "--sbom-scanner-command=/bin/sh -c 'echo SCANNED BUILD CONTEXT {CONTEXT} > {OUTPUT}'",
"--sbom-merge-strategy=cat", "build/basicalpine")

defer os.Remove("./localsbom.txt")
if _, err := os.Stat("./localsbom.txt"); err != nil {
Expect(errors.Is(err, fs.ErrNotExist)).To(BeFalse())
}

defer os.Remove("./localpurl.txt")
if _, err := os.Stat("./localpurl.txt"); err != nil {
Expect(errors.Is(err, fs.ErrNotExist)).To(BeFalse())
}

session := podmanTest.PodmanExitCleanly("run", "--rm", "sbom-img", "ls", "/tmp")
Expect(session.OutputToString()).To(ContainSubstring("purl.txt"))
Expect(session.OutputToString()).To(ContainSubstring("sbom.txt"))
})
})