/home/pvrabec/openscap/openscap-0.5.5/src/OVAL/public/oval_agent_api.h File Reference

OVAL agent API. More...

#include "oval_definitions.h"
#include "oval_system_characteristics.h"
#include "oval_results.h"

Go to the source code of this file.

Data Structures

struct  oval_xml_error

Typedefs

typedef int(* oval_xml_error_handler )(struct oval_xml_error *, void *user_arg)
 OVAL XML error handler function pointer type.

Enumerations

enum  oval_xml_severity_t {
  XML_VALIDITY_WARNING = 1, XML_VALIDITY_ERROR = 2, XML_WARNING = 3, XML_ERROR = 4,
  OVAL_LOG_INFO = 15, OVAL_LOG_DEBUG = 16, OVAL_LOG_WARN = 17
}
 

severity level


Functions

struct oval_import_sourceoval_import_source_new_file (char *filename)
 Create an import source from filename.
void oval_import_source_free (struct oval_import_source *source)
 free a specified import_source.
struct oval_export_targetoval_export_target_new_file (char *filename, char *encoding)
 create export_target object.
void oval_export_target_free (struct oval_export_target *target)
 free an export_target object.
struct oval_definition_modeloval_definition_model_new (void)
 Create an empty oval_definition_model.
struct oval_definition_modeloval_definition_model_clone (struct oval_definition_model *)
 Copy an oval_definition_model.
void oval_definition_model_free (struct oval_definition_model *model)
int oval_definition_model_import (struct oval_definition_model *model, struct oval_import_source *source, oval_xml_error_handler error_handler, void *client)
 Load OVAL definitions from a XML stream.
struct oval_definitionoval_definition_model_get_definition (struct oval_definition_model *model, char *id)
 Get OVAL definition by ID.
struct oval_testoval_definition_model_get_test (struct oval_definition_model *model, char *id)
 Get oval test by ID.
struct oval_objectoval_definition_model_get_object (struct oval_definition_model *model, char *id)
 Get OVAL object by ID.
struct oval_stateoval_definition_model_get_state (struct oval_definition_model *model, char *id)
 Get OVAL state by ID.
struct oval_variableoval_definition_model_get_variable (struct oval_definition_model *model, char *id)
 Get OVAL variable by ID.
struct oval_definition_iterator * oval_definition_model_get_definitions (struct oval_definition_model *model)
 Get OVAL definitions.
struct oval_test_iterator * oval_definition_model_get_tests (struct oval_definition_model *model)
 Get OVAL tests.
struct oval_object_iterator * oval_definition_model_get_objects (struct oval_definition_model *model)
 Get OVAL objects.
struct oval_state_iterator * oval_definition_model_get_states (struct oval_definition_model *model)
 Get OVAL states.
struct oval_variable_iterator * oval_definition_model_get_variables (struct oval_definition_model *model)
 Get OVAL variables.
int oval_definition_model_export (struct oval_definition_model *, struct oval_export_target *)
void oval_definition_model_add_definition (struct oval_definition_model *, struct oval_definition *)
void oval_definition_model_add_test (struct oval_definition_model *, struct oval_test *)
void oval_definition_model_add_object (struct oval_definition_model *, struct oval_object *)
void oval_definition_model_add_state (struct oval_definition_model *, struct oval_state *)
void oval_definition_model_add_variable (struct oval_definition_model *, struct oval_variable *)
void oval_definition_model_bind_variable_model (struct oval_definition_model *, struct oval_variable_model *)
 Bind an oval_variable_model to the specified oval_definition_model.
struct oval_variable_modeloval_variable_model_new (void)
 Create a new OVAL variable model.
struct oval_variable_modeloval_variable_model_clone (struct oval_variable_model *)
 Create an OVAL variable model.
void oval_variable_model_free (struct oval_variable_model *)
 Free memory allocated to a specified oval_variable_model.
void oval_variable_model_import (struct oval_variable_model *, struct oval_import_source *, oval_xml_error_handler, void *)
 Load the specified oval_variable_model from an XML stream.
void oval_variable_model_export (struct oval_variable_model *, struct oval_export_target *)
 Export the specified oval_variable_model to an XML stream.
struct oval_string_iterator * oval_variable_model_get_variable_ids (struct oval_variable_model *)
 Get all external variables managed by a specified oval_variable_model.
oval_datatype_t oval_variable_model_get_datatype (struct oval_variable_model *, char *)
 Get a specified external variable datatype.
const char * oval_variable_model_get_comment (struct oval_variable_model *, char *)
 Get a specified external variable comment.
struct oval_string_iterator * oval_variable_model_get_values (struct oval_variable_model *, char *)
 Get the values bound to a specified external variable.
void oval_variable_model_add (struct oval_variable_model *model, char *varid, const char *comment, oval_datatype_t datatype, char *value)
struct oval_syschar_modeloval_syschar_model_new (struct oval_definition_model *definition_model)
 Create new oval_syschar_model.
struct oval_syschar_modeloval_syschar_model_clone (struct oval_syschar_model *)
 Copy an oval_syschar_model.
void oval_syschar_model_free (struct oval_syschar_model *model)
 free memory allocated to a specified syschar model.
struct oval_definition_modeloval_syschar_model_get_definition_model (struct oval_syschar_model *model)
 Return related oval_definition_model from an oval_syschar_model.
struct oval_syschar_iterator * oval_syschar_model_get_syschars (struct oval_syschar_model *model)
 Return an iterator over the oval_sychar objects persisted by this model.
struct oval_sysinfooval_syschar_model_get_sysinfo (struct oval_syschar_model *model)
 Return default sysinfo bound to syschar model.
struct oval_syscharoval_syschar_model_get_syschar (struct oval_syschar_model *model, char *object_id)
 Return the oval_syschar bound to a specified object_id.
void oval_syschar_model_bind_variable_model (struct oval_syschar_model *, struct oval_variable_model *)
 Bind a variable model to the definitions bound to the syschar model.
void oval_syschar_model_probe_objects (struct oval_syschar_model *)
 Probe oval_objects bound to oval_syschar_model.
int oval_syschar_model_export (struct oval_syschar_model *, struct oval_export_target *)
 Export system characteristics as a XML file.
void oval_syschar_model_import (struct oval_syschar_model *, struct oval_import_source *, oval_xml_error_handler, void *)
 Load OVAL system characteristics from a file.
struct oval_results_modeloval_results_model_new (struct oval_definition_model *definition_model, struct oval_syschar_model **)
 Create new oval_results_model.
struct oval_results_modeloval_results_model_clone (struct oval_results_model *)
 Copy an oval_results_model.
void oval_results_model_free (struct oval_results_model *model)
 free memory allocated to a specified oval results model.
struct oval_definition_modeloval_results_model_get_definition_model (struct oval_results_model *model)
 oval_results_model_definition_model Return bound object model from an oval_results_model.
struct
oval_result_system_iterator * 
oval_results_model_get_systems (struct oval_results_model *)
 Return iterator over reporting systems.
void oval_results_model_add_system (struct oval_results_model *, struct oval_result_system *)
struct oval_result_directivesoval_results_model_import (struct oval_results_model *, struct oval_import_source *, oval_xml_error_handler, void *)
 load oval results from XML file.
struct oval_result_directivesoval_result_directives_new (void)
 Create new OVAL results directives.
void oval_result_directives_free (struct oval_result_directives *)
 Destroy OVAL results directives.
int oval_results_model_export (struct oval_results_model *, struct oval_result_directives *, struct oval_export_target *)
 export oval results to XML file.
struct oval_sysinfooval_sysinfo_probe (void)
struct oval_syscharoval_object_probe (struct oval_object *, struct oval_definition_model *model)
 Probe single OVAL object.

Detailed Description

OVAL agent API.

Author:
"David Niemoller" <David.Niemoller@g2-inc.com>

Function Documentation

void oval_export_target_free ( struct oval_export_target target  ) 

free an export_target object.

Parameters:
target the target to be freed.
struct oval_export_target* oval_export_target_new_file ( char *  filename,
char *  encoding 
) [read]

create export_target object.

Return the created export_target object.

Parameters:
filename the name of the target output file
encoding the target XML encoding.
void oval_import_source_free ( struct oval_import_source source  ) 

free a specified import_source.

Parameters:
source the specified import_source
struct oval_import_source* oval_import_source_new_file ( char *  filename  )  [read]

Create an import source from filename.

Return an import_source that streams from a designated file.

Parameters:
filename the name of the designated file

Generated on 12 Nov 2009 for Open SCAP Library by  doxygen 1.6.1