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

[CWS] Use containerutils.ContainerID in SBOM resolver #31581

Merged
merged 1 commit into from
Nov 28, 2024
Merged

[CWS] Use containerutils.ContainerID in SBOM resolver #31581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion pkg/security/probe/field_handlers_ebpf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ func (fh *EBPFFieldHandlers) resolveSBOMFields(ev *model.Event, f *model.FileEve
return
}

if pkg := fh.resolvers.SBOMResolver.ResolvePackage(string(ev.ContainerContext.ContainerID), f); pkg != nil {
if pkg := fh.resolvers.SBOMResolver.ResolvePackage(ev.ContainerContext.ContainerID, f); pkg != nil {
f.PkgName = pkg.Name
f.PkgVersion = pkg.Version
f.PkgSrcVersion = pkg.SrcVersion
Expand Down
2 changes: 1 addition & 1 deletion pkg/security/probe/probe_ebpf.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2511,7 +2511,7 @@ func (p *EBPFProbe) HandleActions(ctx *eval.Context, rule *rules.Rule) {
_ = p.RefreshUserCache(string(ev.ContainerContext.ContainerID))

case action.InternalCallback != nil && rule.ID == bundled.RefreshSBOMRuleID && p.Resolvers.SBOMResolver != nil && len(ev.ContainerContext.ContainerID) > 0:
if err := p.Resolvers.SBOMResolver.RefreshSBOM(string(ev.ContainerContext.ContainerID)); err != nil {
if err := p.Resolvers.SBOMResolver.RefreshSBOM(ev.ContainerContext.ContainerID); err != nil {
seclog.Warnf("failed to refresh SBOM for container %s, triggered by %s: %s", ev.ContainerContext.ContainerID, ev.ProcessContext.Comm, err)
}

Expand Down
27 changes: 14 additions & 13 deletions pkg/security/resolvers/sbom/resolver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"github.com/DataDog/datadog-agent/pkg/security/config"
"github.com/DataDog/datadog-agent/pkg/security/metrics"
cgroupModel "github.com/DataDog/datadog-agent/pkg/security/resolvers/cgroup/model"
"github.com/DataDog/datadog-agent/pkg/security/secl/containerutils"
"github.com/DataDog/datadog-agent/pkg/security/secl/model"
"github.com/DataDog/datadog-agent/pkg/security/seclog"
"github.com/DataDog/datadog-agent/pkg/security/utils"
Expand All @@ -57,7 +58,7 @@ type SBOM struct {
Host string
Source string
Service string
ContainerID string
ContainerID containerutils.ContainerID
workloadKey string

deleted *atomic.Bool
Expand Down Expand Up @@ -98,7 +99,7 @@ func (s *SBOM) reset() {
}

// NewSBOM returns a new empty instance of SBOM
func NewSBOM(host string, source string, id string, cgroup *cgroupModel.CacheEntry, workloadKey string) (*SBOM, error) {
func NewSBOM(host string, source string, id containerutils.ContainerID, cgroup *cgroupModel.CacheEntry, workloadKey string) (*SBOM, error) {
sbom := &SBOM{
files: fileQuerier{},
Host: host,
Expand All @@ -117,7 +118,7 @@ func NewSBOM(host string, source string, id string, cgroup *cgroupModel.CacheEnt
type Resolver struct {
cfg *config.RuntimeSecurityConfig
sbomsLock sync.RWMutex
sboms map[string]*SBOM
sboms map[containerutils.ContainerID]*SBOM
sbomsCacheLock sync.RWMutex
sbomsCache *simplelru.LRU[string, *SBOM]
scannerChan chan *SBOM
Expand Down Expand Up @@ -165,7 +166,7 @@ func NewSBOMResolver(c *config.RuntimeSecurityConfig, statsdClient statsd.Client
resolver := &Resolver{
cfg: c,
statsdClient: statsdClient,
sboms: make(map[string]*SBOM),
sboms: make(map[containerutils.ContainerID]*SBOM),
sbomsCache: sbomsCache,
scannerChan: make(chan *SBOM, 100),
sbomScanner: sbomScanner,
Expand Down Expand Up @@ -258,7 +259,7 @@ func (r *Resolver) Start(ctx context.Context) error {
}

// RefreshSBOM regenerates a SBOM for a container
func (r *Resolver) RefreshSBOM(containerID string) error {
func (r *Resolver) RefreshSBOM(containerID containerutils.ContainerID) error {
if sbom := r.getSBOM(containerID); sbom != nil {
seclog.Debugf("Refreshing SBOM for container %s", containerID)
sbom.refresh.Call()
Expand Down Expand Up @@ -318,7 +319,7 @@ func (r *Resolver) doScan(sbom *SBOM) (*trivy.Report, error) {
sbom.cgroup.RemovePID(rootCandidatePID)
continue
}
if string(computedID) != sbom.ContainerID {
if computedID != sbom.ContainerID {
sbom.cgroup.RemovePID(rootCandidatePID)
continue
}
Expand Down Expand Up @@ -403,7 +404,7 @@ func (r *Resolver) analyzeWorkload(sbom *SBOM) error {
return nil
}

func (r *Resolver) getSBOM(containerID string) *SBOM {
func (r *Resolver) getSBOM(containerID containerutils.ContainerID) *SBOM {
r.sbomsLock.RLock()
defer r.sbomsLock.RUnlock()

Expand All @@ -416,7 +417,7 @@ func (r *Resolver) getSBOM(containerID string) *SBOM {

// ResolvePackage returns the Package that owns the provided file. Make sure the internal fields of "file" are properly
// resolved.
func (r *Resolver) ResolvePackage(containerID string, file *model.FileEvent) *Package {
func (r *Resolver) ResolvePackage(containerID containerutils.ContainerID, file *model.FileEvent) *Package {
sbom := r.getSBOM(containerID)
if sbom == nil {
return nil
Expand All @@ -430,7 +431,7 @@ func (r *Resolver) ResolvePackage(containerID string, file *model.FileEvent) *Pa

// newWorkloadEntry (thread unsafe) creates a new SBOM entry for the sbom designated by the provided process cache
// entry
func (r *Resolver) newWorkloadEntry(id string, cgroup *cgroupModel.CacheEntry, workloadKey string) (*SBOM, error) {
func (r *Resolver) newWorkloadEntry(id containerutils.ContainerID, cgroup *cgroupModel.CacheEntry, workloadKey string) (*SBOM, error) {
sbom, err := NewSBOM(r.hostname, r.source, id, cgroup, workloadKey)
if err != nil {
return nil, err
Expand Down Expand Up @@ -493,7 +494,7 @@ func (r *Resolver) OnWorkloadSelectorResolvedEvent(cgroup *cgroupModel.CacheEntr
return
}

id := string(cgroup.ContainerID)
id := cgroup.ContainerID
// We don't scan hosts for now
if len(id) == 0 {
return
Expand All @@ -511,7 +512,7 @@ func (r *Resolver) OnWorkloadSelectorResolvedEvent(cgroup *cgroupModel.CacheEntr
}

// GetWorkload returns the sbom of a provided ID
func (r *Resolver) GetWorkload(id string) *SBOM {
func (r *Resolver) GetWorkload(id containerutils.ContainerID) *SBOM {
r.sbomsLock.RLock()
defer r.sbomsLock.RUnlock()

Expand All @@ -524,11 +525,11 @@ func (r *Resolver) GetWorkload(id string) *SBOM {

// OnCGroupDeletedEvent is used to handle a CGroupDeleted event
func (r *Resolver) OnCGroupDeletedEvent(cgroup *cgroupModel.CacheEntry) {
r.Delete(string(cgroup.CGroupID))
r.Delete(cgroup.ContainerID)
}

// Delete removes the SBOM of the provided cgroup id
func (r *Resolver) Delete(id string) {
func (r *Resolver) Delete(id containerutils.ContainerID) {
sbom := r.GetWorkload(id)
if sbom == nil {
return
Expand Down
5 changes: 3 additions & 2 deletions pkg/security/resolvers/sbom/resolver_unsupported.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (

"github.com/DataDog/datadog-agent/pkg/security/config"
cgroupModel "github.com/DataDog/datadog-agent/pkg/security/resolvers/cgroup/model"
"github.com/DataDog/datadog-agent/pkg/security/secl/containerutils"
"github.com/DataDog/datadog-agent/pkg/security/secl/model"
)

Expand All @@ -36,7 +37,7 @@ func (r *Resolver) OnWorkloadSelectorResolvedEvent(_ *cgroupModel.CacheEntry) {
}

// ResolvePackage returns the Package that owns the provided file
func (r *Resolver) ResolvePackage(_ string, _ *model.FileEvent) *Package {
func (r *Resolver) ResolvePackage(_ containerutils.ContainerID, _ *model.FileEvent) *Package {
return nil
}

Expand All @@ -51,6 +52,6 @@ func (r *Resolver) Start(_ context.Context) error {
}

// RefreshSBOM regenerates a SBOM for a container
func (r *Resolver) RefreshSBOM(_ string) error {
func (r *Resolver) RefreshSBOM(_ containerutils.ContainerID) error {
return nil
}
3 changes: 2 additions & 1 deletion pkg/security/tests/sbom_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"testing"

sprobe "github.com/DataDog/datadog-agent/pkg/security/probe"
"github.com/DataDog/datadog-agent/pkg/security/secl/containerutils"
"github.com/DataDog/datadog-agent/pkg/security/secl/model"
"github.com/DataDog/datadog-agent/pkg/security/secl/rules"
"github.com/DataDog/datadog-agent/pkg/util/flavor"
Expand Down Expand Up @@ -69,7 +70,7 @@ func TestSBOM(t *testing.T) {
dockerWrapper.Run(t, "package-rule", func(t *testing.T, _ wrapperType, cmdFunc func(bin string, args, env []string) *exec.Cmd) {
test.WaitSignal(t, func() error {
retry.Do(func() error {
sbom := p.Resolvers.SBOMResolver.GetWorkload(dockerWrapper.containerID)
sbom := p.Resolvers.SBOMResolver.GetWorkload(containerutils.ContainerID(dockerWrapper.containerID))
if sbom == nil {
return fmt.Errorf("failed to find SBOM for '%s'", dockerWrapper.containerID)
}
Expand Down
Loading