/* Copyright (C) 2007-2014 Open Information Security Foundation * * You can copy, redistribute or modify this Program under the terms of * the GNU General Public License version 2 as published by the Free * Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * version 2 along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA * 02110-1301, USA. */ /** * \file * * \author Victor Julien */ #ifndef __DETECT_H__ #define __DETECT_H__ #include #include "flow.h" #include "detect-engine-proto.h" #include "detect-reference.h" #include "packet-queue.h" #include "util-prefilter.h" #include "util-mpm.h" #include "util-spm.h" #include "util-hash.h" #include "util-hashlist.h" #include "util-debug.h" #include "util-error.h" #include "util-radix-tree.h" #include "util-file.h" #include "reputation.h" #include "detect-mark.h" #include "stream.h" #define DETECT_MAX_RULE_SIZE 8192 /* forward declarations for the structures from detect-engine-sigorder.h */ struct SCSigOrderFunc_; struct SCSigSignatureWrapper_; /* The detection engine groups similar signatures/rules together. Internally a tree of different types of data is created on initialization. This is it's global layout: For TCP/UDP - Flow direction -- Protocol -=- Src address -==- Dst address -===- Src port -====- Dst port For the other protocols - Flow direction -- Protocol -=- Src address -==- Dst address */ /* * DETECT ADDRESS */ /* holds the values for different possible lists in struct Signature. * These codes are access points to particular lists in the array * Signature->sm_lists[DETECT_SM_LIST_MAX]. */ enum DetectSigmatchListEnum { DETECT_SM_LIST_MATCH = 0, DETECT_SM_LIST_PMATCH, /* list for DCE matches */ DETECT_SM_LIST_DMATCH, /* base64_data keyword uses some hardcoded logic so consider * built-in * TODO convert to inspect engine */ DETECT_SM_LIST_BASE64_DATA, /* list for post match actions: flowbit set, flowint increment, etc */ DETECT_SM_LIST_POSTMATCH, DETECT_SM_LIST_TMATCH, /**< post-detection tagging */ /* lists for alert thresholding and suppression */ DETECT_SM_LIST_SUPPRESS, DETECT_SM_LIST_THRESHOLD, DETECT_SM_LIST_MAX, /* start of dynamically registered lists */ DETECT_SM_LIST_DYNAMIC_START = DETECT_SM_LIST_MAX, }; /* used for Signature->list, which indicates which list * we're adding keywords to in cases of sticky buffers like * file_data */ #define DETECT_SM_LIST_NOTSET INT_MAX /* a is ... than b */ enum { ADDRESS_ER = -1, /**< error e.g. compare ipv4 and ipv6 */ ADDRESS_LT, /**< smaller [aaa] [bbb] */ ADDRESS_LE, /**< smaller with overlap [aa[bab]bb] */ ADDRESS_EQ, /**< exactly equal [abababab] */ ADDRESS_ES, /**< within [bb[aaa]bb] and [[abab]bbb] and [bbb[abab]] */ ADDRESS_EB, /**< completely overlaps [aa[bbb]aa] and [[baba]aaa] and [aaa[baba]] */ ADDRESS_GE, /**< bigger with overlap [bb[aba]aa] */ ADDRESS_GT, /**< bigger [bbb] [aaa] */ }; #define ADDRESS_FLAG_ANY 0x01 /**< address is "any" */ #define ADDRESS_FLAG_NOT 0x02 /**< address is negated */ /** \brief address structure for use in the detection engine. * * Contains the address information and matching information. */ typedef struct DetectAddress_ { /** address data for this group */ Address ip; Address ip2; /** flags affecting this address */ uint8_t flags; /** ptr to the previous address in the list */ struct DetectAddress_ *prev; /** ptr to the next address in the list */ struct DetectAddress_ *next; } DetectAddress; /** Signature grouping head. Here 'any', ipv4 and ipv6 are split out */ typedef struct DetectAddressHead_ { DetectAddress *any_head; DetectAddress *ipv4_head; DetectAddress *ipv6_head; } DetectAddressHead; #include "detect-threshold.h" typedef struct DetectMatchAddressIPv4_ { uint32_t ip; /**< address in host order, start of range */ uint32_t ip2; /**< address in host order, end of range */ } DetectMatchAddressIPv4; typedef struct DetectMatchAddressIPv6_ { uint32_t ip[4]; uint32_t ip2[4]; } DetectMatchAddressIPv6; /* * DETECT PORT */ /* a is ... than b */ enum { PORT_ER = -1, /* error e.g. compare ipv4 and ipv6 */ PORT_LT, /* smaller [aaa] [bbb] */ PORT_LE, /* smaller with overlap [aa[bab]bb] */ PORT_EQ, /* exactly equal [abababab] */ PORT_ES, /* within [bb[aaa]bb] and [[abab]bbb] and [bbb[abab]] */ PORT_EB, /* completely overlaps [aa[bbb]aa] and [[baba]aaa] and [aaa[baba]] */ PORT_GE, /* bigger with overlap [bb[aba]aa] */ PORT_GT, /* bigger [bbb] [aaa] */ }; #define PORT_FLAG_ANY 0x01 /**< 'any' special port */ #define PORT_FLAG_NOT 0x02 /**< negated port */ #define PORT_SIGGROUPHEAD_COPY 0x04 /**< sgh is a ptr copy */ /** \brief Port structure for detection engine */ typedef struct DetectPort_ { uint16_t port; uint16_t port2; uint8_t flags; /**< flags for this port */ /* signatures that belong in this group * * If the PORT_SIGGROUPHEAD_COPY flag is set, we don't own this pointer * (memory is freed elsewhere). */ struct SigGroupHead_ *sh; struct DetectPort_ *prev; struct DetectPort_ *next; } DetectPort; /* Signature flags */ #define SIG_FLAG_SRC_ANY (1) /**< source is any */ #define SIG_FLAG_DST_ANY (1<<1) /**< destination is any */ #define SIG_FLAG_SP_ANY (1<<2) /**< source port is any */ #define SIG_FLAG_DP_ANY (1<<3) /**< destination port is any */ #define SIG_FLAG_NOALERT (1<<4) /**< no alert flag is set */ #define SIG_FLAG_DSIZE (1<<5) /**< signature has a dsize setting */ #define SIG_FLAG_APPLAYER (1<<6) /**< signature applies to app layer instead of packets */ #define SIG_FLAG_IPONLY (1<<7) /**< ip only signature */ #define SIG_FLAG_STATE_MATCH (1<<8) /**< signature has matches that require stateful inspection */ #define SIG_FLAG_REQUIRE_PACKET (1<<9) /**< signature is requiring packet match */ #define SIG_FLAG_REQUIRE_STREAM (1<<10) /**< signature is requiring stream match */ #define SIG_FLAG_MPM_NEG (1<<11) #define SIG_FLAG_REQUIRE_FLOWVAR (1<<17) /**< signature can only match if a flowbit, flowvar or flowint is available. */ #define SIG_FLAG_FILESTORE (1<<18) /**< signature has filestore keyword */ #define SIG_FLAG_TOSERVER (1<<19) #define SIG_FLAG_TOCLIENT (1<<20) #define SIG_FLAG_TLSSTORE (1<<21) #define SIG_FLAG_BYPASS (1<<22) #define SIG_FLAG_PREFILTER (1<<23) /**< sig is part of a prefilter engine */ /** Proto detect only signature. * Inspected once per direction when protocol detection is done. */ #define SIG_FLAG_PDONLY (1<<24) /* signature init flags */ #define SIG_FLAG_INIT_DEONLY 1 /**< decode event only signature */ #define SIG_FLAG_INIT_PACKET (1<<1) /**< signature has matches against a packet (as opposed to app layer) */ #define SIG_FLAG_INIT_FLOW (1<<2) /**< signature has a flow setting */ #define SIG_FLAG_INIT_BIDIREC (1<<3) /**< signature has bidirectional operator */ #define SIG_FLAG_INIT_FIRST_IPPROTO_SEEN (1 << 4) /** < signature has seen the first ip_proto keyword */ /* signature mask flags */ #define SIG_MASK_REQUIRE_PAYLOAD (1<<0) #define SIG_MASK_REQUIRE_FLOW (1<<1) #define SIG_MASK_REQUIRE_FLAGS_INITDEINIT (1<<2) /* SYN, FIN, RST */ #define SIG_MASK_REQUIRE_FLAGS_UNUSUAL (1<<3) /* URG, ECN, CWR */ #define SIG_MASK_REQUIRE_NO_PAYLOAD (1<<4) #define SIG_MASK_REQUIRE_HTTP_STATE (1<<5) #define SIG_MASK_REQUIRE_DCE_STATE (1<<6) #define SIG_MASK_REQUIRE_ENGINE_EVENT (1<<7) #define SIG_MASK_REQUIRE_SSH_STATE (1<<8) #define SIG_MASK_REQUIRE_TLS_STATE (1<<9) #define SIG_MASK_REQUIRE_DNS_STATE (1<<10) #define SIG_MASK_REQUIRE_FTP_STATE (1<<11) #define SIG_MASK_REQUIRE_SMTP_STATE (1<<12) #define SIG_MASK_REQUIRE_TEMPLATE_STATE (1<<13) #define SIG_MASK_REQUIRE_ENIP_STATE (1<<14) #define SIG_MASK_REQUIRE_DNP3_STATE (1<<15) /* for now a uint8_t is enough */ #define SignatureMask uint16_t #define DETECT_ENGINE_THREAD_CTX_STREAM_CONTENT_MATCH 0x0004 #define FILE_SIG_NEED_FILE 0x01 #define FILE_SIG_NEED_FILENAME 0x02 #define FILE_SIG_NEED_MAGIC 0x04 /**< need the start of the file */ #define FILE_SIG_NEED_FILECONTENT 0x08 #define FILE_SIG_NEED_MD5 0x10 #define FILE_SIG_NEED_SHA1 0x20 #define FILE_SIG_NEED_SHA256 0x40 #define FILE_SIG_NEED_SIZE 0x80 /* Detection Engine flags */ #define DE_QUIET 0x01 /**< DE is quiet (esp for unittests) */ typedef struct IPOnlyCIDRItem_ { /* address data for this item */ uint8_t family; /* netmask in CIDR values (ex. /16 /18 /24..) */ uint8_t netmask; /* If this host or net is negated for the signum */ uint8_t negated; uint32_t ip[4]; SigIntId signum; /**< our internal id */ /* linked list, the header should be the biggest network */ struct IPOnlyCIDRItem_ *next; } IPOnlyCIDRItem; /** \brief Used to start a pointer to SigMatch context * Should never be dereferenced without casting to something else. */ typedef struct SigMatchCtx_ { int foo; } SigMatchCtx; /** \brief a single match condition for a signature */ typedef struct SigMatch_ { uint8_t type; /**< match type */ uint16_t idx; /**< position in the signature */ SigMatchCtx *ctx; /**< plugin specific data */ struct SigMatch_ *next; struct SigMatch_ *prev; } SigMatch; /** \brief Data needed for Match() */ typedef struct SigMatchData_ { uint8_t type; /**< match type */ uint8_t is_last; /**< Last element of the list */ SigMatchCtx *ctx; /**< plugin specific data */ } SigMatchData; struct DetectEngineThreadCtx_;// DetectEngineThreadCtx; typedef int (*InspectEngineFuncPtr)(ThreadVars *tv, struct DetectEngineCtx_ *de_ctx, struct DetectEngineThreadCtx_ *det_ctx, const struct Signature_ *sig, const SigMatchData *smd, Flow *f, uint8_t flags, void *alstate, void *tx, uint64_t tx_id); typedef struct DetectEngineAppInspectionEngine_ { AppProto alproto; uint8_t dir; uint8_t id; /**< per sig id used in state keeping */ int sm_list; /* \retval 0 No match. Don't discontinue matching yet. We need more data. * 1 Match. * 2 Sig can't match. * 3 Special value used by filestore sigs to indicate disabling * filestore for the tx. */ InspectEngineFuncPtr Callback; SigMatchData *smd; struct DetectEngineAppInspectionEngine_ *next; } DetectEngineAppInspectionEngine; #ifdef UNITTESTS #define sm_lists init_data->smlists #define sm_lists_tail init_data->smlists_tail #endif typedef struct SignatureInitData_ { /** Number of sigmatches. Used for assigning SigMatch::idx */ uint16_t sm_cnt; /* used to hold flags that are used during init */ uint32_t init_flags; /* coccinelle: SignatureInitData:init_flags:SIG_FLAG_INIT_ */ /* used at init to determine max dsize */ SigMatch *dsize_sm; /* the fast pattern added from this signature */ SigMatch *mpm_sm; /* used to speed up init of prefilter */ SigMatch *prefilter_sm; /* SigMatch list used for adding content and friends. E.g. file_data; */ int list; /** score to influence rule grouping. A higher value leads to a higher * likelyhood of a rulegroup with this sig ending up as a contained * group. */ int whitelist; /** address settings for this signature */ const DetectAddressHead *src, *dst; int prefilter_list; /* holds all sm lists */ struct SigMatch_ **smlists; /* holds all sm lists' tails */ struct SigMatch_ **smlists_tail; } SignatureInitData; /** \brief Signature container */ typedef struct Signature_ { /* coccinelle: Signature:flags:SIG_FLAG */ uint32_t flags; AppProto alproto; uint16_t dsize_low; uint16_t dsize_high; SignatureMask mask; SigIntId num; /**< signature number, internal id */ /** inline -- action */ uint8_t action; uint8_t file_flags; /** addresses, ports and proto this sig matches on */ DetectProto proto; /** classification id **/ uint8_t class; /** ipv4 match arrays */ uint16_t addr_dst_match4_cnt; uint16_t addr_src_match4_cnt; uint16_t addr_dst_match6_cnt; uint16_t addr_src_match6_cnt; DetectMatchAddressIPv4 *addr_dst_match4; DetectMatchAddressIPv4 *addr_src_match4; /** ipv6 match arrays */ DetectMatchAddressIPv6 *addr_dst_match6; DetectMatchAddressIPv6 *addr_src_match6; uint32_t id; /**< sid, set by the 'sid' rule keyword */ uint32_t gid; /**< generator id */ uint32_t rev; int prio; /** port settings for this signature */ DetectPort *sp, *dp; #ifdef PROFILING uint16_t profiling_id; #endif /** netblocks and hosts specified at the sid, in CIDR format */ IPOnlyCIDRItem *CidrSrc, *CidrDst; DetectEngineAppInspectionEngine *app_inspect; /* Matching structures for the built-ins. The others are in * their inspect engines. */ SigMatchData *sm_arrays[DETECT_SM_LIST_MAX]; /* memory is still owned by the sm_lists/sm_arrays entry */ const struct DetectFilestoreData_ *filestore_ctx; char *msg; /** classification message */ char *class_msg; /** Reference */ DetectReference *references; /* Be careful, this pointer is only valid while parsing the sig, * to warn the user about any possible problem */ char *sig_str; SignatureInitData *init_data; /** ptr to the next sig in the list */ struct Signature_ *next; } Signature; /** \brief one time registration of keywords at start up */ typedef struct DetectMpmAppLayerRegistery_ { const char *name; int direction; /**< SIG_FLAG_TOSERVER or SIG_FLAG_TOCLIENT */ int sm_list; int (*PrefilterRegister)(struct SigGroupHead_ *sgh, MpmCtx *mpm_ctx); int id; /**< index into this array and result arrays */ struct DetectMpmAppLayerRegistery_ *next; } DetectMpmAppLayerRegistery; /** \brief structure for storing per detect engine mpm keyword settings */ typedef struct DetectMpmAppLayerKeyword_ { const DetectMpmAppLayerRegistery *reg; int32_t sgh_mpm_context; /**< mpm factory id */ } DetectMpmAppLayerKeyword; typedef struct DetectReplaceList_ { struct DetectContentData_ *cd; uint8_t *found; struct DetectReplaceList_ *next; } DetectReplaceList; /** only execute flowvar storage if rule matched */ #define DETECT_FLOWVAR_TYPE_POSTMATCH 1 /** execute flowvar storage even if rule doesn't match (for lua) */ #define DETECT_FLOWVAR_TYPE_ALWAYS 2 /** list for flowvar store candidates, to be stored from * post-match function */ typedef struct DetectFlowvarList_ { uint16_t idx; /**< flowvar name idx */ uint16_t len; /**< data len */ int type; /**< type of store candidate POSTMATCH or ALWAYS */ uint8_t *buffer; /**< alloc'd buffer, may be freed by post-match, post-non-match */ struct DetectFlowvarList_ *next; } DetectFlowvarList; typedef struct DetectEngineIPOnlyThreadCtx_ { uint8_t *sig_match_array; /* bit array of sig nums */ uint32_t sig_match_size; /* size in bytes of the array */ } DetectEngineIPOnlyThreadCtx; /** \brief IP only rules matching ctx. */ typedef struct DetectEngineIPOnlyCtx_ { /* lookup hashes */ HashListTable *ht16_src, *ht16_dst; HashListTable *ht24_src, *ht24_dst; /* Lookup trees */ SCRadixTree *tree_ipv4src, *tree_ipv4dst; SCRadixTree *tree_ipv6src, *tree_ipv6dst; /* Used to build the radix trees */ IPOnlyCIDRItem *ip_src, *ip_dst; /* counters */ uint32_t a_src_uniq16, a_src_total16; uint32_t a_dst_uniq16, a_dst_total16; uint32_t a_src_uniq24, a_src_total24; uint32_t a_dst_uniq24, a_dst_total24; uint32_t max_idx; uint8_t *sig_init_array; /* bit array of sig nums */ uint32_t sig_init_size; /* size in bytes of the array */ /* number of sigs in this head */ uint32_t sig_cnt; uint32_t *match_array; } DetectEngineIPOnlyCtx; typedef struct DetectEngineLookupFlow_ { DetectPort *tcp; DetectPort *udp; struct SigGroupHead_ *sgh[256]; } DetectEngineLookupFlow; /* Flow status * * to server * to client */ #define FLOW_STATES 2 /** \brief threshold ctx */ typedef struct ThresholdCtx_ { SCMutex threshold_table_lock; /**< Mutex for hash table */ /** to support rate_filter "by_rule" option */ DetectThresholdEntry **th_entry; uint32_t th_size; } ThresholdCtx; typedef struct DetectEngineThreadKeywordCtxItem_ { void *(*InitFunc)(void *); void (*FreeFunc)(void *); void *data; struct DetectEngineThreadKeywordCtxItem_ *next; int id; const char *name; /* keyword name, for error printing */ } DetectEngineThreadKeywordCtxItem; enum DetectEnginePrefilterSetting { DETECT_PREFILTER_MPM = 0, /**< use only mpm / fast_pattern */ DETECT_PREFILTER_AUTO = 1, /**< use mpm + keyword prefilters */ }; /** \brief main detection engine ctx */ typedef struct DetectEngineCtx_ { uint8_t flags; int failure_fatal; int tenant_id; Signature *sig_list; uint32_t sig_cnt; /* version of the srep data */ uint32_t srep_version; /* reputation for netblocks */ SRepCIDRTree *srepCIDR_ctx; Signature **sig_array; uint32_t sig_array_size; /* size in bytes */ uint32_t sig_array_len; /* size in array members */ uint32_t signum; /** Maximum value of all our sgh's non_mpm_store_cnt setting, * used to alloc det_ctx::non_mpm_id_array */ uint32_t non_pf_store_cnt_max; /* used by the signature ordering module */ struct SCSigOrderFunc_ *sc_sig_order_funcs; /* hash table used for holding the classification config info */ HashTable *class_conf_ht; /* hash table used for holding the reference config info */ HashTable *reference_conf_ht; /* main sigs */ DetectEngineLookupFlow flow_gh[FLOW_STATES]; uint32_t gh_unique, gh_reuse; /* init phase vars */ HashListTable *sgh_hash_table; HashListTable *mpm_hash_table; HashListTable *variable_names; HashListTable *variable_idxs; uint16_t variable_names_idx; /* hash table used to cull out duplicate sigs */ HashListTable *dup_sig_hash_table; DetectEngineIPOnlyCtx io_ctx; ThresholdCtx ths_ctx; uint16_t mpm_matcher; /**< mpm matcher this ctx uses */ uint16_t spm_matcher; /**< spm matcher this ctx uses */ /* spm thread context prototype, built as spm matchers are constructed and * later used to construct thread context for each thread. */ SpmGlobalThreadCtx *spm_global_thread_ctx; /* Config options */ uint16_t max_uniq_toclient_groups; uint16_t max_uniq_toserver_groups; /* specify the configuration for mpm context factory */ uint8_t sgh_mpm_context; uint32_t max_fp_id; MpmCtxFactoryContainer *mpm_ctx_factory_container; /* maximum recursion depth for content inspection */ int inspection_recursion_limit; /* conf parameter that limits the length of the http request body inspected */ int hcbd_buffer_limit; /* conf parameter that limits the length of the http response body inspected */ int hsbd_buffer_limit; /* array containing all sgh's in use so we can loop * through it in Stage4. */ struct SigGroupHead_ **sgh_array; uint32_t sgh_array_cnt; uint32_t sgh_array_size; int32_t sgh_mpm_context_proto_tcp_packet; int32_t sgh_mpm_context_proto_udp_packet; int32_t sgh_mpm_context_proto_other_packet; int32_t sgh_mpm_context_stream; /* the max local id used amongst all sigs */ int32_t byte_extract_max_local_id; /* id used by every detect engine ctx instance */ uint32_t id; /** sgh for signatures that match against invalid packets. In those cases * we can't lookup by proto, address, port as we don't have these */ struct SigGroupHead_ *decoder_event_sgh; /* Maximum size of the buffer for decoded base64 data. */ uint32_t base64_decode_max_len; /** Store rule file and line so that parsers can use them in errors. */ char *rule_file; int rule_line; /** list of keywords that need thread local ctxs */ DetectEngineThreadKeywordCtxItem *keyword_list; int keyword_id; #ifdef PROFILING struct SCProfileDetectCtx_ *profile_ctx; struct SCProfileKeywordDetectCtx_ *profile_keyword_ctx; struct SCProfileKeywordDetectCtx_ **profile_keyword_ctx_per_list; struct SCProfileSghDetectCtx_ *profile_sgh_ctx; uint32_t profile_match_logging_threshold; #endif uint32_t prefilter_maxid; char config_prefix[64]; /** minimal: essentially a stub */ int minimal; /** how many de_ctx' are referencing this */ uint32_t ref_cnt; /** list in master: either active or freelist */ struct DetectEngineCtx_ *next; /** id of loader thread 'owning' this de_ctx */ int loader_id; /** are we useing just mpm or also other prefilters */ enum DetectEnginePrefilterSetting prefilter_setting; HashListTable *dport_hash_table; DetectPort *tcp_whitelist; DetectPort *udp_whitelist; /** table for storing the string representation with the parsers result */ HashListTable *address_table; /** table with mpms and their registration function * \todo we only need this at init, so perhaps this * can move to a DetectEngineCtx 'init' struct */ DetectMpmAppLayerKeyword *app_mpms; } DetectEngineCtx; /* Engine groups profiles (low, medium, high, custom) */ enum { ENGINE_PROFILE_UNKNOWN, ENGINE_PROFILE_LOW, ENGINE_PROFILE_MEDIUM, ENGINE_PROFILE_HIGH, ENGINE_PROFILE_CUSTOM, ENGINE_PROFILE_MAX }; /* Siggroup mpm context profile */ enum { ENGINE_SGH_MPM_FACTORY_CONTEXT_FULL, ENGINE_SGH_MPM_FACTORY_CONTEXT_SINGLE, ENGINE_SGH_MPM_FACTORY_CONTEXT_AUTO }; typedef struct HttpReassembledBody_ { const uint8_t *buffer; uint32_t buffer_size; /**< size of the buffer itself */ uint32_t buffer_len; /**< data len in the buffer */ uint64_t offset; /**< data offset */ } HttpReassembledBody; typedef struct FiledataReassembledBody_ { const uint8_t *buffer; uint32_t buffer_size; /**< size of the buffer itself */ uint32_t buffer_len; /**< data len in the buffer */ uint64_t offset; /**< data offset */ } FiledataReassembledBody; #define DETECT_FILESTORE_MAX 15 typedef struct SignatureNonPrefilterStore_ { SigIntId id; SignatureMask mask; } SignatureNonPrefilterStore; /** * Detection engine thread data. */ typedef struct DetectEngineThreadCtx_ { /** \note multi-tenant hash lookup code from Detect() *depends* * on this beeing the first member */ uint32_t tenant_id; /** ticker that is incremented once per packet. */ uint64_t ticker; /* the thread to which this detection engine thread belongs */ ThreadVars *tv; SigIntId *non_pf_id_array; uint32_t non_pf_id_cnt; // size is cnt * sizeof(uint32_t) uint32_t mt_det_ctxs_cnt; struct DetectEngineThreadCtx_ **mt_det_ctxs; HashTable *mt_det_ctxs_hash; struct DetectEngineTenantMapping_ *tenant_array; uint32_t tenant_array_size; uint32_t (*TenantGetId)(const void *, const Packet *p); /* detection engine variables */ /** offset into the payload of the last match by: * content, pcre, etc */ uint32_t buffer_offset; /* used by pcre match function alone */ uint32_t pcre_match_start_offset; /* counter for the filestore array below -- up here for cache reasons. */ uint16_t filestore_cnt; HttpReassembledBody *hsbd; uint64_t hsbd_start_tx_id; uint16_t hsbd_buffers_size; uint16_t hsbd_buffers_list_len; HttpReassembledBody *hcbd; uint64_t hcbd_start_tx_id; uint16_t hcbd_buffers_size; uint16_t hcbd_buffers_list_len; FiledataReassembledBody *smtp; uint64_t smtp_start_tx_id; uint16_t smtp_buffers_size; uint16_t smtp_buffers_list_len; /** id for alert counter */ uint16_t counter_alerts; #ifdef PROFILING uint16_t counter_mpm_list; uint16_t counter_nonmpm_list; uint16_t counter_fnonmpm_list; uint16_t counter_match_list; #endif /* used to discontinue any more matching */ uint16_t discontinue_matching; uint16_t flags; /* bool: if tx_id is set, this is 1, otherwise 0 */ uint16_t tx_id_set; /** ID of the transaction currently being inspected. */ uint64_t tx_id; SC_ATOMIC_DECLARE(int, so_far_used_by_detect); /* holds the current recursion depth on content inspection */ int inspection_recursion_counter; /** array of signature pointers we're going to inspect in the detection * loop. */ Signature **match_array; /** size of the array in items (mem size if * sizeof(Signature *) * Only used during initialization. */ uint32_t match_array_len; /** size in use */ SigIntId match_array_cnt; /** Array of sigs that had a state change */ SigIntId de_state_sig_array_len; uint8_t *de_state_sig_array; const struct SigGroupHead_ *sgh; SignatureNonPrefilterStore *non_pf_store_ptr; uint32_t non_pf_store_cnt; /** pointer to the current mpm ctx that is stored * in a rule group head -- can be either a content * or uricontent ctx. */ MpmThreadCtx mtc; /**< thread ctx for the mpm */ MpmThreadCtx mtcu; /**< thread ctx for uricontent mpm */ MpmThreadCtx mtcs; /**< thread ctx for stream mpm */ PrefilterRuleStore pmq; StreamMsg *smsg; /** SPM thread context used for scanning. This has been cloned from the * prototype held by DetectEngineCtx. */ SpmThreadCtx *spm_thread_ctx; /** ip only rules ctx */ DetectEngineIPOnlyThreadCtx io_ctx; /* byte jump values */ uint64_t *bj_values; /* string to replace */ DetectReplaceList *replist; /* flowvars to store in post match function */ DetectFlowvarList *flowvarlist; /* Array in which the filestore keyword stores file id and tx id. If the * full signature matches, these are processed by a post-match filestore * function to finalize the store. */ struct { uint16_t file_id; uint64_t tx_id; } filestore[DETECT_FILESTORE_MAX]; DetectEngineCtx *de_ctx; /** store for keyword contexts that need a per thread storage. Per de_ctx. */ void **keyword_ctxs_array; int keyword_ctxs_size; /** store for keyword contexts that need a per thread storage. Global. */ int global_keyword_ctxs_size; void **global_keyword_ctxs_array; uint8_t *base64_decoded; int base64_decoded_len; int base64_decoded_len_max; #ifdef PROFILING struct SCProfileData_ *rule_perf_data; int rule_perf_data_size; struct SCProfileKeywordData_ *keyword_perf_data; struct SCProfileKeywordData_ **keyword_perf_data_per_list; int keyword_perf_list; /**< list we're currently inspecting, DETECT_SM_LIST_* */ struct SCProfileSghData_ *sgh_perf_data; #endif } DetectEngineThreadCtx; /** \brief element in sigmatch type table. */ typedef struct SigTableElmt_ { /** Packet match function pointer */ int (*Match)(ThreadVars *, DetectEngineThreadCtx *, Packet *, const Signature *, const SigMatchCtx *); /** AppLayer TX match function pointer */ int (*AppLayerTxMatch)(ThreadVars *, DetectEngineThreadCtx *, Flow *, uint8_t flags, void *alstate, void *txv, const Signature *, const SigMatchCtx *); /** File match function pointer */ int (*FileMatch)(ThreadVars *, /**< thread local vars */ DetectEngineThreadCtx *, Flow *, /**< *LOCKED* flow */ uint8_t flags, File *, const Signature *, const SigMatchData *); /** keyword setup function pointer */ int (*Setup)(DetectEngineCtx *, Signature *, char *); _Bool (*SupportsPrefilter)(const Signature *s); int (*SetupPrefilter)(struct SigGroupHead_ *sgh); void (*Free)(void *); void (*RegisterTests)(void); uint8_t flags; char *name; /**< keyword name alias */ char *alias; /**< name alias */ char *desc; char *url; } SigTableElmt; #ifdef HAVE_MAGIC #define SIG_GROUP_HEAD_HAVEFILEMAGIC (1 << 20) #endif #define SIG_GROUP_HEAD_HAVEFILEMD5 (1 << 21) #define SIG_GROUP_HEAD_HAVEFILESIZE (1 << 22) #define SIG_GROUP_HEAD_HAVEFILESHA1 (1 << 23) #define SIG_GROUP_HEAD_HAVEFILESHA256 (1 << 24) enum MpmBuiltinBuffers { MPMB_TCP_PKT_TS, MPMB_TCP_PKT_TC, MPMB_TCP_STREAM_TS, MPMB_TCP_STREAM_TC, MPMB_UDP_TS, MPMB_UDP_TC, MPMB_OTHERIP, MPMB_MAX, }; typedef struct MpmStore_ { uint8_t *sid_array; uint32_t sid_array_size; int direction; enum MpmBuiltinBuffers buffer; int sm_list; int32_t sgh_mpm_context; MpmCtx *mpm_ctx; } MpmStore; typedef struct PrefilterEngineList_ { uint16_t id; /** App Proto this engine applies to: only used with Tx Engines */ AppProto alproto; /** Minimal Tx progress we need before running the engine. Only used * with Tx Engine */ int tx_min_progress; /** Context for matching. Might be MpmCtx for MPM engines, other ctx' * for other engines. */ void *pectx; void (*Prefilter)(DetectEngineThreadCtx *det_ctx, Packet *p, const void *pectx); void (*PrefilterTx)(DetectEngineThreadCtx *det_ctx, const void *pectx, Packet *p, Flow *f, void *tx, const uint64_t idx, const uint8_t flags); struct PrefilterEngineList_ *next; /** Free function for pectx data. If NULL the memory is not freed. */ void (*Free)(void *pectx); const char *name; /* global id for this prefilter */ uint32_t gid; } PrefilterEngineList; typedef struct PrefilterEngine_ { uint16_t id; /** App Proto this engine applies to: only used with Tx Engines */ AppProto alproto; /** Minimal Tx progress we need before running the engine. Only used * with Tx Engine */ int tx_min_progress; /** Context for matching. Might be MpmCtx for MPM engines, other ctx' * for other engines. */ void *pectx; union { void (*Prefilter)(DetectEngineThreadCtx *det_ctx, Packet *p, const void *pectx); void (*PrefilterTx)(DetectEngineThreadCtx *det_ctx, const void *pectx, Packet *p, Flow *f, void *tx, const uint64_t idx, const uint8_t flags); } cb; /* global id for this prefilter */ uint32_t gid; int is_last; } PrefilterEngine; typedef struct SigGroupHeadInitData_ { MpmStore mpm_store[MPMB_MAX]; uint8_t *sig_array; /**< bit array of sig nums (internal id's) */ uint32_t sig_size; /**< size in bytes */ uint8_t protos[256]; /**< proto(s) this sgh is for */ uint32_t direction; /**< set to SIG_FLAG_TOSERVER, SIG_FLAG_TOCLIENT or both */ int whitelist; /**< try to make this group a unique one */ MpmCtx **app_mpms; PrefilterEngineList *pkt_engines; PrefilterEngineList *payload_engines; PrefilterEngineList *tx_engines; /* port ptr */ struct DetectPort_ *port; } SigGroupHeadInitData; /** \brief Container for matching data for a signature group */ typedef struct SigGroupHead_ { uint32_t flags; /* number of sigs in this head */ SigIntId sig_cnt; /* non prefilter list excluding SYN rules */ uint32_t non_pf_other_store_cnt; uint32_t non_pf_syn_store_cnt; SignatureNonPrefilterStore *non_pf_other_store_array; // size is non_mpm_store_cnt * sizeof(SignatureNonPrefilterStore) /* non mpm list including SYN rules */ SignatureNonPrefilterStore *non_pf_syn_store_array; // size is non_mpm_syn_store_cnt * sizeof(SignatureNonPrefilterStore) /** the number of signatures in this sgh that have the filestore keyword * set. */ uint16_t filestore_cnt; uint32_t id; /**< unique id used to index sgh_array for stats */ PrefilterEngine *pkt_engines; PrefilterEngine *payload_engines; PrefilterEngine *tx_engines; /** Array with sig ptrs... size is sig_cnt * sizeof(Signature *) */ Signature **match_array; /* ptr to our init data we only use at... init :) */ SigGroupHeadInitData *init; } SigGroupHead; /** sigmatch has no options, so the parser shouldn't expect any */ #define SIGMATCH_NOOPT (1 << 0) /** sigmatch is compatible with a ip only rule */ #define SIGMATCH_IPONLY_COMPAT (1 << 1) /** sigmatch is compatible with a decode event only rule */ #define SIGMATCH_DEONLY_COMPAT (1 << 2) /**< Flag to indicate that the signature inspects the packet payload */ #define SIGMATCH_PAYLOAD (1 << 3) /**< Flag to indicate that the signature is not built-in */ #define SIGMATCH_NOT_BUILT (1 << 4) /** sigmatch may have options, so the parser should be ready to * deal with both cases */ #define SIGMATCH_OPTIONAL_OPT (1 << 5) enum DetectEngineTenantSelectors { TENANT_SELECTOR_UNKNOWN = 0, /**< not set */ TENANT_SELECTOR_DIRECT, /**< method provides direct tenant id */ TENANT_SELECTOR_VLAN, /**< map vlan to tenant id */ }; typedef struct DetectEngineTenantMapping_ { uint32_t tenant_id; /* traffic id that maps to the tenant id */ uint32_t traffic_id; struct DetectEngineTenantMapping_ *next; } DetectEngineTenantMapping; typedef struct DetectEngineMasterCtx_ { SCMutex lock; /** enable multi tenant mode */ int multi_tenant_enabled; /** list of active detection engines. This list is used to generate the * threads det_ctx's */ DetectEngineCtx *list; /** free list, containing detection engines that will be removed but may * still be referenced by det_ctx's. Freed as soon as all references are * gone. */ DetectEngineCtx *free_list; enum DetectEngineTenantSelectors tenant_selector; /** list of tenant mappings. Updated under lock. Used to generate lookup * structures. */ DetectEngineTenantMapping *tenant_mapping_list; /** list of keywords that need thread local ctxs */ DetectEngineThreadKeywordCtxItem *keyword_list; int keyword_id; } DetectEngineMasterCtx; /** \brief Signature loader statistics */ typedef struct SigFileLoaderStat_ { int bad_files; int total_files; int good_sigs_total; int bad_sigs_total; } SigFileLoaderStat; /** Remember to add the options in SignatureIsIPOnly() at detect.c otherwise it wont be part of a signature group */ enum { DETECT_SID, DETECT_PRIORITY, DETECT_REV, DETECT_CLASSTYPE, /* sorted by prefilter priority. Higher in this list means it will be * picked over ones lower in the list */ DETECT_AL_APP_LAYER_PROTOCOL, DETECT_ACK, DETECT_SEQ, DETECT_WINDOW, DETECT_IPOPTS, DETECT_FLAGS, DETECT_FRAGBITS, DETECT_FRAGOFFSET, DETECT_TTL, DETECT_TOS, DETECT_ITYPE, DETECT_ICODE, DETECT_ICMP_ID, DETECT_ICMP_SEQ, DETECT_DSIZE, DETECT_FLOW, /* end prefilter sort */ DETECT_THRESHOLD, DETECT_METADATA, DETECT_REFERENCE, DETECT_TAG, DETECT_MSG, DETECT_CONTENT, DETECT_URICONTENT, DETECT_PCRE, DETECT_DEPTH, DETECT_DISTANCE, DETECT_WITHIN, DETECT_OFFSET, DETECT_REPLACE, DETECT_NOCASE, DETECT_FAST_PATTERN, DETECT_RAWBYTES, DETECT_BYTETEST, DETECT_BYTEJUMP, DETECT_SAMEIP, DETECT_GEOIP, DETECT_IPPROTO, DETECT_FTPBOUNCE, DETECT_ISDATAAT, DETECT_ID, DETECT_RPC, DETECT_FLOWVAR, DETECT_FLOWVAR_POSTMATCH, DETECT_FLOWINT, DETECT_PKTVAR, DETECT_NOALERT, DETECT_FLOWBITS, DETECT_HOSTBITS, DETECT_IPV4_CSUM, DETECT_TCPV4_CSUM, DETECT_TCPV6_CSUM, DETECT_UDPV4_CSUM, DETECT_UDPV6_CSUM, DETECT_ICMPV4_CSUM, DETECT_ICMPV6_CSUM, DETECT_STREAM_SIZE, DETECT_DETECTION_FILTER, DETECT_DECODE_EVENT, DETECT_GID, DETECT_MARK, DETECT_AL_TLS_VERSION, DETECT_AL_TLS_SUBJECT, DETECT_AL_TLS_ISSUERDN, DETECT_AL_TLS_NOTBEFORE, DETECT_AL_TLS_NOTAFTER, DETECT_AL_TLS_EXPIRED, DETECT_AL_TLS_VALID, DETECT_AL_TLS_FINGERPRINT, DETECT_AL_TLS_STORE, DETECT_AL_HTTP_COOKIE, DETECT_AL_HTTP_METHOD, DETECT_AL_HTTP_PROTOCOL, DETECT_AL_HTTP_START, DETECT_AL_URILEN, DETECT_AL_HTTP_CLIENT_BODY, DETECT_AL_HTTP_SERVER_BODY, DETECT_AL_HTTP_HEADER, DETECT_AL_HTTP_HEADER_NAMES, DETECT_AL_HTTP_RAW_HEADER, DETECT_AL_HTTP_URI, DETECT_AL_HTTP_RAW_URI, DETECT_AL_HTTP_STAT_MSG, DETECT_AL_HTTP_STAT_CODE, DETECT_AL_HTTP_USER_AGENT, DETECT_AL_HTTP_HOST, DETECT_AL_HTTP_RAW_HOST, DETECT_AL_HTTP_REQUEST_LINE, DETECT_AL_HTTP_RESPONSE_LINE, DETECT_AL_SSH_PROTOVERSION, DETECT_AL_SSH_SOFTWAREVERSION, DETECT_AL_SSL_VERSION, DETECT_AL_SSL_STATE, DETECT_BYTE_EXTRACT, DETECT_FILE_DATA, DETECT_PKT_DATA, DETECT_AL_APP_LAYER_EVENT, DETECT_DCE_IFACE, DETECT_DCE_OPNUM, DETECT_DCE_STUB_DATA, DETECT_ASN1, DETECT_ENGINE_EVENT, DETECT_STREAM_EVENT, DETECT_FILENAME, DETECT_FILEEXT, DETECT_FILESTORE, DETECT_FILEMAGIC, DETECT_FILEMD5, DETECT_FILESHA1, DETECT_FILESHA256, DETECT_FILESIZE, DETECT_L3PROTO, DETECT_LUA, DETECT_IPREP, DETECT_AL_DNS_QUERY, DETECT_AL_TLS_SNI, DETECT_AL_TLS_CERT_ISSUER, DETECT_AL_TLS_CERT_SUBJECT, DETECT_AL_MODBUS, DETECT_CIPSERVICE, DETECT_ENIPCOMMAND, DETECT_AL_DNP3DATA, DETECT_AL_DNP3FUNC, DETECT_AL_DNP3IND, DETECT_AL_DNP3OBJ, DETECT_XBITS, DETECT_BASE64_DECODE, DETECT_BASE64_DATA, DETECT_TEMPLATE, DETECT_AL_TEMPLATE_BUFFER, DETECT_BYPASS, DETECT_PREFILTER, /* make sure this stays last */ DETECT_TBLSIZE, }; /* Table with all SigMatch registrations */ SigTableElmt sigmatch_table[DETECT_TBLSIZE]; /* detection api */ SigMatch *SigMatchAlloc(void); Signature *SigFindSignatureBySidGid(DetectEngineCtx *, uint32_t, uint32_t); void SigMatchSignaturesBuildMatchArray(DetectEngineThreadCtx *, Packet *, SignatureMask, uint16_t); void SigMatchFree(SigMatch *sm); void SigCleanSignatures(DetectEngineCtx *); void SigTableRegisterTests(void); void SigRegisterTests(void); void DetectSimdRegisterTests(void); void TmModuleDetectRegister (void); int SigGroupBuild(DetectEngineCtx *); int SigGroupCleanup (DetectEngineCtx *de_ctx); void SigAddressPrepareBidirectionals (DetectEngineCtx *); char *DetectLoadCompleteSigPath(const DetectEngineCtx *, char *sig_file); int SigLoadSignatures (DetectEngineCtx *, char *, int); void SigTableList(const char *keyword); void SigTableSetup(void); int SigMatchSignatures(ThreadVars *th_v, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p); int SignatureIsIPOnly(DetectEngineCtx *de_ctx, const Signature *s); SigGroupHead *SigMatchSignaturesGetSgh(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p); Signature *DetectGetTagSignature(void); int SignatureIsFilestoring(const Signature *); int SignatureIsFilemagicInspecting(const Signature *); int SignatureIsFileMd5Inspecting(const Signature *); int SignatureIsFileSha1Inspecting(const Signature *s); int SignatureIsFileSha256Inspecting(const Signature *s); int SignatureIsFilesizeInspecting(const Signature *); int DetectRegisterThreadCtxFuncs(DetectEngineCtx *, const char *name, void *(*InitFunc)(void *), void *data, void (*FreeFunc)(void *), int); void *DetectThreadCtxGetKeywordThreadCtx(DetectEngineThreadCtx *, int); int SigMatchSignaturesRunPostMatch(ThreadVars *tv, DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, Packet *p, const Signature *s); void DetectSignatureApplyActions(Packet *p, const Signature *s); #endif /* __DETECT_H__ */