suricata
detect-sip-stat-msg.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_msg sticky buffer
23  *
24  */
25 
26 #include "suricata-common.h"
27 #include "threads.h"
28 #include "debug.h"
29 #include "decode.h"
30 #include "detect.h"
31 
32 #include "detect-parse.h"
33 #include "detect-engine.h"
34 #include "detect-engine-mpm.h"
36 #include "detect-content.h"
37 #include "detect-pcre.h"
38 #include "detect-urilen.h"
39 
40 #include "flow.h"
41 #include "flow-var.h"
42 #include "flow-util.h"
43 
44 #include "util-debug.h"
45 #include "util-unittest.h"
46 #include "util-unittest-helper.h"
47 #include "util-spm.h"
48 
49 #include "app-layer.h"
50 #include "app-layer-parser.h"
51 
52 #include "detect-sip-stat-msg.h"
53 #include "stream-tcp.h"
54 
55 #include "rust.h"
56 #include "app-layer-sip.h"
57 
58 #define KEYWORD_NAME "sip.stat_msg"
59 #define KEYWORD_DOC "sip-keywords.html#sip-stat-msg"
60 #define BUFFER_NAME "sip.stat_msg"
61 #define BUFFER_DESC "sip response status message"
62 static int g_buffer_id = 0;
63 
64 static int DetectSipStatMsgSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
65 {
66  if (DetectBufferSetActiveList(s, g_buffer_id) < 0)
67  return -1;
68 
70  return -1;
71 
72  return 0;
73 }
74 
75 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
76  const DetectEngineTransforms *transforms, Flow *_f,
77  const uint8_t _flow_flags, void *txv, const int list_id)
78 {
79  SCEnter();
80 
81  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
82  if (buffer->inspect == NULL) {
83  const uint8_t *b = NULL;
84  uint32_t b_len = 0;
85 
86  if (rs_sip_tx_get_stat_msg(txv, &b, &b_len) != 1)
87  return NULL;
88  if (b == NULL || b_len == 0)
89  return NULL;
90 
91  InspectionBufferSetup(buffer, b, b_len);
92  InspectionBufferApplyTransforms(buffer, transforms);
93  }
94 
95  return buffer;
96 }
97 
99 {
100  /* sip.stat_msg sticky buffer */
102  sigmatch_table[DETECT_AL_SIP_STAT_MSG].desc = "sticky buffer to match on the SIP status message";
104  sigmatch_table[DETECT_AL_SIP_STAT_MSG].Setup = DetectSipStatMsgSetup;
106 
110 
113  1);
114 
116 
117  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
118 
119  SCLogDebug("registering " BUFFER_NAME " rule option");
120 }
SigTableElmt_::url
const char * url
Definition: detect.h:1214
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1480
detect-content.h
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1213
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1211
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:376
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
InspectionBuffer
Definition: detect.h:344
threads.h
Flow_
Flow data structure.
Definition: flow.h:347
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:611
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1205
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:767
ALPROTO_SIP
@ ALPROTO_SIP
Definition: app-layer-protos.h:53
rust.h
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-sip-stat-msg.c:60
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:237
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1196
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1061
util-unittest-helper.h
DetectSipStatMsgRegister
void DetectSipStatMsgRegister(void)
Definition: detect-sip-stat-msg.c:98
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:880
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1010
SCEnter
#define SCEnter(...)
Definition: util-debug.h:300
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:1641
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:232
app-layer-sip.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
InspectionBufferSetup
void InspectionBufferSetup(InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1120
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1211
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
util-spm.h
detect-sip-stat-msg.h
BUFFER_DESC
#define BUFFER_DESC
Definition: detect-sip-stat-msg.c:61
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:345
str
#define str(s)
Definition: suricata-common.h:273
detect-parse.h
Signature_
Signature container.
Definition: detect.h:528
DETECT_AL_SIP_STAT_MSG
@ DETECT_AL_SIP_STAT_MSG
Definition: detect-engine-register.h:249
detect-urilen.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1380
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:992
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:908
flow.h
flow-var.h
KEYWORD_DOC
#define KEYWORD_DOC
Definition: detect-sip-stat-msg.c:59
debug.h
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-sip-stat-msg.c:58
app-layer.h