suricata
detect-template-buffer.c
Go to the documentation of this file.
1 /* Copyright (C) 2015-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 #include "../util-unittest.h"
19 #include "../util-unittest-helper.h"
20 #include "../app-layer-parser.h"
21 #include "../detect-engine.h"
22 #include "../detect-parse.h"
23 #include "../flow-util.h"
24 #include "../stream-tcp.h"
25 
26 static int DetectTemplateBufferTest(void)
27 {
29  FAIL_IF_NULL(alp_tctx);
30 
31  Flow f;
32  Packet *p;
33  TcpSession tcp;
34  ThreadVars tv;
35  Signature *s;
36 
37  uint8_t request[] = "Hello World!";
38 
39  /* Setup flow. */
40  memset(&f, 0, sizeof(Flow));
41  memset(&tcp, 0, sizeof(TcpSession));
42  memset(&tv, 0, sizeof(ThreadVars));
43  p = UTHBuildPacket(request, sizeof(request), IPPROTO_TCP);
44  FLOW_INITIALIZE(&f);
46  f.protoctx = (void *)&tcp;
47  f.proto = IPPROTO_TCP;
48  f.flags |= FLOW_IPV4;
49  p->flow = &f;
53 
55  FAIL_IF_NULL(de_ctx);
56 
57  /* This rule should match. */
58  s = DetectEngineAppendSig(de_ctx,
59  "alert tcp any any -> any any ("
60  "msg:\"TEMPLATE Test Rule\"; "
61  "template_buffer; content:\"World!\"; "
62  "sid:1; rev:1;)");
63  FAIL_IF_NULL(s);
64 
65  /* This rule should not match. */
66  s = DetectEngineAppendSig(de_ctx,
67  "alert tcp any any -> any any ("
68  "msg:\"TEMPLATE Test Rule\"; "
69  "template_buffer; content:\"W0rld!\"; "
70  "sid:2; rev:1;)");
71  FAIL_IF_NULL(s);
72 
73  SigGroupBuild(de_ctx);
74 
75  DetectEngineThreadCtx *det_ctx = NULL;
76  DetectEngineThreadCtxInit(&tv, (void *)de_ctx, (void *)&det_ctx);
77  FAIL_IF_NULL(det_ctx);
78 
79  AppLayerParserParse(NULL, alp_tctx, &f, ALPROTO_TEMPLATE,
80  STREAM_TOSERVER, request, sizeof(request));
81 
82  /* Check that we have app-layer state. */
84 
85  SigMatchSignatures(&tv, de_ctx, det_ctx, p);
86  FAIL_IF(!PacketAlertCheck(p, 1));
88 
89  /* Cleanup. */
91  DetectEngineThreadCtxDeinit(&tv, det_ctx);
92  DetectEngineCtxFree(de_ctx);
94  FLOW_DESTROY(&f);
95  UTHFreePacket(p);
96 
97  PASS;
98 }
99 
100 static void DetectTemplateBufferRegisterTests(void)
101 {
102  UtRegisterTest("DetectTemplateBufferTest", DetectTemplateBufferTest);
103 }
Signature * DetectEngineAppendSig(DetectEngineCtx *de_ctx, const char *sigstr)
Parse and append a Signature into the Detection Engine Context signature list.
struct Flow_ * flow
Definition: decode.h:444
int PacketAlertCheck(Packet *p, uint32_t sid)
Check if a certain sid alerted, this is used in the test functions.
uint8_t proto
Definition: flow.h:346
#define PASS
Pass the test.
#define FAIL_IF(expr)
Fail a test if expression evaluates to false.
Definition: util-unittest.h:71
void AppLayerParserThreadCtxFree(AppLayerParserThreadCtx *tctx)
Destroys the app layer parser thread context obtained using AppLayerParserThreadCtxAlloc().
#define FLOW_PKT_ESTABLISHED
Definition: flow.h:195
void StreamTcpFreeConfig(char quiet)
Definition: stream-tcp.c:669
TmEcode DetectEngineThreadCtxInit(ThreadVars *, void *, void **)
initialize thread specific detection engine context
Signature container.
Definition: detect.h:492
#define TRUE
void * protoctx
Definition: flow.h:398
main detection engine ctx
Definition: detect.h:720
TmEcode DetectEngineThreadCtxDeinit(ThreadVars *, void *)
void * alstate
Definition: flow.h:436
#define FLOW_DESTROY(f)
Definition: flow-util.h:115
int SigGroupBuild(DetectEngineCtx *de_ctx)
Convert the signature list into the runtime match structure.
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
void SigMatchSignatures(ThreadVars *th_v, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p)
wrapper for old tests
Definition: detect.c:1752
void StreamTcpInitConfig(char)
To initialize the stream global configuration data.
Definition: stream-tcp.c:365
uint8_t flowflags
Definition: decode.h:438
Packet * UTHBuildPacket(uint8_t *payload, uint16_t payload_len, uint8_t ipproto)
UTHBuildPacket is a wrapper that build packets with default ip and port fields.
#define FLOW_PKT_TOSERVER
Definition: flow.h:193
AppLayerParserThreadCtx * AppLayerParserThreadCtxAlloc(void)
Gets a new app layer protocol's parser thread context.
#define FLOW_INITIALIZE(f)
Definition: flow-util.h:39
#define STREAM_TOSERVER
Definition: stream.h:31
void UTHFreePacket(Packet *p)
UTHFreePacket: function to release the allocated data from UTHBuildPacket and the packet itself...
#define PKT_HAS_FLOW
Definition: decode.h:1101
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
Per thread variable structure.
Definition: threadvars.h:57
AppProto alproto
application level protocol
Definition: flow.h:407
uint32_t flags
Definition: decode.h:442
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Flow data structure.
Definition: flow.h:327
#define FLOW_IPV4
Definition: flow.h:93
uint32_t flags
Definition: flow.h:377
#define PKT_STREAM_EST
Definition: decode.h:1099
int AppLayerParserParse(ThreadVars *tv, AppLayerParserThreadCtx *alp_tctx, Flow *f, AppProto alproto, uint8_t flags, uint8_t *input, uint32_t input_len)
DetectEngineCtx * DetectEngineCtxInit(void)