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));
75  SCLogWarning("pcre2 compile of \"%s\" failed at "
76  "offset %d: %s",
77  DETECT_CLASSCONFIG_REGEX, (int)eo, errbuffer);
78  return;
79  }
80  regex_match = pcre2_match_data_create_from_pattern(regex, NULL);
81  return;
82 }
83 
85 {
86  if (regex != NULL) {
87  pcre2_code_free(regex);
88  regex = NULL;
89  }
90  if (regex_match != NULL) {
91  pcre2_match_data_free(regex_match);
92  regex_match = NULL;
93  }
94 }
95 
96 
97 /**
98  * \brief Inits the context to be used by the Classification Config parsing API.
99  *
100  * This function initializes the hash table to be used by the Detection
101  * Engine Context to hold the data from the classification.config file,
102  * obtains the file desc to parse the classification.config file, and
103  * inits the regex used to parse the lines from classification.config
104  * file.
105  *
106  * \param de_ctx Pointer to the Detection Engine Context.
107  * \param fd Pointer to already opened file
108  *
109  * \note even if the file open fails we will keep the de_ctx->class_conf_ht
110  * initialized.
111  *
112  * \retval fp NULL on error
113  */
114 static FILE *SCClassConfInitContextAndLocalResources(DetectEngineCtx *de_ctx, FILE *fd)
115 {
116  /* init the hash table to be used by the classification config Classtypes */
120  if (de_ctx->class_conf_ht == NULL) {
121  SCLogError("Error initializing the hash "
122  "table");
123  return NULL;
124  }
125 
126  /* if it is not NULL, use the file descriptor. The hack so that we can
127  * avoid using a dummy classification file for testing purposes and
128  * instead use an input stream against a buffer containing the
129  * classification strings */
130  if (fd == NULL) {
131  const char *filename = SCClassConfGetConfFilename(de_ctx);
132  if ( (fd = fopen(filename, "r")) == NULL) {
133 #ifdef UNITTESTS
134  if (RunmodeIsUnittests())
135  return NULL; // silently fail
136 #endif
137  SCLogWarning("could not open: \"%s\": %s", filename, strerror(errno));
138  return NULL;
139  }
140  }
141 
142  return fd;
143 }
144 
145 
146 /**
147  * \brief Returns the path for the Classification Config file. We check if we
148  * can retrieve the path from the yaml conf file. If it is not present,
149  * return the default path for the classification file which is
150  * "./classification.config".
151  *
152  * \retval log_filename Pointer to a string containing the path for the
153  * Classification Config file.
154  */
155 static const char *SCClassConfGetConfFilename(const DetectEngineCtx *de_ctx)
156 {
157  const char *log_filename = NULL;
158 
159  if (de_ctx != NULL && strlen(de_ctx->config_prefix) > 0) {
160  char config_value[256];
161  snprintf(config_value, sizeof(config_value),
162  "%s.classification-file", de_ctx->config_prefix);
163 
164  /* try loading prefix setting, fall back to global if that
165  * fails. */
166  if (ConfGet(config_value, &log_filename) != 1) {
167  if (ConfGet("classification-file", &log_filename) != 1) {
168  log_filename = (char *)SC_CLASS_CONF_DEF_CONF_FILEPATH;
169  }
170  }
171  } else {
172  if (ConfGet("classification-file", &log_filename) != 1) {
173  log_filename = (char *)SC_CLASS_CONF_DEF_CONF_FILEPATH;
174  }
175  }
176 
177  return log_filename;
178 }
179 
180 /**
181  * \brief Releases resources used by the Classification Config API.
182  */
183 static void SCClassConfDeInitLocalResources(DetectEngineCtx *de_ctx, FILE *fd)
184 {
185  if (fd != NULL) {
186  fclose(fd);
187  }
188 }
189 
190 /**
191  * \brief Releases resources used by the Classification Config API.
192  */
194 {
195  if (de_ctx->class_conf_ht != NULL)
197 
198  de_ctx->class_conf_ht = NULL;
199 
200  return;
201 }
202 
203 /**
204  * \brief Converts a string to lowercase.
205  *
206  * \param str Pointer to the string to be converted.
207  */
208 static char *SCClassConfStringToLowercase(const char *str)
209 {
210  char *new_str = NULL;
211  char *temp_str = NULL;
212 
213  if ( (new_str = SCStrdup(str)) == NULL) {
214  SCLogError("Error allocating memory");
215  return NULL;
216  }
217 
218  temp_str = new_str;
219  while (*temp_str != '\0') {
220  *temp_str = u8_tolower((unsigned char)*temp_str);
221  temp_str++;
222  }
223 
224  return new_str;
225 }
226 
227 /**
228  * \brief Parses a line from the classification file and adds it to Classtype
229  * hash table in DetectEngineCtx, i.e. DetectEngineCtx->class_conf_ht.
230  *
231  * \param rawstr Pointer to the string to be parsed.
232  * \param index Relative index of the string to be parsed.
233  * \param de_ctx Pointer to the Detection Engine Context.
234  *
235  * \retval 0 On success.
236  * \retval -1 On failure.
237  */
238 int SCClassConfAddClasstype(DetectEngineCtx *de_ctx, char *rawstr, uint16_t index)
239 {
240  char ct_name[CLASSTYPE_NAME_MAX_LEN];
241  char ct_desc[CLASSTYPE_DESC_MAX_LEN];
242  char ct_priority_str[16];
243  uint32_t ct_priority = 0;
244  uint16_t ct_id = index;
245 
246  SCClassConfClasstype *ct_new = NULL;
247  SCClassConfClasstype *ct_lookup = NULL;
248 
249  int ret = 0;
250 
251  ret = pcre2_match(regex, (PCRE2_SPTR8)rawstr, strlen(rawstr), 0, 0, regex_match, NULL);
252  if (ret < 0) {
253  SCLogError("Invalid Classtype in "
254  "classification.config file %s: \"%s\"",
255  SCClassConfGetConfFilename(de_ctx), rawstr);
256  goto error;
257  }
258 
259  size_t copylen = sizeof(ct_name);
260  /* retrieve the classtype name */
261  ret = pcre2_substring_copy_bynumber(regex_match, 1, (PCRE2_UCHAR8 *)ct_name, &copylen);
262  if (ret < 0) {
263  SCLogInfo("pcre2_substring_copy_bynumber() failed");
264  goto error;
265  }
266 
267  /* retrieve the classtype description */
268  copylen = sizeof(ct_desc);
269  ret = pcre2_substring_copy_bynumber(regex_match, 2, (PCRE2_UCHAR8 *)ct_desc, &copylen);
270  if (ret < 0) {
271  SCLogInfo("pcre2_substring_copy_bynumber() failed");
272  goto error;
273  }
274 
275  /* retrieve the classtype priority */
276  copylen = sizeof(ct_priority_str);
277  ret = pcre2_substring_copy_bynumber(regex_match, 3, (PCRE2_UCHAR8 *)ct_priority_str, &copylen);
278  if (ret < 0) {
279  SCLogInfo("pcre2_substring_copy_bynumber() failed");
280  goto error;
281  }
282  if (StringParseUint32(&ct_priority, 10, 0, (const char *)ct_priority_str) < 0) {
283  goto error;
284  }
285 
286  /* Create a new instance of the parsed Classtype string */
287  ct_new = SCClassConfAllocClasstype(ct_id, ct_name, ct_desc, ct_priority);
288  if (ct_new == NULL)
289  goto error;
290 
291  /* Check if the Classtype is present in the HashTable. In case it's present
292  * ignore it, as it is a duplicate. If not present, add it to the table */
293  ct_lookup = HashTableLookup(de_ctx->class_conf_ht, ct_new, 0);
294  if (ct_lookup == NULL) {
295  if (HashTableAdd(de_ctx->class_conf_ht, ct_new, 0) < 0)
296  SCLogDebug("HashTable Add failed");
297  } else {
298  SCLogDebug("Duplicate classtype found inside classification.config");
299  if (ct_new->classtype_desc) SCFree(ct_new->classtype_desc);
300  if (ct_new->classtype) SCFree(ct_new->classtype);
301  SCFree(ct_new);
302  }
303 
304  return 0;
305 
306  error:
307  return -1;
308 }
309 
310 /**
311  * \brief Checks if a string is a comment or a blank line.
312  *
313  * Comments lines are lines of the following format -
314  * "# This is a comment string" or
315  * " # This is a comment string".
316  *
317  * \param line String that has to be checked
318  *
319  * \retval 1 On the argument string being a comment or blank line
320  * \retval 0 Otherwise
321  */
322 static int SCClassConfIsLineBlankOrComment(char *line)
323 {
324  while (*line != '\0') {
325  /* we have a comment */
326  if (*line == '#')
327  return 1;
328 
329  /* this line is neither a comment line, nor a blank line */
330  if (!isspace((unsigned char)*line))
331  return 0;
332 
333  line++;
334  }
335 
336  /* we have a blank line */
337  return 1;
338 }
339 
340 /**
341  * \brief Parses the Classification Config file and updates the
342  * DetectionEngineCtx->class_conf_ht with the Classtype information.
343  *
344  * \param de_ctx Pointer to the Detection Engine Context.
345  */
346 static bool SCClassConfParseFile(DetectEngineCtx *de_ctx, FILE *fd)
347 {
348  char line[1024];
349  uint16_t i = 1;
350  int errors = 0;
351 
352  while (fgets(line, sizeof(line), fd) != NULL) {
353  if (SCClassConfIsLineBlankOrComment(line))
354  continue;
355 
356  if (SCClassConfAddClasstype(de_ctx, line, i) == -1) {
357  errors++;
358  } else {
359  i++;
360  }
361  }
362 
363 #ifdef UNITTESTS
364  SCLogInfo("Added \"%d\" classification types from the classification file",
366 #endif
367 
368  return errors == 0;
369 }
370 
371 /**
372  * \internal
373  * \brief Returns a new SCClassConfClasstype instance. The classtype string
374  * is converted into lowercase, before being assigned to the instance.
375  *
376  * \param classtype Pointer to the classification type.
377  * \param classtype_desc Pointer to the classification type description.
378  * \param priority Holds the priority for the classification type.
379  *
380  * \retval ct Pointer to the new instance of SCClassConfClasstype on success;
381  * NULL on failure.
382  */
383 static SCClassConfClasstype *SCClassConfAllocClasstype(uint16_t classtype_id,
384  const char *classtype,
385  const char *classtype_desc,
386  int priority)
387 {
388  SCClassConfClasstype *ct = NULL;
389 
390  if (classtype == NULL)
391  return NULL;
392 
393  if ( (ct = SCMalloc(sizeof(SCClassConfClasstype))) == NULL)
394  return NULL;
395  memset(ct, 0, sizeof(SCClassConfClasstype));
396 
397  if ((ct->classtype = SCClassConfStringToLowercase(classtype)) == NULL) {
398  SCClassConfDeAllocClasstype(ct);
399  return NULL;
400  }
401 
402  if (classtype_desc != NULL &&
403  (ct->classtype_desc = SCStrdup(classtype_desc)) == NULL) {
404  SCLogError("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 += u8_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()) {
532  return false;
533  }
534 #endif
535  SCLogError("please check the \"classification-file\" "
536  "option in your suricata.yaml file");
537  return false;
538  }
539 
540  bool ret = true;
541  if (!SCClassConfParseFile(de_ctx, fd)) {
542  SCLogWarning("Error loading classification configuration from %s",
543  SCClassConfGetConfFilename(de_ctx));
544  ret = false;
545  }
546 
547  SCClassConfDeInitLocalResources(de_ctx, fd);
548 
549  return ret;
550 }
551 
552 /**
553  * \brief Gets the classtype from the corresponding hash table stored
554  * in the Detection Engine Context's class conf ht, given the
555  * classtype name.
556  *
557  * \param ct_name Pointer to the classtype name that has to be looked up.
558  * \param de_ctx Pointer to the Detection Engine Context.
559  *
560  * \retval lookup_ct_info Pointer to the SCClassConfClasstype instance from
561  * the hash table on success; NULL on failure.
562  */
565 {
566  char name[strlen(ct_name) + 1];
567  size_t s;
568  for (s = 0; s < strlen(ct_name); s++)
569  name[s] = u8_tolower((unsigned char)ct_name[s]);
570  name[s] = '\0';
571 
572  SCClassConfClasstype ct_lookup = {0, 0, name, NULL };
574  &ct_lookup, 0);
575  return lookup_ct_info;
576 }
577 
578 /*----------------------------------Unittests---------------------------------*/
579 
580 
581 #ifdef UNITTESTS
582 
583 /**
584  * \brief Creates a dummy classification file, with all valid Classtypes, for
585  * testing purposes.
586  *
587  * \file_path Pointer to the file_path for the dummy classification file.
588  */
590 {
591  const char *buffer =
592  "config classification: nothing-wrong,Nothing Wrong With Us,3\n"
593  "config classification: unknown,Unknown are we,3\n"
594  "config classification: bad-unknown,We think it's bad, 2\n";
595 
596  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
597  if (fd == NULL)
598  SCLogDebug("Error with SCFmemopen() called by Classification Config test code");
599 
600  return fd;
601 }
602 
603 /**
604  * \brief Creates a dummy classification file, with some valid Classtypes and a
605  * couple of invalid Classtypes, for testing purposes.
606  *
607  * \file_path Pointer to the file_path for the dummy classification file.
608  */
610 {
611  const char *buffer =
612  "config classification: not-suspicious,Not Suspicious Traffic,3\n"
613  "onfig classification: unknown,Unknown Traffic,3\n"
614  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
615  "config classification: bamboola1,Unknown Traffic,3\n"
616  "config classification: misc-activity,Misc activity,-1\n"
617  "config classification: policy-violation,Potential Corporate "
618  "config classification: bamboola,Unknown Traffic,3\n";
619 
620  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
621  if (fd == NULL)
622  SCLogDebug("Error with SCFmemopen() called by Classification Config test code");
623 
624  return fd;
625 }
626 
627 /**
628  * \brief Creates a dummy classification file, with all invalid Classtypes, for
629  * testing purposes.
630  *
631  * \file_path Pointer to the file_path for the dummy classification file.
632  */
634 {
635  const char *buffer =
636  "conig classification: not-suspicious,Not Suspicious Traffic,3\n"
637  "onfig classification: unknown,Unknown Traffic,3\n"
638  "config classification: _badunknown,Potentially Bad Traffic, 2\n"
639  "config classification: misc-activity,Misc activity,-1\n";
640 
641  FILE *fd = SCFmemopen((void *)buffer, strlen(buffer), "r");
642  if (fd == NULL)
643  SCLogDebug("Error with SCFmemopen() called by Classification Config test code");
644 
645  return fd;
646 }
647 
648 /**
649  * \test Check that the classification file is loaded and the detection engine
650  * content class_conf_hash_table loaded with the classtype data.
651  */
652 static int SCClassConfTest01(void)
653 {
655  int result = 0;
656 
657  if (de_ctx == NULL)
658  return result;
659 
662 
663  if (de_ctx->class_conf_ht == NULL)
664  return result;
665 
666  result = (de_ctx->class_conf_ht->count == 3);
667  if (result == 0) printf("de_ctx->class_conf_ht->count %u: ", de_ctx->class_conf_ht->count);
668 
670 
671  return result;
672 }
673 
674 /**
675  * \test Check that invalid classtypes present in the classification config file
676  * aren't loaded.
677  */
678 static int SCClassConfTest02(void)
679 {
681  int result = 0;
682 
683  if (de_ctx == NULL)
684  return result;
685 
688 
689  if (de_ctx->class_conf_ht == NULL)
690  return result;
691 
692  result = (de_ctx->class_conf_ht->count == 0);
693 
695 
696  return result;
697 }
698 
699 /**
700  * \test Check that only valid classtypes are loaded into the hash table from
701  * the classification.config file.
702  */
703 static int SCClassConfTest03(void)
704 {
706 
708 
711 
713 
714  PASS;
715 }
716 
717 /**
718  * \test Check if the classtype info from the classification.config file have
719  * been loaded into the hash table.
720  */
721 static int SCClassConfTest04(void)
722 {
724  int result = 1;
725 
726  if (de_ctx == NULL)
727  return 0;
728 
731 
732  if (de_ctx->class_conf_ht == NULL)
733  return 0;
734 
735  result = (de_ctx->class_conf_ht->count == 3);
736 
737  result &= (SCClassConfGetClasstype("unknown", de_ctx) != NULL);
738  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) != NULL);
739  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
740  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) != NULL);
741  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) != NULL);
742  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
743 
745 
746  return result;
747 }
748 
749 /**
750  * \test Check if the classtype info from the invalid classification.config file
751  * have not been loaded into the hash table, and cross verify to check
752  * that the hash table contains no classtype data.
753  */
754 static int SCClassConfTest05(void)
755 {
757  int result = 1;
758 
759  if (de_ctx == NULL)
760  return 0;
761 
764 
765  if (de_ctx->class_conf_ht == NULL)
766  return 0;
767 
768  result = (de_ctx->class_conf_ht->count == 0);
769 
770  result &= (SCClassConfGetClasstype("unknown", de_ctx) == NULL);
771  result &= (SCClassConfGetClasstype("unKnoWn", de_ctx) == NULL);
772  result &= (SCClassConfGetClasstype("bamboo", de_ctx) == NULL);
773  result &= (SCClassConfGetClasstype("bad-unknown", de_ctx) == NULL);
774  result &= (SCClassConfGetClasstype("BAD-UNKnOWN", de_ctx) == NULL);
775  result &= (SCClassConfGetClasstype("bed-unknown", de_ctx) == NULL);
776 
778 
779  return result;
780 }
781 
782 /**
783  * \brief This function registers unit tests for Classification Config API.
784  */
786 {
787  UtRegisterTest("SCClassConfTest01", SCClassConfTest01);
788  UtRegisterTest("SCClassConfTest02", SCClassConfTest02);
789  UtRegisterTest("SCClassConfTest03", SCClassConfTest03);
790  UtRegisterTest("SCClassConfTest04", SCClassConfTest04);
791  UtRegisterTest("SCClassConfTest05", SCClassConfTest05);
792 }
793 #endif /* UNITTESTS */
util-byte.h
len
uint8_t len
Definition: app-layer-dnp3.h:2
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:855
SCClassConfClasstype_::classtype
char * classtype
Definition: util-classification-config.h:41
util-fmemopen.h
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
util-hash.h
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:827
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:2612
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
u8_tolower
#define u8_tolower(c)
Definition: suricata-common.h:431
SCClassConfDeinit
void SCClassConfDeinit(void)
Definition: util-classification-config.c:84
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
SCClassConfGenerateInvalidDummyClassConfigFD02
FILE * SCClassConfGenerateInvalidDummyClassConfigFD02(void)
Creates a dummy classification file, with some valid Classtypes and a couple of invalid Classtypes,...
Definition: util-classification-config.c:609
ConfGet
int ConfGet(const char *name, const char **vptr)
Retrieve the value of a configuration node.
Definition: conf.c:335
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:238
StringParseUint32
int StringParseUint32(uint32_t *res, int base, size_t len, const char *str)
Definition: util-byte.c:313
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
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:563
conf.h
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:245
SCLogInfo
#define SCLogInfo(...)
Macro used to log INFORMATIONAL messages.
Definition: util-debug.h:224
SCClassConfGenerateInvalidDummyClassConfigFD03
FILE * SCClassConfGenerateInvalidDummyClassConfigFD03(void)
Creates a dummy classification file, with all invalid Classtypes, for testing purposes.
Definition: util-classification-config.c:633
DetectEngineCtx_::config_prefix
char config_prefix[64]
Definition: detect.h:951
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
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:785
SCMalloc
#define SCMalloc(sz)
Definition: util-mem.h:47
str
#define str(s)
Definition: suricata-common.h:286
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
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:2573
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
SCClassConfGenerateValidDummyClassConfigFD01
FILE * SCClassConfGenerateValidDummyClassConfigFD01(void)
Creates a dummy classification file, with all valid Classtypes, for testing purposes.
Definition: util-classification-config.c:589
SCClassConfLoadClassificationConfigFile
bool SCClassConfLoadClassificationConfigFile(DetectEngineCtx *de_ctx, FILE *fd)
Loads the Classtype info from the classification.config file.
Definition: util-classification-config.c:526
SCClassConfDeInitContext
void SCClassConfDeInitContext(DetectEngineCtx *de_ctx)
Releases resources used by the Classification Config API.
Definition: util-classification-config.c:193