suricata
detect-prefilter.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2016 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  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  * Implements the prefilter keyword
24  */
25 
26 #include "suricata-common.h"
27 #include "decode.h"
28 
29 #include "detect.h"
30 #include "detect-parse.h"
31 #include "detect-content.h"
32 #include "detect-prefilter.h"
33 #include "util-debug.h"
34 
35 static int DetectPrefilterSetup (DetectEngineCtx *, Signature *, const char *);
36 
38 {
39  sigmatch_table[DETECT_PREFILTER].name = "prefilter";
40  sigmatch_table[DETECT_PREFILTER].desc = "force a condition to be used as prefilter";
41  sigmatch_table[DETECT_PREFILTER].url = "/rules/prefilter-keywords.html#prefilter";
43  sigmatch_table[DETECT_PREFILTER].Setup = DetectPrefilterSetup;
46 
48 }
49 
50 /**
51  * \internal
52  * \brief Apply the prefilter keyword to the last match
53  * \param det_ctx detection engine ctx
54  * \param s signature
55  * \param nullstr should be null
56  * \retval 0 ok
57  * \retval -1 failure
58  */
59 static int DetectPrefilterSetup (DetectEngineCtx *de_ctx, Signature *s, const char *nullstr)
60 {
61  SCEnter();
62 
63  if (nullstr != NULL) {
64  SCLogError(SC_ERR_INVALID_VALUE, "prefilter has value");
65  SCReturnInt(-1);
66  }
67 
68  if (s->flags & SIG_FLAG_PREFILTER) {
69  SCLogError(SC_ERR_INVALID_SIGNATURE, "prefilter already set");
70  SCReturnInt(-1);
71  }
72 
73  SigMatch *sm = DetectGetLastSM(s);
74  if (sm == NULL) {
75  SCLogError(SC_ERR_INVALID_SIGNATURE, "prefilter needs preceding match");
76  SCReturnInt(-1);
77  }
78 
79  s->init_data->prefilter_sm = sm;
80 
81  /* if the sig match is content, prefilter should act like
82  * 'fast_pattern' w/o options. */
83  if (sm->type == DETECT_CONTENT) {
85  if ((cd->flags & DETECT_CONTENT_NEGATED) &&
86  ((cd->flags & DETECT_CONTENT_DISTANCE) ||
87  (cd->flags & DETECT_CONTENT_WITHIN) ||
88  (cd->flags & DETECT_CONTENT_OFFSET) ||
89  (cd->flags & DETECT_CONTENT_DEPTH)))
90  {
91  SCLogError(SC_ERR_INVALID_SIGNATURE, "prefilter; cannot be "
92  "used with negated content, along with relative modifiers");
93  SCReturnInt(-1);
94  }
96  } else {
98 
99  /* make sure setup function runs for this type. */
100  de_ctx->sm_types_prefilter[sm->type] = true;
101  }
102 
103  SCReturnInt(0);
104 }
SigTableElmt_::url
const char * url
Definition: detect.h:1212
detect-content.h
SigTableElmt_::desc
const char * desc
Definition: detect.h:1211
SC_ERR_INVALID_VALUE
@ SC_ERR_INVALID_VALUE
Definition: util-error.h:160
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1200
SigTableElmt_::name
const char * name
Definition: detect.h:1209
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:59
SignatureInitData_::prefilter_sm
SigMatch * prefilter_sm
Definition: detect.h:501
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1203
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
DETECT_PREFILTER
@ DETECT_PREFILTER
Definition: detect-engine-register.h:265
SC_ERR_INVALID_SIGNATURE
@ SC_ERR_INVALID_SIGNATURE
Definition: util-error.h:69
DetectContentData_
Definition: detect-content.h:86
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1195
decode.h
util-debug.h
DETECT_CONTENT_DISTANCE
#define DETECT_CONTENT_DISTANCE
Definition: detect-content.h:30
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DETECT_CONTENT_DEPTH
#define DETECT_CONTENT_DEPTH
Definition: detect-content.h:33
SCEnter
#define SCEnter(...)
Definition: util-debug.h:300
detect.h
detect-prefilter.h
DETECT_CONTENT_NEGATED
#define DETECT_CONTENT_NEGATED
Definition: detect-content.h:40
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:322
Signature_::flags
uint32_t flags
Definition: detect.h:528
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:97
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:596
SigTableElmt_::Match
int(* Match)(DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1178
DetectPrefilterRegister
void DetectPrefilterRegister(void)
Definition: detect-prefilter.c:37
DetectGetLastSM
SigMatch * DetectGetLastSM(const Signature *s)
Returns the sm with the largest index (added latest) from this sig.
Definition: detect-parse.c:572
SigMatch_::type
uint8_t type
Definition: detect.h:320
suricata-common.h
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
DetectEngineCtx_::sm_types_prefilter
bool sm_types_prefilter[DETECT_TBLSIZE]
Definition: detect.h:952
DETECT_CONTENT_OFFSET
#define DETECT_CONTENT_OFFSET
Definition: detect-content.h:32
detect-parse.h
Signature_
Signature container.
Definition: detect.h:527
SigMatch_
a single match condition for a signature
Definition: detect.h:319
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1378
DETECT_CONTENT_FAST_PATTERN
#define DETECT_CONTENT_FAST_PATTERN
Definition: detect-content.h:34
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:304
SIG_FLAG_PREFILTER
#define SIG_FLAG_PREFILTER
Definition: detect.h:243
DETECT_CONTENT_WITHIN
#define DETECT_CONTENT_WITHIN
Definition: detect-content.h:31
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1201