suricata
detect-pkt-data.c
Go to the documentation of this file.
1 /* Copyright (C) 2012-2020 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  * \file
20  *
21  * \author Xavier Lange <xrlange@gmail.com>
22  *
23  */
24 
25 #include "suricata-common.h"
26 #include "threads.h"
27 #include "debug.h"
28 #include "decode.h"
29 
30 #include "detect.h"
31 #include "detect-parse.h"
32 #include "detect-pkt-data.h"
33 #include "detect-engine.h"
34 #include "detect-engine-mpm.h"
35 #include "detect-engine-state.h"
36 
37 #include "flow.h"
38 #include "flow-var.h"
39 #include "flow-util.h"
40 
41 #include "util-debug.h"
42 #include "util-spm-bm.h"
43 #include "util-unittest.h"
44 #include "util-unittest-helper.h"
45 
46 static int DetectPktDataSetup (DetectEngineCtx *, Signature *, const char *);
47 static void DetectPktDataTestRegister(void);
48 
49 /**
50  * \brief Registration function for keyword: file_data
51  */
53 {
54  sigmatch_table[DETECT_PKT_DATA].name = "pkt_data";
55  sigmatch_table[DETECT_PKT_DATA].Setup = DetectPktDataSetup;
56  sigmatch_table[DETECT_PKT_DATA].RegisterTests = DetectPktDataTestRegister;
58 }
59 
60 /**
61  * \brief this function is used to parse pkt_data options
62  * \brief into the current signature
63  *
64  * \param de_ctx pointer to the Detection Engine Context
65  * \param s pointer to the current signature
66  * \param unused unused for keyword with SIGMATCH_NOOPT set
67  *
68  * \retval 0 on Success
69  * \retval -1 on Failure
70  */
71 static int DetectPktDataSetup (DetectEngineCtx *de_ctx, Signature *s, const char *unused)
72 {
73  SCEnter();
74  if (s->init_data->transforms.cnt) {
76  "previous transforms not consumed before 'pkt_data'");
77  SCReturnInt(-1);
78  }
80  SCReturnInt(0);
81 }
82 
83 #ifdef UNITTESTS
84 
85 /************************************Unittests*********************************/
86 static int g_file_data_buffer_id = 0;
87 
88 static int DetectPktDataTest01(void)
89 {
92  de_ctx->flags |= DE_QUIET;
93 
94  Signature *sig = DetectEngineAppendSig(de_ctx, "alert tcp any any -> any any "
95  "(file_data; content:\"in file data\";"
96  " pkt_data; content:\"in pkt data\"; sid:1;)");
97  FAIL_IF_NULL(sig);
98 
99  SigMatch *sm = de_ctx->sig_list->sm_lists[g_file_data_buffer_id];
100  FAIL_IF_NULL(sm);
101 
102  sm = de_ctx->sig_list->sm_lists[DETECT_SM_LIST_PMATCH];
103  FAIL_IF_NULL(sm);
104 
106  FAIL_IF_NOT_NULL(sm->next);
107 
110  PASS;
111 }
112 
113 static int DetectPktDataTest02(void)
114 {
117  de_ctx->flags |= DE_QUIET;
118 
119  Signature *sig = DetectEngineAppendSig(de_ctx, "alert tcp any any -> any any "
120  "(file_data; compress_whitespace; "
121  " pkt_data; content:\"in pkt data\"; sid:1;)");
122  FAIL_IF_NOT_NULL(sig);
124  PASS;
125 }
126 #endif
127 
128 static void DetectPktDataTestRegister(void)
129 {
130 #ifdef UNITTESTS
131  g_file_data_buffer_id = DetectBufferTypeGetByName("file_data");
132 
133  UtRegisterTest("DetectPktDataTest01", DetectPktDataTest01);
134  UtRegisterTest("DetectPktDataTest02", DetectPktDataTest02);
135 #endif
136 }
137 
DETECT_PKT_DATA
@ DETECT_PKT_DATA
Definition: detect-engine-register.h:171
detect-engine.h
DETECT_SM_LIST_PMATCH
@ DETECT_SM_LIST_PMATCH
Definition: detect.h:90
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1209
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:59
threads.h
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1203
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
SC_ERR_INVALID_SIGNATURE
@ SC_ERR_INVALID_SIGNATURE
Definition: util-error.h:69
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2092
DE_QUIET
#define DE_QUIET
Definition: detect.h:293
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1195
util-unittest.h
util-unittest-helper.h
FAIL_IF_NOT
#define FAIL_IF_NOT(expr)
Fail a test if expression to true.
Definition: util-unittest.h:82
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:879
decode.h
FAIL_IF_NOT_NULL
#define FAIL_IF_NOT_NULL(expr)
Fail a test if expression evaluates to non-NULL.
Definition: util-unittest.h:96
util-debug.h
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
SignatureInitData_::list
int list
Definition: detect.h:504
SCEnter
#define SCEnter(...)
Definition: util-debug.h:300
detect-engine-mpm.h
detect.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:323
DetectPktDataRegister
void DetectPktDataRegister(void)
Registration function for keyword: file_data.
Definition: detect-pkt-data.c:52
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:596
detect-engine-state.h
Data structures and function prototypes for keeping state for the detection engine.
SigMatch_::type
uint8_t type
Definition: detect.h:320
DETECT_SM_LIST_NOTSET
#define DETECT_SM_LIST_NOTSET
Definition: detect.h:115
DetectEngineAppendSig
Signature * DetectEngineAppendSig(DetectEngineCtx *de_ctx, const char *sigstr)
Parse and append a Signature into the Detection Engine Context signature list.
Definition: detect-parse.c:2338
suricata-common.h
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
util-spm-bm.h
DetectEngineCtx_::sig_list
Signature * sig_list
Definition: detect.h:772
detect-parse.h
Signature_
Signature container.
Definition: detect.h:527
SigMatch_
a single match condition for a signature
Definition: detect.h:319
detect-pkt-data.h
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2047
DetectEngineTransforms::cnt
int cnt
Definition: detect.h:377
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1378
DetectEngineCtx_::flags
uint8_t flags
Definition: detect.h:767
SignatureInitData_::transforms
DetectEngineTransforms transforms
Definition: detect.h:507
flow.h
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:304
flow-var.h
debug.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1201