suricata
detect-ike-spi.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 "debug.h"
26 #include "decode.h"
27 #include "detect.h"
28 
29 #include "detect-parse.h"
30 #include "detect-engine.h"
31 #include "detect-engine-mpm.h"
33 #include "detect-urilen.h"
34 
35 #include "flow.h"
36 #include "flow-var.h"
37 #include "flow-util.h"
38 
39 #include "util-debug.h"
40 #include "util-unittest.h"
41 #include "util-unittest-helper.h"
42 #include "util-spm.h"
43 
44 #include "app-layer.h"
45 #include "app-layer-parser.h"
46 
47 #include "detect-ike-spi.h"
48 #include "stream-tcp.h"
49 
50 #include "rust.h"
51 #include "app-layer-ike.h"
52 #include "rust-bindings.h"
53 
54 #define KEYWORD_NAME_INITIATOR "ike.init_spi"
55 #define KEYWORD_DOC_INITIATOR "ike-keywords.html#ike-init_spi";
56 #define BUFFER_NAME_INITIATOR "ike.init_spi"
57 #define BUFFER_DESC_INITIATOR "ike init spi"
58 
59 #define KEYWORD_NAME_RESPONDER "ike.resp_spi"
60 #define KEYWORD_DOC_RESPONDER "ike-keywords.html#ike-resp_spi";
61 #define BUFFER_NAME_RESPONDER "ike.resp_spi"
62 #define BUFFER_DESC_RESPONDER "ike resp spi"
63 
64 static int g_buffer_initiator_id = 0;
65 static int g_buffer_responder_id = 0;
66 
67 static int DetectSpiInitiatorSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
68 {
69  if (DetectBufferSetActiveList(s, g_buffer_initiator_id) < 0)
70  return -1;
71 
73  return -1;
74 
75  return 0;
76 }
77 
78 static int DetectSpiResponderSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
79 {
80  if (DetectBufferSetActiveList(s, g_buffer_responder_id) < 0)
81  return -1;
82 
84  return -1;
85 
86  return 0;
87 }
88 
89 static InspectionBuffer *GetInitiatorData(DetectEngineThreadCtx *det_ctx,
90  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
91  const int list_id)
92 {
93  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
94  if (buffer->inspect == NULL) {
95  const uint8_t *b = NULL;
96  uint32_t b_len = 0;
97 
98  if (rs_ike_state_get_spi_initiator(txv, &b, &b_len) != 1)
99  return NULL;
100  if (b == NULL || b_len == 0)
101  return NULL;
102 
103  InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
104  InspectionBufferApplyTransforms(buffer, transforms);
105  }
106 
107  return buffer;
108 }
109 
110 static InspectionBuffer *GetResponderData(DetectEngineThreadCtx *det_ctx,
111  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
112  const int list_id)
113 {
114  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
115  if (buffer->inspect == NULL) {
116  const uint8_t *b = NULL;
117  uint32_t b_len = 0;
118 
119  if (rs_ike_state_get_spi_responder(txv, &b, &b_len) != 1)
120  return NULL;
121  if (b == NULL || b_len == 0)
122  return NULL;
123 
124  InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
125  InspectionBufferApplyTransforms(buffer, transforms);
126  }
127 
128  return buffer;
129 }
130 
132 {
133  // register initiator
137  "sticky buffer to match on the IKE spi initiator";
138  sigmatch_table[DETECT_AL_IKE_SPI_INITIATOR].Setup = DetectSpiInitiatorSetup;
141 
143  DetectEngineInspectBufferGeneric, GetInitiatorData);
144 
146  PrefilterGenericMpmRegister, GetInitiatorData, ALPROTO_IKE, 1);
147 
149 
150  g_buffer_initiator_id = DetectBufferTypeGetByName(BUFFER_NAME_INITIATOR);
151  SCLogDebug("registering " BUFFER_NAME_INITIATOR " rule option");
152 
153  // register responder
157  "sticky buffer to match on the IKE spi responder";
158  sigmatch_table[DETECT_AL_IKE_SPI_RESPONDER].Setup = DetectSpiResponderSetup;
161 
163  DetectEngineInspectBufferGeneric, GetResponderData);
164 
166  PrefilterGenericMpmRegister, GetResponderData, ALPROTO_IKE, 1);
167 
169 
170  g_buffer_responder_id = DetectBufferTypeGetByName(BUFFER_NAME_RESPONDER);
171  SCLogDebug("registering " BUFFER_NAME_RESPONDER " rule option");
172 }
SigTableElmt_::url
const char * url
Definition: detect.h:1204
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1489
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1397
ALPROTO_IKE
@ ALPROTO_IKE
Definition: app-layer-protos.h:49
SigTableElmt_::desc
const char * desc
Definition: detect.h:1203
flow-util.h
BUFFER_DESC_RESPONDER
#define BUFFER_DESC_RESPONDER
Definition: detect-ike-spi.c:62
SigTableElmt_::name
const char * name
Definition: detect.h:1201
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:378
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
InspectionBuffer
Definition: detect.h:344
threads.h
Flow_
Flow data structure.
Definition: flow.h:353
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:676
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1195
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:758
KEYWORD_DOC_RESPONDER
#define KEYWORD_DOC_RESPONDER
Definition: detect-ike-spi.c:60
rust.h
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:237
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1186
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1010
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:829
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:236
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
app-layer-ike.h
DetectEngineThreadCtx_
Definition: detect.h:1003
detect-engine-mpm.h
detect.h
app-layer-parser.h
DetectEngineInspectBufferGeneric
int 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:1617
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:174
KEYWORD_NAME_RESPONDER
#define KEYWORD_NAME_RESPONDER
Definition: detect-ike-spi.c:59
detect-ike-spi.h
BUFFER_NAME_INITIATOR
#define BUFFER_NAME_INITIATOR
Definition: detect-ike-spi.c:56
DETECT_AL_IKE_SPI_INITIATOR
@ DETECT_AL_IKE_SPI_INITIATOR
Definition: detect-engine-register.h:303
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
BUFFER_DESC_INITIATOR
#define BUFFER_DESC_INITIATOR
Definition: detect-ike-spi.c:57
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1193
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
util-spm.h
DetectIkeSpiRegister
void DetectIkeSpiRegister(void)
Definition: detect-ike-spi.c:131
KEYWORD_NAME_INITIATOR
#define KEYWORD_NAME_INITIATOR
Definition: detect-ike-spi.c:54
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:345
str
#define str(s)
Definition: suricata-common.h:272
BUFFER_NAME_RESPONDER
#define BUFFER_NAME_RESPONDER
Definition: detect-ike-spi.c:61
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:1091
detect-parse.h
Signature_
Signature container.
Definition: detect.h:517
detect-urilen.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1373
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:941
KEYWORD_DOC_INITIATOR
#define KEYWORD_DOC_INITIATOR
Definition: detect-ike-spi.c:55
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:857
DETECT_AL_IKE_SPI_RESPONDER
@ DETECT_AL_IKE_SPI_RESPONDER
Definition: detect-engine-register.h:304
flow.h
flow-var.h
debug.h
app-layer.h