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

OISF / suricata / 22550237931

01 Mar 2026 06:56PM UTC coverage: 64.812% (-8.9%) from 73.687%
22550237931

Pull #14920

github

web-flow
Merge e05854a6d into 90823fa90
Pull Request #14920: draft: rust based configuration file parser and loader - v4

561 of 789 new or added lines in 4 files covered. (71.1%)

23225 existing lines in 498 files now uncovered.

131605 of 203055 relevant lines covered (64.81%)

2328818.84 hits per line

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

76.85
/src/detect-http-cookie.c
1
/* Copyright (C) 2007-2018 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
 * \ingroup httplayer
20
 *
21
 * @{
22
 */
23

24

25
/**
26
 * \file
27
 *
28
 * \author Gurvinder Singh <gurvindersinghdahiya@gmail.com>
29
 *
30
 * Implements the http_cookie keyword
31
 */
32

33
#include "suricata-common.h"
34
#include "threads.h"
35
#include "decode.h"
36
#include "detect.h"
37

38
#include "detect-parse.h"
39
#include "detect-engine.h"
40
#include "detect-engine-buffer.h"
41
#include "detect-engine-mpm.h"
42
#include "detect-engine-prefilter.h"
43
#include "detect-content.h"
44
#include "detect-pcre.h"
45

46
#include "flow.h"
47
#include "flow-var.h"
48
#include "flow-util.h"
49

50
#include "util-debug.h"
51
#include "util-error.h"
52
#include "util-unittest.h"
53
#include "util-unittest-helper.h"
54
#include "util-spm.h"
55
#include "util-print.h"
56

57
#include "app-layer.h"
58
#include "app-layer-parser.h"
59

60
#include "app-layer-htp.h"
61
#include "detect-http-cookie.h"
62
#include "stream-tcp.h"
63

64
static int DetectHttpCookieSetup (DetectEngineCtx *, Signature *, const char *);
65
static int DetectHttpCookieSetupSticky (DetectEngineCtx *, Signature *, const char *);
66
#ifdef UNITTESTS
67
static void DetectHttpCookieRegisterTests(void);
68
#endif
69
static int g_http_cookie_buffer_id = 0;
70

71
static InspectionBuffer *GetRequestData(DetectEngineThreadCtx *det_ctx,
72
        const DetectEngineTransforms *transforms,
73
        Flow *_f, const uint8_t _flow_flags,
74
        void *txv, const int list_id);
75
static InspectionBuffer *GetResponseData(DetectEngineThreadCtx *det_ctx,
76
        const DetectEngineTransforms *transforms,
77
        Flow *_f, const uint8_t _flow_flags,
78
        void *txv, const int list_id);
79
static InspectionBuffer *GetRequestData2(DetectEngineThreadCtx *det_ctx,
80
        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
81
        const int list_id);
82
static InspectionBuffer *GetResponseData2(DetectEngineThreadCtx *det_ctx,
83
        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
84
        const int list_id);
85
/**
86
 * \brief Registration function for keyword: http_cookie
87
 */
