suricata
detect-sip-uri.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.uri 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-uri.h"
52 #include "stream-tcp.h"
53 
54 #include "rust.h"
55 #include "app-layer-sip.h"
56 
57 #define KEYWORD_NAME "sip.uri"
58 #define KEYWORD_DOC "sip-keywords.html#sip-uri"
59 #define BUFFER_NAME "sip.uri"
60 #define BUFFER_DESC "sip request uri"
61 static int g_buffer_id = 0;
62 
63 static bool DetectSipUriValidateCallback(const Signature *s, const char **sigerror)
64 {
65  return DetectUrilenValidateContent(s, g_buffer_id, sigerror);
66 }
67 
68 static void DetectSipUriSetupCallback(const DetectEngineCtx *de_ctx,
69  Signature *s)
70 {
71  SCLogDebug("callback invoked by %u", s->id);
72  DetectUrilenApplyToContent(s, g_buffer_id);
73 }
74 
75 static int DetectSipUriSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
76 {
77  if (DetectBufferSetActiveList(s, g_buffer_id) < 0)
78  return -1;
79 
81  return -1;
82 
83  return 0;
84 }
85 
86 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
87  const DetectEngineTransforms *transforms, Flow *_f,
88  const uint8_t _flow_flags, void *txv, const int list_id)
89 {
90  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
91  if (buffer->inspect == NULL) {
92  const uint8_t *b = NULL;
93  uint32_t b_len = 0;
94 
95  if (rs_sip_tx_get_uri(txv, &b, &b_len) != 1)
96  return NULL;
97  if (b == NULL || b_len == 0)
98  return NULL;
99 
100  InspectionBufferSetup(det_ctx, list_id, buffer, b, b_len);
101  InspectionBufferApplyTransforms(buffer, transforms);
102  }
103 
104  return buffer;
105 }
106 
108 {
110  sigmatch_table[DETECT_AL_SIP_URI].desc = "sticky buffer to match on the SIP URI";
112  sigmatch_table[DETECT_AL_SIP_URI].Setup = DetectSipUriSetup;
114 
118 
121  1);
122 
124 
126  DetectSipUriSetupCallback);
127 
129  DetectSipUriValidateCallback);
130 
131  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
132 
133  SCLogDebug("registering " BUFFER_NAME " rule option");
134 }
SigTableElmt_::url
const char * url
Definition: detect.h:1248
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1490
detect-content.h
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1247
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:1994
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1245
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:372
KEYWORD_DOC
#define KEYWORD_DOC
Definition: detect-sip-uri.c:58
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:296
InspectionBuffer
Definition: detect.h:338
threads.h
Flow_
Flow data structure.
Definition: flow.h:353
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:1262
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:755
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1239
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:785
ALPROTO_SIP
@ ALPROTO_SIP
Definition: app-layer-protos.h:54
rust.h
DETECT_AL_SIP_URI
@ DETECT_AL_SIP_URI
Definition: detect-engine-register.h:256
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1230
detect-pcre.h
DetectUrilenApplyToContent
void DetectUrilenApplyToContent(Signature *s, int list)
set prefilter dsize pair
Definition: detect-urilen.c:148
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1369
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1086
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:230
decode.h
util-debug.h
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror))
Definition: detect-engine.c:1280
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1034
detect-engine-mpm.h
detect.h
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-sip-uri.c:59
app-layer-parser.h
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
BUFFER_DESC
#define BUFFER_DESC
Definition: detect-sip-uri.c:60
app-layer-sip.h
DetectSipUriRegister
void DetectSipUriRegister(void)
Definition: detect-sip-uri.c:107
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:1552
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-sip-uri.c:57
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
util-spm.h
detect-sip-uri.h
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:339
str
#define str(s)
Definition: suricata-common.h:272
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:1450
Signature_::id
uint32_t id
Definition: detect.h:574
detect-parse.h
Signature_
Signature container.
Definition: detect.h:540
detect-urilen.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1431
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:1300
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1183
DetectUrilenValidateContent
bool DetectUrilenValidateContent(const Signature *s, int list, const char **sigerror)
Definition: detect-urilen.c:211
flow.h
flow-var.h
app-layer.h