-
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 #11989
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.
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
git grep -A 1 -w InspectionBufferSetup shows numbers cases of the pattern: - InspectionBufferSetup - InspectionBufferApplyTransforms Refactor the implementations of those functions into InspectionBufferSetupAndApplyTransforms to reduce function call count. Issuer: 2290
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #11989 +/- ##
==========================================
+ Coverage 82.75% 83.00% +0.25%
==========================================
Files 910 913 +3
Lines 249016 258395 +9379
==========================================
+ Hits 206069 214493 +8424
- Misses 42947 43902 +955
Flags with carried forward coverage won't be shown. Click here to find out more. |
Information: QA ran without warnings. Pipeline 23135 |
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.
Added some nit(ish) documentation comments.
Continued in #12072 |
Continuation of #11940
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#2090
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=