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 
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  sigmatch_table[DETECT_SID].flags = SIGMATCH_SUPPORT_FIREWALL;
48 #ifdef UNITTESTS
49  sigmatch_table[DETECT_SID].RegisterTests = DetectSidRegisterTests;
50 #endif
51 }
52 
53 static int DetectSidSetup (DetectEngineCtx *de_ctx, Signature *s, const char *sidstr)
54 {
55  uint32_t id = 0;
56  if (ByteExtractStringUint32(&id, 10, strlen(sidstr), sidstr) <= 0) {
57  SCLogError("invalid input as arg to sid keyword");
58  goto error;
59  }
60  if (id == 0) {
61  SCLogError("sid value 0 is invalid");
62  goto error;
63  }
64  if (s->id > 0) {
65  SCLogError("duplicated 'sid' keyword detected");
66  goto error;
67  }
68 
69  s->id = id;
70  return 0;
71 
72  error:
73  return -1;
74 }
75 
76 #ifdef UNITTESTS
77 
78 static int SidTestParse01(void)
79 {
80  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
81  FAIL_IF_NULL(de_ctx);
82 
83  Signature *s =
84  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:1; gid:1;)");
85  FAIL_IF_NULL(s);
86  FAIL_IF(s->id != 1);
87 
88  DetectEngineCtxFree(de_ctx);
89  PASS;
90 }
91 
92 static int SidTestParse02(void)
93 {
94  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
95  FAIL_IF_NULL(de_ctx);
96 
97  FAIL_IF_NOT_NULL(
98  DetectEngineAppendSig(de_ctx, "alert tcp 1.2.3.4 any -> any any (sid:a; gid:1;)"));
99 
100  DetectEngineCtxFree(de_ctx);
101  PASS;
102 }
103 
104 static int SidTestParse03(void)
105 {
106  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
107  FAIL_IF_NULL(de_ctx);
108 
109  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
110  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid:\";)"));
111 
112  DetectEngineCtxFree(de_ctx);
113  PASS;
114 }
115 
116 static int SidTestParse04(void)
117 {
118  DetectEngineCtx *de_ctx = DetectEngineCtxInit();
119  FAIL_IF_NULL(de_ctx);
120 
121  FAIL_IF_NOT_NULL(DetectEngineAppendSig(
122  de_ctx, "alert tcp any any -> any any (content:\"ABC\"; sid: 0;)"));
123 
124  /* Let's also make sure that Suricata fails a rule which doesn't have a sid at all */
125  FAIL_IF_NOT_NULL(
126  DetectEngineAppendSig(de_ctx, "alert tcp any any -> any any (content:\"ABC\";)"));
127 
128  DetectEngineCtxFree(de_ctx);
129  PASS;
130 }
131 
132 /**
133  * \brief Register DetectSid unit tests.
134  */
135 static void DetectSidRegisterTests(void)
136 {
137  UtRegisterTest("SidTestParse01", SidTestParse01);
138  UtRegisterTest("SidTestParse02", SidTestParse02);
139  UtRegisterTest("SidTestParse03", SidTestParse03);
140  UtRegisterTest("SidTestParse04", SidTestParse04);
141 }
142 #endif /* UNITTESTS */
util-byte.h
SigTableElmt_::url
const char * url
Definition: detect.h:1545
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:1544
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:78
detect-sid.h
DetectSidRegister
void DetectSidRegister(void)
Definition: detect-sid.c:40
SigTableElmt_::name
const char * name
Definition: detect.h:1542
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:101
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1533
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:995
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2912
ByteExtractStringUint32
int ByteExtractStringUint32(uint32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:194
DetectEngineAppendSig
Signature * DetectEngineAppendSig(DetectEngineCtx *, const char *)
Parse and append a Signature into the Detection Engine Context signature list.
Definition: detect-parse.c:3965
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1524
DETECT_SID
@ DETECT_SID
Definition: detect-engine-register.h:28
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:22
detect.h
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1504
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:274
Signature_::id
uint32_t id
Definition: detect.h:741
detect-parse.h
Signature_
Signature container.
Definition: detect.h:692
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2873
SIGMATCH_SUPPORT_FIREWALL
#define SIGMATCH_SUPPORT_FIREWALL
Definition: detect-engine-register.h:336
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1531