idmef-util

Name

idmef-util -- 

Synopsis



const char* idmef_additional_data_to_string (const idmef_additional_data_t *ad,
                                             char *out,
                                             size_t *size);
const char* idmef_additional_data_type_to_string
                                            (idmef_additional_data_type_t type);
const char* idmef_classification_origin_to_string
                                            (idmef_classification_origin_t origin);
const char* idmef_address_category_to_string
                                            (idmef_address_category_t category);
const char* idmef_node_category_to_string   (idmef_node_category_t category);
const char* idmef_user_category_to_string   (idmef_user_category_t category);
const char* idmef_userid_type_to_string     (idmef_userid_type_t type);
const char* idmef_source_spoofed_to_string  (idmef_spoofed_t spoofed);
const char* idmef_target_decoy_to_string    (idmef_spoofed_t decoy);
const char* idmef_impact_severity_to_string (idmef_impact_severity_t severity);
const char* idmef_impact_completion_to_string
                                            (idmef_impact_completion_t completion);
const char* idmef_impact_type_to_string     (idmef_impact_type_t type);
const char* idmef_linkage_category_to_string
                                            (idmef_linkage_category_t category);
const char* idmef_file_category_to_string   (idmef_file_category_t category);
const char* idmef_confidence_rating_to_string
                                            (idmef_confidence_rating_t rating);
const char* idmef_action_category_to_string (idmef_action_category_t category);
int         idmef_ident_init                (void);
void        idmef_ident_exit                (void);
void        idmef_alert_get_ident           (idmef_alert_t *alert);
void        idmef_heartbeat_get_ident       (idmef_heartbeat_t *heartbeat);
#define     MAX_UTC_DATETIME_SIZE
#define     MAX_NTP_TIMESTAMP_SIZE
void        idmef_get_ntp_timestamp         (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);
int         idmef_get_timestamp             (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);
int         idmef_get_db_timestamp          (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);
int         idmef_get_idmef_timestamp       (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);

Description

Details

idmef_additional_data_to_string ()

const char* idmef_additional_data_to_string (const idmef_additional_data_t *ad,
                                             char *out,
                                             size_t *size);

This function take care of converting the IDMEF AdditionalData data member to a string suitable to be outputed in the IDMEF database.

The provided buffer might not be used. Uppon return, size will reflect the amount of size used in the buffer.

ad : An additional data object.
out : A buffer where the output should be stored.
size : Pointer to the size of the destination buffer.
Returns : NULL on error, a pointer to buf if conversion succeed, or a pointer to the actual data if no conversion is needed.


idmef_additional_data_type_to_string ()

const char* idmef_additional_data_type_to_string
                                            (idmef_additional_data_type_t type);

type : 
Returns : 


idmef_classification_origin_to_string ()

const char* idmef_classification_origin_to_string
                                            (idmef_classification_origin_t origin);

origin : 
Returns : 


idmef_address_category_to_string ()

const char* idmef_address_category_to_string
                                            (idmef_address_category_t category);

category : 
Returns : 


idmef_node_category_to_string ()

const char* idmef_node_category_to_string   (idmef_node_category_t category);

category : 
Returns : 


idmef_user_category_to_string ()

const char* idmef_user_category_to_string   (idmef_user_category_t category);

category : 
Returns : 


idmef_userid_type_to_string ()

const char* idmef_userid_type_to_string     (idmef_userid_type_t type);

type : 
Returns : 


idmef_source_spoofed_to_string ()

const char* idmef_source_spoofed_to_string  (idmef_spoofed_t spoofed);

spoofed : 
Returns : 


idmef_target_decoy_to_string ()

const char* idmef_target_decoy_to_string    (idmef_spoofed_t decoy);

decoy : 
Returns : 


idmef_impact_severity_to_string ()

const char* idmef_impact_severity_to_string (idmef_impact_severity_t severity);

severity : 
Returns : 


idmef_impact_completion_to_string ()

const char* idmef_impact_completion_to_string
                                            (idmef_impact_completion_t completion);

completion : 
Returns : 


idmef_impact_type_to_string ()

const char* idmef_impact_type_to_string     (idmef_impact_type_t type);

type : 
Returns : 


idmef_linkage_category_to_string ()

const char* idmef_linkage_category_to_string
                                            (idmef_linkage_category_t category);

category : 
Returns : 


idmef_file_category_to_string ()

const char* idmef_file_category_to_string   (idmef_file_category_t category);

category : 
Returns : 


idmef_confidence_rating_to_string ()

const char* idmef_confidence_rating_to_string
                                            (idmef_confidence_rating_t rating);

rating : 
Returns : 


idmef_action_category_to_string ()

const char* idmef_action_category_to_string (idmef_action_category_t category);

category : 
Returns : 


idmef_ident_init ()

int         idmef_ident_init                (void);

Returns : 


idmef_ident_exit ()

void        idmef_ident_exit                (void);


idmef_alert_get_ident ()

void        idmef_alert_get_ident           (idmef_alert_t *alert);

alert : 


idmef_heartbeat_get_ident ()

void        idmef_heartbeat_get_ident       (idmef_heartbeat_t *heartbeat);

heartbeat : 


MAX_UTC_DATETIME_SIZE

#define MAX_UTC_DATETIME_SIZE  64   /* YYYY-MM-DDThh:mm:ss.ssZ */


MAX_NTP_TIMESTAMP_SIZE

#define MAX_NTP_TIMESTAMP_SIZE 21   /* 0xNNNNNNNN.0xNNNNNNNN   */


idmef_get_ntp_timestamp ()

void        idmef_get_ntp_timestamp         (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);

time : 
outptr : 
size : 


idmef_get_timestamp ()

int         idmef_get_timestamp             (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);

Translate time to an user readable string.

time : Pointer to an IDMEF time structure.
outptr : Output buffer.
size : size of the output buffer.
Returns : 0 on success, -1 if an error occured.


idmef_get_db_timestamp ()

int         idmef_get_db_timestamp          (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);

Translate time to a string suitable for insertion into a database field of type DATETIME.

time : Pointer to an IDMEF time structure.
outptr : Output buffer.
size : size of the output buffer.
Returns : 


idmef_get_idmef_timestamp ()

int         idmef_get_idmef_timestamp       (const idmef_time_t *time,
                                             char *outptr,
                                             size_t size);

Translate time to an user readable string following the IDMEF specification.

time : Pointer to an IDMEF time structure.
outptr : Output buffer.
size : size of the output buffer.
Returns : 0 on success, -1 if an error occured.