• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

OISF / suricata / 23374838686

21 Mar 2026 07:29AM UTC coverage: 59.341% (-20.0%) from 79.315%
23374838686

Pull #15075

github

web-flow
Merge 90b4e834f into 6587e363a
Pull Request #15075: Stack 8001 v16.4

38 of 70 new or added lines in 10 files covered. (54.29%)

34165 existing lines in 563 files now uncovered.

119621 of 201584 relevant lines covered (59.34%)

650666.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.65
/src/detect-engine-frame.c
1
/* Copyright (C) 2021-2023 Open Information Security Foundation
2
 *
3
 * You can copy, redistribute or modify this Program under the terms of
4
 * the GNU General Public License version 2 as published by the Free
5
 * Software Foundation.
6
 *
7
 * This program is distributed in the hope that it will be useful,
8
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 * GNU General Public License for more details.
11
 *
12
 * You should have received a copy of the GNU General Public License
13
 * version 2 along with this program; if not, write to the Free Software
14
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15
 * 02110-1301, USA.
16
 */
17

18
/**
19
 * \file
20
 *
21
 * \author Victor Julien <victor@inliniac.net>
22
 *
23
 */
24

25
#include "suricata-common.h"
26
#include "suricata.h"
27

28
#include "app-layer-parser.h"
29
#include "rust.h"
30
#include "app-layer-frames.h"
31

32
#include "detect-engine.h"
33
#include "detect-engine-prefilter.h"
34
#include "detect-engine-content-inspection.h"
35
#include "detect-engine-mpm.h"
36
#include "detect-engine-frame.h"
37

38
#include "stream-tcp.h"
39

40
#include "util-profiling.h"
41
#include "util-validate.h"
42
#include "util-print.h"
43

44
struct FrameStreamData {
45
    // shared between prefilter and inspect
46
    DetectEngineThreadCtx *det_ctx;
47
    const DetectEngineTransforms *transforms;
48
    const Frame *frame;
49
    int list_id;
50
    uint32_t idx; /**< multi buffer idx, incremented for each stream chunk */
51

52
    // inspection only
53
    const DetectEngineFrameInspectionEngine *inspect_engine;
54
    const Signature *s;
55
    int inspect_result; // DETECT_ENGINE_INSPECT_SIG_MATCH / DETECT_ENGINE_INSPECT_SIG_NO_MATCH
56
    Packet *p;
57

58
    // prefilter only
59
    const MpmCtx *mpm_ctx;
60

61
    uint64_t requested_stream_offset;
62
};
63

64
static bool SetupStreamCallbackData(struct FrameStreamData *dst, const TcpSession *ssn,
65
        const TcpStream *stream, DetectEngineThreadCtx *det_ctx,
66
        const DetectEngineTransforms *transforms, const Frames *_frames, const Frame *frame,
67
        const int list_id, const bool eof);
68

69
static bool BufferSetup(struct FrameStreamData *fsd, InspectionBuffer *buffer, const uint8_t *input,
70
        const uint32_t input_len, const uint64_t input_offset);
71
static void BufferSetupUdp(DetectEngineThreadCtx *det_ctx, InspectionBuffer *buffer,
72
        const Frame *frame, const Packet *p, const DetectEngineTransforms *transforms);
73

74
void DetectRunPrefilterFrame(DetectEngineThreadCtx *det_ctx, const SigGroupHead *sgh, Packet *p,
75
        const Frames *frames, const Frame *frame, const AppProto alproto)
76
{
833,625✔
77
    SCLogDebug("pcap_cnt %" PRIu64, PcapPacketCntGet(p));
833,625✔
78
    PrefilterEngine *engine = sgh->frame_engines;
833,625✔
79
    do {
1,079,659✔
80
        if ((engine->alproto == alproto || engine->alproto == ALPROTO_UNKNOWN) &&
1,079,659✔
81
                (engine->ctx.frame_type == frame->type ||
1,079,659✔
82
                        engine->ctx.frame_type == FRAME_ANY_TYPE)) {
867,676✔
83
            SCLogDebug("frame %p engine %p", frame, engine);
285,637✔
84
            PREFILTER_PROFILING_START(det_ctx);
285,637✔
85
            engine->cb.PrefilterFrame(det_ctx, engine->pectx, p, frames, frame);
285,637✔
86
            PREFILTER_PROFILING_END(det_ctx, engine->gid);
285,637✔
87
        }
285,637✔
88
        if (engine->is_last)
1,079,659✔
89
            break;
833,625✔
90
        engine++;
246,034✔
91
    } while (1);
246,034✔
92
}
833,625✔
93

94
/* generic mpm for frame engines */
95

96
// TODO same as Generic?
97
typedef struct PrefilterMpmFrameCtx {
98
    int list_id;
99
    const MpmCtx *mpm_ctx;
100
    const DetectEngineTransforms *transforms;
101
} PrefilterMpmFrameCtx;
102

103
static int FrameStreamDataPrefilterFunc(
104
        void *cb_data, const uint8_t *input, const uint32_t input_len, const uint64_t input_offset)
105
{
197,059✔
106
    struct FrameStreamData *fsd = cb_data;
197,059✔
107
    SCLogDebug("prefilter: fsd %p { det_ctx:%p, transforms:%p, frame:%p, list_id:%d, idx:%u, "
197,059✔
108
               "data_offset:%" PRIu64 "}, input: %p, input_len:%u, input_offset:%" PRIu64,
197,059✔
109
            fsd, fsd->det_ctx, fsd->transforms, fsd->frame, fsd->list_id, fsd->idx,
197,059✔
110
            fsd->requested_stream_offset, input, input_len, input_offset);
197,059✔
111
    // PrintRawDataFp(stdout, input, input_len);
112

113
    InspectionBuffer *buffer =
197,059✔
114
            InspectionBufferMultipleForListGet(fsd->det_ctx, fsd->list_id, fsd->idx++);
197,059✔
115
    if (buffer == NULL) {
197,059✔
116
        return 0;
×
117
    }
×
118
    SCLogDebug("buffer %p idx %u", buffer, fsd->idx);
197,059✔
119

120
    const int more_chunks = BufferSetup(fsd, buffer, input, input_len, input_offset);
197,059✔
121

122
    const uint32_t data_len = buffer->inspect_len;
197,059✔
123
    const uint8_t *data = buffer->inspect;
197,059✔
124
    DetectEngineThreadCtx *det_ctx = fsd->det_ctx;
197,059✔
125
    const MpmCtx *mpm_ctx = fsd->mpm_ctx;
197,059✔
126

127
    if (data != NULL && data_len >= mpm_ctx->minlen) {
197,059✔
128
        // PrintRawDataFp(stdout, data, data_len);
129

130
        (void)mpm_table[mpm_ctx->mpm_type].Search(
8,024✔
131
                mpm_ctx, &det_ctx->mtc, &det_ctx->pmq, data, data_len);
8,024✔
132
        SCLogDebug("det_ctx->pmq.rule_id_array_cnt %u", det_ctx->pmq.rule_id_array_cnt);
8,024✔
133
        PREFILTER_PROFILING_ADD_BYTES(det_ctx, data_len);
8,024✔
134
    }
8,024✔
135
    return more_chunks;
197,059✔
136
}
197,059✔
137

138
/** \brief Generic Mpm prefilter callback
139
 *
140
 *  \param det_ctx detection engine thread ctx
141
 *  \param frames container for the frames
142
 *  \param frame frame to inspect
143
 *  \param pectx inspection context
144
 */
145
static void PrefilterMpmFrame(DetectEngineThreadCtx *det_ctx, const void *pectx, Packet *p,
146
        const Frames *frames, const Frame *frame)
