idmef-criteria

idmef-criteria

Functions

Types and Values

Description

Functions

idmef_criterion_operator_to_string ()

const char *
idmef_criterion_operator_to_string (idmef_criterion_operator_t op);

Transforms op to string.

Parameters

Returns

A pointer to an operator string or NULL.


idmef_criterion_new ()

int
idmef_criterion_new (idmef_criterion_t **criterion,
                     idmef_path_t *path,
                     idmef_criterion_value_t *value,
                     idmef_criterion_operator_t op);

Creates a new idmef_criterion_t object and store it in criterion . Matching this criterion will result in comparing the object value pointed by path against the provided value , using op .

Parameters

criterion

Address where to store the created idmef_criterion_t object.

 

path

Pointer to an idmef_path_t object.

 

value

Pointer to an idmef_criterion_value_t object.

 

op

idmef_criterion_operator_t to use for matching this criterion.

 

Returns

0 on success, a negative value if an error occured.


idmef_criterion_destroy ()

void
idmef_criterion_destroy (idmef_criterion_t *criterion);

Destroys criterion and its content.

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

idmef_criterion_clone ()

int
idmef_criterion_clone (const idmef_criterion_t *criterion,
                       idmef_criterion_t **dst);

Clones criterion and stores the cloned criterion within dst .

Parameters

criterion

Pointer to a idmef_criterion_t object to clone.

 

dst

Address where to store the cloned idmef_criterion_t object.

 

Returns

0 on success, a negative value if an error occured.


idmef_criterion_print ()

int
idmef_criterion_print (const idmef_criterion_t *criterion,
                       prelude_io_t *fd);

Dump criterion to fd in the form of: path [value]

Or if there is no value associated with the criterion: operator

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

fd

Pointer to a prelude_io_t object.

 

Returns

0 on success, a negative value if an error occured.


idmef_criterion_to_string ()

int
idmef_criterion_to_string (const idmef_criterion_t *criterion,
                           prelude_string_t *out);

Dump criterion as a string to the out buffer in the form of: path [value]

Or if there is no value associated with the criterion: operator

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

out

Pointer to a prelude_string_t object.

 

Returns

0 on success, a negative value if an error occured.


idmef_criterion_get_path ()

idmef_path_t *
idmef_criterion_get_path (const idmef_criterion_t *criterion);

Used to access the idmef_path_t object associated with criterion .

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

Returns

the idmef_path_t object associated with criterion .


idmef_criterion_get_value ()

idmef_criterion_value_t *
idmef_criterion_get_value (const idmef_criterion_t *criterion);

Used to access the idmef_criterion_value_t associated with criterion . There might be no value specifically if the provided idmef_criterion_operator_t was IDMEF_CRITERION_OPERATOR_NULL or IDMEF_CRITERION_OPERATOR_NOT_NULL.

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

Returns

the idmef_criterion_value_t object associated with criterion .


idmef_criterion_get_operator ()

idmef_criterion_operator_t
idmef_criterion_get_operator (const idmef_criterion_t *criterion);

Used to access the idmef_criterion_operator_t enumeration associated with criterion .

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

Returns

the idmef_criterion_operator_t associated with criterion .


idmef_criterion_match ()

int
idmef_criterion_match (const idmef_criterion_t *criterion,
                       void *object);

Matches message against the provided criterion . This implies retrieving the value associated with criterion path, and matching it with the idmef_criterion_value_t object within criterion .

Parameters

criterion

Pointer to a idmef_criterion_t object.

 

object

Pointer to a idmef_object_t object to match against criterion .

 

Returns

1 for a match, 0 for no match, or a negative value if an error occured.


idmef_criteria_new ()

int
idmef_criteria_new (idmef_criteria_t **criteria);

Creates a new idmef_criteria_t object and store it into criteria .

Parameters

criteria

Address where to store the created idmef_criteria_t object.

 

Returns

0 on success, a negative value if an error occured.


idmef_criteria_ref ()

idmef_criteria_t *
idmef_criteria_ref (idmef_criteria_t *criteria);

Increases criteria reference count.

idmef_criteria_destroy() will decrease the refcount until it reaches 0, at which point criteria will be destroyed.

Parameters

criteria

Pointer to a idmef_criteria_t object to reference.

 

Returns

criteria .


idmef_criteria_destroy ()

void
idmef_criteria_destroy (idmef_criteria_t *criteria);

