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

OISF / suricata / 22586342403

02 Mar 2026 04:53PM UTC coverage: 73.68% (-0.007%) from 73.687%
22586342403

Pull #14930

github

web-flow
Merge 1d6dc53fc into 90823fa90
Pull Request #14930: Sslproxy/v16

38328 of 77468 branches covered (49.48%)

Branch coverage included in aggregate %.

336 of 431 new or added lines in 14 files covered. (77.96%)

66 existing lines in 15 files now uncovered.

265724 of 335196 relevant lines covered (79.27%)

5207223.13 hits per line

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

80.13
/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
{
2,191✔
90
    /* http_cookie content modifier */
91
    sigmatch_table[DETECT_HTTP_COOKIE_CM].name = "http_cookie";
2,191✔
92
    sigmatch_table[DETECT_HTTP_COOKIE_CM].desc =
2,191✔
93
            "content modifier to match only on the HTTP cookie-buffer";
2,191✔
94
    sigmatch_table[DETECT_HTTP_COOKIE_CM].url = "/rules/http-keywords.html#http-cookie";
2,191✔
95
    sigmatch_table[DETECT_HTTP_COOKIE_CM].Setup = DetectHttpCookieSetup;
2,191✔
96
#ifdef UNITTESTS
3✔
97
    sigmatch_table[DETECT_HTTP_COOKIE_CM].RegisterTests = DetectHttpCookieRegisterTests;
3✔
98
#endif
3✔
99
    sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_NOOPT;
2,191✔
100
    sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_INFO_CONTENT_MODIFIER;
2,191✔
101
    sigmatch_table[DETECT_HTTP_COOKIE_CM].alternative = DETECT_HTTP_COOKIE;
2,191✔
102

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

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

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

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

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

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

134
    g_http_cookie_buffer_id = DetectBufferTypeGetByName("http_cookie");
2,191✔
135
}
2,191✔
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
{
177✔
150
    return DetectEngineContentModifierBufferSetup(
177✔
151
            de_ctx, s, str, DETECT_HTTP_COOKIE_CM, g_http_cookie_buffer_id, ALPROTO_HTTP1);
177✔
152
}
177✔
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
{
6,290✔
165
    if (SCDetectBufferSetActiveList(de_ctx, s, g_http_cookie_buffer_id) < 0)
6,290!
166
        return -1;
4✔
167

168
    if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
6,286!
169
        return -1;
109✔
170

171
    return 0;
6,177✔
172
}
6,286✔
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
{
2,988✔
178
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
2,988✔
179
    if (buffer->inspect == NULL) {
2,988✔
180
        htp_tx_t *tx = (htp_tx_t *)txv;
2,941✔
181

182
        if (htp_tx_request_headers(tx) == NULL)
2,941!
183
            return NULL;
×
184

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

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

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

198
    return buffer;
1,348✔
199
}
2,988✔
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)
204
{
2,239✔
205
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
2,239✔
206
    if (buffer->inspect == NULL) {
2,239!
207
        htp_tx_t *tx = (htp_tx_t *)txv;
2,237✔
208

209
        if (htp_tx_response_headers(tx) == NULL)
2,237!
210
            return NULL;
×
211

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

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

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

225
    return buffer;
152✔
226
}
2,239✔
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
{
989✔
232
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
989✔
233
    if (buffer->inspect == NULL) {
990✔
234
        uint32_t b_len = 0;
888✔
235
        const uint8_t *b = NULL;
888✔
236

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

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

245
    return buffer;
223✔
246
}
989✔
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
{
703✔
252
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
703✔
253
    if (buffer->inspect == NULL) {
703!
254
        uint32_t b_len = 0;
703✔
255
        const uint8_t *b = NULL;
703✔
256

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

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

UNCOV
265
    return buffer;
×
266
}
703✔
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