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-content.h"
42 #include "detect-pcre.h"
43 #include "detect-engine-mpm.h"
44 #include "detect-engine-prefilter.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-stat-msg.h"
62 #include "stream-tcp-private.h"
63 #include "stream-tcp.h"
64 
65 static int DetectHttpStatMsgSetup(DetectEngineCtx *, Signature *, const char *);
66 #ifdef UNITTESTS
67 static void DetectHttpStatMsgRegisterTests(void);
68 #endif
69 static int g_http_stat_msg_buffer_id = 0;
70 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
71  const DetectEngineTransforms *transforms, Flow *_f,
72  const uint8_t _flow_flags, void *txv, const int list_id);
73 static int DetectHttpStatMsgSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str);
74 
75 static InspectionBuffer *GetData2(DetectEngineThreadCtx *det_ctx,
76  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
77  const int list_id)
78 {
79  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
80  if (buffer->inspect == NULL) {
81  InspectionBufferSetup(det_ctx, list_id, buffer, (const uint8_t *)"", 0);
82  InspectionBufferApplyTransforms(buffer, transforms);
83  }
84 
85  return buffer;
86 }
87 
88 /**
89  * \brief Registration function for keyword: http_stat_msg
90  */
91 void DetectHttpStatMsgRegister (void)
92 {
93  /* http_stat_msg content modifier */
94  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].name = "http_stat_msg";
95  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].desc = "content modifier to match on HTTP stat-msg-buffer";
96  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].url = "/rules/http-keywords.html#http-stat-msg";
97  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].Setup = DetectHttpStatMsgSetup;
98 #ifdef UNITTESTS
99  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].RegisterTests = DetectHttpStatMsgRegisterTests;
100 #endif
101  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_CONTENT_MODIFIER;
102  sigmatch_table[DETECT_AL_HTTP_STAT_MSG].alternative = DETECT_HTTP_STAT_MSG;
103 
104  /* http.stat_msg sticky buffer */
105  sigmatch_table[DETECT_HTTP_STAT_MSG].name = "http.stat_msg";
106  sigmatch_table[DETECT_HTTP_STAT_MSG].desc = "sticky buffer to match on the HTTP response status message";
107  sigmatch_table[DETECT_HTTP_STAT_MSG].url = "/rules/http-keywords.html#http-stat-msg";
108  sigmatch_table[DETECT_HTTP_STAT_MSG].Setup = DetectHttpStatMsgSetupSticky;
109  sigmatch_table[DETECT_HTTP_STAT_MSG].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_STICKY_BUFFER;
110 
111  DetectAppLayerInspectEngineRegister2("http_stat_msg", ALPROTO_HTTP1, SIG_FLAG_TOCLIENT,
112  HTP_RESPONSE_LINE, DetectEngineInspectBufferGeneric, GetData);
113 
114  DetectAppLayerMpmRegister2("http_stat_msg", SIG_FLAG_TOCLIENT, 3, PrefilterGenericMpmRegister,
115  GetData, ALPROTO_HTTP1, HTP_RESPONSE_LINE);
116 
117  DetectAppLayerInspectEngineRegister2("http_stat_msg", ALPROTO_HTTP2, SIG_FLAG_TOCLIENT,
118  HTTP2StateDataServer, DetectEngineInspectBufferGeneric, GetData2);
119  DetectAppLayerMpmRegister2("http_stat_msg", SIG_FLAG_TOCLIENT, 2, PrefilterGenericMpmRegister,
120  GetData2, ALPROTO_HTTP2, HTTP2StateDataServer);
121 
122  DetectBufferTypeSetDescriptionByName("http_stat_msg",
123  "http response status message");
124 
125  g_http_stat_msg_buffer_id = DetectBufferTypeGetByName("http_stat_msg");
126 }
127 
128 /**
129  * \brief this function setups the http_stat_msg modifier keyword used in the rule
130  *
131  * \param de_ctx Pointer to the Detection Engine Context
132  * \param s Pointer to the Signature to which the current keyword belongs
133  * \param str Should hold an empty string always
134  *
135  * \retval 0 On success
136  * \retval -1 On failure
137  */
138 
139 static int DetectHttpStatMsgSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)
140 {
141  return DetectEngineContentModifierBufferSetup(
142  de_ctx, s, arg, DETECT_AL_HTTP_STAT_MSG, g_http_stat_msg_buffer_id, ALPROTO_HTTP1);
143 }
144 
145 /**
146  * \brief this function setup the http.stat_msg keyword used in the rule
147  *
148  * \param de_ctx Pointer to the Detection Engine Context
149  * \param s Pointer to the Signature to which the current keyword belongs
150  * \param str Should hold an empty string always
151  *
152  * \retval 0 On success
153  */
154 static int DetectHttpStatMsgSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
155 {
156  if (DetectBufferSetActiveList(de_ctx, s, g_http_stat_msg_buffer_id) < 0)
157  return -1;
158  if (DetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
159  return -1;
160  return 0;
161 }
162 
163 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
164  const DetectEngineTransforms *transforms, Flow *_f,
165  const uint8_t _flow_flags, void *txv, const int list_id)
166 {
167  SCEnter();
168 
169  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
170  if (buffer->inspect == NULL) {
171  htp_tx_t *tx = (htp_tx_t *)txv;
172 
173  if (tx->response_message == NULL)
174  return NULL;
175 
176  const uint32_t data_len = bstr_len(tx->response_message);
177  const uint8_t *data = bstr_ptr(tx->response_message);
178 
179  InspectionBufferSetup(det_ctx, list_id, buffer, data, data_len);
180  InspectionBufferApplyTransforms(buffer, transforms);
181  }
182 
183  return buffer;
184 }
185 
186 #ifdef UNITTESTS
187 #include "tests/detect-http-stat-msg.c"
188 #endif /* UNITTESTS */
189 
190 /**
191  * @}
192  */
SigTableElmt_::url
const char * url
Definition: detect.h:1287
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1703
detect-content.h
detect-engine.h
DetectAppLayerMpmRegister2
void DetectAppLayerMpmRegister2(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register a MPM engine
Definition: detect-engine-mpm.c:89
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1490
SigTableElmt_::desc
const char * desc
Definition: detect.h:1286
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:2165
flow-util.h
SIGMATCH_INFO_CONTENT_MODIFIER
#define SIGMATCH_INFO_CONTENT_MODIFIER
Definition: detect.h:1488
SigTableElmt_::name
const char * name
Definition: detect.h:1284
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:399
DetectHttpStatMsgRegisterTests
void DetectHttpStatMsgRegisterTests(void)
Register the UNITTESTS for the http_stat_msg keyword.
Definition: detect-http-stat-msg.c:2173
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1387
InspectionBuffer
Definition: detect.h:364
threads.h
Flow_
Flow data structure.
Definition: flow.h:347
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1278
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:826
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:256
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1269
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1526
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1124
DETECT_HTTP_STAT_MSG
@ DETECT_HTTP_STAT_MSG
Definition: detect-engine-register.h:155
app-layer-htp.h
decode.h
util-debug.h
util-error.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1074
util-print.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
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:745
SigTableElmt_::alternative
uint16_t alternative
Definition: detect.h:1282
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:207
stream-tcp-private.h
DetectAppLayerInspectEngineRegister2
void DetectAppLayerInspectEngineRegister2(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr2 Callback2, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
Definition: detect-engine.c:216
ALPROTO_HTTP2
@ ALPROTO_HTTP2
Definition: app-layer-protos.h:61
detect-http-stat-msg.c
suricata-common.h
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1725
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:30
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:129
util-spm.h
DETECT_AL_HTTP_STAT_MSG
@ DETECT_AL_HTTP_STAT_MSG
Definition: detect-engine-register.h:154
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:365
str
#define str(s)
Definition: suricata-common.h:286
InspectionBufferSetup
void InspectionBufferSetup(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1621
detect-parse.h
Signature_
Signature container.
Definition: detect.h:581
ALPROTO_HTTP
@ ALPROTO_HTTP
Definition: app-layer-protos.h:66
DetectHttpStatMsgRegister
void DetectHttpStatMsgRegister(void)
Registration function for keyword: http_stat_msg.
Definition: detect-http-stat-msg.c:91
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1466
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1221
flow.h
flow-var.h
detect-http-stat-msg.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1276
app-layer.h