new(app_actions)!: adjust base_syscalls option, add base_syscalls.repair #2457
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ limitations under the License. | |
| #include <gtest/gtest.h> | ||
|
|
||
| #define ASSERT_NAMES_EQ(a, b) { \ | ||
| EXPECT_EQ(_order(a).size(), _order(b).size()); \ | ||
| ASSERT_EQ(_order(a), _order(b)); \ | ||
| } | ||
|
|
||
|
|
@@ -47,7 +47,7 @@ static std::string s_sample_ruleset = "sample-ruleset"; | |
| static std::string s_sample_source = falco_common::syscall_source; | ||
|
|
||
| static strset_t s_sample_filters = { | ||
| "evt.type=connect or evt.type=accept or evt.type=accept4 or evt.type=umount2", | ||
|
There was a problem hiding this comment. Small touch up on tests to include some of the overlapping syscalls already. Noticed during testing that As we refactor the ppm sc API one more time with a subsequent libs bump we should include a generic syscalls in the test mock rules as well as this critical test coverage is currently missing. CC @jasondellaluce |
||
| "evt.type in (open, ptrace, mmap, execve, read, container)", | ||
| "evt.type in (open, execve, mprotect) and not evt.type=mprotect"}; | ||
|
|
||
|
|
@@ -99,15 +99,15 @@ TEST(ConfigureInterestingSets, engine_codes_syscalls_set) | |
| auto rules_event_set = engine->event_codes_for_ruleset(s_sample_source); | ||
| auto rules_event_names = libsinsp::events::event_set_to_names(rules_event_set); | ||
| ASSERT_NAMES_EQ(rules_event_names, strset_t({ | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read", "container"})); | ||
|
|
||
| // test if sc code names were extracted from each rule in test ruleset. | ||
| // note, this is not supposed to contain "container", as that's an event | ||
| // not mapped through the ppm_sc_code enumerative. | ||
| auto rules_sc_set = engine->sc_codes_for_ruleset(s_sample_source); | ||
| auto rules_sc_names = libsinsp::events::sc_set_to_names(rules_sc_set); | ||
| ASSERT_NAMES_EQ(rules_sc_names, strset_t({ | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read"})); | ||
| } | ||
|
|
||
| TEST(ConfigureInterestingSets, preconditions_postconditions) | ||
|
|
@@ -158,15 +158,15 @@ TEST(ConfigureInterestingSets, engine_codes_nonsyscalls_set) | |
| // This is a good example of information loss from ppm_event_code <-> ppm_sc_code. | ||
| auto generic_names = libsinsp::events::event_set_to_names({ppm_event_code::PPME_GENERIC_E}); | ||
| auto expected_names = strset_t({ | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read", "container", // ruleset | ||
| "procexit", "switch", "pluginevent"}); // from non-syscall event filters | ||
| expected_names.insert(generic_names.begin(), generic_names.end()); | ||
| ASSERT_NAMES_EQ(rules_event_names, expected_names); | ||
|
|
||
| auto rules_sc_set = engine->sc_codes_for_ruleset(s_sample_source); | ||
| auto rules_sc_names = libsinsp::events::sc_set_to_names(rules_sc_set); | ||
| ASSERT_NAMES_EQ(rules_sc_names, strset_t({ | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read", | ||
| "syncfs", "fanotify_init", // from generic event filters | ||
| })); | ||
| } | ||
|
|
@@ -185,11 +185,11 @@ TEST(ConfigureInterestingSets, selection_not_allevents) | |
| // also check if a warning has been printed in stderr | ||
|
|
||
| // check that the final selected set is the one expected | ||
| ASSERT_GT(s.selected_sc_set.size(), 1); | ||
| auto selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| auto expected_sc_names = strset_t({ | ||
| // note: we expect the "read" syscall to have been erased | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", // from ruleset | ||
| "clone", "clone3", "fork", "vfork", // from sinsp state set (spawned_process) | ||
| "socket", "bind", "close" // from sinsp state set (network, files) | ||
| }); | ||
|
|
@@ -228,11 +228,11 @@ TEST(ConfigureInterestingSets, selection_allevents) | |
| // also check if a warning has not been printed in stderr | ||
|
|
||
| // check that the final selected set is the one expected | ||
| ASSERT_GT(s.selected_sc_set.size(), 1); | ||
| auto selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| auto expected_sc_names = strset_t({ | ||
| // note: we expect the "read" syscall to not be erased | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read", // from ruleset | ||
| "clone", "clone3", "fork", "vfork", // from sinsp state set (spawned_process) | ||
| "socket", "bind", "close" // from sinsp state set (network, files) | ||
| }); | ||
|
|
@@ -251,6 +251,7 @@ TEST(ConfigureInterestingSets, selection_generic_evts) | |
| { | ||
| // run app action with fake engine and without the `-A` option | ||
| falco::app::state s; | ||
| s.options.all_events = false; | ||
| auto filters = s_sample_filters; | ||
| filters.insert(s_sample_generic_filters.begin(), s_sample_generic_filters.end()); | ||
| s.engine = mock_engine_from_filters(filters); | ||
|
|
@@ -259,16 +260,18 @@ TEST(ConfigureInterestingSets, selection_generic_evts) | |
| ASSERT_EQ(result.errstr, ""); | ||
|
|
||
| // check that the final selected set is the one expected | ||
| ASSERT_GT(s.selected_sc_set.size(), 1); | ||
| auto selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| auto expected_sc_names = strset_t({ | ||
| // note: we expect the "read" syscall to not be erased | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", // from ruleset | ||
| "syncfs", "fanotify_init", // from ruleset (generic events) | ||
| "clone", "clone3", "fork", "vfork", // from sinsp state set (spawned_process) | ||
| "socket", "bind", "close" // from sinsp state set (network, files) | ||
| }); | ||
| ASSERT_NAMES_CONTAIN(selected_sc_names, expected_sc_names); | ||
| auto unexpected_sc_names = libsinsp::events::sc_set_to_names(libsinsp::events::io_sc_set()); | ||
| ASSERT_NAMES_NOCONTAIN(selected_sc_names, unexpected_sc_names); | ||
| } | ||
|
|
||
| // expected combinations precedence: | ||
|
|
@@ -285,7 +288,8 @@ TEST(ConfigureInterestingSets, selection_custom_base_set) | |
| auto default_base_set = libsinsp::events::sinsp_state_sc_set(); | ||
|
|
||
| // non-empty custom base set (both positive and negative) | ||
| s.config->m_base_syscalls_repair = false; | ||
| s.config->m_base_syscalls_custom_set = {"syncfs", "!accept"}; | ||
| auto result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
|
|
@@ -297,56 +301,90 @@ TEST(ConfigureInterestingSets, selection_custom_base_set) | |
| // note: `accept` is not included even though it is matched by the rules, | ||
| // which means that the custom negation base set has precedence over the | ||
| // final selection set as a whole | ||
| // todo(jasondellaluce): add "accept4" once names_to_sc_set is polished on the libs side | ||
|
There was a problem hiding this comment. When disabling |
||
| "connect", "umount2", "open", "ptrace", "mmap", "execve", "read", "syncfs", "sched_process_exit" | ||
| }); | ||
| ASSERT_NAMES_EQ(selected_sc_names, expected_sc_names); | ||
|
|
||
| // non-empty custom base set (both positive and negative with collision) | ||
| s.config->m_base_syscalls_repair = false; | ||
| s.config->m_base_syscalls_custom_set = {"syncfs", "accept", "!accept"}; | ||
| result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
| selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| // note: in case of collision, negation has priority, so the expected | ||
| // names are the same as the case above | ||
| ASSERT_NAMES_EQ(selected_sc_names, expected_sc_names); | ||
|
|
||
| // non-empty custom base set (only positive) | ||
| s.config->m_base_syscalls_custom_set = {"syncfs"}; | ||
| result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
| selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| expected_sc_names = strset_t({ | ||
| // note: accept is not negated anymore | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "read", "syncfs", "sched_process_exit" | ||
| }); | ||
| ASSERT_NAMES_EQ(selected_sc_names, expected_sc_names); | ||
|
|
||
| // non-empty custom base set (only negative) | ||
| s.config->m_base_syscalls_custom_set = {"!accept"}; | ||
| result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
| selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| expected_sc_names = unordered_set_union( | ||
| libsinsp::events::sc_set_to_names(default_base_set), | ||
| strset_t({ "connect", "umount2", "open", "ptrace", "mmap", "execve", "read"})); | ||
| expected_sc_names.erase("accept"); | ||
| // todo(jasondellaluce): add "accept4" once names_to_sc_set is polished on the libs side | ||
| expected_sc_names.erase("accept4"); | ||
| ASSERT_NAMES_EQ(selected_sc_names, expected_sc_names); | ||
|
|
||
| // non-empty custom base set (positive, without -A) | ||
| s.options.all_events = false; | ||
| s.config->m_base_syscalls_custom_set = {"read"}; | ||
| result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
| selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| expected_sc_names = strset_t({ | ||
| // note: read is both part of the custom base set and the rules set, | ||
| // but we expect the unset -A option to take precedence | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "sched_process_exit" | ||
| }); | ||
| ASSERT_NAMES_EQ(selected_sc_names, expected_sc_names); | ||
| auto unexpected_sc_names = libsinsp::events::sc_set_to_names(libsinsp::events::io_sc_set()); | ||
| ASSERT_NAMES_NOCONTAIN(selected_sc_names, unexpected_sc_names); | ||
| } | ||
|
|
||
| TEST(ConfigureInterestingSets, selection_custom_base_set_repair) | ||
| { | ||
| // run app action with fake engine and without the `-A` option | ||
| falco::app::state s; | ||
| s.options.all_events = false; | ||
| s.engine = mock_engine_from_filters(s_sample_filters); | ||
|
|
||
| // simulate empty custom set but repair option set. | ||
| // note: here we use file syscalls (e.g. open, openat) and have a custom | ||
| // positive set, so we expect syscalls such as "close" to be selected as | ||
| // repaired. Also, given that we use some network syscalls, we expect "bind" | ||
| // to be selected event if we negate it, because repairment should have | ||
| // take precedence. | ||
| s.config->m_base_syscalls_custom_set = {"openat", "!bind"}; | ||
| s.config->m_base_syscalls_repair = true; | ||
| auto result = falco::app::actions::configure_interesting_sets(s); | ||
| ASSERT_TRUE(result.success); | ||
| ASSERT_EQ(result.errstr, ""); | ||
| auto selected_sc_names = libsinsp::events::sc_set_to_names(s.selected_sc_set); | ||
| auto expected_sc_names = strset_t({ | ||
| // note: expecting syscalls from mock rules and `sinsp_repair_state_sc_set` enforced syscalls | ||
| "connect", "accept", "accept4", "umount2", "open", "ptrace", "mmap", "execve", "sched_process_exit", \ | ||
| "bind", "socket", "clone3", "close", "setuid" | ||
| }); | ||
| ASSERT_NAMES_CONTAIN(selected_sc_names, expected_sc_names); | ||
| auto unexpected_sc_names = libsinsp::events::sc_set_to_names(libsinsp::events::io_sc_set()); | ||
| ASSERT_NAMES_NOCONTAIN(selected_sc_names, unexpected_sc_names); | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tried to make the description easier to follow, we can plan for some final touch up closer to Falco 0.35 release.