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-debug.h"
32 #include "util-error.h"
33 #include "util-unittest.h"
34 
35 static int DetectSidSetup (DetectEngineCtx *, Signature *, const char *);
36 #ifdef UNITTESTS
37 static void DetectSidRegisterTests(void);
38 #endif
39 
40 void DetectSidRegister (void)
41 {
42  sigmatch_table[DETECT_SID].name = "sid";
43  sigmatch_table[DETECT_SID].desc = "set rule ID";
44  sigmatch_table[DETECT_SID].url = "/rules/meta.html#sid-signature-id";
45  sigmatch_table[DETECT_SID].Match = NULL;
46  sigmatch_table[DETECT_SID].Setup = DetectSidSetup;
47 #ifdef UNITTESTS
48  sigmatch_table[DETECT_SID].RegisterTests = DetectSidRegisterTests;
49 #endif
50 }
51 
52 static int DetectSidSetup (DetectEngineCtx *de_ctx, Signature *s, const char *sidstr)
53 {
54  unsigned long id = 0;
55  char *endptr = NULL;
56  errno = 0;
57  id = strtoul(sidstr, &endptr, 10);
58  if (errno == ERANGE || endptr == NULL || *endptr != '\0') {
59  SCLogError("invalid character as arg "
60  "to sid keyword");
61  goto error;
62  }
63  if (id >= UINT_MAX) {
64  SCLogError("sid value too high, max %u", UINT_MAX);
65  goto error;
66  }
67  if (id == 0) {
68  SCLogError("sid value 0 is invalid");
69  goto error;
70  }
71  if (s->id > 0) {
72  SCLogError("duplicated 'sid' keyword detected");
73  goto error;
74  }
75 
76  s->id = (uint32_t)id;
77  return 0;
78 
79  error:
80  return -1;
81 }
82 
83 #ifdef UNITTESTS
84 
85 static int SidTestParse01(void)
86 {
87  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
88  FAIL_IF_NULL(de_ctx);
89 
90  Signature *s =
91  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:1; gid:1;)");
92  FAIL_IF_NULL(s);
93  FAIL_IF(s->id != 1);
94 
95  DetectEngineCtxFree(de_ctx);
96  PASS;
97 }
98 
99 static int SidTestParse02(void)
100 {
101  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
102  FAIL_IF_NULL(de_ctx);
103 
104  FAIL_IF_NOT_NULL(
105  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:a; gid:1;)"));
106 
107  DetectEngineCtxFree(de_ctx);
108  PASS;
109 }
110 
111 static int SidTestParse03(void)
112 {
113  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
114  FAIL_IF_NULL(de_ctx);
115 
116  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
117  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid:\";)"));
118 
119  DetectEngineCtxFree(de_ctx);
120  PASS;
121 }
122 
123 static int SidTestParse04(void)
124 {
125  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
126  FAIL_IF_NULL(de_ctx);
127 
128  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
129  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid: 0;)"));
130 
131  /* Let's also make sure that Suricata fails a rule which doesn't have a sid at all */
132  FAIL_IF_NOT_NULL(
133  DetectEngineAppendSig(de_ctx, "alert tcp any any -> any any (content:\"ABC\";)"));
134 
135  DetectEngineCtxFree(de_ctx);
136  PASS;
137 }
138 
139 /**
140  * \brief Register DetectSid unit tests.
141  */
142 static void DetectSidRegisterTests(void)
143 {
144  UtRegisterTest("SidTestParse01", SidTestParse01);
145  UtRegisterTest("SidTestParse02", SidTestParse02);
146  UtRegisterTest("SidTestParse03", SidTestParse03);
147  UtRegisterTest("SidTestParse04", SidTestParse04);
148 }
149 #endif /* UNITTESTS */
SigTableElmt_::url
const char * url
Definition: detect.h:1329
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:1328
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:153
detect-sid.h
DetectSidRegister
void DetectSidRegister(void)
Definition: detect-sid.c:40
SigTableElmt_::name
const char * name
Definition: detect.h:1326
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:860
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2742
DetectEngineAppendSig
Signature * DetectEngineAppendSig(DetectEngineCtx *, const char *)
Parse and append a Signature into the Detection Engine Context signature list.
Definition: detect-parse.c:2822
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1311
DETECT_SID
@ DETECT_SID
Definition: detect-engine-register.h:30
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:1294
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:261
Signature_::id
uint32_t id
Definition: detect.h:654
detect-parse.h
Signature_
Signature container.
Definition: detect.h:618
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2703
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1318