suricata
util-reference-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  SCRConfReference_
 Holds a reference from the file - reference.config. More...
 

Macros

#define REFERENCE_SYSTEM_NAME_MAX   64
 
#define REFERENCE_CONTENT_NAME_MAX   1024
 

Typedefs

typedef struct SCRConfReference_ SCRConfReference
 Holds a reference from the file - reference.config. More...
 

Functions

SCRConfReferenceSCRConfAllocSCRConfReference (const char *, const char *)
 Returns a new SCRConfReference instance. The reference string is converted into lowercase, before being assigned to the instance. More...
 
void SCRConfDeAllocSCRConfReference (SCRConfReference *)
 Frees a SCRConfReference instance. More...
 
int SCRConfLoadReferenceConfigFile (DetectEngineCtx *, FILE *)
 Loads the Reference info from the reference.config file. More...
 
void SCRConfDeInitContext (DetectEngineCtx *)
 Releases de_ctx resources related to Reference Config API. More...
 
SCRConfReferenceSCRConfGetReference (const char *, DetectEngineCtx *)
 Gets the refernce config from the corresponding hash table stored in the Detection Engine Context's reference conf ht, given the reference name. More...
 
int SCRConfAddReference (DetectEngineCtx *de_ctx, const char *line)
 Parses a line from the reference config file and adds it to Reference Config hash table DetectEngineCtx->reference_conf_ht. More...
 
void SCRConfRegisterTests (void)
 This function registers unit tests for Reference Config API. More...
 
FILE * SCRConfGenerateValidDummyReferenceConfigFD01 (void)
 Creates a dummy reference config, with all valid references, for testing purposes. More...
 
FILE * SCRConfGenerateInValidDummyReferenceConfigFD02 (void)
 Creates a dummy reference config, with some valid references and a couple of invalid references, for testing purposes. More...
 
FILE * SCRConfGenerateInValidDummyReferenceConfigFD03 (void)
 Creates a dummy reference config, with all invalid references, for testing purposes. More...
 
void SCReferenceConfInit (void)
 
void SCReferenceConfDeinit (void)
 

Detailed Description

Macro Definition Documentation

◆ REFERENCE_CONTENT_NAME_MAX

#define REFERENCE_CONTENT_NAME_MAX   1024

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

◆ REFERENCE_SYSTEM_NAME_MAX

#define REFERENCE_SYSTEM_NAME_MAX   64

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

Typedef Documentation

◆ SCRConfReference

Holds a reference from the file - reference.config.

Function Documentation

◆ SCRConfAddReference()

int SCRConfAddReference ( DetectEngineCtx de_ctx,
const char *  line 
)

Parses a line from the reference config file and adds it to Reference Config hash table DetectEngineCtx->reference_conf_ht.

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

Definition at line 233 of file util-reference-config.c.

References MAX_SUBSTRINGS, REFERENCE_CONTENT_NAME_MAX, and REFERENCE_SYSTEM_NAME_MAX.

◆ SCRConfAllocSCRConfReference()

SCRConfReference* SCRConfAllocSCRConfReference ( const char *  system,
const char *  url 
)

Returns a new SCRConfReference instance. The reference string is converted into lowercase, before being assigned to the instance.

Parameters
systemPointer to the system.
urlPointer to the reference url.
Return values
refPointer to the new instance of SCRConfReference.

Definition at line 354 of file util-reference-config.c.

References SC_ERR_INVALID_SIGNATURE, SCLogError, SCMalloc, and SCRConfReference_::system.

Referenced by SCRConfGetReference().

Here is the caller graph for this function:

◆ SCRConfDeAllocSCRConfReference()

void SCRConfDeAllocSCRConfReference ( SCRConfReference ref)

Frees a SCRConfReference instance.

Parameters
Pointerto the SCRConfReference instance that has to be freed.

Definition at line 388 of file util-reference-config.c.

References SCFree, SCRConfReference_::system, and SCRConfReference_::url.

Referenced by SCRConfGetReference(), and SCRConfReferenceHashFree().

Here is the caller graph for this function:

◆ SCRConfDeInitContext()

void SCRConfDeInitContext ( DetectEngineCtx )

Releases de_ctx resources related to Reference Config API.

Definition at line 190 of file util-reference-config.c.

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

Referenced by DetectEngineCtxFree().

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

◆ SCRConfGenerateInValidDummyReferenceConfigFD02()

FILE* SCRConfGenerateInValidDummyReferenceConfigFD02 ( void  )

Creates a dummy reference config, with some valid references and a couple of invalid references, for testing purposes.

Definition at line 566 of file util-reference-config.c.

References SCFmemopen, and SCLogDebug.

◆ SCRConfGenerateInValidDummyReferenceConfigFD03()

FILE* SCRConfGenerateInValidDummyReferenceConfigFD03 ( void  )

Creates a dummy reference config, with all invalid references, for testing purposes.

Definition at line 586 of file util-reference-config.c.

References SCFmemopen, and SCLogDebug.

◆ SCRConfGenerateValidDummyReferenceConfigFD01()

FILE* SCRConfGenerateValidDummyReferenceConfigFD01 ( void  )

Creates a dummy reference config, with all valid references, for testing purposes.

Definition at line 546 of file util-reference-config.c.

References SCFmemopen, and SCLogDebug.

◆ SCRConfGetReference()

SCRConfReference* SCRConfGetReference ( const char *  rconf_name,
DetectEngineCtx de_ctx 
)

Gets the refernce config from the corresponding hash table stored in the Detection Engine Context's reference conf ht, given the reference name.

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

Definition at line 524 of file util-reference-config.c.

References de_ctx, HashTableLookup(), DetectEngineCtx_::reference_conf_ht, SCRConfAllocSCRConfReference(), and SCRConfDeAllocSCRConfReference().

Here is the call graph for this function:

◆ SCRConfLoadReferenceConfigFile()

int SCRConfLoadReferenceConfigFile ( DetectEngineCtx de_ctx,
FILE *  fd 
)

Loads the Reference info from the reference.config file.

   The reference.config file contains references that can be used in
   Signatures.  Each line of the file should  have the following format -
   config reference: system_name, reference_url.
Parameters
de_ctxPointer to the Detection Engine Context that should be updated with reference information.
Return values
0On success.
-1On failure.

Definition at line 493 of file util-reference-config.c.

◆ SCRConfRegisterTests()

void SCRConfRegisterTests ( void  )

This function registers unit tests for Reference Config API.

Definition at line 783 of file util-reference-config.c.

References UtRegisterTest().

Here is the call graph for this function:

◆ SCReferenceConfDeinit()

void SCReferenceConfDeinit ( void  )

Definition at line 80 of file util-reference-config.c.

◆ SCReferenceConfInit()

void SCReferenceConfInit ( void  )

Definition at line 56 of file util-reference-config.c.

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

Here is the caller graph for this function: