suricata
detect-ike-key-exchange-payload.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 "threads.h"
25 #include "decode.h"
26 #include "detect.h"
27 
28 #include "detect-parse.h"
29 #include "detect-engine.h"
30 #include "detect-engine-mpm.h"
32 #include "detect-urilen.h"
33 
34 #include "flow.h"
35 #include "flow-var.h"
36 #include "flow-util.h"
37 
38 #include "util-debug.h"
39 #include "util-unittest.h"
40 #include "util-unittest-helper.h"
41 #include "util-spm.h"
42 
43 #include "app-layer.h"
44 #include "app-layer-parser.h"
45 
47 #include "stream-tcp.h"
48 
49 #include "rust.h"
50 #include "app-layer-ike.h"
51 #include "rust-bindings.h"
52 
53 #define KEYWORD_NAME_KEY_EXCHANGE "ike.key_exchange_payload"
54 #define KEYWORD_DOC_KEY_EXCHANGE "ike-keywords.html#ike-key_exchange_payload";
55 #define BUFFER_NAME_KEY_EXCHANGE "ike.key_exchange_payload"
56 #define BUFFER_DESC_KEY_EXCHANGE "ike key_exchange payload"
57 
58 static int g_buffer_key_exchange_id = 0;
59 
60 static int DetectKeyExchangeSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
61 {
62  if (DetectBufferSetActiveList(s, g_buffer_key_exchange_id) < 0)
63  return -1;
64 
66  return -1;
67 
68  return 0;
69 }
70 
71 static InspectionBuffer *GetKeyExchangeData(DetectEngineThreadCtx *det_ctx,
72  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
73  const int list_id)
74 {
75  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
76  if (buffer->inspect == NULL) {
77  const uint8_t *b = NULL;
78  uint32_t b_len = 0;
79 
80  if (rs_ike_state_get_key_exchange(txv, &b, &b_len) != 1)
81  return NULL;
82  if (b == NULL || b_len == 0)
83  return NULL;
84 
85  InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
86  InspectionBufferApplyTransforms(buffer, transforms);
87  }
88 
89  return buffer;
90 }
91 
93 {
94  // register key_exchange
98  "sticky buffer to match on the IKE key_exchange_payload";
99  sigmatch_table[DETECT_AL_IKE_KEY_EXCHANGE].Setup = DetectKeyExchangeSetup;
102 
104  1, DetectEngineInspectBufferGeneric, GetKeyExchangeData);
105 
107  PrefilterGenericMpmRegister, GetKeyExchangeData, ALPROTO_IKE, 1);
108 
110  1, DetectEngineInspectBufferGeneric, GetKeyExchangeData);
111 
113  PrefilterGenericMpmRegister, GetKeyExchangeData, ALPROTO_IKE, 1);
114 
116 
117  g_buffer_key_exchange_id = DetectBufferTypeGetByName(BUFFER_NAME_KEY_EXCHANGE);
118  SCLogDebug("registering " BUFFER_NAME_KEY_EXCHANGE " rule option");
119 }
SigTableElmt_::url
const char * url
Definition: detect.h:1238
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1493
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1444
ALPROTO_IKE
@ ALPROTO_IKE
Definition: app-layer-protos.h:49
SigTableElmt_::desc
const char * desc
Definition: detect.h:1237
DetectEngineInspectBufferGeneric
uint8_t DetectEngineInspectBufferGeneric(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const 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:1993
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1235
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:371
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:296
InspectionBuffer
Definition: detect.h:337
threads.h
Flow_
Flow data structure.
Definition: flow.h:356
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:749
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1229
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:784
rust.h
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:229
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1220
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1368
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1085
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:228
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
app-layer-ike.h
DetectEngineThreadCtx_
Definition: detect.h:1024
detect-engine-mpm.h
detect.h
DetectIkeKeyExchangeRegister
void DetectIkeKeyExchangeRegister(void)
Definition: detect-ike-key-exchange-payload.c:92
app-layer-parser.h
BUFFER_DESC_KEY_EXCHANGE
#define BUFFER_DESC_KEY_EXCHANGE
Definition: detect-ike-key-exchange-payload.c:56
DetectAppLayerInspectEngineRegister2
void DetectAppLayerInspectEngineRegister2(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr2 Callback2, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
Definition: detect-engine.c:227
detect-ike-key-exchange-payload.h
DetectAppLayerMpmRegister2
void DetectAppLayerMpmRegister2(const char *name, int direction, int priority, int(*PrefilterRegister)(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id), InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register a MPM engine
Definition: detect-engine-mpm.c:89
suricata-common.h
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1551
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:76
util-spm.h
KEYWORD_DOC_KEY_EXCHANGE
#define KEYWORD_DOC_KEY_EXCHANGE
Definition: detect-ike-key-exchange-payload.c:54
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:338
str
#define str(s)
Definition: suricata-common.h:280
KEYWORD_NAME_KEY_EXCHANGE
#define KEYWORD_NAME_KEY_EXCHANGE
Definition: detect-ike-key-exchange-payload.c:53
InspectionBufferSetup
void InspectionBufferSetup(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1449
detect-parse.h
Signature_
Signature container.
Definition: detect.h:539
detect-urilen.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1420
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:1299
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1182
flow.h
flow-var.h
DETECT_AL_IKE_KEY_EXCHANGE
@ DETECT_AL_IKE_KEY_EXCHANGE
Definition: detect-engine-register.h:333
app-layer.h
BUFFER_NAME_KEY_EXCHANGE
#define BUFFER_NAME_KEY_EXCHANGE
Definition: detect-ike-key-exchange-payload.c:55