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 
56 #define KEYWORD_NAME "sip.uri"
57 #define KEYWORD_DOC "sip-keywords.html#sip-uri"
58 #define BUFFER_NAME "sip.uri"
59 #define BUFFER_DESC "sip request uri"
60 static int g_buffer_id = 0;
61 
62 static void DetectSipUriSetupCallback(const DetectEngineCtx *de_ctx,
63  Signature *s)
64 {
65  SCLogDebug("callback invoked by %u", s->id);
66  DetectUrilenApplyToContent(s, g_buffer_id);
67 }
68 
69 static int DetectSipUriSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
70 {
71  if (DetectBufferSetActiveList(de_ctx, s, g_buffer_id) < 0)
72  return -1;
73 
75  return -1;
76 
77  return 0;
78 }
79 
80 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
81  const DetectEngineTransforms *transforms, Flow *_f,
82  const uint8_t _flow_flags, void *txv, const int list_id)
83 {
84  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
85  if (buffer->inspect == NULL) {
86  const uint8_t *b = NULL;
87  uint32_t b_len = 0;
88 
89  if (rs_sip_tx_get_uri(txv, &b, &b_len) != 1)
90  return NULL;
91  if (b == NULL || b_len == 0)
92  return NULL;
93 
94  InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
95  }
96 
97  return buffer;
98 }
99 
101 {
103  sigmatch_table[DETECT_SIP_URI].desc = "sticky buffer to match on the SIP URI";
105  sigmatch_table[DETECT_SIP_URI].Setup = DetectSipUriSetup;
107 
110 
112  GetData, ALPROTO_SIP, 1);
113 
115 
117  DetectSipUriSetupCallback);
118 
120 
121  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
122 
123  SCLogDebug("registering " BUFFER_NAME " rule option");
124 }
SigTableElmt_::url
const char * url
Definition: detect.h:1405
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:2218
detect-content.h
detect-engine.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1404
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:155
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:2252
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1402
InspectionBufferSetupAndApplyTransforms
void InspectionBufferSetupAndApplyTransforms(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len, const DetectEngineTransforms *transforms)
setup the buffer with our initial data
Definition: detect-engine.c:1719
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:415
KEYWORD_DOC
#define KEYWORD_DOC
Definition: detect-sip-uri.c:57
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1422
InspectionBuffer
Definition: detect.h:380
threads.h
Flow_
Flow data structure.
Definition: flow.h:356
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:1351
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1396
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:920
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror, const DetectBufferType *))
Definition: detect-engine.c:1369
ALPROTO_SIP
@ ALPROTO_SIP
Definition: app-layer-protos.h:59
rust.h
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1387
detect-pcre.h
DetectUrilenApplyToContent
void DetectUrilenApplyToContent(Signature *s, int list)
set prefilter dsize pair
Definition: detect-urilen.c:149
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1578
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1157
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
decode.h
util-debug.h
DETECT_SIP_URI
@ DETECT_SIP_URI
Definition: detect-engine-register.h:280
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEngineThreadCtx_
Definition: detect.h:1197
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:1547
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-sip-uri.c:58
DetectAppLayerMpmRegister
void DetectAppLayerMpmRegister(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register an app layer keyword for mpm
Definition: detect-engine-mpm.c:151
app-layer-parser.h
BUFFER_DESC
#define BUFFER_DESC
Definition: detect-sip-uri.c:59
DetectSipUriRegister
void DetectSipUriRegister(void)
Definition: detect-sip-uri.c:100
DetectUrilenValidateContent
bool DetectUrilenValidateContent(const Signature *s, const char **sigerror, const DetectBufferType *dbt)
Definition: detect-urilen.c:217
suricata-common.h
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-sip-uri.c:56
util-spm.h
detect-sip-uri.h
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:381
str
#define str(s)
Definition: suricata-common.h:300
Signature_::id
uint32_t id
Definition: detect.h:714
detect-parse.h
Signature_
Signature container.
Definition: detect.h:669
detect-urilen.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1592
DetectAppLayerInspectEngineRegister
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
Registers an app inspection engine.
Definition: detect-engine.c:245
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1254
flow.h
flow-var.h
app-layer.h