88
void DetectHttpCookieRegister(void)
89
{
30✔
90
    /* http_cookie content modifier */
91
    sigmatch_table[DETECT_HTTP_COOKIE_CM].name = "http_cookie";
30✔
92
    sigmatch_table[DETECT_HTTP_COOKIE_CM].desc =
30✔
93
            "content modifier to match only on the HTTP cookie-buffer";
30✔
94
    sigmatch_table[DETECT_HTTP_COOKIE_CM].url = "/rules/http-keywords.html#http-cookie";
30✔
95
    sigmatch_table[DETECT_HTTP_COOKIE_CM].Setup = DetectHttpCookieSetup;
30✔
96
#ifdef UNITTESTS
97
    sigmatch_table[DETECT_HTTP_COOKIE_CM].RegisterTests = DetectHttpCookieRegisterTests;
98
#endif
99
    sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_NOOPT;
30✔
100
    sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_INFO_CONTENT_MODIFIER;
30✔
101
    sigmatch_table[DETECT_HTTP_COOKIE_CM].alternative = DETECT_HTTP_COOKIE;
30✔
102

103
    /* http.cookie sticky buffer */
104
    sigmatch_table[DETECT_HTTP_COOKIE].name = "http.cookie";
30✔
105
    sigmatch_table[DETECT_HTTP_COOKIE].desc = "sticky buffer to match on the HTTP Cookie/Set-Cookie buffers";
30✔
106
    sigmatch_table[DETECT_HTTP_COOKIE].url = "/rules/http-keywords.html#http-cookie";
30✔
107
    sigmatch_table[DETECT_HTTP_COOKIE].Setup = DetectHttpCookieSetupSticky;
30✔
108
    sigmatch_table[DETECT_HTTP_COOKIE].flags |= SIGMATCH_NOOPT;
30✔
109
    sigmatch_table[DETECT_HTTP_COOKIE].flags |= SIGMATCH_INFO_STICKY_BUFFER;
30✔
110

111
    DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,
30✔
112
            HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetRequestData);
30✔
113
    DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP1, SIG_FLAG_TOCLIENT,
30✔
114
            HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetResponseData);
30✔
115

116
    DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,
30✔
117
            GetRequestData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);
30✔
118
    DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOCLIENT, 2, PrefilterGenericMpmRegister,
30✔
119
            GetResponseData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);
30✔
120

121
    DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,
30✔
122
            HTTP2StateDataClient, DetectEngineInspectBufferGeneric, GetRequestData2);
30✔
123
    DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP2, SIG_FLAG_TOCLIENT,
30✔
124
            HTTP2StateDataServer, DetectEngineInspectBufferGeneric, GetResponseData2);
30✔
125

126
    DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,
30✔
127
            GetRequestData2, ALPROTO_HTTP2, HTTP2StateDataClient);
30✔
128
    DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOCLIENT, 2, PrefilterGenericMpmRegister,
30✔
129
            GetResponseData2, ALPROTO_HTTP2, HTTP2StateDataServer);
30✔
130

131
    DetectBufferTypeSetDescriptionByName("http_cookie",
30✔
132
            "http cookie header");
30✔
133

134
    g_http_cookie_buffer_id = DetectBufferTypeGetByName("http_cookie");
30✔
135
}
30✔
136

137
/**
138
 * \brief this function setups the http_cookie modifier keyword used in the rule
139
 *
140
 * \param de_ctx   Pointer to the Detection Engine Context
141
 * \param s        Pointer to the Signature to which the current keyword belongs
142
 * \param str      Should hold an empty string always
143
 *
144
 * \retval  0 On success
145
 * \retval -1 On failure
146
 */
147

148
static int DetectHttpCookieSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
149
{
70✔
150
    return DetectEngineContentModifierBufferSetup(
70✔
151
            de_ctx, s, str, DETECT_HTTP_COOKIE_CM, g_http_cookie_buffer_id, ALPROTO_HTTP1);
70✔
152
}
70✔
153

154
/**
155
 * \brief this function setup the http.cookie keyword used in the rule
156
 *
157
 * \param de_ctx   Pointer to the Detection Engine Context
158
 * \param s        Pointer to the Signature to which the current keyword belongs
159
 * \param str      Should hold an empty string always
160
 *
161
 * \retval 0       On success
162
 */
163
static int DetectHttpCookieSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
164
{
5,642✔
165
    if (SCDetectBufferSetActiveList(de_ctx, s, g_http_cookie_buffer_id) < 0)
5,642✔
166
        return -1;
4✔
167

168
    if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
5,638✔
169
        return -1;
109✔
170

171
    return 0;
5,529✔
172
}
5,638✔
173

174
static InspectionBuffer *GetRequestData(DetectEngineThreadCtx *det_ctx,
175
        const DetectEngineTransforms *transforms, Flow *_f,
176
        const uint8_t _flow_flags, void *txv, const int list_id)
