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

Dataset set postmatch 5576 v15 #12230

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

catenacyber
Copy link
Contributor

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

Describe changes:

  • detect/dataset: delay set operation after signature full match

SV_BRANCH=OISF/suricata-verify#2093

#12196 more detailed git history

The design is :

  • detect: postmatch can run AppLayerTxMatch callbacks (in its own commit)
  • usage of delay_postmatch: buffers using dataset/set are put at the tail of inspections whatever their progress
  • usage of DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_BUF: dataset may return this new case to tell that ok we match on a multi-buffer, but we still want to try all occurrences of a multi-buffer (instead of returning a simple early match)

Will be useful for dataset, when it needs to find a transaction
buffer again.
Buffers can be put at the tail of inspections whatever their progress.

This will allow dataset/set to be inspected in the context of
the final packet matching or not, and thus use the ephemeral
data from DetectThreadCtxGetKeywordThreadCtx
DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_BUF is the new return status
to allow dataset/set to pick all matching and only the matching
buffers in case of a multi-buffer
The set operation of dataset keyword was done even if signature
did not fully match, which is not the expected behavior.
We want dataset to behave like flowbits for instance.

This patch changes the behavior of the dataset keyword to do a
match and a post match for the set operation.
The postmatch retrieves the data, using the list identifier
associated to the buffer for this signature.

This avoids to store the buffer(s), when we do not have a
dedicated storage (per signature and per tx) that can own
and clean arbitrary buffers over multiple packets, in
the case the transaction spans over multiple packets
with different tx progresses for instance.

Thanks to delay_postmatch, the callback DetectDatasetTxMatch
should be called on the last packet taking the final match
decision. At this point, the inspection buffers are cached
and easy to get.
The most complex case is for multi-buffers, where we need
to know which buffers/local_ids matched. We use the ephemeral
storage (lives with one packet detection) provided by
DetectThreadCtxGetKeywordThreadCtx

For multi-buffers, we also return DETECT_ENGINE_INSPECT_SIG_MATCH_MORE_BUF
to indicate that we want to know all the instances which match.

Ticket: OISF#5576
Copy link

codecov bot commented Dec 5, 2024

Codecov Report

Attention: Patch coverage is 88.23529% with 20 lines in your changes missing coverage. Please review.

Project coverage is 83.19%. Comparing base (09ba69c) to head (316ce29).

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #12230    +/-   ##
========================================
  Coverage   83.19%   83.19%            
========================================
  Files         912      912            
  Lines      257166   257297   +131     
========================================
+ Hits       213938   214059   +121     
- Misses      43228    43238    +10     
Flag Coverage Δ
fuzzcorpus 61.02% <77.05%> (+0.01%) ⬆️
livemode 19.47% <43.52%> (+0.06%) ⬆️
pcap 44.40% <18.82%> (+<0.01%) ⬆️
suricata-verify 62.80% <88.23%> (+0.02%) ⬆️
unittests 59.17% <18.23%> (-0.02%) ⬇️

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

@suricata-qa
Copy link

Information: QA ran without warnings.

Pipeline 23687

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.

2 participants