-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
transform: luaxform transform script #11876
Conversation
This commit makes the detection engine thread context available for transforms to use. The Lua transform requires this value. Issue: 2290
Issue: 2290 This commit extends the hash table logic with an alternate free function that provides the detection engine context. Users that wish to use the next functionality must use the HashListTableInitWithCtx function when initializing the hash table. Using this interface will result in the hash table "free with context" function (new) being used instead.
ERROR: ERROR: QA failed on ASAN_TLPR1_cfg. Pipeline 22992 |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #11876 +/- ##
========================================
Coverage 82.61% 82.61%
========================================
Files 912 915 +3
Lines 249354 249595 +241
========================================
+ Hits 205992 206194 +202
- Misses 43362 43401 +39
Flags with carried forward coverage won't be shown. Click here to find out more. |
Issue: 2290 Defer freeing the keyword hash table until the engine context has been freed. This eliminates a double-free from occurring. For the unittests ONLY, clear the keyword_hash to prevent a double free attempt.
Issue: 2290 This commit adds the source files for the new transform -- luaxform.
Issue: 2290
Issue: 2290 Fixup the macro usage to eliminate compiler warnings.
Information: QA ran without warnings. Pipeline 22993 |
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.
A few doc comments...
This transform allows a Lua script to apply a transformation | ||
to a buffer. |
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.
Just for the sake of extra clarity, should we add something about how the script should be called, via a rule?
Maybe just bring one of the examples that are further below here to help illustrate it right from the beginning...
Continued in #11892 |
Continuation of #11860
Add the
luaxform
transform that uses a Lua script to receive and transform a sticky buffer.Lua transforms receive arguments
Arguments are passed to the lua script as they appear in the rule:
When the transform is invoked, 3 additional arguments are passed (arg count will be 3)
bytes 4
offset 13
hash sha256
The Lua script is responsible for parsing and using the arguments and returning a tuple:
output-buffer, output-buffer-byte-count
I used this lua script:
Example rule using the lua script:
Link to ticket: https://redmine.openinfosecfoundation.org/issues/2290
Describe changes:
Updates
Provide values to any of the below to override the defaults.
link to the pull request in the respective
_BRANCH
variable.SV_REPO=
SV_BRANCH=OISF/suricata-verify#2044
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=