suricata
detect-sip-stat-code.c
Go to the documentation of this file.
1 /* Copyright (C) 2019 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 Giuseppe Longo <giuseppe@glongo.it>
21  *
22  * Implements the sip.stat_code sticky buffer
23  *
24  */
25 
26 #include "suricata-common.h"
27 #include "threads.h"
28 #include "decode.h"
29 #include "detect.h"
30 
31 #include "detect-parse.h"
32 #include "detect-engine.h"
33 #include "detect-engine-mpm.h"
35 #include "detect-content.h"
36 #include "detect-pcre.h"
37 #include "detect-urilen.h"
38 
39 #include "flow.h"
40 #include "flow-var.h"
41 #include "flow-util.h"
42 
43 #include "util-debug.h"
44 #include "util-unittest.h"
45 #include "util-unittest-helper.h"
46 #include "util-spm.h"
47 
48 #include "app-layer.h"
49 #include "app-layer-parser.h"
50 
51 #include "detect-sip-stat-code.h"
52 #include "stream-tcp.h"
53 
54 #include "rust.h"
55 #include "app-layer-sip.h"
56 
57 #define KEYWORD_NAME "sip.stat_code"
58 #define KEYWORD_DOC "sip-keywords.html#sip-stat-code"
59 #define BUFFER_NAME "sip.method"
60 #define BUFFER_DESC "sip response status code"
61 static int g_buffer_id = 0;
62 
63 static int DetectSipStatCodeSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
64 {
65  if (DetectBufferSetActiveList(de_ctx, s, g_buffer_id) < 0)
66  return -1;
67 
69  return -1;
70 
71  return 0;
72 }
73 
74 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
75  const DetectEngineTransforms *transforms, Flow *_f,
76  const uint8_t _flow_flags, void *txv, const int list_id)
77 {
78  SCEnter();
79 
80  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
81  if (buffer->inspect == NULL) {
82  const uint8_t *b = NULL;
83  uint32_t b_len = 0;
84 
85  if (rs_sip_tx_get_stat_code(txv, &b, &b_len) != 1)
86  return NULL;
87  if (b == NULL || b_len == 0)
88  return NULL;
89 
90  InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
91  InspectionBufferApplyTransforms(buffer, transforms);
92  }
93 
94  return buffer;
95 }
96 
98 {
99  /* sip.stat_code sticky buffer */
101  sigmatch_table[DETECT_AL_SIP_STAT_CODE].desc = "sticky buffer to match on the SIP status code";
103  sigmatch_table[DETECT_AL_SIP_STAT_CODE].Setup = DetectSipStatCodeSetup;
105 
108 
110  GetData, ALPROTO_SIP, 1);
111 
113 
114  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
115 
116  SCLogDebug("registering " BUFFER_NAME " rule option");
117 }
SigTableElmt_::url
const char * url
Definition: detect.h:1295
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1753
detect-content.h
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1294
DETECT_AL_SIP_STAT_CODE
@ DETECT_AL_SIP_STAT_CODE
Definition: detect-engine-register.h:272
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:2169
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1292
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:405
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1382
KEYWORD_DOC
#define KEYWORD_DOC
Definition: detect-sip-stat-code.c:58
InspectionBuffer
Definition: detect.h:370
threads.h
Flow_
Flow data structure.
Definition: flow.h:350
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1286
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:835
ALPROTO_SIP
@ ALPROTO_SIP
Definition: app-layer-protos.h:54
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-sip-stat-code.c:57
rust.h
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:263
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1277
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1526
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1119
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1091
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect-engine-mpm.h
detect.h
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:745
DetectAppLayerMpmRegister
void DetectAppLayerMpmRegister(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register a MPM engine
Definition: detect-engine-mpm.c:89
app-layer-parser.h
app-layer-sip.h
detect-sip-stat-code.h
suricata-common.h
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1725
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:127
util-spm.h
BUFFER_DESC
#define BUFFER_DESC
Definition: detect-sip-stat-code.c:60
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:371
str
#define str(s)
Definition: suricata-common.h:291
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:1621
detect-parse.h
Signature_
Signature container.
Definition: detect.h:592
DetectSipStatCodeRegister
void DetectSipStatCodeRegister(void)
Definition: detect-sip-stat-code.c:97
detect-urilen.h
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-sip-stat-code.c:59
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1472
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
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1216
flow.h
flow-var.h
app-layer.h