diff options
Diffstat (limited to 'framework/src/suricata/src/detect-template.c')
| -rw-r--r-- | framework/src/suricata/src/detect-template.c | 303 |
1 files changed, 0 insertions, 303 deletions
diff --git a/framework/src/suricata/src/detect-template.c b/framework/src/suricata/src/detect-template.c deleted file mode 100644 index ecad7880..00000000 --- a/framework/src/suricata/src/detect-template.c +++ /dev/null @@ -1,303 +0,0 @@ -/* Copyright (C) 2015 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 XXX Yourname <youremail@yourdomain> - * - * XXX Short description of the purpose of this keyword - */ - -#include "suricata-common.h" -#include "util-unittest.h" - -#include "detect-parse.h" -#include "detect-engine.h" - -#include "detect-template.h" - -/** - * \brief Regex for parsing our keyword options - */ -#define PARSE_REGEX "^\\s*([0-9]+)?\\s*,s*([0-9]+)?\\s*$" -static pcre *parse_regex; -static pcre_extra *parse_regex_study; - -/* Prototypes of functions registered in DetectTemplateRegister below */ -static int DetectTemplateMatch (ThreadVars *, DetectEngineThreadCtx *, - Packet *, Signature *, const SigMatchCtx *); -static int DetectTemplateSetup (DetectEngineCtx *, Signature *, char *); -static void DetectTemplateFree (void *); -static void DetectTemplateRegisterTests (void); - -/** - * \brief Registration function for template: keyword - * - * This function is called once in the 'lifetime' of the engine. - */ -void DetectTemplateRegister(void) { - /* keyword name: this is how the keyword is used in a rule */ - sigmatch_table[DETECT_TEMPLATE].name = "template"; - /* description: listed in "suricata --list-keywords=all" */ - sigmatch_table[DETECT_TEMPLATE].desc = "give an introduction into how a detection module works"; - /* link to further documentation of the keyword. Normally on the Suricata redmine/wiki */ - sigmatch_table[DETECT_TEMPLATE].url = "https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Suricata_Developers_Guide"; - /* match function is called when the signature is inspected on a packet */ - sigmatch_table[DETECT_TEMPLATE].Match = DetectTemplateMatch; - /* setup function is called during signature parsing, when the template - * keyword is encountered in the rule */ - sigmatch_table[DETECT_TEMPLATE].Setup = DetectTemplateSetup; - /* free function is called when the detect engine is freed. Normally at - * shutdown, but also during rule reloads. */ - sigmatch_table[DETECT_TEMPLATE].Free = DetectTemplateFree; - /* registers unittests into the system */ - sigmatch_table[DETECT_TEMPLATE].RegisterTests = DetectTemplateRegisterTests; - - /* set up the PCRE for keyword parsing */ - const char *eb; - int eo; - int opts = 0; - - parse_regex = pcre_compile(PARSE_REGEX, opts, &eb, &eo, NULL); - if (parse_regex == NULL) { - SCLogError(SC_ERR_PCRE_COMPILE, "pcre compile of \"%s\" failed at " - "offset %" PRId32 ": %s", PARSE_REGEX, eo, eb); - goto error; - } - - parse_regex_study = pcre_study(parse_regex, 0, &eb); - if (eb != NULL) { - SCLogError(SC_ERR_PCRE_STUDY, "pcre study failed: %s", eb); - goto error; - } - return; - -error: - if (parse_regex != NULL) - SCFree(parse_regex); - if (parse_regex_study != NULL) - SCFree(parse_regex_study); - return; -} - -/** - * \brief This function is used to match TEMPLATE rule option on a packet - * - * \param t pointer to thread vars - * \param det_ctx pointer to the pattern matcher thread - * \param p pointer to the current packet - * \param m pointer to the sigmatch with context that we will cast into DetectTemplateData - * - * \retval 0 no match - * \retval 1 match - */ -static int DetectTemplateMatch (ThreadVars *t, DetectEngineThreadCtx *det_ctx, Packet *p, - Signature *s, const SigMatchCtx *ctx) -{ - int ret = 0; - const DetectTemplateData *templated = (const DetectTemplateData *) ctx; -#if 0 - if (PKT_IS_PSEUDOPKT(p)) { - /* fake pkt */ - } - - if (PKT_IS_IPV4(p)) { - /* ipv4 pkt */ - } else if (PKT_IS_IPV6(p)) { - /* ipv6 pkt */ - } else { - SCLogDebug("packet is of not IPv4 or IPv6"); - return ret; - } -#endif - /* packet payload access */ - if (p->payload != NULL && p->payload_len > 0) { - if (templated->arg1 == p->payload[0] && - templated->arg2 == p->payload[p->payload_len - 1]) - { - ret = 1; - } - } - - return ret; -} - -/** - * \brief This function is used to parse template options passed via template: keyword - * - * \param templatestr Pointer to the user provided template options - * - * \retval templated pointer to DetectTemplateData on success - * \retval NULL on failure - */ -static DetectTemplateData *DetectTemplateParse (const char *templatestr) -{ - DetectTemplateData *templated = NULL; - char arg1[4] = ""; - char arg2[4] = ""; -#define MAX_SUBSTRINGS 30 - int ret = 0, res = 0; - int ov[MAX_SUBSTRINGS]; - - ret = pcre_exec(parse_regex, parse_regex_study, - templatestr, strlen(templatestr), - 0, 0, ov, MAX_SUBSTRINGS); - if (ret != 3) { - SCLogError(SC_ERR_PCRE_MATCH, "parse error, ret %" PRId32 "", ret); - goto error; - } - - res = pcre_copy_substring((char *) templatestr, ov, MAX_SUBSTRINGS, 1, arg1, sizeof(arg1)); - if (res < 0) { - SCLogError(SC_ERR_PCRE_GET_SUBSTRING, "pcre_copy_substring failed"); - goto error; - } - SCLogDebug("Arg1 \"%s\"", arg1); - - if (ret >= 3) { - res = pcre_copy_substring((char *) templatestr, ov, MAX_SUBSTRINGS, 2, arg2, sizeof(arg2)); - if (res < 0) { - SCLogError(SC_ERR_PCRE_GET_SUBSTRING, "pcre_copy_substring failed"); - goto error; - } - SCLogDebug("Arg2 \"%s\"", arg2); - - } - - templated = SCMalloc(sizeof (DetectTemplateData)); - if (unlikely(templated == NULL)) - goto error; - templated->arg1 = (uint8_t)atoi(arg1); - templated->arg2 = (uint8_t)atoi(arg2); - - return templated; - -error: - if (templated) - SCFree(templated); - return NULL; -} - -/** - * \brief parse the options from the 'template' keyword in the rule into - * the Signature data structure. - * - * \param de_ctx pointer to the Detection Engine Context - * \param s pointer to the Current Signature - * \param templatestr pointer to the user provided template options - * - * \retval 0 on Success - * \retval -1 on Failure - */ -static int DetectTemplateSetup (DetectEngineCtx *de_ctx, Signature *s, char *templatestr) -{ - DetectTemplateData *templated = NULL; - SigMatch *sm = NULL; - - templated = DetectTemplateParse(templatestr); - if (templated == NULL) - goto error; - - sm = SigMatchAlloc(); - if (sm == NULL) - goto error; - - sm->type = DETECT_TEMPLATE; - sm->ctx = (void *)templated; - - SigMatchAppendSMToList(s, sm, DETECT_SM_LIST_MATCH); - s->flags |= SIG_FLAG_REQUIRE_PACKET; - - return 0; - -error: - if (templated != NULL) - DetectTemplateFree(templated); - if (sm != NULL) - SCFree(sm); - return -1; -} - -/** - * \brief this function will free memory associated with DetectTemplateData - * - * \param ptr pointer to DetectTemplateData - */ -static void DetectTemplateFree(void *ptr) { - DetectTemplateData *templated = (DetectTemplateData *)ptr; - - /* do more specific cleanup here, if needed */ - - SCFree(templated); -} - -#ifdef UNITTESTS - -/** - * \test description of the test - */ - -static int DetectTemplateParseTest01 (void) { - DetectTemplateData *templated = NULL; - uint8_t res = 0; - - templated = DetectTemplateParse("1,10"); - if (templated != NULL) { - if (templated->arg1 == 1 && templated->arg2 == 10) - res = 1; - - DetectTemplateFree(templated); - } - - return res; -} - -static int DetectTemplateSignatureTest01 (void) { - uint8_t res = 0; - - DetectEngineCtx *de_ctx = DetectEngineCtxInit(); - if (de_ctx == NULL) - goto end; - - Signature *sig = DetectEngineAppendSig(de_ctx, "alert ip any any -> any any (template:1,10; sid:1; rev:1;)"); - if (sig == NULL) { - printf("parsing signature failed: "); - goto end; - } - - /* if we get here, all conditions pass */ - res = 1; -end: - if (de_ctx != NULL) - DetectEngineCtxFree(de_ctx); - return res; -} - -#endif /* UNITTESTS */ - -/** - * \brief this function registers unit tests for DetectTemplate - */ -void DetectTemplateRegisterTests(void) { -#ifdef UNITTESTS - UtRegisterTest("DetectTemplateParseTest01", - DetectTemplateParseTest01, 1); - UtRegisterTest("DetectTemplateSignatureTest01", - DetectTemplateSignatureTest01, 1); -#endif /* UNITTESTS */ -} |