147
{
202,964✔
148
    SCEnter();
202,964✔
149

150
    const PrefilterMpmFrameCtx *ctx = (const PrefilterMpmFrameCtx *)pectx;
202,964✔
151
    const MpmCtx *mpm_ctx = ctx->mpm_ctx;
202,964✔
152

153
    SCLogDebug("packet:%" PRIu64 ", prefilter running on list %d -> frame field type %u",
202,964✔
154
            PcapPacketCntGet(p), ctx->list_id, frame->type);
202,964✔
155
    if (p->proto == IPPROTO_UDP) {
202,964✔
156
        // TODO can we use single here? Could it conflict with TCP?
157
        InspectionBuffer *buffer = InspectionBufferMultipleForListGet(det_ctx, ctx->list_id, 0);
498✔
158
        if (buffer == NULL)
498✔
159
            return;
×
160
        DEBUG_VALIDATE_BUG_ON(frame->offset >= p->payload_len);
498✔
161
        if (frame->offset >= p->payload_len)
498✔
162
            return;
×
163

164
        BufferSetupUdp(det_ctx, buffer, frame, p, ctx->transforms);
498✔
165
        const uint32_t data_len = buffer->inspect_len;
498✔
166
        const uint8_t *data = buffer->inspect;
498✔
167

168
        // PrintRawDataFp(stdout, data, data_len);
169

170
        if (data != NULL && data_len >= mpm_ctx->minlen) {
498✔
171
            (void)mpm_table[mpm_ctx->mpm_type].Search(
497✔
172
                    mpm_ctx, &det_ctx->mtc, &det_ctx->pmq, data, data_len);
497✔
173
            SCLogDebug("det_ctx->pmq.rule_id_array_cnt %u", det_ctx->pmq.rule_id_array_cnt);
497✔
174
            PREFILTER_PROFILING_ADD_BYTES(det_ctx, data_len);
497✔
175
        }
497✔
176
    } else if (p->proto == IPPROTO_TCP) {
202,466✔
177
        DEBUG_VALIDATE_BUG_ON(p->flow->protoctx == NULL);
202,466✔
178
        TcpSession *ssn = p->flow->protoctx;
202,466✔
179
        TcpStream *stream;
202,466✔
180
        if (PKT_IS_TOSERVER(p)) {
202,466✔
181
            stream = &ssn->client;
126,652✔
182
        } else {
126,652✔
183
            stream = &ssn->server;
75,814✔
184
        }
75,814✔
185
        const bool eof = ssn->state == TCP_CLOSED || PKT_IS_PSEUDOPKT(p);
202,466✔
186

187
        struct FrameStreamData fsd;
202,466✔
188
        memset(&fsd, 0, sizeof(fsd));
202,466✔
189
        fsd.mpm_ctx = mpm_ctx;
202,466✔
190

191
        if (SetupStreamCallbackData(&fsd, ssn, stream, det_ctx, ctx->transforms, frames, frame,
202,466✔
192
                    ctx->list_id, eof)) {
202,466✔
193
            StreamReassembleForFrame(ssn, stream, FrameStreamDataPrefilterFunc, &fsd,
146,508✔
194
                    fsd.requested_stream_offset, eof);
146,508✔
195
        }
146,508✔
196
    } else {
202,466✔
197
        DEBUG_VALIDATE_BUG_ON(1);
×
198
    }
×
199
    SCLogDebug("packet:%" PRIu64
202,964✔
200
               ", prefilter done running on list %d -> frame field type %u; have %u matches",
202,964✔
201
            PcapPacketCntGet(p), ctx->list_id, frame->type, det_ctx->pmq.rule_id_array_cnt);
202,964✔
202
}
202,964✔
203

204
static void PrefilterMpmFrameFree(void *ptr)
205
{
7,219✔
206
    SCFree(ptr);
7,219✔
207
}
7,219✔
208

209
int PrefilterGenericMpmFrameRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx,
210
        const DetectBufferMpmRegistry *mpm_reg, int list_id)
211
{
7,219✔
212
    SCEnter();
7,219✔
213
    PrefilterMpmFrameCtx *pectx = SCCalloc(1, sizeof(*pectx));
7,219✔
214
    if (pectx == NULL)
7,219✔
215
        return -1;
×
216
    pectx->list_id = list_id;
7,219✔
217
    BUG_ON(mpm_reg->frame_v1.alproto == ALPROTO_UNKNOWN);
7,219✔
218
    pectx->mpm_ctx = mpm_ctx;
7,219✔
219
    pectx->transforms = &mpm_reg->transforms;
7,219✔
220

221
    int r = PrefilterAppendFrameEngine(de_ctx, sgh, PrefilterMpmFrame, mpm_reg->frame_v1.alproto,
7,219✔
222
            mpm_reg->frame_v1.type, pectx, PrefilterMpmFrameFree, mpm_reg->pname);
7,219✔
223
    if (r != 0) {
7,219✔
224
        SCFree(pectx);
×
225
    }
×
226
    return r;
7,219✔
227
}
7,219✔
228

229
bool DetectRunFrameInspectRule(ThreadVars *tv, DetectEngineThreadCtx *det_ctx, const Signature *s,
230
        Flow *f, Packet *p, const Frames *frames, const Frame *frame)
231
{
28,281✔
232
    DEBUG_VALIDATE_BUG_ON(s->frame_inspect == NULL);
28,281✔
233

234
    SCLogDebug("inspecting rule %u against frame %p/%" PRIi64 "/%s", s->id, frame, frame->id,
28,281✔
235
            AppLayerParserGetFrameNameById(f->proto, f->alproto, frame->type));
28,281✔
236

237
    for (DetectEngineFrameInspectionEngine *e = s->frame_inspect; e != NULL; e = e->next) {
55,019✔
238
        if (frame->type == e->type) {
28,456✔
239
            // TODO check alproto, direction?
240

241
            // TODO there should be only one inspect engine for this frame, ever?
242

243
            if (e->v1.Callback(det_ctx, e, s, p, frames, frame)) {
28,456✔
244
                SCLogDebug("sid %u: e %p Callback returned true", s->id, e);
1,718✔
245
                return true;
1,718✔
246
            }
1,718✔
247
            SCLogDebug("sid %u: e %p Callback returned false", s->id, e);
26,738✔
248
        } else {
26,738✔
249
            SCLogDebug(
×
250
                    "sid %u: e %p not for frame type %u (want %u)", s->id, e, frame->type, e->type);
×
251
        }
×
252
    }
28,456✔
253
    return false;
26,563✔
254
}
28,281✔
255

256
static void BufferSetupUdp(DetectEngineThreadCtx *det_ctx, InspectionBuffer *buffer,
257
        const Frame *frame, const Packet *p, const DetectEngineTransforms *transforms)
258
{
498✔
259
    uint8_t ci_flags = DETECT_CI_FLAGS_START;
498✔
260
    uint32_t frame_len;
498✔
261
    if (frame->len == -1) {
498✔
262
        frame_len = (uint32_t)(p->payload_len - frame->offset);
×
263
    } else {
498✔
264
        frame_len = (uint32_t)frame->len;
498✔
265
    }
498✔
266
    if (frame->offset + frame_len > p->payload_len) {
498✔
267
        frame_len = (uint32_t)(p->payload_len - frame->offset);
×
268
    } else {
498✔
269
        ci_flags |= DETECT_CI_FLAGS_END;
498✔
270
    }
498✔
271
    const uint8_t *data = p->payload + frame->offset;
498✔
272
    const uint32_t data_len = frame_len;
498✔
273

274
    SCLogDebug("packet %" PRIu64 " -> frame %p/%" PRIi64 "/%s offset %" PRIu64
498✔
275
               " type %u len %" PRIi64,
498✔
276
            PcapPacketCntGet(p), frame, frame->id,
498✔
277
            AppLayerParserGetFrameNameById(p->flow->proto, p->flow->alproto, frame->type),
498✔
278
            frame->offset, frame->type, frame->len);
498✔
279

280
    InspectionBufferSetupMulti(det_ctx, buffer, transforms, data, data_len);
498✔
281
    buffer->inspect_offset = 0;
498✔
282
    buffer->flags = ci_flags;
498✔
283
}
498✔
284

285
/** \internal
286
 *  \brief setup buffer based on frame in UDP payload
287
 */
288
static int DetectFrameInspectUdp(DetectEngineThreadCtx *det_ctx,
289
        const DetectEngineFrameInspectionEngine *engine, const Signature *s,
290
        const DetectEngineTransforms *transforms, Packet *p, const Frames *_frames,
291
        const Frame *frame, const int list_id)
292
{
402✔
293
    SCLogDebug("packet:%" PRIu64 ", inspect: s:%p s->id:%u, transforms:%p", PcapPacketCntGet(p), s,
402✔
294
            s->id, transforms);
402✔
295

296
    // TODO can we use single here? Could it conflict with TCP?
297
    InspectionBuffer *buffer = InspectionBufferMultipleForListGet(det_ctx, list_id, 0);
402✔
298
    if (buffer == NULL)
402✔
299
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
×
300

301
    DEBUG_VALIDATE_BUG_ON(frame->offset >= p->payload_len);
402✔
302
    if (frame->offset >= p->payload_len)
402✔
303
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
×
304

305
    if (!buffer->initialized)
402✔
306
        BufferSetupUdp(det_ctx, buffer, frame, p, transforms);
×
307
    DEBUG_VALIDATE_BUG_ON(!buffer->initialized);
402✔
308
    if (buffer->inspect == NULL)
402✔
309
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
×
310

311
    const bool match = DetectEngineContentInspection(det_ctx->de_ctx, det_ctx, s, engine->smd, p,
402✔
312
            p->flow, buffer->inspect, buffer->inspect_len, 0, buffer->flags,
402✔
313
            DETECT_ENGINE_CONTENT_INSPECTION_MODE_FRAME);
402✔
314
    if (match) {
402✔
315
        SCLogDebug("match!");
397✔
316
        return DETECT_ENGINE_INSPECT_SIG_MATCH;
397✔
317
    } else {
397✔
318
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
5✔
319
    }
5✔
320
}
402✔
321

322
/**
323
 *  \retval bool true if callback should run again */
324
static bool BufferSetup(struct FrameStreamData *fsd, InspectionBuffer *buffer, const uint8_t *input,
325
        const uint32_t input_len, const uint64_t input_offset)
326
{
224,308✔
327
    const Frame *frame = fsd->frame;
224,308✔
328
    /* so: relative to start of stream */
329
    const uint64_t so_input_re = input_offset + input_len;
224,308✔
330
    const uint64_t so_frame_re =
224,308✔
331
            frame->offset + (uint64_t)frame->len; // TODO if eof, set to available data?
224,308✔
332
    SCLogDebug("frame offset:%" PRIu64, frame->offset);
224,308✔
333
    const uint8_t *data = input;
224,308✔
334
    uint8_t ci_flags = 0;
224,308✔
335
    uint32_t data_len;
224,308✔
336

337
    /* fo: frame offset; offset relative to start of the frame */
338
    uint64_t fo_inspect_offset = 0;
224,308✔
339

340
    if (frame->offset == 0 && input_offset == 0) {
224,308✔
341
        ci_flags |= DETECT_CI_FLAGS_START;
269✔
342
        SCLogDebug("have frame data start");
269✔
343

344
        if (frame->len >= 0) {
269✔
345
            data_len = MIN(input_len, (uint32_t)frame->len);
233✔
346
            if (data_len == frame->len) {
233✔
347
                ci_flags |= DETECT_CI_FLAGS_END;
179✔
348
                SCLogDebug("have frame data end");
179✔
349
            }
179✔
350
        } else {
233✔
351
            data_len = input_len;
36✔
352
        }
36✔
353
    } else {
224,039✔
354
        const uint64_t so_frame_inspect_offset = frame->inspect_progress + frame->offset;
224,039✔
355
        const uint64_t so_inspect_offset = MAX(input_offset, so_frame_inspect_offset);
224,039✔
356
        fo_inspect_offset = so_inspect_offset - frame->offset;
224,039✔
357

358
        if (frame->offset >= input_offset) {
224,039✔
359
            ci_flags |= DETECT_CI_FLAGS_START;
8,385✔
360
            SCLogDebug("have frame data start");
8,385✔
361
        }
8,385✔
362
        if (frame->len >= 0) {
224,039✔
363
            if (fo_inspect_offset >= (uint64_t)frame->len) {
223,890✔
364
                SCLogDebug("data entirely past frame (%" PRIu64 " > %" PRIi64 ")",
215,345✔
365
                        fo_inspect_offset, frame->len);
215,345✔
366
                InspectionBufferSetupMultiEmpty(buffer);
215,345✔
367
                return false;
215,345✔
368
            }
215,345✔
369

370
            /* in: relative to start of input data */
371
            DEBUG_VALIDATE_BUG_ON(so_inspect_offset < input_offset);
8,545✔
372
            DEBUG_VALIDATE_BUG_ON(so_inspect_offset - input_offset > UINT32_MAX);
8,545✔
373
            const uint32_t in_data_offset = (uint32_t)(so_inspect_offset - input_offset);
8,545✔
374
            data += in_data_offset;
8,545✔
375

376
            uint32_t in_data_excess = 0;
8,545✔
377
            if (so_input_re >= so_frame_re) {
8,545✔
378
                ci_flags |= DETECT_CI_FLAGS_END;
8,363✔
379
                SCLogDebug("have frame data end");
8,363✔
380
                DEBUG_VALIDATE_BUG_ON(so_input_re - so_frame_re > UINT32_MAX);
8,363✔
381
                in_data_excess = (uint32_t)(so_input_re - so_frame_re);
8,363✔
382
            }
8,363✔
383
            data_len = input_len - in_data_offset - in_data_excess;
8,545✔
384
        } else {
8,545✔
385
            /* in: relative to start of input data */
386
            DEBUG_VALIDATE_BUG_ON(so_inspect_offset < input_offset);
149✔
387
            DEBUG_VALIDATE_BUG_ON(so_inspect_offset - input_offset > UINT32_MAX);
149✔
388
            const uint32_t in_data_offset = (uint32_t)(so_inspect_offset - input_offset);
149✔
389
            data += in_data_offset;
149✔
390
            data_len = input_len - in_data_offset;
149✔
391
        }
149✔
392
    }
224,039✔
393
    // PrintRawDataFp(stdout, data, data_len);
394
    SCLogDebug("fsd->transforms %p", fsd->transforms);
8,963✔
395
    InspectionBufferSetupMulti(fsd->det_ctx, buffer, fsd->transforms, data, data_len);
8,963✔
396
    SCLogDebug("inspect_offset %" PRIu64, fo_inspect_offset);
8,963✔
397
    buffer->inspect_offset = fo_inspect_offset;
8,963✔
398
    buffer->flags = ci_flags;
8,963✔
399

400
    if (frame->len >= 0 && so_input_re >= so_frame_re) {
8,963✔
401
        SCLogDebug("have the full frame, we can set progress accordingly (%" PRIu64 " > %" PRIu64
8,542✔
402
                   ")",
8,542✔
403
                so_input_re, so_frame_re);
8,542✔
404
        fsd->det_ctx->frame_inspect_progress =
8,542✔
405
                MAX(fo_inspect_offset + data_len, fsd->det_ctx->frame_inspect_progress);
8,542✔
406
    } else {
8,542✔
407
        fsd->det_ctx->frame_inspect_progress =
421✔
408
                MAX(fo_inspect_offset + data_len, fsd->det_ctx->frame_inspect_progress);
421✔
409
        /* in IPS mode keep a sliding window */
410
        const bool ips = StreamTcpInlineMode();
421✔
411
        if (ips) {
421✔
UNCOV
412
            if (fsd->det_ctx->frame_inspect_progress < 2500)
×
UNCOV
413
                fsd->det_ctx->frame_inspect_progress = 0;
×
UNCOV
414
            else
×
UNCOV
415
                fsd->det_ctx->frame_inspect_progress -= 2500;
×
UNCOV
416
        }
×
417
        SCLogDebug("ips %s inspect_progress %" PRIu64, BOOL2STR(ips),
421✔
418
                fsd->det_ctx->frame_inspect_progress);
421✔
419
    }
421✔
420

421
    /* keep going as long as there is possibly still data for this frame */
422
    const bool ret = (frame->len >= 0 && so_input_re >= so_frame_re);
8,963✔
423
    SCLogDebug("buffer set up, more to do: %s", BOOL2STR(ret));
8,963✔
424
    return ret;
8,963✔
425
}
224,308✔
426

427
static int FrameStreamDataInspectFunc(
428
        void *cb_data, const uint8_t *input, const uint32_t input_len, const uint64_t input_offset)
429
{
28,082✔
430
    struct FrameStreamData *fsd = cb_data;
28,082✔
431
    SCLogDebug("inspect: fsd %p { det_ctx:%p, transforms:%p, s:%p, s->id:%u, frame:%p, list_id:%d, "
28,082✔
432
               "idx:%u, "
28,082✔
433
               "requested_stream_offset:%" PRIu64
28,082✔
434
               "}, input: %p, input_len:%u, input_offset:%" PRIu64,
28,082✔
435
            fsd, fsd->det_ctx, fsd->transforms, fsd->s, fsd->s->id, fsd->frame, fsd->list_id,
28,082✔
436
            fsd->idx, fsd->requested_stream_offset, input, input_len, input_offset);
28,082✔
437
    // PrintRawDataFp(stdout, input, input_len);
438

439
    InspectionBuffer *buffer =
28,082✔
440
            InspectionBufferMultipleForListGet(fsd->det_ctx, fsd->list_id, fsd->idx++);
28,082✔
441
    if (buffer == NULL) {
28,082✔
442
        return 0;
×
443
    }
×
444
    SCLogDebug("buffer %p idx %u", buffer, fsd->idx);
28,082✔
445

446
    /* if we've not done so already, set up the buffer */
447
    int more_chunks = 1;
28,082✔
448
    if (!buffer->initialized) {
28,082✔
449
        more_chunks = BufferSetup(fsd, buffer, input, input_len, input_offset);
27,249✔
450
    }
27,249✔
451
    DEBUG_VALIDATE_BUG_ON(!buffer->initialized);
28,082✔
452
    if (buffer->inspect == NULL) {
28,082✔
453
        return more_chunks;
26,463✔
454
    }
26,463✔
455

456
    const uint32_t data_len = buffer->inspect_len;
1,619✔
457
    const uint8_t *data = buffer->inspect;
1,619✔
458
    const uint64_t data_offset = buffer->inspect_offset;
1,619✔
459
    DetectEngineThreadCtx *det_ctx = fsd->det_ctx;
1,619✔
460

461
    const DetectEngineFrameInspectionEngine *engine = fsd->inspect_engine;
1,619✔
462
    const Signature *s = fsd->s;
1,619✔
463
    Packet *p = fsd->p;
1,619✔
464

465
#ifdef DEBUG
466
    const uint8_t ci_flags = buffer->flags;
467
    SCLogDebug("frame %p offset %" PRIu64 " type %u len %" PRIi64
468
               " ci_flags %02x (start:%s, end:%s)",
469
            fsd->frame, fsd->frame->offset, fsd->frame->type, fsd->frame->len, ci_flags,
470
            (ci_flags & DETECT_CI_FLAGS_START) ? "true" : "false",
471
            (ci_flags & DETECT_CI_FLAGS_END) ? "true" : "false");
472
    SCLogDebug("buffer %p offset %" PRIu64 " len %u ci_flags %02x (start:%s, end:%s)", buffer,
473
            buffer->inspect_offset, buffer->inspect_len, ci_flags,
474
            (ci_flags & DETECT_CI_FLAGS_START) ? "true" : "false",
475
            (ci_flags & DETECT_CI_FLAGS_END) ? "true" : "false");
476
    // PrintRawDataFp(stdout, data, data_len);
477
    // PrintRawDataFp(stdout, data, MIN(64, data_len));
478
#endif
479
    DEBUG_VALIDATE_BUG_ON(fsd->frame->len > 0 && (int64_t)data_len > fsd->frame->len);
1,619✔
480

481
    const bool match = DetectEngineContentInspection(det_ctx->de_ctx, det_ctx, s, engine->smd, p,
1,619✔
482
            p->flow, data, data_len, data_offset, buffer->flags,
1,619✔
483
            DETECT_ENGINE_CONTENT_INSPECTION_MODE_FRAME);
1,619✔
484
    if (match) {
1,619✔
485
        SCLogDebug("DETECT_ENGINE_INSPECT_SIG_MATCH");
1,321✔
486
        fsd->inspect_result = DETECT_ENGINE_INSPECT_SIG_MATCH;
1,321✔
487
    } else {
1,321✔
488
        SCLogDebug("DETECT_ENGINE_INSPECT_SIG_NO_MATCH");
298✔
489
    }
298✔
490
    return more_chunks;
1,619✔
491
}
28,082✔
492

493
static bool SetupStreamCallbackData(struct FrameStreamData *dst, const TcpSession *ssn,
494
        const TcpStream *stream, DetectEngineThreadCtx *det_ctx,
495
        const DetectEngineTransforms *transforms, const Frames *_frames, const Frame *frame,
496
        const int list_id, const bool eof)
497
{
230,520✔
498
    SCLogDebug("frame %" PRIi64 ", len %" PRIi64 ", offset %" PRIu64 ", inspect_progress %" PRIu64,
230,520✔
499
            frame->id, frame->len, frame->offset, frame->inspect_progress);
230,520✔
500

501
    const uint64_t frame_offset = frame->offset;
230,520✔
502
    const uint64_t usable = StreamDataRightEdge(stream, eof);
230,520✔
503
    if (usable <= frame_offset)
230,520✔
504
        return false;
12✔
505

506
    uint64_t want = frame->inspect_progress;
230,508✔
507
    if (frame->len == -1) {
230,508✔
508
        if (eof) {
56,108✔
509
            want = usable;
60✔
510
        } else {
56,048✔
511
            want += 2500;
56,048✔
512
        }
56,048✔
513
    } else {
174,400✔
514
        /* don't have the full frame yet */
515
        if (frame->offset + frame->len > usable) {
174,400✔
516
            want += 2500;
182✔
517
        } else {
174,218✔
518
            want = frame->offset + frame->len;
174,218✔
519
        }
174,218✔
520
    }
174,400✔
521

522
    const bool ips = StreamTcpInlineMode();
230,508✔
523

524
    const uint64_t have = usable;
230,508✔
525
    if (!ips && have < want) {
230,508✔
526
        SCLogDebug("wanted %" PRIu64 " bytes, got %" PRIu64, want, have);
56,008✔
527
        return false;
56,008✔
528
    }
56,008✔
529

530
    const uint64_t available_data = usable - STREAM_BASE_OFFSET(stream);
174,500✔
531
    SCLogDebug("check inspection for having 2500 bytes: %" PRIu64, available_data);
174,500✔
532
    if (!ips && !eof && available_data < 2500 &&
174,500✔
533
            (frame->len < 0 || frame->len > (int64_t)available_data)) {
174,500✔
534
        SCLogDebug("skip inspection until we have 2500 bytes (have %" PRIu64 ")", available_data);
×
535
        return false;
×
536
    }
×
537

538
    const uint64_t offset =
174,500✔
539
            MAX(STREAM_BASE_OFFSET(stream), frame->offset + frame->inspect_progress);
174,500✔
540

541
    dst->det_ctx = det_ctx;
174,500✔
542
    dst->transforms = transforms;
174,500✔
543
    dst->frame = frame;
174,500✔
544
    dst->list_id = list_id;
174,500✔
545
    dst->requested_stream_offset = offset;
174,500✔
546
    return true;
174,500✔
547
}
174,500✔
548

549
/**
550
 * \brief Do the content inspection & validation for a signature
551
 *
552
 * \param de_ctx Detection engine context
553
 * \param det_ctx Detection engine thread context
554
 * \param s Signature to inspect
555
 * \param p Packet
556
 * \param frame stream frame to inspect
557
 *
558
 * \retval 0 no match.
559
 * \retval 1 match.
560
 */
561
int DetectEngineInspectFrameBufferGeneric(DetectEngineThreadCtx *det_ctx,
562
        const DetectEngineFrameInspectionEngine *engine, const Signature *s, Packet *p,
563
        const Frames *frames, const Frame *frame)
564
{
28,456✔
565
    /* if prefilter didn't already run, we need to consider transformations */
566
    const DetectEngineTransforms *transforms = NULL;
28,456✔
567
    if (!engine->mpm) {
28,456✔
568
        transforms = engine->v1.transforms;
242✔
569
    }
242✔
570
    const int list_id = engine->sm_list;
28,456✔
571
    SCLogDebug("running inspect on %d", list_id);
28,456✔
572

573
    if (p->proto == IPPROTO_UDP) {
28,456✔
574
        return DetectFrameInspectUdp(det_ctx, engine, s, transforms, p, frames, frame, list_id);
402✔
575
    }
402✔
576
    DEBUG_VALIDATE_BUG_ON(p->proto != IPPROTO_TCP);
28,054✔
577

578
    SCLogDebug("packet:%" PRIu64 ", frame->id:%" PRIu64
28,054✔
579
               ", list:%d, transforms:%p, s:%p, s->id:%u, engine:%p",
28,054✔
580
            PcapPacketCntGet(p), frame->id, engine->sm_list, engine->v1.transforms, s, s->id,
28,054✔
581
            engine);
28,054✔
582

583
    DEBUG_VALIDATE_BUG_ON(p->flow->protoctx == NULL);
28,054✔
584
    TcpSession *ssn = p->flow->protoctx;
28,054✔
585
    TcpStream *stream;
28,054✔
586
    if (PKT_IS_TOSERVER(p)) {
28,054✔
587
        stream = &ssn->client;
27,731✔
588
    } else {
27,731✔
589
        stream = &ssn->server;
323✔
590
    }
323✔
591
    const bool eof = ssn->state == TCP_CLOSED || PKT_IS_PSEUDOPKT(p);
28,054✔
592

593
    struct FrameStreamData fsd;
28,054✔
594
    memset(&fsd, 0, sizeof(fsd));
28,054✔
595
    fsd.inspect_engine = engine;
28,054✔
596
    fsd.s = s;
28,054✔
597
    fsd.inspect_result = DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
28,054✔
598
    fsd.p = p;
28,054✔
599

600
    if (!SetupStreamCallbackData(
28,054✔
601
                &fsd, ssn, stream, det_ctx, transforms, frames, frame, list_id, eof)) {
28,054✔
602
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
62✔
603
    }
62✔
604
    StreamReassembleForFrame(
27,992✔
605
            ssn, stream, FrameStreamDataInspectFunc, &fsd, fsd.requested_stream_offset, eof);
27,992✔
606

607
    return fsd.inspect_result;
27,992✔
608
}
28,054✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc