suricata
util-mpm.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2014 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 
24 #ifndef __UTIL_MPM_H__
25 #define __UTIL_MPM_H__
26 
27 #include "util-prefilter.h"
28 
29 #define MPM_INIT_HASH_SIZE 65536
30 
31 enum {
33 
34  /* aho-corasick */
39  /* table size */
41 };
42 
43 /* Internal Pattern Index: 0 to pattern_cnt-1 */
44 typedef uint32_t MpmPatternIndex;
45 
46 typedef struct MpmThreadCtx_ {
47  void *ctx;
48 
49  uint32_t memory_cnt;
50  uint32_t memory_size;
51 
53 
54 typedef struct MpmPattern_ {
55  /* length of the pattern */
56  uint16_t len;
57  /* flags decribing the pattern */
58  uint8_t flags;
59 
60  /* offset into the buffer where match may start */
61  uint16_t offset;
62 
63  /* offset into the buffer before which match much complete */
64  uint16_t depth;
65 
66  /* holds the original pattern that was added */
67  uint8_t *original_pat;
68  /* case sensitive */
69  uint8_t *cs;
70  /* case INsensitive */
71  uint8_t *ci;
72  /* pattern id */
73  uint32_t id;
74 
75  /* sid(s) for this pattern */
76  uint32_t sids_size;
78 
79  struct MpmPattern_ *next;
81 
82 /* Indicates if this a global mpm_ctx. Global mpm_ctx is the one that
83  * is instantiated when we use "single". Non-global is "full", i.e.
84  * one per sgh. */
85 #define MPMCTX_FLAGS_GLOBAL BIT_U8(0)
86 #define MPMCTX_FLAGS_NODEPTH BIT_U8(1)
87 
88 typedef struct MpmCtx_ {
89  void *ctx;
90  uint8_t mpm_type;
91 
92  uint8_t flags;
93 
94  uint16_t maxdepth;
95 
96  /* unique patterns */
97  uint32_t pattern_cnt;
98 
99  uint16_t minlen;
100  uint16_t maxlen;
101 
102  uint32_t memory_cnt;
103  uint32_t memory_size;
104 
105  uint32_t max_pat_id;
106 
107  /* hash used during ctx initialization */
110 
111 /* if we want to retrieve an unique mpm context from the mpm context factory
112  * we should supply this as the key */
113 #define MPM_CTX_FACTORY_UNIQUE_CONTEXT -1
114 
115 typedef struct MpmCtxFactoryItem_ {
116  const char *name;
119  int32_t id;
121 
122 typedef struct MpmCtxFactoryContainer_ {
124  int32_t no_of_items;
126 
127 /** pattern is case insensitive */
128 #define MPM_PATTERN_FLAG_NOCASE 0x01
129 /** pattern is negated */
130 #define MPM_PATTERN_FLAG_NEGATED 0x02
131 /** pattern has a depth setting */
132 #define MPM_PATTERN_FLAG_DEPTH 0x04
133 /** pattern has an offset setting */
134 #define MPM_PATTERN_FLAG_OFFSET 0x08
135 /** one byte pattern (used in b2g) */
136 #define MPM_PATTERN_ONE_BYTE 0x10
137 /** the ctx uses it's own internal id instead of
138  * what is passed through the API */
139 #define MPM_PATTERN_CTX_OWNS_ID 0x20
140 
141 typedef struct MpmTableElmt_ {
142  const char *name;
143  void (*InitCtx)(struct MpmCtx_ *);
144  void (*InitThreadCtx)(struct MpmCtx_ *, struct MpmThreadCtx_ *);
145  void (*DestroyCtx)(struct MpmCtx_ *);
146  void (*DestroyThreadCtx)(struct MpmCtx_ *, struct MpmThreadCtx_ *);
147 
148  /** function pointers for adding patterns to the mpm ctx.
149  *
150  * \param mpm_ctx Mpm context to add the pattern to
151  * \param pattern pointer to the pattern
152  * \param pattern_len length of the pattern in bytes
153  * \param offset pattern offset setting
154  * \param depth pattern depth setting
155  * \param pid pattern id
156  * \param sid signature _internal_ id
157  * \param flags pattern flags
158  */
159  int (*AddPattern)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t);
160  int (*AddPatternNocase)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t);
161  int (*Prepare)(struct MpmCtx_ *);
162  uint32_t (*Search)(const struct MpmCtx_ *, struct MpmThreadCtx_ *, PrefilterRuleStore *, const uint8_t *, uint32_t);
163  void (*PrintCtx)(struct MpmCtx_ *);
164  void (*PrintThreadCtx)(struct MpmThreadCtx_ *);
165  void (*RegisterUnittests)(void);
166  uint8_t flags;
168 
170 extern int mpm_default_matcher;
171 
172 struct DetectEngineCtx_;
173 
174 int32_t MpmFactoryRegisterMpmCtxProfile(struct DetectEngineCtx_ *, const char *);
178 int32_t MpmFactoryIsMpmCtxAvailable(const struct DetectEngineCtx_ *, const MpmCtx *);
179 
184 
185 void MpmTableSetup(void);
186 void MpmRegisterTests(void);
187 
188 void MpmInitCtx(MpmCtx *mpm_ctx, uint16_t matcher);
189 void MpmInitThreadCtx(MpmThreadCtx *mpm_thread_ctx, uint16_t);
190 
191 int MpmAddPatternCS(struct MpmCtx_ *mpm_ctx, uint8_t *pat, uint16_t patlen,
192  uint16_t offset, uint16_t depth,
193  uint32_t pid, SigIntId sid, uint8_t flags);
194 int MpmAddPatternCI(struct MpmCtx_ *mpm_ctx, uint8_t *pat, uint16_t patlen,
195  uint16_t offset, uint16_t depth,
196  uint32_t pid, SigIntId sid, uint8_t flags);
197 
198 void MpmFreePattern(MpmCtx *mpm_ctx, MpmPattern *p);
199 
200 int MpmAddPattern(MpmCtx *mpm_ctx, uint8_t *pat, uint16_t patlen,
201  uint16_t offset, uint16_t depth, uint32_t pid,
202  SigIntId sid, uint8_t flags);
203 
204 #endif /* __UTIL_MPM_H__ */
MpmTableElmt_::PrintThreadCtx
void(* PrintThreadCtx)(struct MpmThreadCtx_ *)
Definition: util-mpm.h:164
mpm_default_matcher
int mpm_default_matcher
Definition: util-mpm.c:49
MpmCtx_::mpm_type
uint8_t mpm_type
Definition: util-mpm.h:90
MpmCtxFactoryItem_::mpm_ctx_ts
MpmCtx * mpm_ctx_ts
Definition: util-mpm.h:117
MpmPatternIndex
uint32_t MpmPatternIndex
Definition: util-mpm.h:44
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
MpmTableElmt_::InitThreadCtx
void(* InitThreadCtx)(struct MpmCtx_ *, struct MpmThreadCtx_ *)
Definition: util-mpm.h:144
MpmTableElmt_::flags
uint8_t flags
Definition: util-mpm.h:166
MpmThreadCtx_
Definition: util-mpm.h:46
MpmAddPattern
int MpmAddPattern(MpmCtx *mpm_ctx, uint8_t *pat, uint16_t patlen, uint16_t offset, uint16_t depth, uint32_t pid, SigIntId sid, uint8_t flags)
Definition: util-mpm.c:481
MpmTableElmt_::name
const char * name
Definition: util-mpm.h:142
PrefilterRuleStore_
structure for storing potential rule matches
Definition: util-prefilter.h:32
PmqCleanup
void PmqCleanup(PrefilterRuleStore *)
Cleanup a Pmq.
Definition: util-prefilter.c:113
MpmThreadCtx_::memory_cnt
uint32_t memory_cnt
Definition: util-mpm.h:49
MpmCtxFactoryItem_::mpm_ctx_tc
MpmCtx * mpm_ctx_tc
Definition: util-mpm.h:118
MpmAddPatternCI
int MpmAddPatternCI(struct MpmCtx_ *mpm_ctx, uint8_t *pat, uint16_t patlen, uint16_t offset, uint16_t depth, uint32_t pid, SigIntId sid, uint8_t flags)
Definition: util-mpm.c:304
MpmCtxFactoryContainer
struct MpmCtxFactoryContainer_ MpmCtxFactoryContainer
MpmTableElmt
struct MpmTableElmt_ MpmTableElmt
MpmAddPatternCS
int MpmAddPatternCS(struct MpmCtx_ *mpm_ctx, uint8_t *pat, uint16_t patlen, uint16_t offset, uint16_t depth, uint32_t pid, SigIntId sid, uint8_t flags)
Definition: util-mpm.c:295
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
MpmCtx_::memory_size
uint32_t memory_size
Definition: util-mpm.h:103
MpmTableElmt_::AddPatternNocase
int(* AddPatternNocase)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t)
Definition: util-mpm.h:160
MpmCtx_::maxlen
uint16_t maxlen
Definition: util-mpm.h:100
MpmTableElmt_::AddPattern
int(* AddPattern)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t)
Definition: util-mpm.h:159
mpm_table
MpmTableElmt mpm_table[MPM_TABLE_SIZE]
Definition: util-mpm.c:48
MpmPattern_::original_pat
uint8_t * original_pat
Definition: util-mpm.h:67
MpmCtx_::maxdepth
uint16_t maxdepth
Definition: util-mpm.h:94
MPM_AC
@ MPM_AC
Definition: util-mpm.h:35
MpmThreadCtx
struct MpmThreadCtx_ MpmThreadCtx
MpmTableElmt_::InitCtx
void(* InitCtx)(struct MpmCtx_ *)
Definition: util-mpm.h:143
MPM_AC_BS
@ MPM_AC_BS
Definition: util-mpm.h:36
MpmPattern_::flags
uint8_t flags
Definition: util-mpm.h:58
MpmInitThreadCtx
void MpmInitThreadCtx(MpmThreadCtx *mpm_thread_ctx, uint16_t)
Definition: util-mpm.c:249
MpmCtxFactoryItem_::name
const char * name
Definition: util-mpm.h:116
MpmTableElmt_::PrintCtx
void(* PrintCtx)(struct MpmCtx_ *)
Definition: util-mpm.h:163
MpmCtx_::max_pat_id
uint32_t max_pat_id
Definition: util-mpm.h:105
MpmTableSetup
void MpmTableSetup(void)
Definition: util-mpm.c:269
MpmInitCtx
void MpmInitCtx(MpmCtx *mpm_ctx, uint16_t matcher)
Definition: util-mpm.c:254
MPM_AC_KS
@ MPM_AC_KS
Definition: util-mpm.h:37
MpmPattern
struct MpmPattern_ MpmPattern
MpmCtxFactoryItem_::id
int32_t id
Definition: util-mpm.h:119
MpmPattern_::next
struct MpmPattern_ * next
Definition: util-mpm.h:79
MPM_HS
@ MPM_HS
Definition: util-mpm.h:38
MpmPattern_::id
uint32_t id
Definition: util-mpm.h:73
MpmThreadCtx_::memory_size
uint32_t memory_size
Definition: util-mpm.h:50
MpmFactoryIsMpmCtxAvailable
int32_t MpmFactoryIsMpmCtxAvailable(const struct DetectEngineCtx_ *, const MpmCtx *)
MpmCtxFactoryContainer_::items
MpmCtxFactoryItem * items
Definition: util-mpm.h:123
MpmCtx_::minlen
uint16_t minlen
Definition: util-mpm.h:99
PmqReset
void PmqReset(PrefilterRuleStore *)
Reset a Pmq for reusage. Meant to be called after a single search.
Definition: util-prefilter.c:101
MpmPattern_::sids_size
uint32_t sids_size
Definition: util-mpm.h:76
MpmFreePattern
void MpmFreePattern(MpmCtx *mpm_ctx, MpmPattern *p)
Definition: util-mpm.c:403
MPM_NOTSET
@ MPM_NOTSET
Definition: util-mpm.h:32
MpmCtxFactoryItem_
Definition: util-mpm.h:115
MpmTableElmt_::Prepare
int(* Prepare)(struct MpmCtx_ *)
Definition: util-mpm.h:161
MpmPattern_
Definition: util-mpm.h:54
MpmTableElmt_::Search
uint32_t(* Search)(const struct MpmCtx_ *, struct MpmThreadCtx_ *, PrefilterRuleStore *, const uint8_t *, uint32_t)
Definition: util-mpm.h:162
MpmFactoryRegisterMpmCtxProfile
int32_t MpmFactoryRegisterMpmCtxProfile(struct DetectEngineCtx_ *, const char *)
Register a new Mpm Context.
Definition: util-mpm.c:58
MpmPattern_::ci
uint8_t * ci
Definition: util-mpm.h:71
MPM_TABLE_SIZE
@ MPM_TABLE_SIZE
Definition: util-mpm.h:40
util-prefilter.h
flags
uint8_t flags
Definition: decode-gre.h:0
MpmCtx_::pattern_cnt
uint32_t pattern_cnt
Definition: util-mpm.h:97
MpmFactoryReClaimMpmCtx
void MpmFactoryReClaimMpmCtx(const struct DetectEngineCtx_ *, MpmCtx *)
PmqFree
void PmqFree(PrefilterRuleStore *)
Cleanup and free a Pmq.
Definition: util-prefilter.c:126
MpmPattern_::offset
uint16_t offset
Definition: util-mpm.h:61
MpmPattern_::sids
SigIntId * sids
Definition: util-mpm.h:77
MpmRegisterTests
void MpmRegisterTests(void)
Definition: util-mpm.c:617
MpmPattern_::depth
uint16_t depth
Definition: util-mpm.h:64
MpmFactoryDeRegisterAllMpmCtxProfiles
void MpmFactoryDeRegisterAllMpmCtxProfiles(struct DetectEngineCtx_ *)
Definition: util-mpm.c:222
MpmTableElmt_::DestroyCtx
void(* DestroyCtx)(struct MpmCtx_ *)
Definition: util-mpm.h:145
MpmCtxFactoryContainer_::no_of_items
int32_t no_of_items
Definition: util-mpm.h:124
PmqSetup
int PmqSetup(PrefilterRuleStore *)
Setup a pmq.
Definition: util-prefilter.c:36
MpmCtx_::memory_cnt
uint32_t memory_cnt
Definition: util-mpm.h:102
MpmCtx_::init_hash
MpmPattern ** init_hash
Definition: util-mpm.h:108
MpmPattern_::len
uint16_t len
Definition: util-mpm.h:56
MpmCtx
struct MpmCtx_ MpmCtx
MpmTableElmt_::DestroyThreadCtx
void(* DestroyThreadCtx)(struct MpmCtx_ *, struct MpmThreadCtx_ *)
Definition: util-mpm.h:146
MpmCtx_
Definition: util-mpm.h:88
MpmPattern_::cs
uint8_t * cs
Definition: util-mpm.h:69
SigIntId
#define SigIntId
Definition: suricata-common.h:297
MpmCtx_::flags
uint8_t flags
Definition: util-mpm.h:92
MpmTableElmt_
Definition: util-mpm.h:141
MpmCtx_::ctx
void * ctx
Definition: util-mpm.h:89
MpmFactoryGetMpmCtxForProfile
MpmCtx * MpmFactoryGetMpmCtxForProfile(const struct DetectEngineCtx_ *, int32_t, int)
MpmThreadCtx_::ctx
void * ctx
Definition: util-mpm.h:47
MpmTableElmt_::RegisterUnittests
void(* RegisterUnittests)(void)
Definition: util-mpm.h:165
MpmCtxFactoryItem
struct MpmCtxFactoryItem_ MpmCtxFactoryItem
MpmCtxFactoryContainer_
Definition: util-mpm.h:122