suricata
detect-http-cookie.c
Go to the documentation of this file.
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-helper.h"
53 #include "util-spm.h"
54 #include "util-print.h"
55 
56 #include "app-layer.h"
57 #include "app-layer-parser.h"
58 
59 #include "app-layer-htp.h"
60 #include "detect-http-cookie.h"
61 #include "stream-tcp.h"
62 
63 static int DetectHttpCookieSetup (DetectEngineCtx *, Signature *, const char *);
64 static int DetectHttpCookieSetupSticky (DetectEngineCtx *, Signature *, const char *);
65 #ifdef UNITTESTS
66 static void DetectHttpCookieRegisterTests(void);
67 #endif
68 static int g_http_cookie_buffer_id = 0;
69 static int g_http2_thread_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 {
90  /* http_cookie content modifier */
91  sigmatch_table[DETECT_HTTP_COOKIE_CM].name = "http_cookie";
92  sigmatch_table[DETECT_HTTP_COOKIE_CM].desc =
93  "content modifier to match only on the HTTP cookie-buffer";
94  sigmatch_table[DETECT_HTTP_COOKIE_CM].url = "/rules/http-keywords.html#http-cookie";
95  sigmatch_table[DETECT_HTTP_COOKIE_CM].Setup = DetectHttpCookieSetup;
96 #ifdef UNITTESTS
97  sigmatch_table[DETECT_HTTP_COOKIE_CM].RegisterTests = DetectHttpCookieRegisterTests;
98 #endif
99  sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_NOOPT;
100  sigmatch_table[DETECT_HTTP_COOKIE_CM].flags |= SIGMATCH_INFO_CONTENT_MODIFIER;
101  sigmatch_table[DETECT_HTTP_COOKIE_CM].alternative = DETECT_HTTP_COOKIE;
102 
103  /* http.cookie sticky buffer */
104  sigmatch_table[DETECT_HTTP_COOKIE].name = "http.cookie";
105  sigmatch_table[DETECT_HTTP_COOKIE].desc = "sticky buffer to match on the HTTP Cookie/Set-Cookie buffers";
106  sigmatch_table[DETECT_HTTP_COOKIE].url = "/rules/http-keywords.html#http-cookie";
107  sigmatch_table[DETECT_HTTP_COOKIE].Setup = DetectHttpCookieSetupSticky;
108  sigmatch_table[DETECT_HTTP_COOKIE].flags |= SIGMATCH_NOOPT;
109  sigmatch_table[DETECT_HTTP_COOKIE].flags |= SIGMATCH_INFO_STICKY_BUFFER;
110 
111  DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,
112  HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetRequestData);
113  DetectAppLayerInspectEngineRegister("http_cookie", ALPROTO_HTTP1, SIG_FLAG_TOCLIENT,
114  HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetResponseData);
115 
116  DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,
117  GetRequestData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);
118  DetectAppLayerMpmRegister("http_cookie", SIG_FLAG_TOCLIENT, 2, PrefilterGenericMpmRegister,
119  GetResponseData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);
120 
121  DetectAppLayerInspectEngineRegisterSubState("http_cookie", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,
122  HTTP2TxTypeStream, HTTP2ProgHeaders, DetectEngineInspectBufferGeneric, GetRequestData2);
123  DetectAppLayerInspectEngineRegisterSubState("http_cookie", ALPROTO_HTTP2, SIG_FLAG_TOCLIENT,
124  HTTP2TxTypeStream, HTTP2ProgHeaders, DetectEngineInspectBufferGeneric,
125  GetResponseData2);
126 
127  DetectAppLayerMpmRegisterSubState("http_cookie", SIG_FLAG_TOSERVER, 2,
128  PrefilterGenericMpmRegister, GetRequestData2, ALPROTO_HTTP2, HTTP2TxTypeStream,
129  HTTP2ProgHeaders);
130  DetectAppLayerMpmRegisterSubState("http_cookie", SIG_FLAG_TOCLIENT, 2,
131  PrefilterGenericMpmRegister, GetResponseData2, ALPROTO_HTTP2, HTTP2TxTypeStream,
132  HTTP2ProgHeaders);
133 
134  DetectBufferTypeSetDescriptionByName("http_cookie",
135  "http cookie header");
136 
137  g_http2_thread_id = SCDetectRegisterThreadCtxGlobalFuncs(
138  "http_cookie", SCDetectThreadBufDataInit, NULL, SCDetectThreadBufDataFree);
139 
140  g_http_cookie_buffer_id = DetectBufferTypeGetByName("http_cookie");
141 }
142 
143 /**
144  * \brief this function setups the http_cookie modifier keyword used in the rule
145  *
146  * \param de_ctx Pointer to the Detection Engine Context
147  * \param s Pointer to the Signature to which the current keyword belongs
148  * \param str Should hold an empty string always
149  *
150  * \retval 0 On success
151  * \retval -1 On failure
152  */
153 
154 static int DetectHttpCookieSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
155 {
156  return DetectEngineContentModifierBufferSetup(
157  de_ctx, s, str, DETECT_HTTP_COOKIE_CM, g_http_cookie_buffer_id, ALPROTO_HTTP1);
158 }
159 
160 /**
161  * \brief this function setup the http.cookie keyword used in the rule
162  *
163  * \param de_ctx Pointer to the Detection Engine Context
164  * \param s Pointer to the Signature to which the current keyword belongs
165  * \param str Should hold an empty string always
166  *
167  * \retval 0 On success
168  */
169 static int DetectHttpCookieSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
170 {
171  if (SCDetectBufferSetActiveList(de_ctx, s, g_http_cookie_buffer_id) < 0)
172  return -1;
173 
174  if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
175  return -1;
176 
177  return 0;
178 }
179 
180 static InspectionBuffer *GetRequestData(DetectEngineThreadCtx *det_ctx,
181  const DetectEngineTransforms *transforms, Flow *_f,
182  const uint8_t _flow_flags, void *txv, const int list_id)
183 {
184  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
185  if (buffer->inspect == NULL) {
186  htp_tx_t *tx = (htp_tx_t *)txv;
187 
188  if (htp_tx_request_headers(tx) == NULL)
189  return NULL;
190 
191  const htp_header_t *h = htp_tx_request_header(tx, "Cookie");
192  if (h == NULL || htp_header_value(h) == NULL) {
193  SCLogDebug("HTTP cookie header not present in this request");
194  return NULL;
195  }
196 
197  const uint32_t data_len = (uint32_t)htp_header_value_len(h);
198  const uint8_t *data = htp_header_value_ptr(h);
199 
200  SCInspectionBufferSetupAndApplyTransforms(
201  det_ctx, list_id, buffer, data, data_len, transforms);
202  }
203 
204  return buffer;
205 }
206 
207 static InspectionBuffer *GetResponseData(DetectEngineThreadCtx *det_ctx,
208  const DetectEngineTransforms *transforms, Flow *_f,
209  const uint8_t _flow_flags, void *txv, const int list_id)
210 {
211  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
212  if (buffer->inspect == NULL) {
213  htp_tx_t *tx = (htp_tx_t *)txv;
214 
215  if (htp_tx_response_headers(tx) == NULL)
216  return NULL;
217 
218  const htp_header_t *h = htp_tx_response_header(tx, "Set-Cookie");
219  if (h == NULL || htp_header_value(h) == NULL) {
220  SCLogDebug("HTTP cookie header not present in this request");
221  return NULL;
222  }
223 
224  const uint32_t data_len = (uint32_t)htp_header_value_len(h);
225  const uint8_t *data = htp_header_value_ptr(h);
226 
227  SCInspectionBufferSetupAndApplyTransforms(
228  det_ctx, list_id, buffer, data, data_len, transforms);
229  }
230 
231  return buffer;
232 }
233 
234 static InspectionBuffer *GetRequestData2(DetectEngineThreadCtx *det_ctx,
235  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
236  const int list_id)
237 {
238  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
239  if (buffer->inspect == NULL) {
240  uint32_t b_len = 0;
241  const uint8_t *b = NULL;
242 
243  void *thread_buf = SCDetectThreadCtxGetGlobalKeywordThreadCtx(det_ctx, g_http2_thread_id);
244  if (thread_buf == NULL)
245  return NULL;
246  if (SCHttp2TxGetCookie(txv, STREAM_TOSERVER, &b, &b_len, thread_buf) != 1)
247  return NULL;
248  if (b == NULL || b_len == 0)
249  return NULL;
250 
251  SCInspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
252  }
253 
254  return buffer;
255 }
256 
257 static InspectionBuffer *GetResponseData2(DetectEngineThreadCtx *det_ctx,
258  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
259  const int list_id)
260 {
261  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
262  if (buffer->inspect == NULL) {
263  uint32_t b_len = 0;
264  const uint8_t *b = NULL;
265 
266  void *thread_buf = SCDetectThreadCtxGetGlobalKeywordThreadCtx(det_ctx, g_http2_thread_id);
267  if (thread_buf == NULL)
268  return NULL;
269  if (SCHttp2TxGetCookie(txv, STREAM_TOCLIENT, &b, &b_len, thread_buf) != 1)
270  return NULL;
271  if (b == NULL || b_len == 0)
272  return NULL;
273 
274  SCInspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
275  }
276 
277  return buffer;
278 }
279 
280 /******************************** UNITESTS **********************************/
281 
282 #ifdef UNITTESTS
283 #include "tests/detect-http-cookie.c"
284 #endif /* UNITTESTS */
285 
286 /**
287  * @}
288  */
SigTableElmt_::url
const char * url
Definition: detect.h:1545
detect-content.h
detect-engine.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect-engine-register.h:308
SigTableElmt_::desc
const char * desc
Definition: detect.h:1544
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:78
DetectEngineInspectBufferGeneric
uint8_t DetectEngineInspectBufferGeneric(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags, void *alstate, void *txv, uint64_t tx_id)
Do the content inspection & validation for a signature.
Definition: detect-engine.c:2267
flow-util.h
SCInspectionBufferGet
InspectionBuffer * SCInspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine-inspect-buffer.c:56
SigTableElmt_::name
const char * name
Definition: detect.h:1542
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:395
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1533
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:282
SCDetectThreadCtxGetGlobalKeywordThreadCtx
void * SCDetectThreadCtxGetGlobalKeywordThreadCtx(DetectEngineThreadCtx *det_ctx, int id)
Retrieve thread local keyword ctx by id.
Definition: detect-engine.c:4097
InspectionBuffer
Definition: detect-engine-inspect-buffer.h:34
threads.h
Flow_
Flow data structure.
Definition: flow.h:359
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:995
SCInspectionBufferSetupAndApplyTransforms
void SCInspectionBufferSetupAndApplyTransforms(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len, const DetectEngineTransforms *transforms)
setup the buffer with our initial data
Definition: detect-engine-inspect-buffer.c:197
DETECT_HTTP_COOKIE_CM
@ DETECT_HTTP_COOKIE_CM
Definition: detect-engine-register.h:161
SCDetectBufferSetActiveList
int SCDetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine-buffer.c:29
SCDetectSignatureSetAppProto
int SCDetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:2613
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:275
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1524
detect-pcre.h
DetectAppLayerMpmRegisterSubState
void DetectAppLayerMpmRegisterSubState(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, uint8_t sub_state, uint8_t tx_min_progress)
Definition: detect-engine-mpm.c:167
detect-engine-prefilter.h
DetectAppLayerInspectEngineRegister
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, uint8_t progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
Registers an app inspection engine.
Definition: detect-engine.c:275
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1452
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:274
app-layer-htp.h
decode.h
util-debug.h
util-error.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:22
DetectEngineThreadCtx_
Definition: detect.h:1316
util-print.h
detect-engine-mpm.h
detect.h
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:1707
SigTableElmt_::alternative
uint16_t alternative
Definition: detect.h:1540
app-layer-parser.h
SIGMATCH_INFO_CONTENT_MODIFIER
#define SIGMATCH_INFO_CONTENT_MODIFIER
Definition: detect-engine-register.h:328
DetectEngineContentModifierBufferSetup
int DetectEngineContentModifierBufferSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg, int sm_type, int sm_list, AppProto alproto)
Definition: detect-parse.c:183
ALPROTO_HTTP2
@ ALPROTO_HTTP2
Definition: app-layer-protos.h:69
suricata-common.h
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:36
util-spm.h
DetectAppLayerMpmRegister
void DetectAppLayerMpmRegister(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, uint8_t tx_min_progress)
register an app layer keyword for mpm
Definition: detect-engine-mpm.c:159
detect-engine-buffer.h
DetectAppLayerInspectEngineRegisterSubState
void DetectAppLayerInspectEngineRegisterSubState(const char *name, AppProto alproto, uint32_t dir, uint8_t sub_state, uint8_t progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
register an app inspection engine for a tx type
Definition: detect-engine.c:298
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect-engine-inspect-buffer.h:35
str
#define str(s)
Definition: suricata-common.h:313
detect-parse.h
Signature_
Signature container.
Definition: detect.h:692
ALPROTO_HTTP
@ ALPROTO_HTTP
Definition: app-layer-protos.h:77
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect-engine-register.h:330
DETECT_HTTP_COOKIE
@ DETECT_HTTP_COOKIE
Definition: detect-engine-register.h:162
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1549
flow.h
SCDetectRegisterThreadCtxGlobalFuncs
int SCDetectRegisterThreadCtxGlobalFuncs(const char *name, void *(*InitFunc)(void *), void *data, void(*FreeFunc)(void *))
Register Thread keyword context Funcs (Global)
Definition: detect-engine.c:4053
flow-var.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1531
app-layer.h