suricata
detect-http-stat-msg.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  * \author Anoop Saldanha <anoopsaldanha@gmail.com>
30  *
31  * Implements the http_stat_msg keyword
32  */
33 
34 #include "suricata-common.h"
35 #include "threads.h"
36 #include "decode.h"
37 #include "detect.h"
38 
39 #include "detect-parse.h"
40 #include "detect-engine.h"
41 #include "detect-engine-buffer.h"
42 #include "detect-content.h"
43 #include "detect-pcre.h"
44 #include "detect-engine-mpm.h"
45 #include "detect-engine-prefilter.h"
46 
47 #include "flow.h"
48 #include "flow-var.h"
49 #include "flow-util.h"
50 
51 #include "util-debug.h"
52 #include "util-error.h"
53 #include "util-unittest.h"
54 #include "util-unittest-helper.h"
55 #include "util-spm.h"
56 #include "util-print.h"
57 
58 #include "app-layer.h"
59 #include "app-layer-parser.h"
60 
61 #include "app-layer-htp.h"
62 #include "detect-http-stat-msg.h"
63 #include "stream-tcp-private.h"
64 #include "stream-tcp.h"
65 
66 static int DetectHttpStatMsgSetup(DetectEngineCtx *, Signature *, const char *);
67 #ifdef UNITTESTS
68 static void DetectHttpStatMsgRegisterTests(void);
69 #endif
70 static int g_http_stat_msg_buffer_id = 0;
71 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
72  const DetectEngineTransforms *transforms, Flow *_f,
73  const uint8_t _flow_flags, void *txv, const int list_id);
74 static int DetectHttpStatMsgSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str);
75 
76 static InspectionBuffer *GetData2(DetectEngineThreadCtx *det_ctx,
77  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
78  const int list_id)
79 {
80  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
81  if (buffer->inspect == NULL) {
82  InspectionBufferSetupAndApplyTransforms(
83  det_ctx, list_id, buffer, (const uint8_t *)"", 0, transforms);
84  }
85 
86  return buffer;
87 }
88 
89 /**
90  * \brief Registration function for keyword: http_stat_msg
91  */
92 void DetectHttpStatMsgRegister (void)
93 {
94  /* http_stat_msg content modifier */
95  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].name = "http_stat_msg";
96  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].desc =
97  "content modifier to match on HTTP stat-msg-buffer";
98  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].url = "/rules/http-keywords.html#http-stat-msg";
99  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].Setup = DetectHttpStatMsgSetup;
100 #ifdef UNITTESTS
101  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].RegisterTests = DetectHttpStatMsgRegisterTests;
102 #endif
103  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].flags |=
104  SIGMATCH_NOOPT | SIGMATCH_INFO_CONTENT_MODIFIER;
105  sigmatch_table[DETECT_HTTP_STAT_MSG_CM].alternative = DETECT_HTTP_STAT_MSG;
106 
107  /* http.stat_msg sticky buffer */
108  sigmatch_table[DETECT_HTTP_STAT_MSG].name = "http.stat_msg";
109  sigmatch_table[DETECT_HTTP_STAT_MSG].desc = "sticky buffer to match on the HTTP response status message";
110  sigmatch_table[DETECT_HTTP_STAT_MSG].url = "/rules/http-keywords.html#http-stat-msg";
111  sigmatch_table[DETECT_HTTP_STAT_MSG].Setup = DetectHttpStatMsgSetupSticky;
112  sigmatch_table[DETECT_HTTP_STAT_MSG].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_STICKY_BUFFER;
113 
114  DetectAppLayerInspectEngineRegister("http_stat_msg", ALPROTO_HTTP1, SIG_FLAG_TOCLIENT,
115  HTP_RESPONSE_PROGRESS_LINE, DetectEngineInspectBufferGeneric, GetData);
116 
117  DetectAppLayerMpmRegister("http_stat_msg", SIG_FLAG_TOCLIENT, 3, PrefilterGenericMpmRegister,
118  GetData, ALPROTO_HTTP1, HTP_RESPONSE_PROGRESS_LINE);
119 
120  DetectAppLayerInspectEngineRegister("http_stat_msg", ALPROTO_HTTP2, SIG_FLAG_TOCLIENT,
121  HTTP2StateDataServer, DetectEngineInspectBufferGeneric, GetData2);
122  DetectAppLayerMpmRegister("http_stat_msg", SIG_FLAG_TOCLIENT, 2, PrefilterGenericMpmRegister,
123  GetData2, ALPROTO_HTTP2, HTTP2StateDataServer);
124 
125  DetectBufferTypeSetDescriptionByName("http_stat_msg",
126  "http response status message");
127 
128  g_http_stat_msg_buffer_id = DetectBufferTypeGetByName("http_stat_msg");
129 }
130 
131 /**
132  * \brief this function setups the http_stat_msg modifier keyword used in the rule
133  *
134  * \param de_ctx Pointer to the Detection Engine Context
135  * \param s Pointer to the Signature to which the current keyword belongs
136  * \param str Should hold an empty string always
137  *
138  * \retval 0 On success
139  * \retval -1 On failure
140  */
141 
142 static int DetectHttpStatMsgSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)
143 {
144  return DetectEngineContentModifierBufferSetup(
145  de_ctx, s, arg, DETECT_HTTP_STAT_MSG_CM, g_http_stat_msg_buffer_id, ALPROTO_HTTP1);
146 }
147 
148 /**
149  * \brief this function setup the http.stat_msg keyword used in the rule
150  *
151  * \param de_ctx Pointer to the Detection Engine Context
152  * \param s Pointer to the Signature to which the current keyword belongs
153  * \param str Should hold an empty string always
154  *
155  * \retval 0 On success
156  */
157 static int DetectHttpStatMsgSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
158 {
159  if (SCDetectBufferSetActiveList(de_ctx, s, g_http_stat_msg_buffer_id) < 0)
160  return -1;
161  if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
162  return -1;
163  return 0;
164 }
165 
166 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
167  const DetectEngineTransforms *transforms, Flow *_f,
168  const uint8_t _flow_flags, void *txv, const int list_id)
169 {
170  SCEnter();
171 
172  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
173  if (buffer->inspect == NULL) {
174  htp_tx_t *tx = (htp_tx_t *)txv;
175 
176  if (htp_tx_response_message(tx) == NULL)
177  return NULL;
178 
179  const uint32_t data_len = (uint32_t)bstr_len(htp_tx_response_message(tx));
180  const uint8_t *data = bstr_ptr(htp_tx_response_message(tx));
181 
182  InspectionBufferSetupAndApplyTransforms(
183  det_ctx, list_id, buffer, data, data_len, transforms);
184  }
185 
186  return buffer;
187 }
188 
189 #ifdef UNITTESTS
190 #include "tests/detect-http-stat-msg.c"
191 #endif /* UNITTESTS */
192 
193 /**
194  * @}
195  */
SigTableElmt_::url
const char * url
Definition: detect.h:1462
detect-content.h
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1676
SigTableElmt_::desc
const char * desc
Definition: detect.h:1461
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
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:2057
flow-util.h
SIGMATCH_INFO_CONTENT_MODIFIER
#define SIGMATCH_INFO_CONTENT_MODIFIER
Definition: detect.h:1674
SigTableElmt_::name
const char * name
Definition: detect.h:1459
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:391
DetectHttpStatMsgRegisterTests
void DetectHttpStatMsgRegisterTests(void)
Register the UNITTESTS for the http_stat_msg keyword.
Definition: detect-http-stat-msg.c:2173
InspectionBuffer
Definition: detect-engine-inspect-buffer.h:34
threads.h
Flow_
Flow data structure.
Definition: flow.h:356
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1450
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:932
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:2229
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:272
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine-inspect-buffer.c:56
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1441
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1277
DETECT_HTTP_STAT_MSG
@ DETECT_HTTP_STAT_MSG
Definition: detect-engine-register.h:179
app-layer-htp.h
decode.h
util-debug.h
util-error.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEngineThreadCtx_
Definition: detect.h:1244
util-print.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:277
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:1584
SigTableElmt_::alternative
uint16_t alternative
Definition: detect.h:1457
DetectAppLayerMpmRegister
void DetectAppLayerMpmRegister(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register an app layer keyword for mpm
Definition: detect-engine-mpm.c:152
app-layer-parser.h
DetectEngineContentModifierBufferSetup
int DetectEngineContentModifierBufferSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg, int sm_type, int sm_list, AppProto alproto)
Definition: detect-parse.c:146
stream-tcp-private.h
ALPROTO_HTTP2
@ ALPROTO_HTTP2
Definition: app-layer-protos.h:69
detect-http-stat-msg.c
suricata-common.h
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:36
util-spm.h
detect-engine-buffer.h
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect-engine-inspect-buffer.h:35
str
#define str(s)
Definition: suricata-common.h:308
detect-parse.h
Signature_
Signature container.
Definition: detect.h:668
ALPROTO_HTTP
@ ALPROTO_HTTP
Definition: app-layer-protos.h:76
InspectionBufferSetupAndApplyTransforms
void InspectionBufferSetupAndApplyTransforms(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
DetectHttpStatMsgRegister
void DetectHttpStatMsgRegister(void)
Registration function for keyword: http_stat_msg.
Definition: detect-http-stat-msg.c:92
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1651
DetectAppLayerInspectEngineRegister
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
Registers an app inspection engine.
Definition: detect-engine.c:272
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1374
flow.h
flow-var.h
detect-http-stat-msg.h
DETECT_HTTP_STAT_MSG_CM
@ DETECT_HTTP_STAT_MSG_CM
Definition: detect-engine-register.h:178
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1448
app-layer.h