Lua packetlib/v2 #12512
Open
Lua packetlib/v2 #12512
+300
−174
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
Example:
```
local packet = require "suricata.packet"
function init (args)
local needs = {}
return needs
end
function match (args)
p = packet.get()
payload = p:payload()
ts = p:timestring()
for line in payload:gmatch("([^\r\n]*)[\r\n]+") do
if line == "GET /index.html HTTP/1.0" then
ipver, srcip, dstip, proto, sp, dp = p:tuple()
SCLogNotice(string.format("%s %s->%s %d->%d (pcap_cnt:%d) match! %s", ts, srcip, dstip, sp, dp, p:pcap_cnt(), line));
return 1
end
end
return 0
end
```
Methods:
`get` creates the packet object.
`payload` returns the packet payload as a buffer
`packet` returns the whole packet (includes headers)
`pcap_cnt` returns the `pcap_cnt` (pcap file mode only)
`tuple` returns various fields: srcip, dstip, proto, sp, dp
`timestamp` returns time as 2 numbers: seconds and microseconds
`timestring` returns a timestamp as a string
Ticket: OISF#7488.
Moving forward the packetlib is to be used. Ticket: OISF#7488.
Register internal libs for the case where loading external modules is allowed.
Closed
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #12512 +/- ##
=======================================
Coverage 80.56% 80.57%
=======================================
Files 925 926 +1
Lines 259292 259333 +41
=======================================
+ Hits 208906 208947 +41
Misses 50386 50386
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 24450 |
jasonish
reviewed
Jan 30, 2025
| } | ||
|
|
||
| char timebuf[64]; | ||
| CreateTimeString(s->p->ts, timebuf, sizeof(timebuf)); |
There was a problem hiding this comment.
I think for a new API it would be really nice to generate a stanard timestring.. So instead of
YYYY/MM/DD-HH:mm:ss.ssssss
we should do:
YYYY-MM-DDTHH:mm:ss.ssssssZ
If needed, add a _legacy variant for the old one. Or timestamp_rfc3339 for this new one, and some other specifier for the legacy format?
jasonish
reviewed
Jan 30, 2025
Comment on lines
+234
to
+254
| static const luaL_Reg packetlib[] = { | ||
| // clang-format off | ||
| { "get", LuaPacketGet }, | ||
| { NULL, NULL } | ||
| // clang-format on | ||
| }; | ||
|
|
||
| static const luaL_Reg packetlib_meta[] = { | ||
| // clang-format off | ||
| { "packet", LuaPacketPacket }, | ||
| { "payload", LuaPacketPayload }, | ||
| { "pcap_cnt", LuaPacketPcapCnt }, | ||
| { "timestring", LuaPacketTimestring }, | ||
| { "timestamp", LuaPacketTimestamp }, | ||
| { "tuple", LuaPacketTuple }, | ||
| { "sp", LuaPacketSport }, | ||
| { "dp", LuaPacketDport }, | ||
| { "__gc", LuaPacketGC }, | ||
| { NULL, NULL } | ||
| // clang-format on | ||
| }; |
There was a problem hiding this comment.
Otherwise API looks OK to me. Time for docs :)
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.
SV_BRANCH=OISF/suricata-verify#2267
https://redmine.openinfosecfoundation.org/issues/7488
#12506 with fixes.
Docs are still a todo.