Refactor policy #4400
Open
Refactor policy #4400
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit renames the `parameters` field in event definitions to `fields`. This change reflects the evolving nature of Tracee, which now supports various event types beyond just syscalls. The term "fields" more accurately describes the structured data within events, aligning with the concept of event schemas and the `data` section in the new event structure. This renaming also avoids future confusion with the planned introduction of "event parameters," which will be configurable settings for modifying event behavior.
Split the filter help message into separate scope and events help messages to match the CLI structure. Moved documentation from the deprecated filter flag into their respective --scope and --events flag help messages.
Restructure filters to match tracee's policy structure by moving event-specific filters into policy.Rules. Main changes: - Move DataFilter, ScopeFilter and RetFilter from top-level maps into policy.Rules[eventID] - Remove filter.go and its flag as event filtering is now handled through the policy structure - Adjust all filter operations to work with the new Rules-based structure This change better reflects tracee's policy design where each event has its own set of filters under a rule, preparing the stage for moving from matched_policies to matched_rules resolution.
github-actions
bot
added
area/ebpf
area/testing
area/UX
area/events
area/filtering
area/flags
labels
Split the large CreatePolicies function into smaller, focused functions for better readability and maintainability. The main changes: - Split policy creation logic into separate functions - Simplified function signatures and parameter passing - Made variable naming more consistent - Improved error handling organization No functional changes, only code reorganization.
Add unit tests for recently added policy parsing functions: - parseScopeFilters - createSinglePolicy - parseEventFilters
yanivagman
force-pushed
the
refactor_policy
branch
from
558bd37
to
ccb3045
Compare
geyslan
reviewed
Nov 29, 2024
| @@ -12,7 +11,7 @@ import ( | |||
| ) | |||
|
|
|||
| type DataFilter struct { | |||
| filters map[events.ID]map[string]Filter[*StringFilter] | |||
| filters map[string]Filter[*StringFilter] | |||
There was a problem hiding this comment.
@rscampos this conflicts with your effort.
geyslan
reviewed
Nov 29, 2024
| enabled: false, | ||
| } | ||
| } | ||
|
|
||
| // GetEventFilters returns the data filters map for a specific event | ||
| // writing to the map may have unintentional consequences, avoid doing so | ||
| func (af *DataFilter) GetEventFilters(eventID events.ID) map[string]Filter[*StringFilter] { | ||
| return af.filters[eventID] | ||
| // TODO: encapsulate by replacing this function with "GetFieldFilter(fieldName string) StringFilter" |
There was a problem hiding this comment.
If possible, GetFieldFilter(field int) should receive an int.
--- EDIT
I'm concerned about calls from hotpaths, if it's not the case, ignore it.
geyslan
reviewed
Nov 29, 2024
Comment on lines
+131
to
+139
| // Check filters under Rules | ||
| for _, rule := range p.Rules { | ||
| if rule.DataFilter.Enabled() || | ||
| rule.RetFilter.Enabled() || | ||
| rule.ScopeFilter.Enabled() { | ||
| hasUserlandFilters = true | ||
| break | ||
| } | ||
| } |
There was a problem hiding this comment.
Could this logic set an internal flag to be checked via a Rules public method as a shortcut in the pipeline?
geyslan
reviewed
Nov 29, 2024
| } | ||
|
|
||
| type RuleData struct { | ||
| EventName string |
geyslan
reviewed
Nov 29, 2024
| ProcessTreeFilter *filters.ProcessTreeFilter | ||
| BinaryFilter *filters.BinaryFilter | ||
| Follow bool | ||
| Rules map[events.ID]RuleData |
There was a problem hiding this comment.
I'm aware that you're just following the current structure definition but, just as a reminder, we'll better encapsulate it converting all public objects to private and make them accessible only by specific methods as we already started in policy.Manager.
|
I've skimmed it and put some thoughts. When the conflicts are resolved, gonna check it again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
1. Explain what the PR does
commit 9e6ddcd
Author: Yaniv Agman [email protected]
Date: Thu Nov 28 17:32:23 2024 +0200
commit ec0ec43
Author: Yaniv Agman [email protected]
Date: Thu Nov 28 14:16:57 2024 +0200
commit d575f3d
Author: Yaniv Agman [email protected]
Date: Mon Nov 25 17:54:48 2024 +0200
commit cc8947d
Author: Yaniv Agman [email protected]
Date: Thu Nov 28 11:48:17 2024 +0200
2. Explain how to test it
3. Other comments