Destroys criteria and its content.

Parameters

criteria

Pointer to a idmef_criteria_t object.

 

idmef_criteria_clone ()

int
idmef_criteria_clone (idmef_criteria_t *src,
                      idmef_criteria_t **dst);

Clones src and stores the cloned criteria within dst .

Parameters

src

Pointer to a idmef_criteria_t object to clone.

 

dst

Address where to store the cloned idmef_criteria_t object.

 

Returns

0 on success, a negative value if an error occured.


idmef_criteria_print ()

int
idmef_criteria_print (const idmef_criteria_t *criteria,
                      prelude_io_t *fd);

idmef_criteria_to_string ()

int
idmef_criteria_to_string (const idmef_criteria_t *criteria,
                          prelude_string_t *out);

idmef_criteria_is_criterion ()

prelude_bool_t
idmef_criteria_is_criterion (const idmef_criteria_t *criteria);

idmef_criteria_get_criterion ()

idmef_criterion_t *
idmef_criteria_get_criterion (const idmef_criteria_t *criteria);

idmef_criteria_set_criterion ()

void
idmef_criteria_set_criterion (idmef_criteria_t *criteria,
                              idmef_criterion_t *criterion);

idmef_criteria_or_criteria ()

void
idmef_criteria_or_criteria (idmef_criteria_t *criteria,
                            idmef_criteria_t *criteria2);

idmef_criteria_and_criteria ()

int
idmef_criteria_and_criteria (idmef_criteria_t *criteria,
                             idmef_criteria_t *criteria2);

idmef_criteria_match ()

int
idmef_criteria_match (const idmef_criteria_t *criteria,
                      void *object);

Matches object against the provided criteria.

Parameters

criteria

Pointer to a idmef_criteria_t object.

 

object

Pointer to a idmef_object_t object.

 

Returns

1 if criteria match, 0 if it did not, a negative value if an error occured.


idmef_criteria_get_or ()

idmef_criteria_t *
idmef_criteria_get_or (const idmef_criteria_t *criteria);

idmef_criteria_get_and ()

idmef_criteria_t *
idmef_criteria_get_and (const idmef_criteria_t *criteria);

idmef_criteria_new_from_string ()

int
idmef_criteria_new_from_string (idmef_criteria_t **criteria,
                                const char *str);

idmef_criteria_get_negation ()

prelude_bool_t
idmef_criteria_get_negation (const idmef_criteria_t *criteria);

idmef_criteria_set_negation ()

void
idmef_criteria_set_negation (idmef_criteria_t *criteria,
                             prelude_bool_t negate);

Types and Values

enum idmef_criterion_operator_t

Members

IDMEF_CRITERION_OPERATOR_NOT

   

IDMEF_CRITERION_OPERATOR_NOCASE

   

IDMEF_CRITERION_OPERATOR_EQUAL

   

IDMEF_CRITERION_OPERATOR_EQUAL_NOCASE

   

IDMEF_CRITERION_OPERATOR_NOT_EQUAL

   

IDMEF_CRITERION_OPERATOR_NOT_EQUAL_NOCASE

   

IDMEF_CRITERION_OPERATOR_LESSER

   

IDMEF_CRITERION_OPERATOR_LESSER_OR_EQUAL

   

IDMEF_CRITERION_OPERATOR_GREATER

   

IDMEF_CRITERION_OPERATOR_GREATER_OR_EQUAL

   

IDMEF_CRITERION_OPERATOR_SUBSTR

   

IDMEF_CRITERION_OPERATOR_SUBSTR_NOCASE

   

IDMEF_CRITERION_OPERATOR_NOT_SUBSTR

   

IDMEF_CRITERION_OPERATOR_NOT_SUBSTR_NOCASE

   

IDMEF_CRITERION_OPERATOR_REGEX

   

IDMEF_CRITERION_OPERATOR_REGEX_NOCASE

   

IDMEF_CRITERION_OPERATOR_NOT_REGEX

   

IDMEF_CRITERION_OPERATOR_NOT_REGEX_NOCASE

   

IDMEF_CRITERION_OPERATOR_NULL

   

IDMEF_CRITERION_OPERATOR_NOT_NULL

   

idmef_criteria_t

typedef struct idmef_criteria idmef_criteria_t;

idmef_criterion_t

typedef struct idmef_criterion idmef_criterion_t;