suricata
util-classification-config.c File Reference
#include "suricata-common.h"
#include "detect.h"
#include "detect-engine.h"
#include "util-hash.h"
#include "conf.h"
#include "util-classification-config.h"
#include "util-unittest.h"
#include "util-error.h"
#include "util-debug.h"
#include "util-fmemopen.h"
#include "util-byte.h"
Include dependency graph for util-classification-config.c:

Go to the source code of this file.

Macros

#define DETECT_CLASSCONFIG_REGEX   "^\\s*config\\s*classification\\s*:\\s*([a-zA-Z][a-zA-Z0-9-_]*)\\s*,\\s*(.+)\\s*,\\s*(\\d+)\\s*$"
 
#define SC_CLASS_CONF_DEF_CONF_FILEPATH   CONFIG_DIR "/classification.config"
 
#define MAX_SUBSTRINGS   30
 

Functions

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 HashTableInit function for DetectEngineCtx->class_conf_ht. More...
 
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 an argument to the HashTableInit function for DetectionEngineCtx->class_conf_ct. More...
 
void SCClassConfClasstypeHashFree (void *ch)
 Used to free the Classification Config Hash Data that was stored in DetectEngineCtx->class_conf_ht Hashtable. More...
 
void SCClassConfInit (void)
 
void SCClassConfDeinit (void)
 
void SCClassConfDeInitContext (DetectEngineCtx *de_ctx)
 Releases resources used by the Classification Config API. More...
 
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, i.e. DetectEngineCtx->class_conf_ht. More...
 
void SCClassConfLoadClassficationConfigFile (DetectEngineCtx *de_ctx, FILE *fd)
 Loads the Classtype info from the classification.config file. More...
 
SCClassConfClasstypeSCClassConfGetClasstype (const char *ct_name, DetectEngineCtx *de_ctx)
 Gets the classtype from the corresponding hash table stored in the Detection Engine Context's class conf ht, given the classtype name. More...
 
FILE * SCClassConfGenerateValidDummyClassConfigFD01 (void)
 Creates a dummy classification file, with all valid Classtypes, for testing purposes. More...
 
FILE * SCClassConfGenerateInValidDummyClassConfigFD02 (void)
 Creates a dummy classification file, with some valid Classtypes and a couple of invalid Classtypes, for testing purposes. More...
 
FILE * SCClassConfGenerateInValidDummyClassConfigFD03 (void)
 Creates a dummy classification file, with all invalid Classtypes, for testing purposes. More...
 
void SCClassConfRegisterTests (void)
 This function registers unit tests for Classification Config API. More...
 

Detailed Description

Author
Anoop Saldanha anoop.nosp@m.sald.nosp@m.anha@.nosp@m.gmai.nosp@m.l.com

Used for parsing a classification.config file

Definition in file util-classification-config.c.

Macro Definition Documentation

◆ DETECT_CLASSCONFIG_REGEX

#define DETECT_CLASSCONFIG_REGEX   "^\\s*config\\s*classification\\s*:\\s*([a-zA-Z][a-zA-Z0-9-_]*)\\s*,\\s*(.+)\\s*,\\s*(\\d+)\\s*$"

Definition at line 43 of file util-classification-config.c.

◆ MAX_SUBSTRINGS

#define MAX_SUBSTRINGS   30

◆ SC_CLASS_CONF_DEF_CONF_FILEPATH

#define SC_CLASS_CONF_DEF_CONF_FILEPATH   CONFIG_DIR "/classification.config"

Definition at line 49 of file util-classification-config.c.

Function Documentation

◆ 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, i.e. DetectEngineCtx->class_conf_ht.

Parameters
rawstrPointer to the string to be parsed.
indexRelative index of the string to be parsed.
de_ctxPointer to the Detection Engine Context.
Return values
0On success.
-1On failure.

Definition at line 243 of file util-classification-config.c.

References CLASSTYPE_DESC_MAX_LEN, CLASSTYPE_NAME_MAX_LEN, and MAX_SUBSTRINGS.

◆ 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 an argument to the HashTableInit function for DetectionEngineCtx->class_conf_ct.

Parameters
data1Pointer to the first SCClassConfClasstype to be compared.
len1Not used by this function.
data2Pointer to the second SCClassConfClasstype to be compared.
len2Not used by this function.
Return values
1On data1 and data2 being equal.
0On data1 and data2 not being equal.

Definition at line 477 of file util-classification-config.c.

References SCClassConfClasstype_::classtype, and SCLogDebug.

◆ SCClassConfClasstypeHashFree()

void SCClassConfClasstypeHashFree ( void *  ch)

Used to free the Classification Config Hash Data that was stored in DetectEngineCtx->class_conf_ht Hashtable.

Parameters
chPointer to the data that has to be freed.

Definition at line 508 of file util-classification-config.c.

◆ 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 HashTableInit function for DetectEngineCtx->class_conf_ht.

Parameters
htPointer to the HashTable.
dataPointer to the data to be hashed. In this case, the data would be a pointer to a SCClassConfClasstype instance.
datalenNot used by this function.

Definition at line 448 of file util-classification-config.c.

References HashTable_::array_size, SCClassConfClasstype_::classtype, and len.

◆ SCClassConfDeinit()

void SCClassConfDeinit ( void  )

Definition at line 87 of file util-classification-config.c.

◆ SCClassConfDeInitContext()

void SCClassConfDeInitContext ( DetectEngineCtx de_ctx)

Releases resources used by the Classification Config API.

Definition at line 198 of file util-classification-config.c.

References DetectEngineCtx_::class_conf_ht, de_ctx, and HashTableFree().

Referenced by DetectEngineCtxFree().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SCClassConfGenerateInValidDummyClassConfigFD02()

FILE* SCClassConfGenerateInValidDummyClassConfigFD02 ( void  )

Creates a dummy classification file, with some valid Classtypes and a couple of invalid Classtypes, for testing purposes.

\file_path Pointer to the file_path for the dummy classification file.

Definition at line 604 of file util-classification-config.c.

References SCFmemopen, and SCLogDebug.

◆ SCClassConfGenerateInValidDummyClassConfigFD03()

FILE* SCClassConfGenerateInValidDummyClassConfigFD03 ( void  )

Creates a dummy classification file, with all invalid Classtypes, for testing purposes.

\file_path Pointer to the file_path for the dummy classification file.

Definition at line 628 of file util-classification-config.c.

References SCFmemopen, and SCLogDebug.

◆ SCClassConfGenerateValidDummyClassConfigFD01()

FILE* SCClassConfGenerateValidDummyClassConfigFD01 ( void  )

Creates a dummy classification file, with all valid Classtypes, for testing purposes.

\file_path Pointer to the file_path for the dummy classification file.

Definition at line 584 of file util-classification-config.c.

References SCFmemopen, and SCLogDebug.

◆ 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 conf ht, given the classtype name.

Parameters
ct_namePointer to the classtype name that has to be looked up.
de_ctxPointer to the Detection Engine Context.
Return values
lookup_ct_infoPointer to the SCClassConfClasstype instance from the hash table on success; NULL on failure.

Definition at line 558 of file util-classification-config.c.

References DetectEngineCtx_::class_conf_ht, de_ctx, and HashTableLookup().

Here is the call graph for this function:

◆ SCClassConfInit()

void SCClassConfInit ( void  )

Definition at line 64 of file util-classification-config.c.

Referenced by LLVMFuzzerTestOneInput(), PostConfLoadedDetectSetup(), and RunUnittests().

Here is the caller graph for this function:

◆ SCClassConfLoadClassficationConfigFile()

void SCClassConfLoadClassficationConfigFile ( DetectEngineCtx de_ctx,
FILE *  fd 
)

Loads the Classtype info from the classification.config file.

   The classification.config file contains the different classtypes,
   that can be used to label Signatures.  Each line of the file should
   have the following format -
   classtype_name, classtype_description, priority
   None of the above parameters should hold a quote inside the file.
Parameters
de_ctxPointer to the Detection Engine Context that should be updated with Classtype information.

Definition at line 527 of file util-classification-config.c.

◆ SCClassConfRegisterTests()

void SCClassConfRegisterTests ( void  )

This function registers unit tests for Classification Config API.

Definition at line 819 of file util-classification-config.c.

References UtRegisterTest().

Here is the call graph for this function: