suricata
detect-filesha1.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  * \author Duarte Silva <duarte.silva@serializing.me>
23  *
24  */
25 
26 #include "suricata-common.h"
27 
28 #include "detect-engine.h"
29 #include "detect-file-hash-common.h"
30 #include "util-unittest.h"
31 #include "util-unittest-helper.h"
32 
33 #include "detect-filesha1.h"
34 
35 static int DetectFileSha1Setup (DetectEngineCtx *, Signature *, const char *);
36 #ifdef UNITTESTS
37 static void DetectFileSha1RegisterTests(void);
38 #endif
39 static int g_file_match_list_id = 0;
40 
41 /**
42  * \brief Registration function for keyword: filesha1
43  */
44 void DetectFileSha1Register(void)
45 {
46  sigmatch_table[DETECT_FILESHA1].name = "filesha1";
47  sigmatch_table[DETECT_FILESHA1].desc = "match file SHA-1 against list of SHA-1 checksums";
48  sigmatch_table[DETECT_FILESHA1].url = "/rules/file-keywords.html#filesha1";
49  sigmatch_table[DETECT_FILESHA1].FileMatch = DetectFileHashMatch;
50  sigmatch_table[DETECT_FILESHA1].Setup = DetectFileSha1Setup;
51  sigmatch_table[DETECT_FILESHA1].Free = DetectFileHashFree;
52 #ifdef UNITTESTS
53  sigmatch_table[DETECT_FILESHA1].RegisterTests = DetectFileSha1RegisterTests;
54 #endif
55  g_file_match_list_id = DetectBufferTypeRegister("files");
56 
57  SCLogDebug("registering filesha1 rule option");
58  return;
59 }
60 
61 /**
62  * \brief this function is used to parse filesha1 options
63  * \brief into the current signature
64  *
65  * \param de_ctx pointer to the Detection Engine Context
66  * \param s pointer to the Current Signature
67  * \param str pointer to the user provided "filesha1" option
68  */
69 static int DetectFileSha1Setup (DetectEngineCtx *de_ctx, Signature *s, const char *str)
70 {
71  return DetectFileHashSetup(de_ctx, s, str, DETECT_FILESHA1, g_file_match_list_id);
72 }
73 
74 #ifdef UNITTESTS
75 static int SHA1MatchLookupString(ROHashTable *hash, const char *string)
76 {
77  uint8_t sha1[20];
78  if (ReadHashString(sha1, string, "file", 88, 40) == 1) {
79  void *ptr = ROHashLookup(hash, &sha1, (uint16_t)sizeof(sha1));
80  if (ptr == NULL)
81  return 0;
82  else
83  return 1;
84  }
85  return 0;
86 }
87 
88 static int SHA1MatchTest01(void)
89 {
90  ROHashTable *hash = ROHashInit(4, 20);
91  FAIL_IF_NULL(hash);
92  FAIL_IF(LoadHashTable(hash, "447661c5de965bd4d837b50244467e37bddc184d", "file", 1,
93  DETECT_FILESHA1) != 1);
94  FAIL_IF(LoadHashTable(hash, "75a9af1e34dc0bb2f7fcde9d56b2503072ac35dd", "file", 2,
95  DETECT_FILESHA1) != 1);
96  FAIL_IF(LoadHashTable(hash, "53224a297bbb30631670fdcd2d295d87a1d328e9", "file", 3,
97  DETECT_FILESHA1) != 1);
98  FAIL_IF(LoadHashTable(hash, "3395856ce81f2b7382dee72602f798b642f14140", "file", 4,
99  DETECT_FILESHA1) != 1);
100  FAIL_IF(LoadHashTable(hash, "65559245709fe98052eb284577f1fd61c01ad20d", "file", 5,
101  DETECT_FILESHA1) != 1);
102  FAIL_IF(LoadHashTable(hash, "0931fd4e05e6ea81c75f8488ecc1db9e66f22cbb", "file", 6,
103  DETECT_FILESHA1) != 1);
104 
105  FAIL_IF(ROHashInitFinalize(hash) != 1);
106 
107  FAIL_IF(SHA1MatchLookupString(hash, "447661c5de965bd4d837b50244467e37bddc184d") != 1);
108  FAIL_IF(SHA1MatchLookupString(hash, "75a9af1e34dc0bb2f7fcde9d56b2503072ac35dd") != 1);
109  FAIL_IF(SHA1MatchLookupString(hash, "53224a297bbb30631670fdcd2d295d87a1d328e9") != 1);
110  FAIL_IF(SHA1MatchLookupString(hash, "3395856ce81f2b7382dee72602f798b642f14140") != 1);
111  FAIL_IF(SHA1MatchLookupString(hash, "65559245709fe98052eb284577f1fd61c01ad20d") != 1);
112  FAIL_IF(SHA1MatchLookupString(hash, "0931fd4e05e6ea81c75f8488ecc1db9e66f22cbb") != 1);
113  /* Shouldn't match */
114  FAIL_IF(SHA1MatchLookupString(hash, "3333333333333333333333333333333333333333") == 1);
115 
116  ROHashFree(hash);
117  PASS;
118 }
119 
120 static void DetectFileSha1RegisterTests(void)
121 {
122  UtRegisterTest("SHA1MatchTest01", SHA1MatchTest01);
123 }
124 #endif
SigTableElmt_::url
const char * url
Definition: detect.h:1299
detect-engine.h
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
SigTableElmt_::desc
const char * desc
Definition: detect.h:1298
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1286
detect-filesha1.h
SigTableElmt_::name
const char * name
Definition: detect.h:1296
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
SigTableElmt_::FileMatch
int(* FileMatch)(DetectEngineThreadCtx *, Flow *, uint8_t flags, File *, const Signature *, const SigMatchCtx *)
Definition: detect.h:1272
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:839
ROHashTable_
Definition: util-rohash.h:27
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1281
util-unittest.h
util-unittest-helper.h
ROHashInitFinalize
int ROHashInitFinalize(ROHashTable *table)
create final hash data structure
Definition: util-rohash.c:181
DetectFileHashFree
void DetectFileHashFree(DetectEngineCtx *de_ctx, void *ptr)
this function will free memory associated with DetectFileHashData
Definition: detect-file-hash-common.c:359
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectFileHashSetup
int DetectFileHashSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str, uint16_t type, int list)
this function is used to parse filemd5, filesha1 and filesha256 options
Definition: detect-file-hash-common.c:318
ROHashLookup
void * ROHashLookup(ROHashTable *table, void *data, uint16_t size)
Definition: util-rohash.c:113
DetectFileHashMatch
int DetectFileHashMatch(DetectEngineThreadCtx *det_ctx, Flow *f, uint8_t flags, File *file, const Signature *s, const SigMatchCtx *m)
Match the specified file hash.
Definition: detect-file-hash-common.c:144
DETECT_FILESHA1
@ DETECT_FILESHA1
Definition: detect-engine-register.h:223
detect-file-hash-common.h
FAIL_IF
#define FAIL_IF(expr)
Fail a test if expression evaluates to true.
Definition: util-unittest.h:71
DetectBufferTypeRegister
int DetectBufferTypeRegister(const char *name)
Definition: detect-engine.c:1008
suricata-common.h
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:127
ROHashInit
ROHashTable * ROHashInit(uint8_t hash_bits, uint16_t item_size)
initialize a new rohash
Definition: util-rohash.c:64
DetectFileSha1Register
void DetectFileSha1Register(void)
Registration function for keyword: filesha1.
Definition: detect-filesha1.c:44
str
#define str(s)
Definition: suricata-common.h:291
ROHashFree
void ROHashFree(ROHashTable *table)
Definition: util-rohash.c:91
LoadHashTable
int LoadHashTable(ROHashTable *hash_table, const char *string, const char *filename, int line_no, uint32_t type)
Store a hash into the hash table.
Definition: detect-file-hash-common.c:85
Signature_
Signature container.
Definition: detect.h:596
ReadHashString
int ReadHashString(uint8_t *hash, const char *string, const char *filename, int line_no, uint16_t expected_len)
Read the bytes of a hash from an hexadecimal string.
Definition: detect-file-hash-common.c:47
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1288