suricata
util-classification-config.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SCClassConfClasstype_
 Container for a Classtype from the Classification.config file. More...
 

Macros

#define CLASSTYPE_NAME_MAX_LEN   64
 
#define CLASSTYPE_DESC_MAX_LEN   512
 

Typedefs

typedef struct SCClassConfClasstype_ SCClassConfClasstype
 Container for a Classtype from the Classification.config file. More...
 

Functions

void SCClassConfLoadClassficationConfigFile (DetectEngineCtx *, FILE *fd)
 Loads the Classtype info from the classification.config file. 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...
 
SCClassConfClasstypeSCClassConfGetClasstype (const char *, DetectEngineCtx *)
 Gets the classtype from the corresponding hash table stored in the Detection Engine Context's class conf ht, given the classtype name. More...
 
void SCClassConfDeInitContext (DetectEngineCtx *)
 Releases resources used by the Classification Config API. More...
 
void SCClassConfInit (void)
 
void SCClassConfDeinit (void)
 
void SCClassConfRegisterTests (void)
 This function registers unit tests for Classification Config API. 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...
 

Detailed Description

Macro Definition Documentation

◆ CLASSTYPE_DESC_MAX_LEN

#define CLASSTYPE_DESC_MAX_LEN   512

Definition at line 29 of file util-classification-config.h.

◆ CLASSTYPE_NAME_MAX_LEN

#define CLASSTYPE_NAME_MAX_LEN   64

Definition at line 28 of file util-classification-config.h.

Typedef Documentation

◆ SCClassConfClasstype

Container for a Classtype from the Classification.config file.

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.

◆ SCClassConfDeinit()

void SCClassConfDeinit ( void  )

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

◆ SCClassConfDeInitContext()

void SCClassConfDeInitContext ( DetectEngineCtx )

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: