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

OISF / suricata / 22618661228

02 Mar 2026 09:33PM UTC coverage: 42.258% (-34.4%) from 76.611%
22618661228

push

github

victorjulien
github-actions: bump actions/download-artifact from 7.0.0 to 8.0.0

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 7.0.0 to 8.0.0.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/37930b1c2...70fc10c6e)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-version: 8.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

91511 of 216553 relevant lines covered (42.26%)

3416852.41 hits per line

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

0.0
/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
{
×
77
    SCLogDebug("pcap_cnt %" PRIu64, PcapPacketCntGet(p));
×
78
    PrefilterEngine *engine = sgh->frame_engines;
×
79
    do {
×
80
        if ((engine->alproto == alproto || engine->alproto == ALPROTO_UNKNOWN) &&
×
81
                (engine->ctx.frame_type == frame->type ||
×
82
                        engine->ctx.frame_type == FRAME_ANY_TYPE)) {
×
83
            SCLogDebug("frame %p engine %p", frame, engine);
×
84
            PREFILTER_PROFILING_START(det_ctx);
×
85
            engine->cb.PrefilterFrame(det_ctx, engine->pectx, p, frames, frame);
×
86
            PREFILTER_PROFILING_END(det_ctx, engine->gid);
×
87
        }
×
88
        if (engine->is_last)
×
89
            break;
×
90
        engine++;
×
91
    } while (1);
×
92
}
×
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
{
×
106
    struct FrameStreamData *fsd = cb_data;
×
107
    SCLogDebug("prefilter: fsd %p { det_ctx:%p, transforms:%p, frame:%p, list_id:%d, idx:%u, "
×
108
               "data_offset:%" PRIu64 "}, input: %p, input_len:%u, input_offset:%" PRIu64,
×
109
            fsd, fsd->det_ctx, fsd->transforms, fsd->frame, fsd->list_id, fsd->idx,
×
110
            fsd->requested_stream_offset, input, input_len, input_offset);
×
111
    // PrintRawDataFp(stdout, input, input_len);
112

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

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

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

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

130
        (void)mpm_table[mpm_ctx->mpm_type].Search(
×
131
                mpm_ctx, &det_ctx->mtc, &det_ctx->pmq, data, data_len);
×
132
        SCLogDebug("det_ctx->pmq.rule_id_array_cnt %u", det_ctx->pmq.rule_id_array_cnt);
×
133
        PREFILTER_PROFILING_ADD_BYTES(det_ctx, data_len);
×
134
    }
×
135
    return more_chunks;
×
136
}
×
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
{
×
148
    SCEnter();
×
149

150
    const PrefilterMpmFrameCtx *ctx = (const PrefilterMpmFrameCtx *)pectx;
×
151
    const MpmCtx *mpm_ctx = ctx->mpm_ctx;
×
152

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

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

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

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

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

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

204
static void PrefilterMpmFrameFree(void *ptr)
205
{
×
206
    SCFree(ptr);
×
207
}
×
208

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

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

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

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

237
    for (DetectEngineFrameInspectionEngine *e = s->frame_inspect; e != NULL; e = e->next) {
×
238
        if (frame->type == e->type) {
×
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)) {
×
244
                SCLogDebug("sid %u: e %p Callback returned true", s->id, e);
×
245
                return true;
×
246
            }
×
247
            SCLogDebug("sid %u: e %p Callback returned false", s->id, e);
×
248
        } else {
×
249
            SCLogDebug(
×
250
                    "sid %u: e %p not for frame type %u (want %u)", s->id, e, frame->type, e->type);
×
251
        }
×
252
    }
×
253
    return false;
×
254
}
×
255

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

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

280
    InspectionBufferSetupMulti(det_ctx, buffer, transforms, data, data_len);
×
281
    buffer->inspect_offset = 0;
×
282
    buffer->flags = ci_flags;
