transform: luaxform transform script #12251
Closed
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 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
jlucovsky
requested review from
jasonish,
jufajardini and
victorjulien
as code owners
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #12251 +/- ##
==========================================
+ Coverage 83.18% 83.20% +0.01%
==========================================
Files 912 914 +2
Lines 257174 257389 +215
==========================================
+ Hits 213930 214149 +219
+ Misses 43244 43240 -4
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 23733 |
|
Testing this gives me some crashes / asan errrors: rule script function init (args)
-- Optional, no return value
end
function transform(input_len, input, argc, args)
ipver, srcip, dstip, proto, sp, dp = SCFlowTuple()
str = srcip .. ">:<" .. dp .. ">:<" .. input
return str
end
return 0Invoked with |
| } | ||
|
|
||
| error: | ||
| lua_pop(tlua->luastate, return_value_count); // Pop the result string/length |
There was a problem hiding this comment.
in the error path the state is not cleared, this is what my asan issue is. State keeps growing with each error until it fails to grow further
| const uint8_t *input = buffer->inspect; | ||
| const uint32_t input_len = buffer->inspect_len; | ||
| /* Lua script args are: buffer length, buffer, arg count, args */ | ||
| LuaPushInteger(tlua->luastate, (lua_Integer)input_len); |
There was a problem hiding this comment.
this is not needed. In the script we can use
input_len = #inputto get the length
| /* Lua script args are: buffer length, buffer, arg count, args */ | ||
| LuaPushInteger(tlua->luastate, (lua_Integer)input_len); | ||
| LuaPushStringBuffer(tlua->luastate, input, (size_t)input_len); | ||
| LuaPushInteger(tlua->luastate, (lua_Integer)lua->arg_count); |
There was a problem hiding this comment.
this isn't needed, in the script #args can be used to get the same
There was a problem hiding this comment.
e.g.
SCLogNotice("args " .. #args)
for i = 1, #args do
SCLogNotice("Argument " .. i .. ":" .. args[i])
end| * Add provided arguments for lua script (these are optionally | ||
| * provided by the rule writer). | ||
| * | ||
| * Start at offset 1 (arg[0] is the lua script filename) |
There was a problem hiding this comment.
this does not appear to be working. arg[0] is invalid, args[0] can't be printed. attempt to concatenate a nil value (field 'integer index')
There was a problem hiding this comment.
lua->args[0] contains the filename; the filename is not passed to the Lua script.
|
Can you split out the general refactor commits so we can get these in already? |
|
"transform: Add luaxform files" - need a better commit subject. Adding the files isn't the relevant info, plus it is redundant with what the diff already shows. |
Open
|
Replaced by #12425 |
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.
Continuation of #12247
Add the
luaxformtransform 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 4offset 13hash sha256The Lua script is responsible for parsing and using the arguments and returning a tuple:
output-buffer, output-buffer-byte-countI 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
_BRANCHvariable.SV_REPO=
SV_BRANCH=OISF/suricata-verify#2090
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=