177
{
425✔
178
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
425✔
179
    if (buffer->inspect == NULL) {
425✔
180
        htp_tx_t *tx = (htp_tx_t *)txv;
421✔
181

182
        if (htp_tx_request_headers(tx) == NULL)
421✔
183
            return NULL;
×
184

185
        const htp_header_t *h = htp_tx_request_header(tx, "Cookie");
421✔
186
        if (h == NULL || htp_header_value(h) == NULL) {
421✔
187
            SCLogDebug("HTTP cookie header not present in this request");
195✔
188
            return NULL;
195✔
189
        }
195✔
190

191
        const uint32_t data_len = (uint32_t)htp_header_value_len(h);
226✔
192
        const uint8_t *data = htp_header_value_ptr(h);
226✔
193

194
        InspectionBufferSetupAndApplyTransforms(
226✔
195
                det_ctx, list_id, buffer, data, data_len, transforms);
226✔
196
    }
226✔
197

198
    return buffer;
230✔
199
}
425✔
200

201
static InspectionBuffer *GetResponseData(DetectEngineThreadCtx *det_ctx,
202
        const DetectEngineTransforms *transforms, Flow *_f,
203
        const uint8_t _flow_flags, void *txv, const int list_id)
UNCOV
204
{
×
UNCOV
205
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
×
UNCOV
206
    if (buffer->inspect == NULL) {
×
UNCOV
207
        htp_tx_t *tx = (htp_tx_t *)txv;
×
208

UNCOV
209
        if (htp_tx_response_headers(tx) == NULL)
×
210
            return NULL;
×
211

UNCOV
212
        const htp_header_t *h = htp_tx_response_header(tx, "Set-Cookie");
×
UNCOV
213
        if (h == NULL || htp_header_value(h) == NULL) {
×
UNCOV
214
            SCLogDebug("HTTP cookie header not present in this request");
×
UNCOV
215
            return NULL;
×
UNCOV
216
        }
×
217

UNCOV
218
        const uint32_t data_len = (uint32_t)htp_header_value_len(h);
×
UNCOV
219
        const uint8_t *data = htp_header_value_ptr(h);
×
220

UNCOV
221
        InspectionBufferSetupAndApplyTransforms(
×
UNCOV
222
                det_ctx, list_id, buffer, data, data_len, transforms);
×
UNCOV
223
    }
×
224

UNCOV
225
    return buffer;
×
UNCOV
226
}
×
227

228
static InspectionBuffer *GetRequestData2(DetectEngineThreadCtx *det_ctx,
229
        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
230
        const int list_id)
231
{
804✔
232
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
804✔
233
    if (buffer->inspect == NULL) {
804✔
234
        uint32_t b_len = 0;
706✔
235
        const uint8_t *b = NULL;
706✔
236

237
        if (SCHttp2TxGetCookie(txv, STREAM_TOSERVER, &b, &b_len) != 1)
706✔
238
            return NULL;
597✔
239
        if (b == NULL || b_len == 0)
109✔
240
            return NULL;
×
241

242
        InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
109✔
243
    }
109✔
244

245
    return buffer;
207✔
246
}
804✔
247

248
static InspectionBuffer *GetResponseData2(DetectEngineThreadCtx *det_ctx,
249
        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
250
        const int list_id)
251
{
502✔
252
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
502✔
253
    if (buffer->inspect == NULL) {
502✔
254
        uint32_t b_len = 0;
502✔
255
        const uint8_t *b = NULL;
502✔
256

257
        if (SCHttp2TxGetCookie(txv, STREAM_TOCLIENT, &b, &b_len) != 1)
502✔
258
            return NULL;
502✔
UNCOV
259
        if (b == NULL || b_len == 0)
×
260
            return NULL;
×
261

UNCOV
262
        InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
×
UNCOV
263
    }
×
264

UNCOV
265
    return buffer;
×
266
}
502✔
267

268
/******************************** UNITESTS **********************************/
269

270
#ifdef UNITTESTS
271
#include "tests/detect-http-cookie.c"
272
#endif /* UNITTESTS */
273

274
/**
275
 * @}
276
 */
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