×
283
}
×
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
{
×
293
    SCLogDebug("packet:%" PRIu64 ", inspect: s:%p s->id:%u, transforms:%p", PcapPacketCntGet(p), s,
×
294
            s->id, transforms);
×
295

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

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

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

311
    const bool match = DetectEngineContentInspection(det_ctx->de_ctx, det_ctx, s, engine->smd, p,
×
312
            p->flow, buffer->inspect, buffer->inspect_len, 0, buffer->flags,
×
313
            DETECT_ENGINE_CONTENT_INSPECTION_MODE_FRAME);
×
314
    if (match) {
×
315
        SCLogDebug("match!");
×
316
        return DETECT_ENGINE_INSPECT_SIG_MATCH;
×
317
    } else {
×
318
        return DETECT_ENGINE_INSPECT_SIG_NO_MATCH;
×
319
    }
×
320
}
×
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
{
×
327
    const Frame *frame = fsd->frame;
×
328
    /* so: relative to start of stream */
329
    const uint64_t so_input_re = input_offset + input_len;
×
330
    const uint64_t so_frame_re =
×
331
            frame->offset + (uint64_t)frame->len; // TODO if eof, set to available data?
×
332
    SCLogDebug("frame offset:%" PRIu64, frame->offset);
×
333
    const uint8_t *data = input;
×
334
    uint8_t ci_flags = 0;
×
335
    uint32_t data_len;
×
336

337
    /* fo: frame offset; offset relative to start of the frame */
338
    uint64_t fo_inspect_offset = 0;
×
339

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

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

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

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

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

400
    if (frame->len >= 0 && so_input_re >= so_frame_re) {
×
401
        SCLogDebug("have the full frame, we can set progress accordingly (%" PRIu64 " > %" PRIu64
×
402
                   ")",
×
403
                so_input_re, so_frame_re);
×
404
        fsd->det_ctx->frame_inspect_progress =
×
405
                MAX(fo_inspect_offset + data_len, fsd->det_ctx->frame_inspect_progress);
×
406
    } else {
×
407
        fsd->det_ctx->frame_inspect_progress =
×
408
                MAX(fo_inspect_offset + data_len, fsd->det_ctx->frame_inspect_progress);
×
409
        /* in IPS mode keep a sliding window */
410
        const bool ips = StreamTcpInlineMode();
×
411
        if (ips) {
×
412
            if (fsd->det_ctx->frame_inspect_progress < 2500)
×
413
                fsd->det_ctx->frame_inspect_progress = 0;
×
414
            else
×
415
                fsd->det_ctx->frame_inspect_progress -= 2500;
×
416
        }
×
417
        SCLogDebug("ips %s inspect_progress %" PRIu64, BOOL2STR(ips),
×
418
                fsd->det_ctx->frame_inspect_progress);
×
419
    }
×
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);
×
423
    SCLogDebug("buffer set up, more to do: %s", BOOL2STR(ret));
×
424
    return ret;
×
425
}
×
426

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

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

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

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

461
    const DetectEngineFrameInspectionEngine *engine = fsd->inspect_engine;
×
462
    const Signature *s = fsd->s;
×
463
    Packet *p = fsd->p;
×
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);
×
480

481
    const bool match = DetectEngineContentInspection(det_ctx->de_ctx, det_ctx, s, engine->smd, p,
×
482
            p->flow, data, data_len, data_offset, buffer->flags,
×
483
            DETECT_ENGINE_CONTENT_INSPECTION_MODE_FRAME);
×
484
    if (match) {
×
485
        SCLogDebug("DETECT_ENGINE_INSPECT_SIG_MATCH");
×
486
        fsd->inspect_result = DETECT_ENGINE_INSPECT_SIG_MATCH;
×
487
    } else {
×
488
        SCLogDebug("DETECT_ENGINE_INSPECT_SIG_NO_MATCH");
×
489
    }
×
490
    return more_chunks;
×
491
}
×
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
{
×
498
    SCLogDebug("frame %" PRIi64 ", len %" PRIi64 ", offset %" PRIu64 ", inspect_progress %" PRIu64,
×
499
            frame->id, frame->len, frame->offset, frame->inspect_progress);
×
500

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

506
    uint64_t want = frame->inspect_progress;
×
507
    if (frame->len == -1) {
×
508
        if (eof) {
×
509
            want = usable;
×
510
        } else {
×
511
            want += 2500;
×
512
        }
×
513
    } else {
×
514
        /* don't have the full frame yet */
515
        if (frame->offset + frame->len > usable) {
×
516
            want += 2500;
×
517
        } else {
×
518
            want = frame->offset + frame->len;
×
519
        }
×
520
    }
×
521

522
    const bool ips = StreamTcpInlineMode();
×
523

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

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

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

541
    dst->det_ctx = det_ctx;
×
542
    dst->transforms = transforms;
×
543
    dst->frame = frame;
×
544
    dst->list_id = list_id;
×
545
    dst->requested_stream_offset = offset;
×
546
    return true;
×
547
}
×
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
{
×
565
    /* if prefilter didn't already run, we need to consider transformations */
566
    const DetectEngineTransforms *transforms = NULL;
×
567
    if (!engine->mpm) {
×
568
        transforms = engine->v1.transforms;
×
569
    }
×
570
    const int list_id = engine->sm_list;
×
571
    SCLogDebug("running inspect on %d", list_id);
×
572

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

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

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

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

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

607
    return fsd.inspect_result;
×
608
}
×
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