particle-os/debian-forge-composer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Worker/depsolve: add support for SBOM

Browse source 
Add support to the `DepsolveJob` for requesting SBOM documents and
returning the results from the job.

Signed-off-by: Tomáš Hozza <thozza@redhat.com>
This commit is contained in:
Tomáš Hozza 2024-09-10 14:47:20 +02:00 • committed by Tomáš Hozza
parent 0628ac9131
commit 4779e90e17
2 changed files with 25 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

19
cmd/osbuild-worker/jobimpl-depsolve.go
View file

@ -52,27 +52,34 @@ type DepsolveJobImpl struct {
// in repos are used for all package sets, whereas the repositories in
// packageSetsRepos are only used for the package set with the same name
// (matching map keys).
func (impl *DepsolveJobImpl) depsolve(packageSets map[string][]rpmmd.PackageSet, modulePlatformID, arch, releasever string) (map[string][]rpmmd.PackageSpec, map[string][]rpmmd.RepoConfig, error) {
func (impl *DepsolveJobImpl) depsolve(packageSets map[string][]rpmmd.PackageSet, modulePlatformID, arch, releasever string, sbomType sbom.StandardType) (map[string][]rpmmd.PackageSpec, map[string][]rpmmd.RepoConfig, map[string]worker.SbomDoc, error) {
solver := impl.Solver.NewWithConfig(modulePlatformID, releasever, arch, "")
if impl.RepositoryMTLSConfig != nil && impl.RepositoryMTLSConfig.Proxy != nil {
err := solver.SetProxy(impl.RepositoryMTLSConfig.Proxy.String())
if err != nil {
return nil, nil, err
return nil, nil, nil, err
}
}
depsolvedSets := make(map[string][]rpmmd.PackageSpec)
repoConfigs := make(map[string][]rpmmd.RepoConfig)
var sbomDocs map[string]worker.SbomDoc
if sbomType != sbom.StandardTypeNone {
sbomDocs = make(map[string]worker.SbomDoc)
}
for name, pkgSet := range packageSets {
res, err := solver.Depsolve(pkgSet, sbom.StandardTypeNone)
res, err := solver.Depsolve(pkgSet, sbomType)
if err != nil {
return nil, nil, err
return nil, nil, nil, err
}
depsolvedSets[name] = res.Packages
repoConfigs[name] = res.Repos
if sbomType != sbom.StandardTypeNone {
sbomDocs[name] = worker.SbomDoc(*res.SBOM)
}
}
return depsolvedSets, repoConfigs, nil
return depsolvedSets, repoConfigs, sbomDocs, nil
}
func workerClientErrorFrom(err error, logWithId *logrus.Entry) *clienterrors.Error {
@ -142,7 +149,7 @@ func (impl *DepsolveJobImpl) Run(job worker.Job) error {
}
}
result.PackageSpecs, result.RepoConfigs, err = impl.depsolve(args.PackageSets, args.ModulePlatformID, args.Arch, args.Releasever)
result.PackageSpecs, result.RepoConfigs, result.SbomDocs, err = impl.depsolve(args.PackageSets, args.ModulePlatformID, args.Arch, args.Releasever, args.SbomType)
if err != nil {
result.JobError = workerClientErrorFrom(err, logWithId)
}

12
internal/worker/json.go
View file

@ -9,6 +9,7 @@ import (
"github.com/osbuild/images/pkg/manifest"
"github.com/osbuild/images/pkg/osbuild"
"github.com/osbuild/images/pkg/rpmmd"
"github.com/osbuild/images/pkg/sbom"
"github.com/osbuild/osbuild-composer/internal/target"
"github.com/osbuild/osbuild-composer/internal/worker/clienterrors"
"golang.org/x/exp/slices"
@ -180,6 +181,10 @@ type DepsolveJob struct {
ModulePlatformID string `json:"module_platform_id"`
Arch string `json:"arch"`
Releasever string `json:"releasever"`
// NB: for now, the worker supports only a single SBOM type, but keep the options
// open for the future by passing the actual type and not just bool.
SbomType sbom.StandardType `json:"sbom_type,omitempty"`
}
type ErrorType string
@ -189,8 +194,15 @@ const (
OtherErrorType ErrorType = "other"
)
// SbomDoc represents a single SBOM document result.
type SbomDoc struct {
DocType sbom.StandardType `json:"type"`
Document json.RawMessage `json:"document"`
}
type DepsolveJobResult struct {
PackageSpecs map[string][]rpmmd.PackageSpec `json:"package_specs"`
SbomDocs map[string]SbomDoc `json:"sbom_docs,omitempty"`
RepoConfigs map[string][]rpmmd.RepoConfig `json:"repo_configs"`
Error string `json:"error"`
ErrorType ErrorType `json:"error_type"`