suricata
detect-sip-method.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.method 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 
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-method.h"
52 #include "stream-tcp.h"
53 
54 #include "rust.h"
55 #include "app-layer-sip.h"
56 
57 #define KEYWORD_NAME "sip.method"
58 #define KEYWORD_DOC "sip-keywords.html#sip-method"
59 #define BUFFER_NAME "sip.method"
60 #define BUFFER_DESC "sip request method"
61 static int g_buffer_id = 0;
62 
63 static int DetectSipMethodSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
64 {
65  if (DetectBufferSetActiveList(s, g_buffer_id) < 0)
66  return -1;
67 
69  return -1;
70 
71  return 0;
72 }
73 
74 static bool DetectSipMethodValidateCallback(const Signature *s, const char **sigerror)
75 {
76  const SigMatch *sm = s->init_data->smlists[g_buffer_id];
77  for ( ; sm != NULL; sm = sm->next) {
78  if (sm->type != DETECT_CONTENT)
79  continue;
80  const DetectContentData *cd = (const DetectContentData *)sm->ctx;
81  if (cd->content && cd->content_len) {
82  if (cd->content[cd->content_len-1] == 0x20) {
83  *sigerror = "sip.method pattern with trailing space";
84  SCLogError(SC_ERR_INVALID_SIGNATURE, "%s", *sigerror);
85  return true;
86  } else if (cd->content[0] == 0x20) {
87  *sigerror = "sip.method pattern with leading space";
88  SCLogError(SC_ERR_INVALID_SIGNATURE, "%s", *sigerror);
89  return true;
90  } else if (cd->content[cd->content_len-1] == 0x09) {
91  *sigerror = "sip.method pattern with trailing tab";
92  SCLogError(SC_ERR_INVALID_SIGNATURE, "%s", *sigerror);
93  return true;
94  } else if (cd->content[0] == 0x09) {
95  *sigerror = "sip.method pattern with leading tab";
96  SCLogError(SC_ERR_INVALID_SIGNATURE, "%s", *sigerror);
97  return true;
98  }
99  }
100  }
101  return true;
102 }
103 
104 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
105  const DetectEngineTransforms *transforms, Flow *_f,
106  const uint8_t _flow_flags, void *txv, const int list_id)
107 {
108  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
109  if (buffer->inspect == NULL) {
110  const uint8_t *b = NULL;
111  uint32_t b_len = 0;
112 
113  if (rs_sip_tx_get_method(txv, &b, &b_len) != 1)
114  return NULL;
115  if (b == NULL || b_len == 0)
116  return NULL;
117 
118  InspectionBufferSetup(buffer, b, b_len);
119  InspectionBufferApplyTransforms(buffer, transforms);
120  }
121 
122  return buffer;
123 }
124 
126 {
127  /* sip.method sticky buffer */
129  sigmatch_table[DETECT_AL_SIP_METHOD].desc = "sticky buffer to match on the SIP method buffer";
131  sigmatch_table[DETECT_AL_SIP_METHOD].Setup = DetectSipMethodSetup;
133 
137 
140  1);
141 
143 
145  DetectSipMethodValidateCallback);
146 
147  g_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
148 
149  SCLogDebug("registering " BUFFER_NAME " rule option");
150 }
SigTableElmt_::url
const char * url
Definition: detect.h:1212
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1471
detect-content.h
detect-engine.h
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-sip-method.c:57
SigTableElmt_::desc
const char * desc
Definition: detect.h:1211
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1209
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:375
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:59
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
InspectionBuffer
Definition: detect.h:343
threads.h
Flow_
Flow data structure.
Definition: flow.h:343
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:1203
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
SC_ERR_INVALID_SIGNATURE
@ SC_ERR_INVALID_SIGNATURE
Definition: util-error.h:69
ALPROTO_SIP
@ ALPROTO_SIP
Definition: app-layer-protos.h:53
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-sip-method.c:59
rust.h
DetectContentData_
Definition: detect-content.h:86
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1195
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1060
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:879
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:236
decode.h
util-debug.h
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror))
Definition: detect-engine.c:971
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1009
detect-engine-mpm.h
detect.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:323
BUFFER_DESC
#define BUFFER_DESC
Definition: detect-sip-method.c:60
app-layer-parser.h
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:322
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:1640
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:231
DetectSipMethodRegister
void DetectSipMethodRegister(void)
Definition: detect-sip-method.c:125
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:596
KEYWORD_DOC
#define KEYWORD_DOC
Definition: detect-sip-method.c:58
SignatureInitData_::smlists
struct SigMatch_ ** smlists
Definition: detect.h:521
app-layer-sip.h
detect-sip-method.h
SigMatch_::type
uint8_t type
Definition: detect.h:320
DETECT_AL_SIP_METHOD
@ DETECT_AL_SIP_METHOD
Definition: detect-engine-register.h:236
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:1119
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1210
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
util-spm.h
DetectContentData_::content
uint8_t * content
Definition: detect-content.h:87
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:344
str
#define str(s)
Definition: suricata-common.h:273
detect-parse.h
Signature_
Signature container.
Definition: detect.h:527
SigMatch_
a single match condition for a signature
Definition: detect.h:319
DetectContentData_::content_len
uint16_t content_len
Definition: detect-content.h:88
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1378
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:991
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:907
flow.h
flow-var.h
debug.h
app-layer.h