Requires keyword/v1 #12138
Open
Requires keyword/v1 #12138
+106
−7
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
For example, "requires: foo bar" is an unknown requirement, however its not tracked, nor an error as it follows the syntax. Instead, record these unknown keywords, and fails the requirements check if any are present. A future version of Suricata may have new requires keywords, for example a check for keywords.
To be used by the requires keyword to check for keyword support. Ticket: OISF#7403
For example:
requires: keyword foo;
Will require that Suricata supports the "foo" keyword.
Ticket: OISF#7403
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #12138 +/- ##
===========================================
+ Coverage 62.68% 83.10% +20.42%
===========================================
Files 840 909 +69
Lines 153669 257928 +104259
===========================================
+ Hits 96323 214354 +118031
+ Misses 57346 43574 -13772
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
Information: QA ran without warnings. Pipeline 23452 |
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.
The idea is to allow a rule to require the existence of keywords, for example, #12120 brings 2 new keywords that are dynamically loaded as part of a plugin. It could get pretty crazy adding feature flags, version checks, etc. Or we could just add a check for the existence of a keyword.
One other important change: Suricata 7, and 8 before this PR would ignore unknown requires statements like
requires: foo bar, I think this was flawed. Instead, we should treat an unknown, yet syntactically valid requirements statement as an unmet requirement.Ticket: https://redmine.openinfosecfoundation.org/issues/7403
SV_BRANCH=OISF/suricata-verify#2133