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 #include "rust-sip-detect-gen.h"
58 
59 #define KEYWORD_NAME "sip.stat_msg"
60 #define KEYWORD_DOC "sip-keywords.html#sip-stat-msg"
61 #define BUFFER_NAME "sip.stat_msg"
62 #define BUFFER_DESC "sip response status message"
63 static int g_buffer_id = 0;
64 
65 static int DetectSipStatMsgSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
66 {
67  if (DetectBufferSetActiveList(s, g_buffer_id) < 0)
68  return -1;
69 
71  return -1;
72 
73  return 0;
74 }
75 
76 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
77  const DetectEngineTransforms *transforms, Flow *_f,
78  const uint8_t _flow_flags, void *txv, const int list_id)
79 {
80  SCEnter();
81 
82  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
83  if (buffer->inspect == NULL) {
84  const uint8_t *b = NULL;
85  uint32_t b_len = 0;
86 
87  if (rs_sip_tx_get_stat_msg(txv, &b, &b_len) != 1)
88  return NULL;
89  if (b == NULL || b_len == 0)
90  return NULL;
91 
92  InspectionBufferSetup(buffer, b, b_len);
93  InspectionBufferApplyTransforms(buffer, transforms);
94  }
95 
96  return buffer;
97 }
98 
100 {
101  /* sip.stat_msg sticky buffer */
103  sigmatch_table[DETECT_AL_SIP_STAT_MSG].desc = "sticky buffer to match on the SIP status message";
105  sigmatch_table[DETECT_AL_SIP_STAT_MSG].Setup = DetectSipStatMsgSetup;
107 
111 
114  1);
115 
117 
118  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
119 
120  SCLogDebug("registering " BUFFER_NAME " rule option");
121 }
#define KEYWORD_DOC
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect.h:1448
#define KEYWORD_NAME
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1186
#define SCLogDebug(...)
Definition: util-debug.h:335
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
#define BUFFER_NAME
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
const char * name
Definition: detect.h:1200
Signature container.
Definition: detect.h:522
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
main detection engine ctx
Definition: detect.h:761
int DetectBufferTypeGetByName(const char *name)
#define str(s)
#define SIG_FLAG_TOCLIENT
Definition: detect.h:237
void DetectSipStatMsgRegister(void)
#define SCEnter(...)
Definition: util-debug.h:337
void DetectAppLayerInspectEngineRegister2(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr2 Callback2, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
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.
#define BUFFER_DESC
const char * desc
Definition: detect.h:1202
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
void InspectionBufferSetup(InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
#define SIGMATCH_NOOPT
Definition: detect.h:1369
const char * url
Definition: detect.h:1203
int DetectBufferSetActiveList(Signature *s, const int list)
const uint8_t * inspect
Definition: detect.h:343
#define DOC_URL
Definition: suricata.h:86
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
#define DOC_VERSION
Definition: suricata.h:91
uint16_t flags
Definition: detect.h:1194
Flow data structure.
Definition: flow.h:325