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

fix(filters): handle syscall arg #3893

Merged
merged 1 commit into from
Apr 1, 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
103 changes: 68 additions & 35 deletions pkg/filters/args.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package filters

import (
"fmt"
"strconv"
"strings"

"github.com/aquasecurity/tracee/pkg/errfmt"
Expand All @@ -24,12 +25,12 @@ func NewArgFilter() *ArgFilter {

// GetEventFilters returns the argument filters map for a specific event
// writing to the map may have unintentional consequences, avoid doing so
func (filter *ArgFilter) GetEventFilters(eventID events.ID) map[string]Filter {
return filter.filters[eventID]
func (af *ArgFilter) GetEventFilters(eventID events.ID) map[string]Filter {
return af.filters[eventID]
}

func (filter *ArgFilter) Filter(eventID events.ID, args []trace.Argument) bool {
if !filter.Enabled() {
func (af *ArgFilter) Filter(eventID events.ID, args []trace.Argument) bool {
if !af.Enabled() {
return true
}

Expand All @@ -42,9 +43,10 @@ func (filter *ArgFilter) Filter(eventID events.ID, args []trace.Argument) bool {
return true
}

for argName, filter := range filter.filters[eventID] {
for argName, f := range af.filters[eventID] {
found := false
var argVal interface{}

for _, arg := range args {
if arg.Name == argName {
found = true
Expand All @@ -55,11 +57,11 @@ func (filter *ArgFilter) Filter(eventID events.ID, args []trace.Argument) bool {
if !found {
return false
}

// TODO: use type assertion instead of string conversion
if argName != "syscall" {
argVal = fmt.Sprint(argVal)
}
res := filter.Filter(argVal)
argVal = fmt.Sprint(argVal)

res := f.Filter(argVal)
if !res {
return false
}
Expand All @@ -68,7 +70,7 @@ func (filter *ArgFilter) Filter(eventID events.ID, args []trace.Argument) bool {
return true
}

func (filter *ArgFilter) Parse(filterName string, operatorAndValues string, eventsNameToID map[string]events.ID) error {
func (af *ArgFilter) Parse(filterName string, operatorAndValues string, eventsNameToID map[string]events.ID) error {
// Event argument filter has the following format: "event.args.argname=argval"
// filterName have the format event.argname, and operatorAndValues have the format "=argval"
parts := strings.Split(filterName, ".")
Expand Down Expand Up @@ -111,82 +113,113 @@ func (filter *ArgFilter) Parse(filterName string, operatorAndValues string, even
return InvalidEventArgument(argName)
}

err := filter.parseFilter(id, argName, operatorAndValues, func() Filter {
// TODO: map argument type to an appropriate filter constructor
return NewStringFilter()
})
// valueHandler is passed to the filter constructor to allow for custom value handling
// before the filter is applied
valueHandler := func(val string) (string, error) {
switch id {
case events.SysEnter,
events.SysExit:
if argName == "syscall" { // handle either syscall name or syscall id
_, err := strconv.Atoi(val)
if err != nil {
// if val is a syscall name, then we need to convert it to a syscall id
syscallID, ok := events.Core.GetDefinitionIDByName(val)
if !ok {
return val, errfmt.Errorf("invalid syscall name: %s", val)
}
val = strconv.Itoa(int(syscallID))
}
}
case events.HookedSyscall:
if argName == "syscall" { // handle either syscall name or syscall id
argEventID, err := strconv.Atoi(val)
if err == nil {
// if val is a syscall id, then we need to convert it to a syscall name
val = events.Core.GetDefinitionByID(events.ID(argEventID)).GetName()
}
}
}

return val, nil
}

err := af.parseFilter(id, argName, operatorAndValues,
func() Filter {
// TODO: map argument type to an appropriate filter constructor
return NewStringFilter(valueHandler)
})
if err != nil {
return errfmt.WrapError(err)
}

filter.Enable()
af.Enable()

return nil
}

// parseFilter adds an argument filter with the relevant filterConstructor
// The user must responsibly supply a reliable Filter object.
func (filter *ArgFilter) parseFilter(id events.ID, argName string, operatorAndValues string, filterConstructor func() Filter) error {
if _, ok := filter.filters[id]; !ok {
filter.filters[id] = map[string]Filter{}
func (af *ArgFilter) parseFilter(id events.ID, argName string, operatorAndValues string, filterConstructor func() Filter) error {
if _, ok := af.filters[id]; !ok {
af.filters[id] = map[string]Filter{}
}

if _, ok := filter.filters[id][argName]; !ok {
if _, ok := af.filters[id][argName]; !ok {
// store new event arg filter if missing
argFilter := filterConstructor()
filter.filters[id][argName] = argFilter
af.filters[id][argName] = argFilter
}

// extract the arg filter and parse expression into it
argFilter := filter.filters[id][argName]
err := argFilter.Parse(operatorAndValues)
f := af.filters[id][argName]
err := f.Parse(operatorAndValues)
if err != nil {
return errfmt.WrapError(err)
}

// store the arg filter again
filter.filters[id][argName] = argFilter
af.filters[id][argName] = f

return nil
}

func (filter *ArgFilter) Enable() {
filter.enabled = true
for _, filterMap := range filter.filters {
func (af *ArgFilter) Enable() {
af.enabled = true
for _, filterMap := range af.filters {
for _, f := range filterMap {
f.Enable()
}
}
}

func (filter *ArgFilter) Disable() {
filter.enabled = false
for _, filterMap := range filter.filters {
func (af *ArgFilter) Disable() {
af.enabled = false
for _, filterMap := range af.filters {
for _, f := range filterMap {
f.Disable()
}
}
}

func (filter *ArgFilter) Enabled() bool {
return filter.enabled
func (af *ArgFilter) Enabled() bool {
return af.enabled
}

func (filter *ArgFilter) Clone() utils.Cloner {
if filter == nil {
func (af *ArgFilter) Clone() utils.Cloner {
if af == nil {
return nil
}

n := NewArgFilter()

for eventID, filterMap := range filter.filters {
for eventID, filterMap := range af.filters {
n.filters[eventID] = map[string]Filter{}
for argName, f := range filterMap {
n.filters[eventID][argName] = f.Clone().(Filter)
}
}

n.enabled = filter.enabled
n.enabled = af.enabled

return n
}
Loading
Loading