suricata
detect-ike-exch-type.c
Go to the documentation of this file.
1 /* Copyright (C) 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  *
20  * \author Frank Honza <frank.honza@dcso.de>
21  */
22 
23 #include "suricata-common.h"
24 #include "conf.h"
25 #include "detect.h"
26 #include "detect-parse.h"
27 #include "detect-engine.h"
29 #include "detect-ike-exch-type.h"
30 #include "app-layer-parser.h"
31 #include "util-byte.h"
32 #include "detect-engine-uint.h"
33 
34 #include "rust-bindings.h"
35 
36 /**
37  * [ike.exchtype]:[<|>|<=|>=]<type>;
38  */
39 
40 static int DetectIkeExchTypeSetup(DetectEngineCtx *, Signature *s, const char *str);
41 static void DetectIkeExchTypeFree(DetectEngineCtx *, void *);
42 static int g_ike_exch_type_buffer_id = 0;
43 
44 static int DetectIkeExchTypeMatch(DetectEngineThreadCtx *, Flow *, uint8_t, void *, void *,
45  const Signature *, const SigMatchCtx *);
46 
47 /**
48  * \brief Registration function for ike.exchtype keyword.
49  */
51 {
53  sigmatch_table[DETECT_AL_IKE_EXCH_TYPE].desc = "match IKE exchange type";
54  sigmatch_table[DETECT_AL_IKE_EXCH_TYPE].url = "/rules/ike-keywords.html#ike-exchtype";
56  sigmatch_table[DETECT_AL_IKE_EXCH_TYPE].AppLayerTxMatch = DetectIkeExchTypeMatch;
57  sigmatch_table[DETECT_AL_IKE_EXCH_TYPE].Setup = DetectIkeExchTypeSetup;
58  sigmatch_table[DETECT_AL_IKE_EXCH_TYPE].Free = DetectIkeExchTypeFree;
59 
62 
65 
66  g_ike_exch_type_buffer_id = DetectBufferTypeGetByName("ike.exchtype");
67 }
68 
69 /**
70  * \internal
71  * \brief Function to match exchange type of a IKE state
72  *
73  * \param det_ctx Pointer to the pattern matcher thread.
74  * \param f Pointer to the current flow.
75  * \param flags Flags.
76  * \param state App layer state.
77  * \param txv Pointer to the Ike Transaction.
78  * \param s Pointer to the Signature.
79  * \param ctx Pointer to the sigmatch that we will cast into DetectU8Data.
80  *
81  * \retval 0 no match.
82  * \retval 1 match.
83  */
84 static int DetectIkeExchTypeMatch(DetectEngineThreadCtx *det_ctx, Flow *f, uint8_t flags,
85  void *state, void *txv, const Signature *s, const SigMatchCtx *ctx)
86 {
87  SCEnter();
88 
89  uint8_t exch_type;
90  if (!rs_ike_state_get_exch_type(txv, &exch_type))
91  SCReturnInt(0);
92 
93  const DetectU8Data *du8 = (const DetectU8Data *)ctx;
94  SCReturnInt(DetectU8Match(exch_type, du8));
95 }
96 
97 /**
98  * \brief Function to add the parsed IKE exchange type field into the current signature.
99  *
100  * \param de_ctx Pointer to the Detection Engine Context.
101  * \param s Pointer to the Current Signature.
102  * \param rawstr Pointer to the user provided flags options.
103  *
104  * \retval 0 on Success.
105  * \retval -1 on Failure.
106  */
107 static int DetectIkeExchTypeSetup(DetectEngineCtx *de_ctx, Signature *s, const char *rawstr)
108 {
110  return -1;
111 
112  DetectU8Data *ike_exch_type = DetectU8Parse(rawstr);
113  if (ike_exch_type == NULL)
114  return -1;
115 
116  /* okay so far so good, lets get this into a SigMatch
117  * and put it in the Signature. */
118 
120  g_ike_exch_type_buffer_id) == NULL) {
121  goto error;
122  }
123  return 0;
124 
125 error:
126  DetectIkeExchTypeFree(de_ctx, ike_exch_type);
127  return -1;
128 }
129 
130 /**
131  * \internal
132  * \brief Function to free memory associated with DetectU8Data.
133  *
134  * \param de_ptr Pointer to DetectU8Data.
135  */
136 static void DetectIkeExchTypeFree(DetectEngineCtx *de_ctx, void *ptr)
137 {
138  rs_detect_u8_free(ptr);
139 }
util-byte.h
detect-engine-uint.h
SigTableElmt_::url
const char * url
Definition: detect.h:1296
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1753
detect-engine.h
ALPROTO_IKE
@ ALPROTO_IKE
Definition: app-layer-protos.h:49
SigTableElmt_::desc
const char * desc
Definition: detect.h:1295
DetectIkeExchTypeRegister
void DetectIkeExchTypeRegister(void)
Registration function for ike.exchtype keyword.
Definition: detect-ike-exch-type.c:50
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1283
SigTableElmt_::name
const char * name
Definition: detect.h:1293
Flow_
Flow data structure.
Definition: flow.h:351
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:836
SigTableElmt_::AppLayerTxMatch
int(* AppLayerTxMatch)(DetectEngineThreadCtx *, Flow *, uint8_t flags, void *alstate, void *txv, const Signature *, const SigMatchCtx *)
Definition: detect.h:1264
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:264
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1278
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1119
DetectU8Parse
DetectUintData_u8 * DetectU8Parse(const char *u8str)
This function is used to parse u8 options passed via some u8 keyword.
Definition: detect-engine-uint.c:85
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:263
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1092
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect.h
DetectU8Data
DetectUintData_u8 DetectU8Data
Definition: detect-engine-uint.h:43
app-layer-parser.h
conf.h
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1261
detect-engine-content-inspection.h
SigMatchCtx_
Used to start a pointer to SigMatch context Should never be dereferenced without casting to something...
Definition: detect.h:342
DETECT_AL_IKE_EXCH_TYPE
@ DETECT_AL_IKE_EXCH_TYPE
Definition: detect-engine-register.h:341
DetectU8Match
int DetectU8Match(const uint8_t parg, const DetectUintData_u8 *du8)
Definition: detect-engine-uint.c:71
flags
uint8_t flags
Definition: decode-gre.h:0
suricata-common.h
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:127
DetectEngineInspectGenericList
uint8_t DetectEngineInspectGenericList(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const struct DetectEngineAppInspectionEngine_ *engine, const Signature *s, Flow *f, uint8_t flags, void *alstate, void *txv, uint64_t tx_id)
Do the content inspection & validation for a signature.
Definition: detect-engine.c:2126
detect-ike-exch-type.h
str
#define str(s)
Definition: suricata-common.h:291
detect-parse.h
Signature_
Signature container.
Definition: detect.h:593
DetectAppLayerInspectEngineRegister
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
Definition: detect-engine.c:216
SigMatchAppendSMToList
SigMatch * SigMatchAppendSMToList(DetectEngineCtx *de_ctx, Signature *s, uint16_t type, SigMatchCtx *ctx, const int list)
Append a SigMatch to the list type.
Definition: detect-parse.c:447
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275