diff --git a/src/Makefile.am b/src/Makefile.am index a637c7fc73..768f53ee0e 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -79,6 +79,7 @@ detect-fragbits.c detect-fragbits.h \ detect-gid.c detect-gid.h \ detect-noalert.c detect-noalert.h \ detect-csum.c detect-csum.h \ +detect-ttl.c detect-ttl.h \ util-print.c util-print.h \ util-mpm.c util-mpm.h \ util-binsearch.c util-binsearch.h \ diff --git a/src/detect-stream_size.c b/src/detect-stream_size.c index dfd522629c..a03fb12515 100644 --- a/src/detect-stream_size.c +++ b/src/detect-stream_size.c @@ -12,6 +12,7 @@ #include "flow.h" #include "detect-stream_size.h" #include "stream-tcp-private.h" +#include "util-debug.h" /** * \brief Regex for parsing our flow options @@ -44,13 +45,13 @@ void DetectStreamSizeRegister(void) { parse_regex = pcre_compile(PARSE_REGEX, opts, &eb, &eo, NULL); if (parse_regex == NULL) { - printf("pcre compile of \"%s\" failed at offset %" PRId32 ": %s\n", PARSE_REGEX, eo, eb); + SCLogDebug("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) { - printf("pcre study failed: %s\n", eb); + SCLogDebug("pcre study failed: %s", eb); goto error; } return; @@ -97,7 +98,6 @@ static inline int DetectStreamSizeCompare (uint32_t diff, uint32_t stream_size, ret = 1; break; case DETECTSSIZE_GT: - //printf("diff %"PRIu32", stream_size %"PRIu32"\n", diff, stream_size); if (diff > stream_size) ret = 1; break; @@ -182,7 +182,7 @@ DetectStreamSizeData *DetectStreamSizeParse (char *streamstr) { ret = pcre_exec(parse_regex, parse_regex_study, streamstr, strlen(streamstr), 0, 0, ov, MAX_SUBSTRINGS); if (ret != 4) { - printf("DetectStreamSizeSetup: parse error, ret %" PRId32 "\n", ret); + SCLogDebug("DetectStreamSizeSetup: parse error, ret %" PRId32 "", ret); goto error; } @@ -190,28 +190,28 @@ DetectStreamSizeData *DetectStreamSizeParse (char *streamstr) { res = pcre_get_substring((char *)streamstr, ov, MAX_SUBSTRINGS, 1, &str_ptr); if (res < 0) { - printf("DetectStreamSizeSetup: pcre_get_substring failed\n"); + SCLogDebug("DetectStreamSizeSetup: pcre_get_substring failed"); goto error; } arg = (char *)str_ptr; res = pcre_get_substring((char *)streamstr, ov, MAX_SUBSTRINGS, 2, &str_ptr); if (res < 0) { - printf("DetectDsizeSetup: pcre_get_substring failed\n"); + SCLogDebug("DetectStreamSizeSetup: pcre_get_substring failed"); goto error; } mode = (char *)str_ptr; res = pcre_get_substring((char *)streamstr, ov, MAX_SUBSTRINGS, 3, &str_ptr); if (res < 0) { - printf("DetectDsizeSetup: pcre_get_substring failed\n"); + SCLogDebug("DetectStreamSizeSetup: pcre_get_substring failed"); goto error; } value = (char *)str_ptr; sd = malloc(sizeof(DetectStreamSizeData)); if (sd == NULL) { - printf("DetectStreamSizeSetup malloc failed\n"); + SCLogDebug("DetectStreamSizeSetup malloc failed"); goto error; } sd->ssize = 0; @@ -236,7 +236,7 @@ DetectStreamSizeData *DetectStreamSizeParse (char *streamstr) { /* inspect our options and set the flags */ if (strcmp(arg, "server") == 0) { if (sd->flags & STREAM_SIZE_SERVER) { - printf("DetectFlowParse error STREAM_SIZE_SERVER flag is already set \n"); + SCLogDebug("DetectStreamSizeParse error STREAM_SIZE_SERVER flag is already set "); goto error; } sd->flags |= STREAM_SIZE_SERVER; @@ -244,7 +244,7 @@ DetectStreamSizeData *DetectStreamSizeParse (char *streamstr) { } else if (strcmp(arg, "client") == 0) { if (sd->flags & STREAM_SIZE_CLIENT) { - printf("DetectFlowParse error STREAM_SIZE_CLIENT flag is already set \n"); + SCLogDebug("DetectStreamSizeParse error STREAM_SIZE_CLIENT flag is already set "); goto error; } sd->flags |= STREAM_SIZE_CLIENT; @@ -252,14 +252,14 @@ DetectStreamSizeData *DetectStreamSizeParse (char *streamstr) { } else if ((strcmp(arg, "both") == 0)) { if (sd->flags & STREAM_SIZE_SERVER || sd->flags & STREAM_SIZE_CLIENT) { - printf("DetectFlowParse error STREAM_SIZE_SERVER or STREAM_SIZE_CLIENT flag is already set \n"); + SCLogDebug("DetectStreamSizeParse error STREAM_SIZE_SERVER or STREAM_SIZE_CLIENT flag is already set "); goto error; } sd->flags |= STREAM_SIZE_BOTH; } else if (strcmp(arg, "either") == 0) { if (sd->flags & STREAM_SIZE_SERVER || sd->flags & STREAM_SIZE_CLIENT) { - printf("DetectFlowParse error STREAM_SIZE_SERVER or STREAM_SIZE_CLIENT flag is already set \n"); + SCLogDebug("DetectStreamSizeParse error STREAM_SIZE_SERVER or STREAM_SIZE_CLIENT flag is already set "); goto error; } sd->flags |= STREAM_SIZE_EITHER; diff --git a/src/detect-ttl.c b/src/detect-ttl.c new file mode 100644 index 0000000000..aad12908b2 --- /dev/null +++ b/src/detect-ttl.c @@ -0,0 +1,516 @@ +/** + * \file + * \author Gurvinder Singh + * + * ttl rule keyword support for the detection engine. + */ + +#include "eidps-common.h" +#include "stream-tcp.h" +#include "util-unittest.h" +#include "detect.h" +#include "detect-ttl.h" +#include "util-debug.h" + +/** + * \brief Regex for parsing our flow options + */ +#define PARSE_REGEX "^\\s*?\\s*([0-9]*)?\\s*([<>=-]+)?\\s*([0-9]+)?\\s*$" + +static pcre *parse_regex; +static pcre_extra *parse_regex_study; + +/*prototypes*/ +int DetectTtlMatch (ThreadVars *, DetectEngineThreadCtx *, Packet *, Signature *, SigMatch *); +int DetectTtlSetup (DetectEngineCtx *, Signature *, SigMatch *, char *); +void DetectTtlFree (void *); +void DetectTtlRegisterTests (void); + +/** + * \brief Registration function for ttl: keyword + */ + +void DetectTtlRegister(void) { + sigmatch_table[DETECT_TTL].name = "ttl"; + sigmatch_table[DETECT_TTL].Match = DetectTtlMatch; + sigmatch_table[DETECT_TTL].Setup = DetectTtlSetup; + sigmatch_table[DETECT_TTL].Free = DetectTtlFree; + sigmatch_table[DETECT_TTL].RegisterTests = DetectTtlRegisterTests; + + const char *eb; + int eo; + int opts = 0; + + parse_regex = pcre_compile(PARSE_REGEX, opts, &eb, &eo, NULL); + if (parse_regex == NULL) { + SCLogDebug("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) { + SCLogDebug("pcre study failed: %s", eb); + goto error; + } + return; + +error: + if (parse_regex != NULL) free(parse_regex); + if (parse_regex_study != NULL) free(parse_regex_study); + return; +} + +/** + * \brief This function is used to match TTL rule option on a packet with those passed via ttl: + * + * \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 that we will cast into DetectTtlData + * + * \retval 0 no match + * \retval 1 match + */ +int DetectTtlMatch (ThreadVars *t, DetectEngineThreadCtx *det_ctx, Packet *p, Signature *s, SigMatch *m) { + + int ret = 0; + uint8_t pttl; + DetectTtlData *ttld = (DetectTtlData *) m->ctx; + + if (PKT_IS_IPV4(p)) { + pttl = p->ip4c.ip_ttl; + } else if (PKT_IS_IPV6(p)) { + pttl = p->ip6c.hlim; + } else { + SCLogDebug("Packet is of not IPv4 or IPv6"); + return ret; + } + + if (ttld->mode == DETECT_TTL_EQ && pttl == ttld->ttl1) + ret = 1; + else if (ttld->mode == DETECT_TTL_LT && pttl < ttld->ttl1) + ret = 1; + else if (ttld->mode == DETECT_TTL_GT && pttl > ttld->ttl1) + ret = 1; + else if (ttld->mode == DETECT_TTL_RA && (pttl > ttld->ttl1 && pttl < ttld->ttl2)) + ret = 1; + + return ret; +} + +/** + * \brief This function is used to parse ttl options passed via ttl: keyword + * + * \param ttlstr Pointer to the user provided ttl options + * + * \retval ttld pointer to DetectTtlData on success + * \retval NULL on failure + */ + +DetectTtlData *DetectTtlParse (char *ttlstr) { + + DetectTtlData *ttld = NULL; + char *arg1 = NULL; + char *arg2 = NULL; + char *arg3 = NULL; +#define MAX_SUBSTRINGS 30 + int ret = 0, res = 0; + int ov[MAX_SUBSTRINGS]; + + ret = pcre_exec(parse_regex, parse_regex_study, ttlstr, strlen(ttlstr), 0, 0, ov, MAX_SUBSTRINGS); + if (ret < 2 || ret > 4) { + SCLogDebug("DetectTtlSetup: parse error, ret %" PRId32 "", ret); + goto error; + } + const char *str_ptr; + + res = pcre_get_substring((char *) ttlstr, ov, MAX_SUBSTRINGS, 1, &str_ptr); + if (res < 0) { + SCLogDebug("DetectTtlSetup: pcre_get_substring failed"); + goto error; + } + arg1 = (char *) str_ptr; + SCLogDebug("Arg1 \"%s\"", arg1); + + res = pcre_get_substring((char *) ttlstr, ov, MAX_SUBSTRINGS, 2, &str_ptr); + if (res < 0) { + SCLogDebug("DetectTtlSetup: pcre_get_substring failed"); + goto error; + } + arg2 = (char *) str_ptr; + SCLogDebug("Arg2 \"%s\"", arg2); + + res = pcre_get_substring((char *) ttlstr, ov, MAX_SUBSTRINGS, 3, &str_ptr); + if (res < 0) { + SCLogDebug("DetectTtlSetup: pcre_get_substring failed"); + goto error; + } + arg3 = (char *) str_ptr; + SCLogDebug("Arg3 \"%s\"", arg3); + + ttld = malloc(sizeof (DetectTtlData)); + if (ttld == NULL) { + SCLogDebug("DetectTtlSetup malloc failed"); + goto error; + } + ttld->ttl1 = 0; + ttld->ttl2 = 0; + + if (arg2[0] == '<') ttld->mode = DETECT_TTL_LT; + else if (arg2[0] == '>') ttld->mode = DETECT_TTL_GT; + else if (arg2[0] == '-') { + if (strlen(arg1)== 0) + goto error; + + ttld->mode = DETECT_TTL_RA; + } else ttld->mode = DETECT_TTL_EQ; + + /* set the value */ + switch (ttld->mode) { + case DETECT_TTL_EQ: + ttld->ttl1 = (uint8_t) atoi(arg1); + if (strlen(arg2) > 0 || strlen(arg3) > 0) + goto error; + + break; + case DETECT_TTL_LT: + case DETECT_TTL_GT: + ttld->ttl1 = (uint8_t) atoi(arg3); + SCLogDebug("ttl is %"PRIu8"",ttld->ttl1); + if (strlen(arg1) > 0) + goto error; + + break; + case DETECT_TTL_RA: + ttld->ttl1 = (uint8_t) atoi(arg1); + if (strlen(arg3) == 0) + goto error; + + ttld->ttl2 = (uint8_t) atoi(arg3); + SCLogDebug("ttl is %"PRIu8" and %"PRIu8"",ttld->ttl1, ttld->ttl2); + break; + } + + free(arg1); + free(arg2); + free(arg3); + return ttld; + +error: + if (ttld) free(ttld); + if (arg1) free(arg1); + if (arg2) free(arg2); + if (arg3) free(arg3); + return NULL; +} + +/** + * \brief this function is used to attld the parsed ttl data into the current signature + * + * \param de_ctx pointer to the Detection Engine Context + * \param s pointer to the Current Signature + * \param m pointer to the Current SigMatch + * \param ttlstr pointer to the user provided ttl options + * + * \retval 0 on Success + * \retval -1 on Failure + */ +int DetectTtlSetup (DetectEngineCtx *de_ctx, Signature *s, SigMatch *m, char *ttlstr) { + + DetectTtlData *ttld = NULL; + SigMatch *sm = NULL; + + ttld = DetectTtlParse(ttlstr); + if (ttld == NULL) + goto error; + + sm = SigMatchAlloc(); + if (sm == NULL) + goto error; + + sm->type = DETECT_TTL; + sm->ctx = (void *)ttld; + + SigMatchAppend(s,m,sm); + + return 0; + +error: + if (ttld != NULL) DetectTtlFree(ttld); + if (sm != NULL) free(sm); + return -1; +} + +/** + * \brief this function will free memory associated with DetectTtlData + * + * \param ptr pointer to DetectTtlData + */ +void DetectTtlFree(void *ptr) { + DetectTtlData *ttld = (DetectTtlData *)ptr; + free(ttld); +} + +#ifdef UNITTESTS + +#include "detect-parse.h" +#include "detect-engine.h" +#include "detect-engine-mpm.h" + +static int DetectTtlInitTest(DetectEngineCtx **de_ctx, Signature **sig, DetectTtlData **ttld, char *str) { + char fullstr[1024]; + int result = 0; + + *de_ctx = NULL; + *sig = NULL; + + if (snprintf(fullstr, 1024, "alert ip any any -> any any (msg:\"Ttl test\"; ttl:%s; sid:1;)", str) >= 1024) { + goto end; + } + + *de_ctx = DetectEngineCtxInit(); + if (*de_ctx == NULL) { + goto end; + } + + (*de_ctx)->flags |= DE_QUIET; + + (*de_ctx)->sig_list = SigInit(*de_ctx, fullstr); + if ((*de_ctx)->sig_list == NULL) { + goto end; + } + + *sig = (*de_ctx)->sig_list; + + *ttld = DetectTtlParse(str); + + result = 1; + +end: + return result; +} + +int DetectTtlParseTest01 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + + ttld = DetectTtlParse("10"); + if (ttld) { + if (ttld->ttl1 == 10 && ttld->mode == DETECT_TTL_EQ) + res = 1; + + DetectTtlFree(ttld); + } + + return res; +} + +int DetectTtlParseTest02 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + ttld = DetectTtlParse("<10"); + if (ttld) { + if (ttld->ttl1 == 10 && ttld->mode == DETECT_TTL_LT) + res = 1; + DetectTtlFree(ttld); + } + + return res; +} + +int DetectTtlParseTest03 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + ttld = DetectTtlParse("1-2"); + if (ttld) { + if (ttld->ttl1 == 1 && ttld->ttl2 == 2 && ttld->mode == DETECT_TTL_RA) + res = 1; + DetectTtlFree(ttld); + } + + return res; +} + +int DetectTtlParseTest04 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + + ttld = DetectTtlParse(" > 10 "); + if (ttld) { + if (ttld->ttl1 == 10 && ttld->mode == DETECT_TTL_GT) + res = 1; + + DetectTtlFree(ttld); + } + + return res; +} + +int DetectTtlParseTest05 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + + ttld = DetectTtlParse(" 1 - 2 "); + if (ttld) { + if (ttld->ttl1 == 1 && ttld->ttl2 == 2 && ttld->mode == DETECT_TTL_RA) + res = 1; + DetectTtlFree(ttld); + } + + return res; +} + +int DetectTtlParseTest06 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + + ttld = DetectTtlParse(" 1 = 2 "); + if (ttld == NULL) + res = 1; + if (ttld) free(ttld); + + return res; +} + +int DetectTtlParseTest07 (void) { + DetectTtlData *ttld = NULL; + uint8_t res = 0; + + ttld = DetectTtlParse(" 1<>2 "); + if (ttld == NULL) + res = 1; + + if (ttld) free(ttld); + + return res; +} + +static int DetectTtlSetpTest01(void) { + + DetectTtlData *ttld = NULL; + uint8_t res = 0; + Signature *sig = NULL; + DetectEngineCtx *de_ctx = NULL; + + res = DetectTtlInitTest(&de_ctx, &sig, &ttld, "1 - 2 "); + if (res == 0) { + goto end; + } + + if(ttld == NULL) + goto cleanup; + + if (ttld) { + if (ttld->ttl1 == 1 && ttld->ttl2 == 2 && ttld->mode == DETECT_TTL_RA) + res = 1; + } + +cleanup: + if (ttld) free(ttld); + SigGroupCleanup(de_ctx); + SigCleanSignatures(de_ctx); + DetectEngineCtxFree(de_ctx); +end: + return res; +} + +static int DetectTtlTestSig1(void) { + + Packet p; + Signature *s = NULL; + ThreadVars th_v; + DetectEngineThreadCtx *det_ctx; + int result = 0; + IPV4Cache ip4c; + IPV4Hdr ip4h; + + memset(&th_v, 0, sizeof(th_v)); + memset(&p, 0, sizeof(p)); + memset(&ip4c, 0, sizeof(ip4c)); + memset(&ip4h, 0, sizeof(ip4h)); + + p.src.family = AF_INET; + p.dst.family = AF_INET; + p.proto = IPPROTO_TCP; + ip4c.ip_ttl = 15; + p.ip4c =ip4c; + p.ip4h = &ip4h; + + DetectEngineCtx *de_ctx = DetectEngineCtxInit(); + if (de_ctx == NULL) { + goto end; + } + + de_ctx->flags |= DE_QUIET; + + s = de_ctx->sig_list = SigInit(de_ctx,"alert ip any any -> any any (msg:\"with in ttl limit\"; ttl: >16; sid:1;)"); + if (s == NULL) { + goto end; + } + + s = s->next = SigInit(de_ctx,"alert ip any any -> any any (msg:\"Less than 17\"; ttl: <17; sid:2;)"); + if (s == NULL) { + goto end; + } + + s = s->next = SigInit(de_ctx,"alert ip any any -> any any (msg:\"Greater than 5\"; ttl:15; sid:3;)"); + if (s == NULL) { + goto end; + } + + s = s->next = SigInit(de_ctx,"alert ip any any -> any any (msg:\"Equals tcp\"; ttl: 1-30; sid:4;)"); + if (s == NULL) { + goto end; + } + + SigGroupBuild(de_ctx); + PatternMatchPrepare(mpm_ctx, MPM_B2G); + DetectEngineThreadCtxInit(&th_v, (void *)de_ctx, (void *)&det_ctx); + + SigMatchSignatures(&th_v, de_ctx, det_ctx, &p); + if (PacketAlertCheck(&p, 1)) { + printf("sid 1 alerted, but should not have: "); + goto cleanup; + } else if (PacketAlertCheck(&p, 2) == 0) { + printf("sid 2 did not alert, but should have: "); + goto cleanup; + } else if (PacketAlertCheck(&p, 3) == 0) { + printf("sid 3 did not alert, but should have: "); + goto cleanup; + } else if (PacketAlertCheck(&p, 4) == 0) { + printf("sid 4 did not alert, but should have: "); + goto cleanup; + } + + result = 1; + +cleanup: + SigGroupCleanup(de_ctx); + SigCleanSignatures(de_ctx); + + DetectEngineThreadCtxDeinit(&th_v, (void *)det_ctx); + PatternMatchDestroy(mpm_ctx); + DetectEngineCtxFree(de_ctx); + +end: + return result; +} + +#endif /* UNITTESTS */ + +/** + * \brief this function registers unit tests for DetectTtl + */ +void DetectTtlRegisterTests(void) { +#ifdef UNITTESTS + UtRegisterTest("DetectTtlParseTest01", DetectTtlParseTest01, 1); + UtRegisterTest("DetectTtlParseTest02", DetectTtlParseTest02, 1); + UtRegisterTest("DetectTtlParseTest03", DetectTtlParseTest03, 1); + UtRegisterTest("DetectTtlParseTest04", DetectTtlParseTest04, 1); + UtRegisterTest("DetectTtlParseTest05", DetectTtlParseTest05, 1); + UtRegisterTest("DetectTtlParseTest06", DetectTtlParseTest06, 1); + UtRegisterTest("DetectTtlParseTest07", DetectTtlParseTest07, 1); + UtRegisterTest("DetectTtlSetpTest01", DetectTtlSetpTest01, 1); + UtRegisterTest("DetectTtlTestSig1", DetectTtlTestSig1, 1); +#endif /* UNITTESTS */ +} \ No newline at end of file diff --git a/src/detect-ttl.h b/src/detect-ttl.h new file mode 100644 index 0000000000..11844e0b0e --- /dev/null +++ b/src/detect-ttl.h @@ -0,0 +1,24 @@ +/* + * File: detect-stream_size.h + * \author Gurvinder Singh + * + */ + +#ifndef _DETECT_TTL_H +#define _DETECT_TTL_H + +#define DETECT_TTL_LT 0 +#define DETECT_TTL_EQ 1 +#define DETECT_TTL_GT 2 +#define DETECT_TTL_RA 3 + +typedef struct DetectTtlData_ { + uint8_t ttl1; + uint8_t ttl2; + uint8_t mode; +}DetectTtlData; + +void DetectTtlRegister(void); + +#endif /* _DETECT_TTL_H */ + diff --git a/src/detect.c b/src/detect.c index 1c519cb0d4..776aa57229 100644 --- a/src/detect.c +++ b/src/detect.c @@ -58,6 +58,7 @@ #include "detect-csum.h" #include "detect-stream_size.h" #include "detect-engine-sigorder.h" +#include "detect-ttl.h" #include "action-globals.h" #include "tm-modules.h" @@ -2576,6 +2577,7 @@ void SigTableSetup(void) { DetectGidRegister(); DetectCsumRegister(); DetectStreamSizeRegister(); + DetectTtlRegister(); uint8_t i = 0; for (i = 0; i < DETECT_TBLSIZE; i++) { diff --git a/src/detect.h b/src/detect.h index 2fc75b611b..986a39f0bb 100644 --- a/src/detect.h +++ b/src/detect.h @@ -439,6 +439,7 @@ enum { DETECT_ICMPV4_CSUM, DETECT_ICMPV6_CSUM, DETECT_STREAM_SIZE, + DETECT_TTL, DETECT_ADDRESS, DETECT_PROTO,