suricata
detect-http-request-line.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 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 Victor Julien <victor@inliniac.net>
29  *
30  * Implements support for the http_request_line keyword.
31  */
32 
33 #include "suricata-common.h"
34 #include "threads.h"
35 #include "decode.h"
36 
37 #include "detect.h"
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-state.h"
43 #include "detect-engine-prefilter.h"
44 #include "detect-engine-content-inspection.h"
45 #include "detect-content.h"
46 #include "detect-pcre.h"
47 
48 #include "flow.h"
49 #include "flow-var.h"
50 #include "flow-util.h"
51 
52 #include "util-debug.h"
53 #include "util-unittest.h"
54 #include "util-unittest-helper.h"
55 #include "util-spm.h"
56 
57 #include "app-layer.h"
58 #include "app-layer-parser.h"
59 
60 #include "app-layer-htp.h"
61 #include "stream-tcp.h"
62 #include "detect-http-request-line.h"
63 
64 static int DetectHttpRequestLineSetup(DetectEngineCtx *, Signature *, const char *);
65 #ifdef UNITTESTS
66 static void DetectHttpRequestLineRegisterTests(void);
67 #endif
68 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
69  const DetectEngineTransforms *transforms,
70  Flow *_f, const uint8_t _flow_flags,
71  void *txv, const int list_id);
72 static int g_http_request_line_buffer_id = 0;
73 
74 static InspectionBuffer *GetData2(DetectEngineThreadCtx *det_ctx,
75  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
76  const int list_id)
77 {
78  SCEnter();
79 
80  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
81  if (buffer->inspect == NULL) {
82  uint32_t b_len = 0;
83  const uint8_t *b = NULL;
84 
85  if (SCHttp2TxGetRequestLine(txv, &b, &b_len) != 1)
86  return NULL;
87  if (b == NULL || b_len == 0)
88  return NULL;
89 
90  SCInspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
91  }
92 
93  return buffer;
94 }
95 
96 /**
97  * \brief Registers the keyword handlers for the "http_request_line" keyword.
98  */
99 void DetectHttpRequestLineRegister(void)
100 {
101  sigmatch_table[DETECT_HTTP_REQUEST_LINE].name = "http.request_line";
102  sigmatch_table[DETECT_HTTP_REQUEST_LINE].alias = "http_request_line";
103  sigmatch_table[DETECT_HTTP_REQUEST_LINE].desc =
104  "sticky buffer to match on the HTTP request line";
105  sigmatch_table[DETECT_HTTP_REQUEST_LINE].url = "/rules/http-keywords.html#http-request-line";
106  sigmatch_table[DETECT_HTTP_REQUEST_LINE].Match = NULL;
107  sigmatch_table[DETECT_HTTP_REQUEST_LINE].Setup = DetectHttpRequestLineSetup;
108 #ifdef UNITTESTS
109  sigmatch_table[DETECT_HTTP_REQUEST_LINE].RegisterTests = DetectHttpRequestLineRegisterTests;
110 #endif
111  sigmatch_table[DETECT_HTTP_REQUEST_LINE].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_STICKY_BUFFER;
112 
113  DetectAppLayerInspectEngineRegister("http_request_line", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,
114  HTP_REQUEST_PROGRESS_LINE, DetectEngineInspectBufferGeneric, GetData);
115 
116  DetectAppLayerMpmRegister("http_request_line", SIG_FLAG_TOSERVER, 2,
117  PrefilterGenericMpmRegister, GetData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_LINE);
118 
119  DetectAppLayerInspectEngineRegisterSubState("http_request_line", ALPROTO_HTTP2,
120  SIG_FLAG_TOSERVER, HTTP2TxTypeStream, HTTP2ProgData, DetectEngineInspectBufferGeneric,
121  GetData2);
122  DetectAppLayerMpmRegisterSubState("http_request_line", SIG_FLAG_TOSERVER, 2,
123  PrefilterGenericMpmRegister, GetData2, ALPROTO_HTTP2, HTTP2TxTypeStream, HTTP2ProgData);
124 
125  DetectBufferTypeSetDescriptionByName("http_request_line",
126  "http request line");
127 
128  g_http_request_line_buffer_id = DetectBufferTypeGetByName("http_request_line");
129 }
130 
131 /**
132  * \brief The setup function for the http_request_line keyword for a signature.
133  *
134  * \param de_ctx Pointer to the detection engine context.
135  * \param s Pointer to the signature for the current Signature being
136  * parsed from the rules.
137  * \param m Pointer to the head of the SigMatch for the current rule
138  * being parsed.
139  * \param arg Pointer to the string holding the keyword value.
140  *
141  * \retval 0 On success
142  * \retval -1 On failure
143  */
144 static int DetectHttpRequestLineSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)
145 {
146  if (SCDetectBufferSetActiveList(de_ctx, s, g_http_request_line_buffer_id) < 0)
147  return -1;
148 
149  if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
150  return -1;
151 
152  return 0;
153 }
154 
155 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
156  const DetectEngineTransforms *transforms,
157  Flow *_f, const uint8_t _flow_flags,
158  void *txv, const int list_id)
159 {
160  InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);
161  if (buffer->inspect == NULL) {
162  htp_tx_t *tx = (htp_tx_t *)txv;
163  if (unlikely(htp_tx_request_line(tx) == NULL)) {
164  return NULL;
165  }
166  const uint32_t data_len = (uint32_t)bstr_len(htp_tx_request_line(tx));
167  const uint8_t *data = bstr_ptr(htp_tx_request_line(tx));
168 
169  SCInspectionBufferSetupAndApplyTransforms(
170  det_ctx, list_id, buffer, data, data_len, transforms);
171  }
172  return buffer;
173 }
174 
175 /************************************Unittests*********************************/
176 
177 #ifdef UNITTESTS
178 
179 #include "stream-tcp-reassemble.h"
180 
181 /**
182  * \test Test that a signature containing a http_request_line is correctly parsed
183  * and the keyword is registered.
184  */
185 static int DetectHttpRequestLineTest01(void)
186 {
187  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
188  FAIL_IF_NULL(de_ctx);
189 
190  de_ctx->flags |= DE_QUIET;
191  de_ctx->sig_list = SigInit(de_ctx, "alert tcp any any -> any any "
192  "(http_request_line; content:\"GET /\"; sid:1;)");
193  FAIL_IF_NULL(de_ctx->sig_list);
194 
195  DetectEngineCtxFree(de_ctx);
196  PASS;
197 }
198 
199 static void DetectHttpRequestLineRegisterTests(void)
200 {
201  UtRegisterTest("DetectHttpRequestLineTest01", DetectHttpRequestLineTest01);
202 }
203 #endif /* UNITTESTS */
204 /**
205  * @}
206  */
SigTableElmt_::url
const char * url
Definition: detect.h:1521
detect-content.h
detect-engine.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect-engine-register.h:306
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
SigTableElmt_::desc
const char * desc
Definition: detect.h:1520
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:2226
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:1518
stream-tcp.h
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
DetectEngineTransforms
Definition: detect.h:391
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1509
InspectionBuffer
Definition: detect-engine-inspect-buffer.h:34
threads.h
Flow_
Flow data structure.
Definition: flow.h:354
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:981
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
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2872
DE_QUIET
#define DE_QUIET
Definition: detect.h:330
stream-tcp-reassemble.h
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:2461
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1500
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
util-unittest.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:276
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1455
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
app-layer-htp.h
decode.h
util-debug.h
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:22
DetectEngineThreadCtx_
Definition: detect.h:1300
SCEnter
#define SCEnter(...)
Definition: util-debug.h:284
detect-engine-mpm.h
detect.h
DETECT_HTTP_REQUEST_LINE
@ DETECT_HTTP_REQUEST_LINE
Definition: detect-engine-register.h:197
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:1674
SigInit
Signature * SigInit(DetectEngineCtx *de_ctx, const char *sigstr)
Parses a signature and adds it to the Detection Engine Context.
Definition: detect-parse.c:3455
app-layer-parser.h
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1480
ALPROTO_HTTP2
@ ALPROTO_HTTP2
Definition: app-layer-protos.h:69
detect-engine-content-inspection.h
SigTableElmt_::alias
const char * alias
Definition: detect.h:1519
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
DetectEngineCtx_::sig_list
Signature * sig_list
Definition: detect.h:991
DetectHttpRequestLineRegister
void DetectHttpRequestLineRegister(void)
Registers the keyword handlers for the "http_request_line" keyword.
Definition: detect-http-request-line.c:99
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:299
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect-engine-inspect-buffer.h:35
detect-http-request-line.h
detect-parse.h
Signature_
Signature container.
Definition: detect.h:682
ALPROTO_HTTP
@ ALPROTO_HTTP
Definition: app-layer-protos.h:77
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect-engine-register.h:328
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2833
DetectEngineCtx_::flags
uint8_t flags
Definition: detect.h:983
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1552
flow.h
flow-var.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1507
app-layer.h