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"
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
40static int DetectIkeExchTypeSetup(DetectEngineCtx *, Signature *s, const char *str);
41static void DetectIkeExchTypeFree(DetectEngineCtx *, void *);
42static int g_ike_exch_type_buffer_id = 0;
43
44static 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_IKE_EXCH_TYPE].desc = "match IKE exchange type";
54 sigmatch_table[DETECT_IKE_EXCH_TYPE].url = "/rules/ike-keywords.html#ike-exchtype";
56 sigmatch_table[DETECT_IKE_EXCH_TYPE].AppLayerTxMatch = DetectIkeExchTypeMatch;
57 sigmatch_table[DETECT_IKE_EXCH_TYPE].Setup = DetectIkeExchTypeSetup;
58 sigmatch_table[DETECT_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 */
84static 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 (!SCIkeStateGetExchType(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 */
107static 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
125error:
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 */
136static void DetectIkeExchTypeFree(DetectEngineCtx *de_ctx, void *ptr)
137{
138 SCDetectU8Free(ptr);
139}
@ ALPROTO_IKE
uint8_t flags
Definition decode-gre.h:0
@ DETECT_IKE_EXCH_TYPE
DetectUintData_u8 * DetectU8Parse(const char *u8str)
This function is used to parse u8 options passed via some u8 keyword.
int DetectU8Match(const uint8_t parg, const DetectUintData_u8 *du8)
DetectUintData_u8 DetectU8Data
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
Registers an app inspection engine.
int DetectBufferTypeGetByName(const char *name)
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.
void DetectIkeExchTypeRegister(void)
Registration function for ike.exchtype keyword.
int SCDetectSignatureSetAppProto(Signature *s, AppProto alproto)
SigMatch * SCSigMatchAppendSMToList(DetectEngineCtx *de_ctx, Signature *s, uint16_t type, SigMatchCtx *ctx, const int list)
Append a SigMatch to the list type.
SigTableElmt * sigmatch_table
#define SIG_FLAG_TOCLIENT
Definition detect.h:272
#define SIG_FLAG_TOSERVER
Definition detect.h:271
DetectEngineCtx * de_ctx
struct Thresholds ctx
main detection engine ctx
Definition detect.h:932
Flow data structure.
Definition flow.h:356
Used to start a pointer to SigMatch context Should never be dereferenced without casting to something...
Definition detect.h:351
const char * url
Definition detect.h:1462
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition detect.h:1441
void(* Free)(DetectEngineCtx *, void *)
Definition detect.h:1446
const char * desc
Definition detect.h:1461
int(* AppLayerTxMatch)(DetectEngineThreadCtx *, Flow *, uint8_t flags, void *alstate, void *txv, const Signature *, const SigMatchCtx *)
Definition detect.h:1424
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition detect.h:1421
const char * name
Definition detect.h:1459
Signature container.
Definition detect.h:668
#define str(s)
#define SCEnter(...)
Definition util-debug.h:277
#define SCReturnInt(x)
Definition util-debug.h:281