Skip to content
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

Closed
wants to merge 6 commits into from
Closed

Conversation

jlucovsky
Copy link
Contributor

Continuation of #11860

Add the luaxform transform that uses a Lua script to receive and transform a sticky buffer.

Lua transforms receive arguments

  • (always): length of input buffer and input buffer
  • (always): number of additional arguments (may be 0)
  • (when present): argument array (bounded by argument count)

Arguments are passed to the lua script as they appear in the rule:

 luaxform:./lua/lua-transform.lua, bytes 4, offset 13, hash sha256;

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:

function init (args)
    local needs = {}
    return needs
end

function transform(input_len, input, argc, args)
    SCLogNotice("Input length: " .. input_len .. " arg-count: " .. argc)
    for i = 1, argc do
        print("Argument " .. i .. ":", args[i])
    end
    return string.upper(input), input_len
end

return 0

Example rule using the lua script:

alert http any any -> any any (msg:"Lua Xform example"; flow:established;  file.data; luaxform:./lua/lua-transform.lua; content: "abc"; sid: 1;)

Link to ticket: https://redmine.openinfosecfoundation.org/issues/2290

Describe changes:

  • Luaxform transform changes

Updates

  • Fixed ASAN issues with unittests (discovered in CI).

Provide values to any of the below to override the defaults.

  • To use an LibHTP, Suricata-Verify or Suricata-Update pull request,
    link to the pull request in the respective _BRANCH variable.
  • Leave unused overrides blank or remove.

SV_REPO=
SV_BRANCH=OISF/suricata-verify#2044
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=

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.
@suricata-qa
Copy link

ERROR:
ERROR: ASAN TEST FAIL in ASAN_TLPR1_cfg QA test

ERROR: QA failed on ASAN_TLPR1_cfg.

Pipeline 22992

Copy link

codecov bot commented Oct 4, 2024

Codecov Report

Attention: Patch coverage is 77.21088% with 67 lines in your changes missing coverage. Please review.

Project coverage is 82.61%. Comparing base (3f0512e) to head (7fde97a).

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     
Flag Coverage Δ
fuzzcorpus 60.56% <28.17%> (-0.07%) ⬇️
livemode 18.72% <15.46%> (-0.13%) ⬇️
pcap 44.08% <18.55%> (-0.01%) ⬇️
suricata-verify 62.02% <76.63%> (+0.02%) ⬆️
unittests 58.89% <22.10%> (-0.04%) ⬇️

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

Fixup the macro usage to eliminate compiler warnings.
@suricata-qa
Copy link

Information: QA ran without warnings.

Pipeline 22993

Copy link
Contributor

@jufajardini jufajardini left a 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...

doc/userguide/configuration/suricata-yaml.rst Show resolved Hide resolved
doc/userguide/lua/lua-usage.rst Show resolved Hide resolved
doc/userguide/rules/transforms.rst Show resolved Hide resolved
doc/userguide/rules/transforms.rst Show resolved Hide resolved
Comment on lines +252 to +253
This transform allows a Lua script to apply a transformation
to a buffer.
Copy link
Contributor

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...

@jlucovsky jlucovsky marked this pull request as ready for review October 5, 2024 11:38
@jlucovsky
Copy link
Contributor Author

Continued in #11892

@jlucovsky jlucovsky closed this Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants