suricata
util-classification-config.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2010 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 Anoop Saldanha <anoopsaldanha@gmail.com>
22  *
23  * Used for parsing a classification.config file
24  */
25 
26 #include "suricata-common.h"
27 #include "detect.h"
28 #include "detect-engine.h"
29 #include "util-hash.h"
30 
31 #include "conf.h"
33 #include "util-unittest.h"
34 #include "util-error.h"
35 #include "util-debug.h"
36 #include "util-fmemopen.h"
37 #include "util-byte.h"
38 
39 /* Regex to parse the classtype argument from a Signature. The first substring
40  * holds the classtype name, the second substring holds the classtype the
41  * classtype description, and the third argument holds the priority */
42 #define DETECT_CLASSCONFIG_REGEX "^\\s*config\\s*classification\\s*:\\s*([a-zA-Z][a-zA-Z0-9-_]*)\\s*,\\s*(.+)\\s*,\\s*(\\d+)\\s*$"
43 
44 /* Default path for the classification.config file */
45 #if defined OS_WIN32 || defined __CYGWIN__
46 #define SC_CLASS_CONF_DEF_CONF_FILEPATH CONFIG_DIR "\\\\classification.config"
47 #else
48 #define SC_CLASS_CONF_DEF_CONF_FILEPATH CONFIG_DIR "/classification.config"
49 #endif
50 
51 static pcre2_code *regex = NULL;
52 static pcre2_match_data *regex_match = NULL;
53 
54 uint32_t SCClassConfClasstypeHashFunc(HashTable *ht, void *data, uint16_t datalen);
55 char SCClassConfClasstypeHashCompareFunc(void *data1, uint16_t datalen1,
56  void *data2, uint16_t datalen2);
57 void SCClassConfClasstypeHashFree(void *ch);
58 static const char *SCClassConfGetConfFilename(const DetectEngineCtx *de_ctx);
59 
60 static SCClassConfClasstype *SCClassConfAllocClasstype(uint16_t classtype_id,
61  const char *classtype, const char *classtype_desc, int priority);
62 static void SCClassConfDeAllocClasstype(SCClassConfClasstype *ct);
63 
64 void SCClassConfInit(void)
65 {
66  int en;
67  PCRE2_SIZE eo;
68  int opts = 0;
69 
70  regex = pcre2_compile(
71  (PCRE2_SPTR8)DETECT_CLASSCONFIG_REGEX, PCRE2_ZERO_TERMINATED, opts, &en, &eo, NULL);
72  if (regex == NULL) {
73  PCRE2_UCHAR errbuffer[256];
74  pcre2_get_error_message(en, errbuffer, sizeof(errbuffer));
76  "pcre2 compile of \"%s\" failed at "
77  "offset %d: %s",
78  DETECT_CLASSCONFIG_REGEX, (int)eo, errbuffer);
79  return;
80  }
81  regex_match = pcre2_match_data_create_from_pattern(regex, NULL);
82  return;
83 }
84 
86 {
87  if (regex != NULL) {
88  pcre2_code_free(regex);
89  regex = NULL;
90  }
91  if (regex_match != NULL) {
92  pcre2_match_data_free(regex_match);
93  regex_match = NULL;
94  }
95 }
96 
97 
98 /**
99  * \brief Inits the context to be used by the Classification Config parsing API.
100  *
101  * This function initializes the hash table to be used by the Detection
102  * Engine Context to hold the data from the classification.config file,
103  * obtains the file desc to parse the classification.config file, and
104  * inits the regex used to parse the lines from classification.config
105  * file.
106  *
107  * \param de_ctx Pointer to the Detection Engine Context.
108  * \param fd Pointer to already opened file
109  *
110  * \note even if the file open fails we will keep the de_ctx->class_conf_ht
111  * initialized.
112  *
113  * \retval fp NULL on error
114  */
115 static FILE *SCClassConfInitContextAndLocalResources(DetectEngineCtx *de_ctx, FILE *fd)
116 {
117  /* init the hash table to be used by the classification config Classtypes */
121  if (de_ctx->class_conf_ht == NULL) {
122  SCLogError(SC_ERR_HASH_TABLE_INIT, "Error initializing the hash "
123  "table");
124  return NULL;
125  }
126 
127  /* if it is not NULL, use the file descriptor. The hack so that we can
128  * avoid using a dummy classification file for testing purposes and
129  * instead use an input stream against a buffer containing the
130  * classification strings */
131  if (fd == NULL) {
132  const char *filename = SCClassConfGetConfFilename(de_ctx);
133  if ( (fd = fopen(filename, "r")) == NULL) {
134 #ifdef UNITTESTS
135  if (RunmodeIsUnittests())
136  return NULL; // silently fail
137 #endif
138  SCLogWarning(SC_ERR_FOPEN, "could not open: \"%s\": %s",
139  filename, strerror(errno));
140  return NULL;
141  }
142  }
143 
144  return fd;
145 }
146 
147 
148 /**
149  * \brief Returns the path for the Classification Config file. We check if we
150  * can retrieve the path from the yaml conf file. If it is not present,
151  * return the default path for the classification file which is
152  * "./classification.config".
153  *
154  * \retval log_filename Pointer to a string containing the path for the
155  * Classification Config file.
156  */
157 static const char *SCClassConfGetConfFilename(const DetectEngineCtx *de_ctx)
158 {
159  const char *log_filename = NULL;
160 
161  if (de_ctx != NULL && strlen(de_ctx->config_prefix) > 0) {
162  char config_value[256];
163  snprintf(config_value, sizeof(config_value),
164  "%s.classification-file", de_ctx->config_prefix);
165 
166  /* try loading prefix setting, fall back to global if that
167  * fails. */
168  if (ConfGet(config_value, &log_filename) != 1) {
169  if (ConfGet("classification-file", &log_filename) != 1) {
170  log_filename = (char *)SC_CLASS_CONF_DEF_CONF_FILEPATH;
171  }
172  }
173  } else {
174  if (ConfGet("classification-file", &log_filename) != 1) {
175  log_filename = (char *)SC_CLASS_CONF_DEF_CONF_FILEPATH;
176  }
177  }
178 
179  return log_filename;
180 }
181 
182 /**
183  * \brief Releases resources used by the Classification Config API.
184  */
185 static void SCClassConfDeInitLocalResources(DetectEngineCtx *de_ctx, FILE *fd)
186 {
187  if (fd != NULL) {
188  fclose(fd);
189  fd = NULL;
190  }
191 }
192 
193 /**
194  * \brief Releases resources used by the Classification Config API.
195  */
197 {
198  if (de_ctx->class_conf_ht != NULL)
200 
201  de_ctx->class_conf_ht = NULL;
202 
203  return;
204 }
205 
206 /**
207  * \brief Converts a string to lowercase.
208  *
209  * \param str Pointer to the string to be converted.
210  */
211 static char *SCClassConfStringToLowercase(const char *str)
212 {
213  char *new_str = NULL;
214  char *temp_str = NULL;
215 
216  if ( (new_str = SCStrdup(str)) == NULL) {
217  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
218  return NULL;
219  }
220 
221  temp_str = new_str;
222  while (*temp_str != '\0') {
223  *temp_str = tolower((unsigned char)*temp_str);
224  temp_str++;
225  }
226 
227  return new_str;
228 }
229 
230 /**
231  * \brief Parses a line from the classification file and adds it to Classtype
232  * hash table in DetectEngineCtx, i.e. DetectEngineCtx->class_conf_ht.
233  *
234  * \param rawstr Pointer to the string to be parsed.
235  * \param index Relative index of the string to be parsed.
236  * \param de_ctx Pointer to the Detection Engine Context.
237  *
238  * \retval 0 On success.
239  * \retval -1 On failure.
240  */
241 int SCClassConfAddClasstype(DetectEngineCtx *de_ctx, char *rawstr, uint16_t index)
242 {
243  char ct_name[CLASSTYPE_NAME_MAX_LEN];
244  char ct_desc[CLASSTYPE_DESC_MAX_LEN];
245  char ct_priority_str[16];
246  uint32_t ct_priority = 0;
247  uint16_t ct_id = index;
248 
249  SCClassConfClasstype *ct_new = NULL;
250  SCClassConfClasstype *ct_lookup = NULL;
251 
252  int ret = 0;
253 
254  ret = pcre2_match(regex, (PCRE2_SPTR8)rawstr, strlen(rawstr), 0, 0, regex_match, NULL);
255  if (ret < 0) {
256  SCLogError(SC_ERR_INVALID_SIGNATURE, "Invalid Classtype in "
257  "classification.config file");
258  goto error;
259  }
260 
261  size_t copylen = sizeof(ct_name);
262  /* retrieve the classtype name */
263  ret = pcre2_substring_copy_bynumber(regex_match, 1, (PCRE2_UCHAR8 *)ct_name, &copylen);
264  if (ret < 0) {
265  SCLogInfo("pcre2_substring_copy_bynumber() failed");
266  goto error;
267  }
268 
269  /* retrieve the classtype description */
270  copylen = sizeof(ct_desc);
271  ret = pcre2_substring_copy_bynumber(regex_match, 2, (PCRE2_UCHAR8 *)ct_desc, &copylen);
272  if (ret < 0) {
273  SCLogInfo("pcre2_substring_copy_bynumber() failed");
274  goto error;
275  }
276 
277  /* retrieve the classtype priority */
278  copylen = sizeof(ct_priority_str);
279  ret = pcre2_substring_copy_bynumber(regex_match, 3, (PCRE2_UCHAR8 *)ct_priority_str, &copylen);
280  if (ret < 0) {
281  SCLogInfo("pcre2_substring_copy_bynumber() failed");
282  goto error;
283  }
284  if (StringParseUint32(&ct_priority, 10, 0, (const char *)ct_priority_str) < 0) {
285  goto error;
286  }
287 
288  /* Create a new instance of the parsed Classtype string */
289  ct_new = SCClassConfAllocClasstype(ct_id, ct_name, ct_desc, ct_priority);
290  if (ct_new == NULL)
291  goto error;
292 
293  /* Check if the Classtype is present in the HashTable. In case it's present
294  * ignore it, as it is a duplicate. If not present, add it to the table */
295  ct_lookup = HashTableLookup(de_ctx->class_conf_ht, ct_new, 0);
296  if (ct_lookup == NULL) {
297  if (HashTableAdd(de_ctx->class_conf_ht, ct_new, 0) < 0)
298  SCLogDebug("HashTable Add failed");
299  } else {
300  SCLogDebug("Duplicate classtype found inside classification.config");
301  if (ct_new->classtype_desc) SCFree(ct_new->classtype_desc);
302  if (ct_new->classtype) SCFree(ct_new->classtype);
303  SCFree(ct_new);
304  }
305 
306  return 0;
307 
308  error:
309  return -1;
310 }
311 
312 /**
313  * \brief Checks if a string is a comment or a blank line.
314  *
315  * Comments lines are lines of the following format -
316  * "# This is a comment string" or
317  * " # This is a comment string".
318  *
319  * \param line String that has to be checked
320  *
321  * \retval 1 On the argument string being a comment or blank line
322  * \retval 0 Otherwise
323  */
324 static int SCClassConfIsLineBlankOrComment(char *line)
325 {
326  while (*line != '\0') {
327  /* we have a comment */
328  if (*line == '#')
329  return 1;
330 
331  /* this line is neither a comment line, nor a blank line */
332  if (!isspace((unsigned char)*line))
333  return 0;
334 
335  line++;
336  }
337 
338  /* we have a blank line */
339  return 1;
340 }
341 
342 /**
343  * \brief Parses the Classification Config file and updates the
344  * DetectionEngineCtx->class_conf_ht with the Classtype information.
345  *
346  * \param de_ctx Pointer to the Detection Engine Context.
347  */
348 static void SCClassConfParseFile(DetectEngineCtx *de_ctx, FILE *fd)
349 {
350  char line[1024];
351  uint16_t i = 1;
352 
353  while (fgets(line, sizeof(line), fd) != NULL) {
354  if (SCClassConfIsLineBlankOrComment(line))
355  continue;
356 
358  i++;
359  }
360 
361 #ifdef UNITTESTS
362  SCLogInfo("Added \"%d\" classification types from the classification file",
364 #endif
365 
366  return;
367 }
368 
369 /**
370  * \internal
371  * \brief Returns a new SCClassConfClasstype instance. The classtype string
372  * is converted into lowercase, before being assigned to the instance.
373  *
374  * \param classtype Pointer to the classification type.
375  * \param classtype_desc Pointer to the classification type description.
376  * \param priority Holds the priority for the classification type.
377  *
378  * \retval ct Pointer to the new instance of SCClassConfClasstype on success;
379  * NULL on failure.
380  */
381 static SCClassConfClasstype *SCClassConfAllocClasstype(uint16_t classtype_id,
382  const char *classtype,
383  const char *classtype_desc,
384  int priority)
385 {
386  SCClassConfClasstype *ct = NULL;
387 
388  if (classtype == NULL)
389  return NULL;
390 
391  if ( (ct = SCMalloc(sizeof(SCClassConfClasstype))) == NULL)
392  return NULL;
393  memset(ct, 0, sizeof(SCClassConfClasstype));
394 
395  if ( (ct->classtype = SCClassConfStringToLowercase(classtype)) == NULL) {
396  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
397 
398  SCClassConfDeAllocClasstype(ct);
399  return NULL;
400  }
401 
402  if (classtype_desc != NULL &&
403  (ct->classtype_desc = SCStrdup(classtype_desc)) == NULL) {
404  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
405 
406  SCClassConfDeAllocClasstype(ct);
407  return NULL;
408  }
409 
410  ct->classtype_id = classtype_id;
411  ct->priority = priority;
412 
413  return ct;
414 }
415 
416 /**
417  * \internal
418  * \brief Frees a SCClassConfClasstype instance
419  *
420  * \param Pointer to the SCClassConfClasstype instance that has to be freed
421  */
422 static void SCClassConfDeAllocClasstype(SCClassConfClasstype *ct)
423 {
424  if (ct != NULL) {
425  if (ct->classtype != NULL)
426  SCFree(ct->classtype);
427 
428  if (ct->classtype_desc != NULL)
429  SCFree(ct->classtype_desc);
430 
431  SCFree(ct);
432  }
433 
434  return;
435 }
436 
437 /**
438  * \brief Hashing function to be used to hash the Classtype name. Would be
439  * supplied as an argument to the HashTableInit function for
440  * DetectEngineCtx->class_conf_ht.
441  *
442  * \param ht Pointer to the HashTable.
443  * \param data Pointer to the data to be hashed. In this case, the data
444  * would be a pointer to a SCClassConfClasstype instance.
445  * \param datalen Not used by this function.
446  */
447 uint32_t SCClassConfClasstypeHashFunc(HashTable *ht, void *data, uint16_t datalen)
448 {
450  uint32_t hash = 0;
451  int i = 0;
452 
453  int len = strlen(ct->classtype);
454 
455  for (i = 0; i < len; i++)
456  hash += tolower((unsigned char)(ct->classtype)[i]);
457 
458  hash = hash % ht->array_size;
459 
460  return hash;
461 }
462 
463 /**
464  * \brief Used to compare two Classtypes that have been stored in the HashTable.
465  * This function is supplied as an argument to the HashTableInit function
466  * for DetectionEngineCtx->class_conf_ct.
467  *
468  * \param data1 Pointer to the first SCClassConfClasstype to be compared.
469  * \param len1 Not used by this function.
470  * \param data2 Pointer to the second SCClassConfClasstype to be compared.
471  * \param len2 Not used by this function.
472  *
473  * \retval 1 On data1 and data2 being equal.
474  * \retval 0 On data1 and data2 not being equal.
475  */
476 char SCClassConfClasstypeHashCompareFunc(void *data1, uint16_t datalen1,
477  void *data2, uint16_t datalen2)
478 {
481  int len1 = 0;
482  int len2 = 0;
483 
484  if (ct1 == NULL || ct2 == NULL)
485  return 0;
486 
487  if (ct1->classtype == NULL || ct2->classtype == NULL)
488  return 0;
489 
490  len1 = strlen(ct1->classtype);
491  len2 = strlen(ct2->classtype);
492 
493  if (len1 == len2 && memcmp(ct1->classtype, ct2->classtype, len1) == 0) {
494  SCLogDebug("Match found inside Classification-Config hash function");
495  return 1;
496  }
497 
498  return 0;
499 }
500 
501 /**
502  * \brief Used to free the Classification Config Hash Data that was stored in
503  * DetectEngineCtx->class_conf_ht Hashtable.
504  *
505  * \param ch Pointer to the data that has to be freed.
506  */
508 {
509  SCClassConfDeAllocClasstype(ch);
510 
511  return;
512 }
513 
514 /**
515  * \brief Loads the Classtype info from the classification.config file.
516  *
517  * The classification.config file contains the different classtypes,
518  * that can be used to label Signatures. Each line of the file should
519  * have the following format -
520  * classtype_name, classtype_description, priority
521  * None of the above parameters should hold a quote inside the file.
522  *
523  * \param de_ctx Pointer to the Detection Engine Context that should be updated
524  * with Classtype information.
525  */
527 {
528  fd = SCClassConfInitContextAndLocalResources(de_ctx, fd);
529  if (fd == NULL) {
530 #ifdef UNITTESTS
531  if (RunmodeIsUnittests() && fd == NULL) {
532  return;
533  }
534 #endif
535  SCLogError(SC_ERR_OPENING_FILE, "please check the \"classification-file\" "
536  "option in your suricata.yaml file");
537  return;
538  }
539 
540  SCClassConfParseFile(de_ctx, fd);
541  SCClassConfDeInitLocalResources(de_ctx, fd);
542 
543  return;
544 }
545 
546 /**
547  * \brief Gets the classtype from the corresponding hash table stored
548  * in the Detection Engine Context's class conf ht, given the
549  * classtype name.
550  *
551  * \param ct_name Pointer to the classtype name that has to be looked up.
552  * \param de_ctx Pointer to the Detection Engine Context.
553  *
554  * \retval lookup_ct_info Pointer to the SCClassConfClasstype instance from
555  * the hash table on success; NULL on failure.
556  */
559 {
560  char name[strlen(ct_name) + 1];
561  size_t s;
562  for (s = 0; s < strlen(ct_name); s++)
563  name[s] = tolower((unsigned char)ct_name[s]);
564  name[s] = '\0';
565 
566  SCClassConfClasstype ct_lookup = {0, 0, name, NULL };
568  &ct_lookup, 0);
569  return lookup_ct_info;
570 }
571 
572 /*----------------------------------Unittests---------------------------------*/
573 
574 
575 #ifdef UNITTESTS
576 
577 /**
578  * \brief Creates a dummy classification file, with all valid Classtypes, for
579  * testing purposes.
580  *
581  * \file_path Pointer to the file_path for the dummy classification file.
582  */
584 {
585  const char *buffer =
586  "config classification: nothing-wrong,Nothing Wrong With Us,3\n"
587  "config classification: unknown,Unknown are we,3\n"
588  "config classification: bad-unknown,We think it's bad, 2\n";
589 
590  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
591  if (fd == NULL)
592  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
593 
594  return fd;
595 }
596 
597 /**
598  * \brief Creates a dummy classification file, with some valid Classtypes and a
599  * couple of invalid Classtypes, for testing purposes.
600  *
601  * \file_path Pointer to the file_path for the dummy classification file.
602  */
604 {
605  const char *buffer =
606  "config classification: not-suspicious,Not Suspicious Traffic,3\n"
607  "onfig classification: unknown,Unknown Traffic,3\n"
608  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
609  "config classification: bamboola1,Unknown Traffic,3\n"
610  "config classification: misc-activity,Misc activity,-1\n"
611  "config classification: policy-violation,Potential Corporate "
612  "config classification: bamboola,Unknown Traffic,3\n";
613 
614  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
615  if (fd == NULL)
616  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
617 
618  return fd;
619 }
620 
621 /**
622  * \brief Creates a dummy classification file, with all invalid Classtypes, for
623  * testing purposes.
624  *
625  * \file_path Pointer to the file_path for the dummy classification file.
626  */
628 {
629  const char *buffer =
630  "conig classification: not-suspicious,Not Suspicious Traffic,3\n"
631  "onfig classification: unknown,Unknown Traffic,3\n"
632  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
633  "config classification: misc-activity,Misc activity,-1\n";
634 
635  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
636  if (fd == NULL)
637  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
638 
639  return fd;
640 }
641 
642 /**
643  * \test Check that the classification file is loaded and the detection engine
644  * content class_conf_hash_table loaded with the classtype data.
645  */
646 static int SCClassConfTest01(void)
647 {
649  int result = 0;
650 
651  if (de_ctx == NULL)
652  return result;
653 
656 
657  if (de_ctx->class_conf_ht == NULL)
658  return result;
659 
660  result = (de_ctx->class_conf_ht->count == 3);
661  if (result == 0) printf("de_ctx->class_conf_ht->count %u: ", de_ctx->class_conf_ht->count);
662 
664 
665  return result;
666 }
667 
668 /**
669  * \test Check that invalid classtypes present in the classification config file
670  * aren't loaded.
671  */
672 static int SCClassConfTest02(void)
673 {
675  int result = 0;
676 
677  if (de_ctx == NULL)
678  return result;
679 
682 
683  if (de_ctx->class_conf_ht == NULL)
684  return result;
685 
686  result = (de_ctx->class_conf_ht->count == 0);
687 
689 
690  return result;
691 }
692 
693 /**
694  * \test Check that only valid classtypes are loaded into the hash table from
695  * the classfication.config file.
696  */
697 static int SCClassConfTest03(void)
698 {
700  int result = 0;
701 
702  if (de_ctx == NULL)
703  return result;
704 
707 
708  if (de_ctx->class_conf_ht == NULL)
709  return result;
710 
711  result = (de_ctx->class_conf_ht->count == 3);
712 
714 
715  return result;
716 }
717 
718 /**
719  * \test Check if the classtype info from the classification.config file have
720  * been loaded into the hash table.
721  */
722 static int SCClassConfTest04(void)
723 {
725  int result = 1;
726 
727  if (de_ctx == NULL)
728  return 0;
729 
732 
733  if (de_ctx->class_conf_ht == NULL)
734  return 0;
735 
736  result = (de_ctx->class_conf_ht->count == 3);
737 
738  result &= (SCClassConfGetClasstype("unknown", de_ctx) != NULL);
739  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) != NULL);
740  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
741  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) != NULL);
742  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) != NULL);
743  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
744 
746 
747  return result;
748 }
749 
750 /**
751  * \test Check if the classtype info from the invalid classification.config file
752  * have not been loaded into the hash table, and cross verify to check
753  * that the hash table contains no classtype data.
754  */
755 static int SCClassConfTest05(void)
756 {
758  int result = 1;
759 
760  if (de_ctx == NULL)
761  return 0;
762 
765 
766  if (de_ctx->class_conf_ht == NULL)
767  return 0;
768 
769  result = (de_ctx->class_conf_ht->count == 0);
770 
771  result &= (SCClassConfGetClasstype("unknown", de_ctx) == NULL);
772  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) == NULL);
773  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
774  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) == NULL);
775  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) == NULL);
776  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
777 
779 
780  return result;
781 }
782 
783 /**
784  * \test Check if the classtype info from the classification.config file have
785  * been loaded into the hash table.
786  */
787 static int SCClassConfTest06(void)
788 {
790  int result = 1;
791 
792  if (de_ctx == NULL)
793  return 0;
794 
797 
798  if (de_ctx->class_conf_ht == NULL)
799  return 0;
800 
801  result = (de_ctx->class_conf_ht->count == 3);
802 
803  result &= (SCClassConfGetClasstype("unknown", de_ctx) == NULL);
804  result &= (SCClassConfGetClasstype("not-suspicious", de_ctx) != NULL);
805  result &= (SCClassConfGetClasstype("bamboola1", de_ctx) != NULL);
806  result &= (SCClassConfGetClasstype("bamboola1", de_ctx) != NULL);
807  result &= (SCClassConfGetClasstype("BAMBOolA1", de_ctx) != NULL);
808  result &= (SCClassConfGetClasstype("unkNOwn", de_ctx) == NULL);
809 
811 
812  return result;
813 }
814 
815 /**
816  * \brief This function registers unit tests for Classification Config API.
817  */
819 {
820  UtRegisterTest("SCClassConfTest01", SCClassConfTest01);
821  UtRegisterTest("SCClassConfTest02", SCClassConfTest02);
822  UtRegisterTest("SCClassConfTest03", SCClassConfTest03);
823  UtRegisterTest("SCClassConfTest04", SCClassConfTest04);
824  UtRegisterTest("SCClassConfTest05", SCClassConfTest05);
825  UtRegisterTest("SCClassConfTest06", SCClassConfTest06);
826 }
827 #endif /* UNITTESTS */
util-byte.h
len
uint8_t len
Definition: app-layer-dnp3.h:2
SC_ERR_PCRE_COMPILE
@ SC_ERR_PCRE_COMPILE
Definition: util-error.h:35
detect-engine.h
DetectEngineCtx_::class_conf_ht
HashTable * class_conf_ht
Definition: detect.h:787
SCClassConfClasstype_::classtype
char * classtype
Definition: util-classification-config.h:41
util-fmemopen.h
SC_ERR_HASH_TABLE_INIT
@ SC_ERR_HASH_TABLE_INIT
Definition: util-error.h:144
SCClassConfGenerateInValidDummyClassConfigFD02
FILE * SCClassConfGenerateInValidDummyClassConfigFD02(void)
Creates a dummy classification file, with some valid Classtypes and a couple of invalid Classtypes,...
Definition: util-classification-config.c:603
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
SCClassConfLoadClassficationConfigFile
void SCClassConfLoadClassficationConfigFile(DetectEngineCtx *de_ctx, FILE *fd)
Loads the Classtype info from the classification.config file.
Definition: util-classification-config.c:526
util-hash.h
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:758
SC_ERR_INVALID_SIGNATURE
@ SC_ERR_INVALID_SIGNATURE
Definition: util-error.h:69
SCClassConfClasstypeHashFunc
uint32_t SCClassConfClasstypeHashFunc(HashTable *ht, void *data, uint16_t datalen)
Hashing function to be used to hash the Classtype name. Would be supplied as an argument to the HashT...
Definition: util-classification-config.c:447
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2068
SCClassConfClasstypeHashFree
void SCClassConfClasstypeHashFree(void *ch)
Used to free the Classification Config Hash Data that was stored in DetectEngineCtx->class_conf_ht Ha...
Definition: util-classification-config.c:507
DETECT_CLASSCONFIG_REGEX
#define DETECT_CLASSCONFIG_REGEX
Definition: util-classification-config.c:42
HashTable_
Definition: util-hash.h:35
SCClassConfDeinit
void SCClassConfDeinit(void)
Definition: util-classification-config.c:85
SCFmemopen
#define SCFmemopen
Definition: util-fmemopen.h:52
util-unittest.h
HashTableFree
void HashTableFree(HashTable *ht)
Definition: util-hash.c:79
HashTable_::array_size
uint32_t array_size
Definition: util-hash.h:37
ConfGet
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:330
util-debug.h
util-error.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
SCClassConfClasstype_
Container for a Classtype from the Classification.config file.
Definition: util-classification-config.h:33
SC_CLASS_CONF_DEF_CONF_FILEPATH
#define SC_CLASS_CONF_DEF_CONF_FILEPATH
Definition: util-classification-config.c:48
HashTableLookup
void * HashTableLookup(HashTable *ht, void *data, uint16_t datalen)
Definition: util-hash.c:193
detect.h
SCClassConfClasstype_::classtype_id
uint16_t classtype_id
Definition: util-classification-config.h:35
SCClassConfAddClasstype
int SCClassConfAddClasstype(DetectEngineCtx *de_ctx, char *rawstr, uint16_t index)
Parses a line from the classification file and adds it to Classtype hash table in DetectEngineCtx,...
Definition: util-classification-config.c:241
HashTableAdd
int HashTableAdd(HashTable *ht, void *data, uint16_t datalen)
Definition: util-hash.c:113
SCClassConfGetClasstype
SCClassConfClasstype * SCClassConfGetClasstype(const char *ct_name, DetectEngineCtx *de_ctx)
Gets the classtype from the corresponding hash table stored in the Detection Engine Context's class c...
Definition: util-classification-config.c:557
SC_ERR_FOPEN
@ SC_ERR_FOPEN
Definition: util-error.h:74
conf.h
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:267
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:217
DetectEngineCtx_::config_prefix
char config_prefix[64]
Definition: detect.h:890
StringParseUint32
int StringParseUint32(uint32_t *res, int base, uint16_t len, const char *str)
Definition: util-byte.c:313
suricata-common.h
CLASSTYPE_DESC_MAX_LEN
#define CLASSTYPE_DESC_MAX_LEN
Definition: util-classification-config.h:28
HashTable_::count
uint32_t count
Definition: util-hash.h:39
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
util-classification-config.h
SCStrdup
#define SCStrdup(s)
Definition: util-mem.h:56
SCClassConfInit
void SCClassConfInit(void)
Definition: util-classification-config.c:64
SCClassConfClasstype_::priority
int priority
Definition: util-classification-config.h:38
SCClassConfRegisterTests
void SCClassConfRegisterTests(void)
This function registers unit tests for Classification Config API.
Definition: util-classification-config.c:818
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
str
#define str(s)
Definition: suricata-common.h:268
SCLogWarning
#define SCLogWarning(err_code,...)
Macro used to log WARNING messages.
Definition: util-debug.h:244
SCFree
#define SCFree(p)
Definition: util-mem.h:61
CLASSTYPE_NAME_MAX_LEN
#define CLASSTYPE_NAME_MAX_LEN
Definition: util-classification-config.h:27
HashTableInit
HashTable * HashTableInit(uint32_t size, uint32_t(*Hash)(struct HashTable_ *, void *, uint16_t), char(*Compare)(void *, uint16_t, void *, uint16_t), void(*Free)(void *))
Definition: util-hash.c:34
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2023
SCClassConfClasstypeHashCompareFunc
char SCClassConfClasstypeHashCompareFunc(void *data1, uint16_t datalen1, void *data2, uint16_t datalen2)
Used to compare two Classtypes that have been stored in the HashTable. This function is supplied as a...
Definition: util-classification-config.c:476
SCClassConfClasstype_::classtype_desc
char * classtype_desc
Definition: util-classification-config.h:45
SC_ERR_MEM_ALLOC
@ SC_ERR_MEM_ALLOC
Definition: util-error.h:31
SCClassConfGenerateValidDummyClassConfigFD01
FILE * SCClassConfGenerateValidDummyClassConfigFD01(void)
Creates a dummy classification file, with all valid Classtypes, for testing purposes.
Definition: util-classification-config.c:583
SCClassConfGenerateInValidDummyClassConfigFD03
FILE * SCClassConfGenerateInValidDummyClassConfigFD03(void)
Creates a dummy classification file, with all invalid Classtypes, for testing purposes.
Definition: util-classification-config.c:627
SC_ERR_OPENING_FILE
@ SC_ERR_OPENING_FILE
Definition: util-error.h:70
SCClassConfDeInitContext
void SCClassConfDeInitContext(DetectEngineCtx *de_ctx)
Releases resources used by the Classification Config API.
Definition: util-classification-config.c:196