suricata
detect-sid.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2021 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 Victor Julien <victor@inliniac.net>
22  *
23  * Implements the sid keyword
24  */
25 
26 #include "suricata-common.h"
27 #include "detect.h"
28 #include "detect-engine.h"
29 #include "detect-parse.h"
30 #include "detect-sid.h"
31 #include "util-byte.h"
32 #include "util-debug.h"
33 #include "util-error.h"
34 #include "util-unittest.h"
35 
36 static int DetectSidSetup (DetectEngineCtx *, Signature *, const char *);
37 #ifdef UNITTESTS
38 static void DetectSidRegisterTests(void);
39 #endif
40 
41 void DetectSidRegister (void)
42 {
43  sigmatch_table[DETECT_SID].name = "sid";
44  sigmatch_table[DETECT_SID].desc = "set rule ID";
45  sigmatch_table[DETECT_SID].url = "/rules/meta.html#sid-signature-id";
46  sigmatch_table[DETECT_SID].Match = NULL;
47  sigmatch_table[DETECT_SID].Setup = DetectSidSetup;
48  sigmatch_table[DETECT_SID].flags = SIGMATCH_SUPPORT_FIREWALL;
49 #ifdef UNITTESTS
50  sigmatch_table[DETECT_SID].RegisterTests = DetectSidRegisterTests;
51 #endif
52 }
53 
54 static int DetectSidSetup (DetectEngineCtx *de_ctx, Signature *s, const char *sidstr)
55 {
56  uint32_t id = 0;
57  if (ByteExtractStringUint32(&id, 10, strlen(sidstr), sidstr) <= 0) {
58  SCLogError("invalid input as arg to sid keyword");
59  goto error;
60  }
61  if (id == 0) {
62  SCLogError("sid value 0 is invalid");
63  goto error;
64  }
65  if (s->id > 0) {
66  SCLogError("duplicated 'sid' keyword detected");
67  goto error;
68  }
69 
70  s->id = id;
71  return 0;
72 
73  error:
74  return -1;
75 }
76 
77 #ifdef UNITTESTS
78 
79 static int SidTestParse01(void)
80 {
81  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
82  FAIL_IF_NULL(de_ctx);
83 
84  Signature *s =
85  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:1; gid:1;)");
86  FAIL_IF_NULL(s);
87  FAIL_IF(s->id != 1);
88 
89  DetectEngineCtxFree(de_ctx);
90  PASS;
91 }
92 
93 static int SidTestParse02(void)
94 {
95  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
96  FAIL_IF_NULL(de_ctx);
97 
98  FAIL_IF_NOT_NULL(
99  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:a; gid:1;)"));
100 
101  DetectEngineCtxFree(de_ctx);
102  PASS;
103 }
104 
105 static int SidTestParse03(void)
106 {
107  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
108  FAIL_IF_NULL(de_ctx);
109 
110  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
111  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid:\";)"));
112 
113  DetectEngineCtxFree(de_ctx);
114  PASS;
115 }
116 
117 static int SidTestParse04(void)
118 {
119  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
120  FAIL_IF_NULL(de_ctx);
121 
122  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
123  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid: 0;)"));
124 
125  /* Let's also make sure that Suricata fails a rule which doesn't have a sid at all */
126  FAIL_IF_NOT_NULL(
127  DetectEngineAppendSig(de_ctx, "alert tcp any any -> any any (content:\"ABC\";)"));
128 
129  DetectEngineCtxFree(de_ctx);
130  PASS;
131 }
132 
133 /**
134  * \brief Register DetectSid unit tests.
135  */
136 static void DetectSidRegisterTests(void)
137 {
138  UtRegisterTest("SidTestParse01", SidTestParse01);
139  UtRegisterTest("SidTestParse02", SidTestParse02);
140  UtRegisterTest("SidTestParse03", SidTestParse03);
141  UtRegisterTest("SidTestParse04", SidTestParse04);
142 }
143 #endif /* UNITTESTS */
util-byte.h
SigTableElmt_::url
const char * url
Definition: detect.h:1462
detect-engine.h
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:1461
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
detect-sid.h
DetectSidRegister
void DetectSidRegister(void)
Definition: detect-sid.c:41
SigTableElmt_::name
const char * name
Definition: detect.h:1459
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1450
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:932
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2641
ByteExtractStringUint32
int ByteExtractStringUint32(uint32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:239
SIGMATCH_SUPPORT_FIREWALL
#define SIGMATCH_SUPPORT_FIREWALL
Definition: detect.h:1682
DetectEngineAppendSig
Signature * DetectEngineAppendSig(DetectEngineCtx *, const char *)
Parse and append a Signature into the Detection Engine Context signature list.
Definition: detect-parse.c:3437
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1441
DETECT_SID
@ DETECT_SID
Definition: detect-engine-register.h:28
util-unittest.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
util-error.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
detect.h
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1421
FAIL_IF
#define FAIL_IF(expr)
Fail a test if expression evaluates to true.
Definition: util-unittest.h:71
suricata-common.h
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:267
Signature_::id
uint32_t id
Definition: detect.h:713
detect-parse.h
Signature_
Signature container.
Definition: detect.h:668
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2602
id
uint32_t id
Definition: detect-flowbits.c:938
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1448