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.

Sign up for GitHub

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

Jump to bottom

[draft] flow callbacks, thread callbacks, user thread storage; ndpi stub plugin - v2 #11942

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

[draft] flow callbacks, thread callbacks, user thread storage; ndpi stub plugin - v2 #11942

wants to merge 4 commits into from
+750 −7

Conversation

jasonish
Copy link
Member

Previous PR: #11935

Add features required for implementing something like nDPI as a plugin, includes:

  • flow init callback
  • flow update callback
  • flow finish callback
  • thread storage (based on flow storage)
  • thread init callback

Still needs:

  • eve log hook

@jasonish
flow: add callbacks for flow init and flow updates
785ffc0 
Adds user registerable callbacks for flow initialization, flow
update and flow finish.

Some plugins, such as other DPI libraries like nDPI need a way to hook
into these flow lifecycle events.

Ticket: OISF#7319
Ticket: OISF#7320
@jasonish jasonish mentioned this pull request Oct 11, 2024
Closed
@codecov Codecov
Copy link

codecov bot commented Oct 11, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 64.00000% with 63 lines in your changes missing coverage. Please review.

Project coverage is 82.73%. Comparing base (58556b7) to head (d061138).

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #11942      +/-   ##
==========================================
- Coverage   82.74%   82.73%   -0.02%     
==========================================
  Files         912      915       +3     
  Lines      249102   249273     +171     
==========================================
+ Hits       206117   206229     +112     
- Misses      42985    43044      +59
Flag Coverage Δ
fuzzcorpus 60.77% <15.73%> (+0.05%) ⬆️
livemode 18.84% <19.10%> (-0.02%) ⬇️
pcap 43.84% <21.34%> (-0.27%) ⬇️
suricata-verify 62.14% <21.34%> (-0.04%) ⬇️
unittests 58.99% <57.14%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

@jasonish
threads: add storage api, based on thread storage
eeab764
@jasonish
threads: add initialization callbacks
a9c3874 
For library users and plugins that need to hook into the thread life
cycle, perhaps to initialize some thread storage.
@jasonish
plugins/ndpi: stub in dummy ndpi plugin
d061138 
This plugin stub shows how a plugin like nDPI might be use the flow
init and flow update callbacks to do its work. Also shows usage of
FlowStorage to avoid modifying the Flow struct directly.
@jasonish jasonish mentioned this pull request Oct 11, 2024
Draft
@suricata-qa
Copy link

Information: QA ran without warnings.

Pipeline 23090

@suricata-qa
Copy link

Information: QA ran without warnings.

Pipeline 23093

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@victorjulien victorjulien Awaiting requested review from victorjulien victorjulien will be requested when the pull request is marked ready for review victorjulien is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jasonish @suricata-qa