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  }
190 }
191 
192 /**
193  * \brief Releases resources used by the Classification Config API.
194  */
196 {
197  if (de_ctx->class_conf_ht != NULL)
199 
200  de_ctx->class_conf_ht = NULL;
201 
202  return;
203 }
204 
205 /**
206  * \brief Converts a string to lowercase.
207  *
208  * \param str Pointer to the string to be converted.
209  */
210 static char *SCClassConfStringToLowercase(const char *str)
211 {
212  char *new_str = NULL;
213  char *temp_str = NULL;
214 
215  if ( (new_str = SCStrdup(str)) == NULL) {
216  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
217  return NULL;
218  }
219 
220  temp_str = new_str;
221  while (*temp_str != '\0') {
222  *temp_str = u8_tolower((unsigned char)*temp_str);
223  temp_str++;
224  }
225 
226  return new_str;
227 }
228 
229 /**
230  * \brief Parses a line from the classification file and adds it to Classtype
231  * hash table in DetectEngineCtx, i.e. DetectEngineCtx->class_conf_ht.
232  *
233  * \param rawstr Pointer to the string to be parsed.
234  * \param index Relative index of the string to be parsed.
235  * \param de_ctx Pointer to the Detection Engine Context.
236  *
237  * \retval 0 On success.
238  * \retval -1 On failure.
239  */
240 int SCClassConfAddClasstype(DetectEngineCtx *de_ctx, char *rawstr, uint16_t index)
241 {
242  char ct_name[CLASSTYPE_NAME_MAX_LEN];
243  char ct_desc[CLASSTYPE_DESC_MAX_LEN];
244  char ct_priority_str[16];
245  uint32_t ct_priority = 0;
246  uint16_t ct_id = index;
247 
248  SCClassConfClasstype *ct_new = NULL;
249  SCClassConfClasstype *ct_lookup = NULL;
250 
251  int ret = 0;
252 
253  ret = pcre2_match(regex, (PCRE2_SPTR8)rawstr, strlen(rawstr), 0, 0, regex_match, NULL);
254  if (ret < 0) {
256  "Invalid Classtype in "
257  "classification.config file %s: \"%s\"",
258  SCClassConfGetConfFilename(de_ctx), rawstr);
259  goto error;
260  }
261 
262  size_t copylen = sizeof(ct_name);
263  /* retrieve the classtype name */
264  ret = pcre2_substring_copy_bynumber(regex_match, 1, (PCRE2_UCHAR8 *)ct_name, &copylen);
265  if (ret < 0) {
266  SCLogInfo("pcre2_substring_copy_bynumber() failed");
267  goto error;
268  }
269 
270  /* retrieve the classtype description */
271  copylen = sizeof(ct_desc);
272  ret = pcre2_substring_copy_bynumber(regex_match, 2, (PCRE2_UCHAR8 *)ct_desc, &copylen);
273  if (ret < 0) {
274  SCLogInfo("pcre2_substring_copy_bynumber() failed");
275  goto error;
276  }
277 
278  /* retrieve the classtype priority */
279  copylen = sizeof(ct_priority_str);
280  ret = pcre2_substring_copy_bynumber(regex_match, 3, (PCRE2_UCHAR8 *)ct_priority_str, &copylen);
281  if (ret < 0) {
282  SCLogInfo("pcre2_substring_copy_bynumber() failed");
283  goto error;
284  }
285  if (StringParseUint32(&ct_priority, 10, 0, (const char *)ct_priority_str) < 0) {
286  goto error;
287  }
288 
289  /* Create a new instance of the parsed Classtype string */
290  ct_new = SCClassConfAllocClasstype(ct_id, ct_name, ct_desc, ct_priority);
291  if (ct_new == NULL)
292  goto error;
293 
294  /* Check if the Classtype is present in the HashTable. In case it's present
295  * ignore it, as it is a duplicate. If not present, add it to the table */
296  ct_lookup = HashTableLookup(de_ctx->class_conf_ht, ct_new, 0);
297  if (ct_lookup == NULL) {
298  if (HashTableAdd(de_ctx->class_conf_ht, ct_new, 0) < 0)
299  SCLogDebug("HashTable Add failed");
300  } else {
301  SCLogDebug("Duplicate classtype found inside classification.config");
302  if (ct_new->classtype_desc) SCFree(ct_new->classtype_desc);
303  if (ct_new->classtype) SCFree(ct_new->classtype);
304  SCFree(ct_new);
305  }
306 
307  return 0;
308 
309  error:
310  return -1;
311 }
312 
313 /**
314  * \brief Checks if a string is a comment or a blank line.
315  *
316  * Comments lines are lines of the following format -
317  * "# This is a comment string" or
318  * " # This is a comment string".
319  *
320  * \param line String that has to be checked
321  *
322  * \retval 1 On the argument string being a comment or blank line
323  * \retval 0 Otherwise
324  */
325 static int SCClassConfIsLineBlankOrComment(char *line)
326 {
327  while (*line != '\0') {
328  /* we have a comment */
329  if (*line == '#')
330  return 1;
331 
332  /* this line is neither a comment line, nor a blank line */
333  if (!isspace((unsigned char)*line))
334  return 0;
335 
336  line++;
337  }
338 
339  /* we have a blank line */
340  return 1;
341 }
342 
343 /**
344  * \brief Parses the Classification Config file and updates the
345  * DetectionEngineCtx->class_conf_ht with the Classtype information.
346  *
347  * \param de_ctx Pointer to the Detection Engine Context.
348  */
349 static bool SCClassConfParseFile(DetectEngineCtx *de_ctx, FILE *fd)
350 {
351  char line[1024];
352  uint16_t i = 1;
353  int errors = 0;
354 
355  while (fgets(line, sizeof(line), fd) != NULL) {
356  if (SCClassConfIsLineBlankOrComment(line))
357  continue;
358 
359  if (SCClassConfAddClasstype(de_ctx, line, i) == -1) {
360  errors++;
361  } else {
362  i++;
363  }
364  }
365 
366 #ifdef UNITTESTS
367  SCLogInfo("Added \"%d\" classification types from the classification file",
369 #endif
370 
371  return errors == 0;
372 }
373 
374 /**
375  * \internal
376  * \brief Returns a new SCClassConfClasstype instance. The classtype string
377  * is converted into lowercase, before being assigned to the instance.
378  *
379  * \param classtype Pointer to the classification type.
380  * \param classtype_desc Pointer to the classification type description.
381  * \param priority Holds the priority for the classification type.
382  *
383  * \retval ct Pointer to the new instance of SCClassConfClasstype on success;
384  * NULL on failure.
385  */
386 static SCClassConfClasstype *SCClassConfAllocClasstype(uint16_t classtype_id,
387  const char *classtype,
388  const char *classtype_desc,
389  int priority)
390 {
391  SCClassConfClasstype *ct = NULL;
392 
393  if (classtype == NULL)
394  return NULL;
395 
396  if ( (ct = SCMalloc(sizeof(SCClassConfClasstype))) == NULL)
397  return NULL;
398  memset(ct, 0, sizeof(SCClassConfClasstype));
399 
400  if ( (ct->classtype = SCClassConfStringToLowercase(classtype)) == NULL) {
401  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
402 
403  SCClassConfDeAllocClasstype(ct);
404  return NULL;
405  }
406 
407  if (classtype_desc != NULL &&
408  (ct->classtype_desc = SCStrdup(classtype_desc)) == NULL) {
409  SCLogError(SC_ERR_MEM_ALLOC, "Error allocating memory");
410 
411  SCClassConfDeAllocClasstype(ct);
412  return NULL;
413  }
414 
415  ct->classtype_id = classtype_id;
416  ct->priority = priority;
417 
418  return ct;
419 }
420 
421 /**
422  * \internal
423  * \brief Frees a SCClassConfClasstype instance
424  *
425  * \param Pointer to the SCClassConfClasstype instance that has to be freed
426  */
427 static void SCClassConfDeAllocClasstype(SCClassConfClasstype *ct)
428 {
429  if (ct != NULL) {
430  if (ct->classtype != NULL)
431  SCFree(ct->classtype);
432 
433  if (ct->classtype_desc != NULL)
434  SCFree(ct->classtype_desc);
435 
436  SCFree(ct);
437  }
438 
439  return;
440 }
441 
442 /**
443  * \brief Hashing function to be used to hash the Classtype name. Would be
444  * supplied as an argument to the HashTableInit function for
445  * DetectEngineCtx->class_conf_ht.
446  *
447  * \param ht Pointer to the HashTable.
448  * \param data Pointer to the data to be hashed. In this case, the data
449  * would be a pointer to a SCClassConfClasstype instance.
450  * \param datalen Not used by this function.
451  */
452 uint32_t SCClassConfClasstypeHashFunc(HashTable *ht, void *data, uint16_t datalen)
453 {
455  uint32_t hash = 0;
456  int i = 0;
457 
458  int len = strlen(ct->classtype);
459 
460  for (i = 0; i < len; i++)
461  hash += u8_tolower((unsigned char)(ct->classtype)[i]);
462 
463  hash = hash % ht->array_size;
464 
465  return hash;
466 }
467 
468 /**
469  * \brief Used to compare two Classtypes that have been stored in the HashTable.
470  * This function is supplied as an argument to the HashTableInit function
471  * for DetectionEngineCtx->class_conf_ct.
472  *
473  * \param data1 Pointer to the first SCClassConfClasstype to be compared.
474  * \param len1 Not used by this function.
475  * \param data2 Pointer to the second SCClassConfClasstype to be compared.
476  * \param len2 Not used by this function.
477  *
478  * \retval 1 On data1 and data2 being equal.
479  * \retval 0 On data1 and data2 not being equal.
480  */
481 char SCClassConfClasstypeHashCompareFunc(void *data1, uint16_t datalen1,
482  void *data2, uint16_t datalen2)
483 {
486  int len1 = 0;
487  int len2 = 0;
488 
489  if (ct1 == NULL || ct2 == NULL)
490  return 0;
491 
492  if (ct1->classtype == NULL || ct2->classtype == NULL)
493  return 0;
494 
495  len1 = strlen(ct1->classtype);
496  len2 = strlen(ct2->classtype);
497 
498  if (len1 == len2 && memcmp(ct1->classtype, ct2->classtype, len1) == 0) {
499  SCLogDebug("Match found inside Classification-Config hash function");
500  return 1;
501  }
502 
503  return 0;
504 }
505 
506 /**
507  * \brief Used to free the Classification Config Hash Data that was stored in
508  * DetectEngineCtx->class_conf_ht Hashtable.
509  *
510  * \param ch Pointer to the data that has to be freed.
511  */
513 {
514  SCClassConfDeAllocClasstype(ch);
515 
516  return;
517 }
518 
519 /**
520  * \brief Loads the Classtype info from the classification.config file.
521  *
522  * The classification.config file contains the different classtypes,
523  * that can be used to label Signatures. Each line of the file should
524  * have the following format -
525  * classtype_name, classtype_description, priority
526  * None of the above parameters should hold a quote inside the file.
527  *
528  * \param de_ctx Pointer to the Detection Engine Context that should be updated
529  * with Classtype information.
530  */
532 {
533  fd = SCClassConfInitContextAndLocalResources(de_ctx, fd);
534  if (fd == NULL) {
535 #ifdef UNITTESTS
536  if (RunmodeIsUnittests()) {
537  return false;
538  }
539 #endif
540  SCLogError(SC_ERR_OPENING_FILE, "please check the \"classification-file\" "
541  "option in your suricata.yaml file");
542  return false;
543  }
544 
545  bool ret = true;
546  if (!SCClassConfParseFile(de_ctx, fd)) {
548  "Error loading classification configuration from %s",
549  SCClassConfGetConfFilename(de_ctx));
550  ret = false;
551  }
552 
553  SCClassConfDeInitLocalResources(de_ctx, fd);
554 
555  return ret;
556 }
557 
558 /**
559  * \brief Gets the classtype from the corresponding hash table stored
560  * in the Detection Engine Context's class conf ht, given the
561  * classtype name.
562  *
563  * \param ct_name Pointer to the classtype name that has to be looked up.
564  * \param de_ctx Pointer to the Detection Engine Context.
565  *
566  * \retval lookup_ct_info Pointer to the SCClassConfClasstype instance from
567  * the hash table on success; NULL on failure.
568  */
571 {
572  char name[strlen(ct_name) + 1];
573  size_t s;
574  for (s = 0; s < strlen(ct_name); s++)
575  name[s] = u8_tolower((unsigned char)ct_name[s]);
576  name[s] = '\0';
577 
578  SCClassConfClasstype ct_lookup = {0, 0, name, NULL };
580  &ct_lookup, 0);
581  return lookup_ct_info;
582 }
583 
584 /*----------------------------------Unittests---------------------------------*/
585 
586 
587 #ifdef UNITTESTS
588 
589 /**
590  * \brief Creates a dummy classification file, with all valid Classtypes, for
591  * testing purposes.
592  *
593  * \file_path Pointer to the file_path for the dummy classification file.
594  */
596 {
597  const char *buffer =
598  "config classification: nothing-wrong,Nothing Wrong With Us,3\n"
599  "config classification: unknown,Unknown are we,3\n"
600  "config classification: bad-unknown,We think it's bad, 2\n";
601 
602  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
603  if (fd == NULL)
604  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
605 
606  return fd;
607 }
608 
609 /**
610  * \brief Creates a dummy classification file, with some valid Classtypes and a
611  * couple of invalid Classtypes, for testing purposes.
612  *
613  * \file_path Pointer to the file_path for the dummy classification file.
614  */
616 {
617  const char *buffer =
618  "config classification: not-suspicious,Not Suspicious Traffic,3\n"
619  "onfig classification: unknown,Unknown Traffic,3\n"
620  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
621  "config classification: bamboola1,Unknown Traffic,3\n"
622  "config classification: misc-activity,Misc activity,-1\n"
623  "config classification: policy-violation,Potential Corporate "
624  "config classification: bamboola,Unknown Traffic,3\n";
625 
626  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
627  if (fd == NULL)
628  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
629 
630  return fd;
631 }
632 
633 /**
634  * \brief Creates a dummy classification file, with all invalid Classtypes, for
635  * testing purposes.
636  *
637  * \file_path Pointer to the file_path for the dummy classification file.
638  */
640 {
641  const char *buffer =
642  "conig classification: not-suspicious,Not Suspicious Traffic,3\n"
643  "onfig classification: unknown,Unknown Traffic,3\n"
644  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
645  "config classification: misc-activity,Misc activity,-1\n";
646 
647  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
648  if (fd == NULL)
649  SCLogDebug("Error with SCFmemopen() called by Classifiation Config test code");
650 
651  return fd;
652 }
653 
654 /**
655  * \test Check that the classification file is loaded and the detection engine
656  * content class_conf_hash_table loaded with the classtype data.
657  */
658 static int SCClassConfTest01(void)
659 {
661  int result = 0;
662 
663  if (de_ctx == NULL)
664  return result;
665 
668 
669  if (de_ctx->class_conf_ht == NULL)
670  return result;
671 
672  result = (de_ctx->class_conf_ht->count == 3);
673  if (result == 0) printf("de_ctx->class_conf_ht->count %u: ", de_ctx->class_conf_ht->count);
674 
676 
677  return result;
678 }
679 
680 /**
681  * \test Check that invalid classtypes present in the classification config file
682  * aren't loaded.
683  */
684 static int SCClassConfTest02(void)
685 {
687  int result = 0;
688 
689  if (de_ctx == NULL)
690  return result;
691 
694 
695  if (de_ctx->class_conf_ht == NULL)
696  return result;
697 
698  result = (de_ctx->class_conf_ht->count == 0);
699 
701 
702  return result;
703 }
704 
705 /**
706  * \test Check that only valid classtypes are loaded into the hash table from
707  * the classfication.config file.
708  */
709 static int SCClassConfTest03(void)
710 {
712 
714 
717 
719 
720  PASS;
721 }
722 
723 /**
724  * \test Check if the classtype info from the classification.config file have
725  * been loaded into the hash table.
726  */
727 static int SCClassConfTest04(void)
728 {
730  int result = 1;
731 
732  if (de_ctx == NULL)
733  return 0;
734 
737 
738  if (de_ctx->class_conf_ht == NULL)
739  return 0;
740 
741  result = (de_ctx->class_conf_ht->count == 3);
742 
743  result &= (SCClassConfGetClasstype("unknown", de_ctx) != NULL);
744  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) != NULL);
745  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
746  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) != NULL);
747  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) != NULL);
748  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
749 
751 
752  return result;
753 }
754 
755 /**
756  * \test Check if the classtype info from the invalid classification.config file
757  * have not been loaded into the hash table, and cross verify to check
758  * that the hash table contains no classtype data.
759  */
760 static int SCClassConfTest05(void)
761 {
763  int result = 1;
764 
765  if (de_ctx == NULL)
766  return 0;
767 
770 
771  if (de_ctx->class_conf_ht == NULL)
772  return 0;
773 
774  result = (de_ctx->class_conf_ht->count == 0);
775 
776  result &= (SCClassConfGetClasstype("unknown", de_ctx) == NULL);
777  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) == NULL);
778  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
779  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) == NULL);
780  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) == NULL);
781  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
782 
784 
785  return result;
786 }
787 
788 /**
789  * \brief This function registers unit tests for Classification Config API.
790  */
792 {
793  UtRegisterTest("SCClassConfTest01", SCClassConfTest01);
794  UtRegisterTest("SCClassConfTest02", SCClassConfTest02);
795  UtRegisterTest("SCClassConfTest03", SCClassConfTest03);
796  UtRegisterTest("SCClassConfTest04", SCClassConfTest04);
797  UtRegisterTest("SCClassConfTest05", SCClassConfTest05);
798 }
799 #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
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
DetectEngineCtx_::class_conf_ht
HashTable * class_conf_ht
Definition: detect.h:813
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:615
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:296
util-hash.h
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:784
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:452
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2444
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:512
DETECT_CLASSCONFIG_REGEX
#define DETECT_CLASSCONFIG_REGEX
Definition: util-classification-config.c:42
HashTable_
Definition: util-hash.h:35
u8_tolower
#define u8_tolower(c)
Definition: suricata-common.h:425
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:80
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:331
util-debug.h
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
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:194
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:240
StringParseUint32
int StringParseUint32(uint32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:313
HashTableAdd
int HashTableAdd(HashTable *ht, void *data, uint16_t datalen)
Definition: util-hash.c:114
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:569
SC_ERR_FOPEN
@ SC_ERR_FOPEN
Definition: util-error.h:74
SCClassConfLoadClassficationConfigFile
bool SCClassConfLoadClassficationConfigFile(DetectEngineCtx *de_ctx, FILE *fd)
Loads the Classtype info from the classification.config file.
Definition: util-classification-config.c:531
conf.h
SC_WARN_CLASSIFICATION_CONFIG
@ SC_WARN_CLASSIFICATION_CONFIG
Definition: util-error.h:381
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:234
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:215
DetectEngineCtx_::config_prefix
char config_prefix[64]
Definition: detect.h:916
FAIL_IF
#define FAIL_IF(expr)
Fail a test if expression evaluates to true.
Definition: util-unittest.h:71
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:255
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:791
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
str
#define str(s)
Definition: suricata-common.h:280
SCLogWarning
#define SCLogWarning(err_code,...)
Macro used to log WARNING messages.
Definition: util-debug.h:242
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:35
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2405
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:481
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:595
SCClassConfGenerateInValidDummyClassConfigFD03
FILE * SCClassConfGenerateInValidDummyClassConfigFD03(void)
Creates a dummy classification file, with all invalid Classtypes, for testing purposes.
Definition: util-classification-config.c:639
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:195