OVALDEF
[OVAL]

Interface for Definition model. More...

Data Structures

struct  oval_definition_model
 Oval definition model. More...
struct  oval_definition
 Oval definition specification. More...
struct  oval_definition_iterator
struct  oval_test
 An Oval_test specifies a technical control by identifying an oval_object that is evaluated on an instrumented host platform and, optionally, an Oval_state instance that matches the object query. More...
struct  oval_test_iterator
struct  oval_object
 An Oval_object instance describes a set of items to look for on an instrumented host platform. More...
struct  oval_object_iterator
struct  oval_state
 An Oval_state instance is a collection of one or more characteristics pertaining to a specific object type. More...
struct  oval_state_iterator
struct  oval_variable
 An oval variable resolves an oval_value stream which specifies constraints for oval_objects and oval_states. More...
struct  oval_variable_iterator
struct  oval_affected
 Each OVAL Definition specifies certain type of affected system(s). More...
struct  oval_affected_iterator
struct  oval_reference
 An Oval_reference links an Oval_definition to a definitive external reference. More...
struct  oval_reference_iterator
struct  oval_criteria_node
 Specify oval_definition dependencies. More...
struct  oval_criteria_node_iterator
struct  oval_object_content
 An Oval_object_content instance specifies an oval_object field. More...
struct  oval_object_content_iterator
struct  oval_behavior
 OVAL behavior. More...
struct  oval_behavior_iterator
struct  oval_state_content
 An Oval_state_content instance specifies an oval_state field. More...
struct  oval_state_content_iterator
struct  oval_value
 OVAL object or item entity value. More...
struct  oval_value_iterator
struct  oval_entity
 OVAL entity. More...
struct  oval_entity_iterator
struct  oval_setobject
 OVAL set object. More...
struct  oval_setobject_iteraor
struct  oval_component
 OVAL variable component Oval_component instances specify evaluation constraints on local variables (see oval_variable_get_type). More...
struct  oval_component_iterator
struct  oval_string_iterator

Files

file  oval_definitions.h

Defines

#define OVAL_FUNCTION   10

Enumerations

enum  oval_affected_family_t {
  OVAL_AFCFML_UNKNOWN = 0, OVAL_AFCFML_CATOS = 1, OVAL_AFCFML_IOS = 2, OVAL_AFCFML_MACOS = 3,
  OVAL_AFCFML_PIXOS = 4, OVAL_AFCFML_UNDEFINED = 5, OVAL_AFCFML_UNIX = 6, OVAL_AFCFML_WINDOWS = 7
}
 

Affected family enumeration.

More...
enum  oval_criteria_node_type_t { OVAL_NODETYPE_UNKNOWN = 0, OVAL_NODETYPE_CRITERIA = 1, OVAL_NODETYPE_CRITERION = 2, OVAL_NODETYPE_EXTENDDEF = 3 }
 

Criteria node type.


enum  oval_operator_t {
  OVAL_OPERATOR_UNKNOWN = 0, OVAL_OPERATOR_AND = 1, OVAL_OPERATOR_ONE = 2, OVAL_OPERATOR_OR = 3,
  OVAL_OPERATOR_XOR = 4
}
 

Boolean operators.


enum  oval_operation_t {
  OVAL_OPERATION_UNKNOWN = 0, OVAL_OPERATION_EQUALS = 1, OVAL_OPERATION_NOT_EQUAL = 2, OVAL_OPERATION_CASE_INSENSITIVE_EQUALS = 3,
  OVAL_OPERATION_CASE_INSENSITIVE_NOT_EQUAL = 4, OVAL_OPERATION_GREATER_THAN = 5, OVAL_OPERATION_LESS_THAN = 6, OVAL_OPERATION_GREATER_THAN_OR_EQUAL = 7,
  OVAL_OPERATION_LESS_THAN_OR_EQUAL = 8, OVAL_OPERATION_BITWISE_AND = 9, OVAL_OPERATION_BITWISE_OR = 10, OVAL_OPERATION_PATTERN_MATCH = 11
}
 

Operations.


enum  oval_definition_class_t {
  OVAL_CLASS_UNKNOWN = 0, OVAL_CLASS_COMPLIANCE = 1, OVAL_CLASS_INVENTORY = 2, OVAL_CLASS_MISCELLANEOUS = 3,
  OVAL_CLASS_PATCH = 4, OVAL_CLASS_VULNERABILITY = 5
}
 

Definition classes.

More...
enum  oval_existence_t {
  OVAL_EXISTENCE_UNKNOWN = 0, OVAL_ALL_EXIST = 1, OVAL_ANY_EXIST = 2, OVAL_AT_LEAST_ONE_EXISTS = 3,
  OVAL_ONLY_ONE_EXISTS = 4, OVAL_NONE_EXIST = 5
}
 

Existence check enumeration.


enum  oval_check_t {
  OVAL_CHECK_UNKNOWN = 0, OVAL_CHECK_ALL = 1, OVAL_CHECK_AT_LEAST_ONE = 2, OVAL_CHECK_NONE_EXIST = 3,
  OVAL_CHECK_NONE_SATISFY = 4, OVAL_CHECK_ONLY_ONE = 5
}
 

Check enumeration.


enum  oval_object_content_type_t { OVAL_OBJECTCONTENT_UNKNOWN = 0, OVAL_OBJECTCONTENT_ENTITY = 1, OVAL_OBJECTCONTENT_SET = 2 }
 

Type of object content.


enum  oval_entity_type_t {
  OVAL_ENTITY_TYPE_UNKNOWN, OVAL_ENTITY_TYPE_ANY, OVAL_ENTITY_TYPE_BINARY, OVAL_ENTITY_TYPE_BOOLEAN,
  OVAL_ENTITY_TYPE_FLOAT, OVAL_ENTITY_TYPE_INTEGER, OVAL_ENTITY_TYPE_STRING
}
 

Type of OVAL entity.


enum  oval_datatype_t {
  OVAL_DATATYPE_UNKNOWN = 0, OVAL_DATATYPE_BINARY = 1, OVAL_DATATYPE_BOOLEAN = 2, OVAL_DATATYPE_EVR_STRING = 3,
  OVAL_DATATYPE_FILESET_REVISION = 4, OVAL_DATATYPE_FLOAT = 5, OVAL_DATATYPE_IOS_VERSION = 6, OVAL_DATATYPE_VERSION = 7,
  OVAL_DATATYPE_INTEGER = 8, OVAL_DATATYPE_STRING = 9
}
 

Datatypes.


enum  oval_entity_varref_type_t { OVAL_ENTITY_VARREF_UNKNOWN, OVAL_ENTITY_VARREF_NONE, OVAL_ENTITY_VARREF_ATTRIBUTE, OVAL_ENTITY_VARREF_ELEMENT }
 

Varref types.


enum  oval_setobject_type_t { OVAL_SET_UNKNOWN, OVAL_SET_AGGREGATE, OVAL_SET_COLLECTIVE }
 

OVAL set object types.


enum  oval_setobject_operation_t { OVAL_SET_OPERATION_UNKNOWN, OVAL_SET_OPERATION_COMPLEMENT = 1, OVAL_SET_OPERATION_INTERSECTION = 2, OVAL_SET_OPERATION_UNION = 3 }
 

Set operations.


enum  oval_variable_type_t { OVAL_VARIABLE_UNKNOWN, OVAL_VARIABLE_EXTERNAL, OVAL_VARIABLE_CONSTANT, OVAL_VARIABLE_LOCAL }
 

OVAL variable types.


enum  oval_component_type_t {
  OVAL_COMPONENT_UNKNOWN = 0, OVAL_COMPONENT_LITERAL = 1, OVAL_COMPONENT_OBJECTREF = 2, OVAL_COMPONENT_VARREF = 3,
  OVAL_COMPONENT_FUNCTION = 4, OVAL_FUNCTION_BEGIN = OVAL_FUNCTION + 1, OVAL_FUNCTION_CONCAT = OVAL_FUNCTION + 2, OVAL_FUNCTION_END = OVAL_FUNCTION + 3,
  OVAL_FUNCTION_SPLIT = OVAL_FUNCTION + 4, OVAL_FUNCTION_SUBSTRING = OVAL_FUNCTION + 5, OVAL_FUNCTION_TIMEDIF = OVAL_FUNCTION + 6, OVAL_FUNCTION_ESCAPE_REGEX = OVAL_FUNCTION + 7,
  OVAL_FUNCTION_REGEX_CAPTURE = OVAL_FUNCTION + 8, OVAL_FUNCTION_ARITHMETIC = OVAL_FUNCTION + 9
}
 

Component types.


enum  oval_arithmetic_operation_t {
  OVAL_ARITHMETIC_UNKNOWN = 0, OVAL_ARITHMETIC_ADD = 1, OVAL_ARITHMETIC_MULTIPLY = 2, OVAL_ARITHMETIC_SUBTRACT = 3,
  OVAL_ARITHMETIC_DIVIDE = 4
}
 

Arithmetic format enumeration.


enum  oval_datetime_format_t {
  OVAL_DATETIME_UNKNOWN = 0, OVAL_DATETIME_YEAR_MONTH_DAY = 1, OVAL_DATETIME_MONTH_DAY_YEAR = 2, OVAL_DATETIME_DAY_MONTH_YEAR = 3,
  OVAL_DATETIME_WIN_FILETIME = 4, OVAL_DATETIME_SECONDS_SINCE_EPOCH = 5
}
 

Datetime format enumeration.


Functions

oval_family_t oval_subtype_get_family (oval_subtype_t)
 Get the family associated with a given subtype.
const char * oval_operator_get_text (oval_operator_t)
const char * oval_subtype_get_text (oval_subtype_t)
const char * oval_family_get_text (oval_family_t)
const char * oval_check_get_text (oval_check_t)
const char * oval_existence_get_text (oval_existence_t)
const char * oval_affected_family_get_text (oval_affected_family_t)
const char * oval_datatype_get_text (oval_datatype_t)
const char * oval_operation_get_text (oval_operation_t)
const char * oval_set_operation_get_text (oval_setobject_operation_t)
const char * oval_datetime_format_get_text (oval_datetime_format_t)
const char * oval_arithmetic_operation_get_text (oval_arithmetic_operation_t)
struct oval_definition_modeloval_definition_model::oval_definition_model_new (void)
 Create an empty oval_definition_model.
struct oval_definition_modeloval_definition_model::oval_definition_model_import (const char *file)
 Import the content from the file into an oval_definition_model.
int oval_definition_model::oval_definition_model_merge (struct oval_definition_model *model, const char *file)
 Merge the content from the file with specified oval_definition_model.
struct oval_definition_modeloval_definition_model::oval_definition_model_clone (struct oval_definition_model *)
 Copy an oval_definition_model.
int oval_definition_model::oval_definition_model_export (struct oval_definition_model *, const char *file)
 Export an oval_definition_model into file.
void oval_definition_model::oval_definition_model_free (struct oval_definition_model *model)
 Free OVAL object model.
struct oval_definitionoval_definition::oval_definition_new (struct oval_definition_model *, const char *id)
 Construct an instance of oval_definition.
struct oval_definitionoval_definition::oval_definition_clone (struct oval_definition_model *new_model, struct oval_definition *old_definition)
 Clone instance of oval_definition and add it to the specified oval_definition_model.
void oval_definition::oval_definition_free (struct oval_definition *)
 Release an instance of oval_definition.
struct oval_testoval_test::oval_test_new (struct oval_definition_model *, const char *id)
 Construct new instance of oval_test.
struct oval_testoval_test::oval_test_clone (struct oval_definition_model *new_model, struct oval_test *old_test)
 Clone instance of oval_test and add it to the specified oval_definition_model.
void oval_test::oval_test_free (struct oval_test *)
 Destruct instance of oval_test.
struct oval_objectoval_object::oval_object_new (struct oval_definition_model *, const char *id)
 Construct new intance of oval_object.
struct oval_objectoval_object::oval_object_clone (struct oval_definition_model *new_model, struct oval_object *old_object)
 Clone instance of oval_object and add it to the specified oval_definition_model.
void oval_object::oval_object_free (struct oval_object *)
 Free instance of oval_object.
struct oval_stateoval_state::oval_state_new (struct oval_definition_model *, const char *id)
 Construct new intance of oval_state.
struct oval_stateoval_state::oval_state_clone (struct oval_definition_model *new_model, struct oval_state *old_state)
 Clone instance of oval_state and add it to the specified oval_definition_model.
void oval_state::oval_state_free (struct oval_state *)
 Free instance of oval_state.
struct oval_variableoval_variable::oval_variable_new (struct oval_definition_model *model, const char *id, oval_variable_type_t type)
 Construct new instance of oval_variable.
struct oval_variableoval_variable::oval_variable_clone (struct oval_definition_model *new_model, struct oval_variable *old_variable)
 Clone instance of oval_variable and add it to the specified oval_definition_model.
void oval_variable::oval_variable_free (struct oval_variable *)
 Free instance of oval_variable.
struct oval_affectedoval_affected::oval_affected_new (struct oval_definition_model *)
 Construct instance of oval_affected.
struct oval_affectedoval_affected::oval_affected_clone (struct oval_definition_model *new_model, struct oval_affected *old_affected)
 Clone instance of oval_affected.
void oval_affected::oval_affected_free (struct oval_affected *)
 Release instance of oval_affected.
struct oval_referenceoval_reference::oval_reference_new (struct oval_definition_model *)
struct oval_referenceoval_reference::oval_reference_clone (struct oval_definition_model *new_model, struct oval_reference *old_reference)
void oval_reference::oval_reference_free (struct oval_reference *)
struct oval_criteria_nodeoval_criteria_node::oval_criteria_node_new (struct oval_definition_model *, oval_criteria_node_type_t type)
 Construct an instance of oval_criteria_node.
struct oval_criteria_nodeoval_criteria_node::oval_criteria_node_clone (struct oval_definition_model *new_model, struct oval_criteria_node *old_node)
 Clone an instance of oval_criteria_node.
void oval_criteria_node::oval_criteria_node_free (struct oval_criteria_node *)
 Free an instance of oval_criteria_node.
struct oval_object_contentoval_object_content::oval_object_content_new (struct oval_definition_model *model, oval_object_content_type_t type)
struct oval_object_contentoval_object_content::oval_object_content_clone (struct oval_definition_model *new_model, struct oval_object_content *old_content)
void oval_object_content::oval_object_content_free (struct oval_object_content *)
struct oval_behavioroval_behavior::oval_behavior_new (struct oval_definition_model *)
struct oval_behavioroval_behavior::oval_behavior_clone (struct oval_definition_model *new_model, struct oval_behavior *old_behavior)
void oval_behavior::oval_behavior_free (struct oval_behavior *)
struct oval_state_contentoval_state_content::oval_state_content_new (struct oval_definition_model *)
struct oval_state_contentoval_state_content::oval_state_content_clone (struct oval_definition_model *new_model, struct oval_state_content *old_content)
void oval_state_content::oval_state_content_free (struct oval_state_content *)
struct oval_valueoval_value::oval_value_new (oval_datatype_t datatype, char *text_value)
struct oval_valueoval_value::oval_value_clone (struct oval_value *old_value)
void oval_value::oval_value_free (struct oval_value *)
struct oval_entityoval_entity::oval_entity_new (struct oval_definition_model *)
struct oval_entityoval_entity::oval_entity_clone (struct oval_definition_model *model, struct oval_entity *old_entity)
void oval_entity::oval_entity_free (struct oval_entity *)
struct oval_setobjectoval_setobject::oval_setobject_new (struct oval_definition_model *)
struct oval_setobjectoval_setobject::oval_setobject_clone (struct oval_definition_model *new_model, struct oval_setobject *old_setobject)
void oval_setobject::oval_setobject_free (struct oval_setobject *)
struct oval_componentoval_component::oval_component_new (struct oval_definition_model *, oval_component_type_t type)
 Construct new intance of Oval_component.
struct oval_componentoval_component::oval_component_clone (struct oval_definition_model *new_model, struct oval_component *old_component)
 Clone instance of Oval_component.
void oval_component::oval_component_free (struct oval_component *)
 Free instance of Oval_component.

Setters



void oval_definition_model_clear_external_variables (struct oval_definition_model *)
void oval_variable_clear_values (struct oval_variable *)
void oval_setobject_set_type (struct oval_setobject *, oval_setobject_type_t)
void oval_definition_model::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.
void oval_definition_model::oval_definition_model_add_definition (struct oval_definition_model *, struct oval_definition *)
void oval_definition_model::oval_definition_model_add_test (struct oval_definition_model *, struct oval_test *)
void oval_definition_model::oval_definition_model_add_object (struct oval_definition_model *, struct oval_object *)
void oval_definition_model::oval_definition_model_add_state (struct oval_definition_model *, struct oval_state *)
void oval_definition_model::oval_definition_model_add_variable (struct oval_definition_model *, struct oval_variable *)
void oval_definition_model::oval_definition_model_lock (struct oval_definition_model *definition_model)
 Lock the definition_model instance.
void oval_definition::oval_definition_set_version (struct oval_definition *, int version)
 Set attribute oval_definition->version.
void oval_definition::oval_definition_set_class (struct oval_definition *, oval_definition_class_t)
 Set attribute oval_definition->class.
void oval_definition::oval_definition_set_deprecated (struct oval_definition *, bool deprecated)
 Set attribute oval_definition->deprecated.
void oval_definition::oval_definition_set_title (struct oval_definition *, char *title)
 Set attribute oval_definition->title.
void oval_definition::oval_definition_set_description (struct oval_definition *, char *description)
 Set attribute oval_definition->description.
void oval_definition::oval_definition_add_affected (struct oval_definition *, struct oval_affected *affected)
 Append instance of oval_affected to attribute oval_definition->affected.
void oval_definition::oval_definition_add_reference (struct oval_definition *, struct oval_reference *reference)
 Append instance of oval_reference to attribute oval_definition->references.
void oval_definition::oval_definition_add_note (struct oval_definition *, char *note)
 Append a copy of the note parameter to attribute Oval_definition->notes.
void oval_definition::oval_definition_set_criteria (struct oval_definition *, struct oval_criteria_node *criteria)
 Set attribute oval_definition->criteria.
void oval_test::oval_test_set_subtype (struct oval_test *, oval_subtype_t subtype)
 Sets attributes oval_test->subtype and Oval_test->family.
void oval_test::oval_test_add_note (struct oval_test *, char *note)
 Appends a copy of the note parameter to attribute oval_test->notes.
void oval_test::oval_test_set_comment (struct oval_test *, char *comment)
 Sets a copy of the comment parameter to attribute oval_test->comment.
void oval_test::oval_test_set_deprecated (struct oval_test *, bool deprecated)
 Sets attribute oval_test->deprecated.
void oval_test::oval_test_set_version (struct oval_test *, int version)
 Sets attribute oval_test->version.
void oval_test::oval_test_set_existence (struct oval_test *, oval_existence_t)
 Sets attribute oval_test->existence.
void oval_test::oval_test_set_check (struct oval_test *, oval_check_t)
 Sets attribute oval_test->check.
void oval_test::oval_test_set_object (struct oval_test *, struct oval_object *)
 Sets attribute oval_test->object.
void oval_test::oval_test_set_state (struct oval_test *, struct oval_state *state)
 Sets attribute oval_test->state.
void oval_object::oval_object_set_subtype (struct oval_object *, oval_subtype_t subtype)
 Sets attributes oval_object->subtype and oval_object->family.
void oval_object::oval_object_add_note (struct oval_object *, char *note)
 Appends a copy of the note parameter to attribute oval_object->notes.
void oval_object::oval_object_set_comment (struct oval_object *, char *comment)
 Sets a copy of the comment parameter to attribute oval_object->comment.
void oval_object::oval_object_set_deprecated (struct oval_object *, bool deprecated)
 Sets attribute oval_object->deprecated.
void oval_object::oval_object_set_version (struct oval_object *, int version)
 Sets attribute oval_object->version.
void oval_object::oval_object_add_object_content (struct oval_object *, struct oval_object_content *content)
 Append instance of oval_object_content to attribute oval_object->object_contents.
void oval_object::oval_object_add_behavior (struct oval_object *, struct oval_behavior *behavior)
 Append instance of oval_behavior to attribute oval_object->behaviors.
void oval_state::oval_state_set_subtype (struct oval_state *, oval_subtype_t subtype)
 Sets attributes oval_state->subtype and oval_state->family.
void oval_state::oval_state_add_note (struct oval_state *, char *note)
 Appends a copy of the note parameter to attribute oval_state->notes.
void oval_state::oval_state_set_comment (struct oval_state *, char *comment)
 Sets a copy of the comment parameter to attribute oval_state->comment.
void oval_state::oval_state_set_deprecated (struct oval_state *, bool deprecated)
 Sets attribute oval_state->deprecated.
void oval_state::oval_state_set_version (struct oval_state *, int version)
 Sets attribute oval_state->version.
void oval_state::oval_state_set_operator (struct oval_state *, oval_operator_t)
 Sets attribute oval_state->operator.
void oval_state::oval_state_add_content (struct oval_state *, struct oval_state_content *content)
 Append instance of oval_state_content to attribute oval_state->state_contents.
void oval_variable::oval_variable_set_comment (struct oval_variable *, char *comment)
 set attribute oval_variable->comment.
void oval_variable::oval_variable_set_version (struct oval_variable *, int version)
 set attribute oval_variable->version.
void oval_variable::oval_variable_set_deprecated (struct oval_variable *, bool deprecated)
 set attribute oval_variable->deprecated.
void oval_variable::oval_variable_set_datatype (struct oval_variable *, oval_datatype_t)
 set attribute oval_variable->datatype.
void oval_variable::oval_variable_add_value (struct oval_variable *, struct oval_value *)
 Append an instance of Oval_value to the attribute Oval_constant->values.
void oval_variable::oval_variable_set_component (struct oval_variable *, struct oval_component *component)
 Bind an instance of Oval_component to the attribute Oval_local->component.
void oval_affected::oval_affected_set_family (struct oval_affected *, oval_affected_family_t family)
 Set oval_affected family.
void oval_affected::oval_affected_add_platform (struct oval_affected *, char *platform_name)
 Append name to oval_affected platform names.
void oval_affected::oval_affected_add_product (struct oval_affected *, char *product_name)
 Append name to oval_affected product names.
void oval_reference::oval_reference_set_source (struct oval_reference *, char *)
 Set OVAL reference source.
void oval_reference::oval_reference_set_id (struct oval_reference *, char *)
void oval_reference::oval_reference_set_url (struct oval_reference *, char *)
void oval_criteria_node::oval_criteria_node_set_negate (struct oval_criteria_node *, bool negate)
 Set attribute Oval_criteria_node->negate.
void oval_criteria_node::oval_criteria_set_node_type (struct oval_criteria_node *node, oval_criteria_node_type_t type)
 Set attribute Oval_criteria_node->type.
void oval_criteria_node::oval_criteria_node_set_comment (struct oval_criteria_node *, char *comment)
 set attribute Oval_criteria_node->comment.
void oval_criteria_node::oval_criteria_node_set_operator (struct oval_criteria_node *, oval_operator_t op)
 Set attribute Oval_criteria->operator.
void oval_criteria_node::oval_criteria_node_add_subnode (struct oval_criteria_node *, struct oval_criteria_node *node)
 Append instance of Oval_criteria_node to attribute Oval_criteria->subnodes.
void oval_criteria_node::oval_criteria_node_set_test (struct oval_criteria_node *, struct oval_test *)
 Sets attribute Oval_criterion->test.
void oval_criteria_node::oval_criteria_node_set_definition (struct oval_criteria_node *, struct oval_definition *)
 Sets attribute Oval_extends->definition.
void oval_object_content::oval_object_content_set_type (struct oval_object_content *, oval_object_content_type_t)
void oval_object_content::oval_object_content_set_field_name (struct oval_object_content *, char *)
void oval_object_content::oval_object_content_set_entity (struct oval_object_content *, struct oval_entity *)
void oval_object_content::oval_object_content_set_varCheck (struct oval_object_content *, oval_check_t)
void oval_object_content::oval_object_content_set_setobject (struct oval_object_content *, struct oval_setobject *)
void oval_behavior::oval_behavior_set_keyval (struct oval_behavior *behavior, const char *key, const char *value)
void oval_state_content::oval_state_content_set_entity (struct oval_state_content *, struct oval_entity *)
void oval_state_content::oval_state_content_set_varcheck (struct oval_state_content *, oval_check_t)
void oval_state_content::oval_state_content_set_entcheck (struct oval_state_content *, oval_check_t)
void oval_entity::oval_entity_set_type (struct oval_entity *, oval_entity_type_t)
void oval_entity::oval_entity_set_datatype (struct oval_entity *, oval_datatype_t)
void oval_entity::oval_entity_set_mask (struct oval_entity *, int)
void oval_entity::oval_entity_set_varref_type (struct oval_entity *, oval_entity_varref_type_t)
void oval_entity::oval_entity_set_variable (struct oval_entity *, struct oval_variable *)
void oval_entity::oval_entity_set_value (struct oval_entity *, struct oval_value *)
void oval_entity::oval_entity_set_name (struct oval_entity *, char *)
void oval_entity::oval_entity_set_operation (struct oval_entity *, oval_operation_t)
void oval_setobject::oval_setobject_set_operation (struct oval_setobject *, oval_setobject_operation_t)
void oval_setobject::oval_setobject_add_subset (struct oval_setobject *, struct oval_setobject *)
void oval_setobject::oval_setobject_add_object (struct oval_setobject *, struct oval_object *)
void oval_setobject::oval_setobject_add_filter (struct oval_setobject *, struct oval_state *)
void oval_component::oval_component_set_type (struct oval_component *component, oval_component_type_t type)
 Set type of component Oval_component->type.
void oval_component::oval_component_set_object (struct oval_component *, struct oval_object *object)
 set attribute Oval_component_object->object.
void oval_component::oval_component_set_object_field (struct oval_component *, char *field)
 set attribute Oval_component_object->object_field.
void oval_component::oval_component_set_variable (struct oval_component *, struct oval_variable *variable)
 set attribute Oval_component_object->variable.
void oval_component::oval_component_add_function_component (struct oval_component *, struct oval_component *)
 set attribute Oval_component_object->object_field.
void oval_component::oval_component_set_arithmetic_operation (struct oval_component *, oval_arithmetic_operation_t)
void oval_component::oval_component_set_prefix (struct oval_component *, char *)
void oval_component::oval_component_set_suffix (struct oval_component *, char *)
void oval_component::oval_component_set_split_delimiter (struct oval_component *, char *)
void oval_component::oval_component_set_substring_start (struct oval_component *, int)
void oval_component::oval_component_set_substring_length (struct oval_component *, int)
void oval_component::oval_component_set_timedif_format_1 (struct oval_component *, oval_datetime_format_t)
void oval_component::oval_component_set_timedif_format_2 (struct oval_component *, oval_datetime_format_t)
void oval_component::oval_component_set_regex_pattern (struct oval_component *, char *)
void oval_component::oval_component_set_literal_value (struct oval_component *, struct oval_value *)

Getters



struct oval_definitionoval_definition_model::oval_definition_model_get_definition (struct oval_definition_model *, const char *id)
 Returns the appended oval_definition having the specified id.
struct oval_testoval_definition_model::oval_definition_model_get_test (struct oval_definition_model *model, const char *id)
 Get oval test by ID.
struct oval_objectoval_definition_model::oval_definition_model_get_object (struct oval_definition_model *model, const char *id)
 Get OVAL object by ID.
struct oval_stateoval_definition_model::oval_definition_model_get_state (struct oval_definition_model *model, const char *id)
 Get OVAL state by ID.
struct oval_variableoval_definition_model::oval_definition_model_get_variable (struct oval_definition_model *model, const char *id)
 Get OVAL variable by ID.
struct oval_definition_iteratoroval_definition_model::oval_definition_model_get_definitions (struct oval_definition_model *model)
 Returns all appended oval_definition instances.
struct oval_test_iteratoroval_definition_model::oval_definition_model_get_tests (struct oval_definition_model *model)
 Get OVAL tests.
struct oval_object_iteratoroval_definition_model::oval_definition_model_get_objects (struct oval_definition_model *model)
 Get OVAL objects.
struct oval_state_iteratoroval_definition_model::oval_definition_model_get_states (struct oval_definition_model *model)
 Get OVAL states.
struct oval_variable_iteratoroval_definition_model::oval_definition_model_get_variables (struct oval_definition_model *model)
 Get OVAL variables.
bool oval_definition_model::oval_definition_model_is_locked (struct oval_definition_model *definition_model)
 Return true if the definition_model instance is locked.
const char * oval_definition_model::oval_definition_model_supported (void)
 Get supported version of OVAL XML.
char * oval_definition::oval_definition_get_id (struct oval_definition *)
 Returns attribute oval_definition->id (identifier).
int oval_definition::oval_definition_get_version (struct oval_definition *)
 Returns attribute oval_definition->version.
oval_definition_class_t oval_definition::oval_definition_get_class (struct oval_definition *)
 Returns attribute oval_definition->class.
bool oval_definition::oval_definition_get_deprecated (struct oval_definition *)
 Returns attribute oval_definition->deprecated.
char * oval_definition::oval_definition_get_title (struct oval_definition *)
 Returns attribute oval_definition->title.
char * oval_definition::oval_definition_get_description (struct oval_definition *)
 Returns attribute oval_definition->description.
struct oval_affected_iteratoroval_definition::oval_definition_get_affected (struct oval_definition *)
 Returns attribute oval_definition->affected.
struct oval_reference_iteratoroval_definition::oval_definition_get_references (struct oval_definition *)
 Returns attribute oval_definition->references.
struct oval_string_iteratoroval_definition::oval_definition_get_notes (struct oval_definition *)
 Returns attribute oval_definition->notes.
struct oval_criteria_nodeoval_definition::oval_definition_get_criteria (struct oval_definition *)
 Returns attribute oval_definition->criteria.
bool oval_definition::oval_definition_is_locked (struct oval_definition *definition)
 return true if the definition instance is locked.
oval_family_t oval_test::oval_test_get_family (struct oval_test *)
 Returns attribute Oval_test->family.
oval_subtype_t oval_test::oval_test_get_subtype (struct oval_test *)
 Returns attribute Oval_test->subtype.
struct oval_string_iteratoroval_test::oval_test_get_notes (struct oval_test *)
 Returns attribute oval_test->notes.
char * oval_test::oval_test_get_comment (struct oval_test *)
 Returns attribute Oval_test->comment.
char * oval_test::oval_test_get_id (struct oval_test *)
 Returns attribute oval_test->id.
bool oval_test::oval_test_get_deprecated (struct oval_test *)
 Returns attribute oval_test->deprecated.
int oval_test::oval_test_get_version (struct oval_test *)
 Returns attribute oval_test->version.
oval_existence_t oval_test::oval_test_get_existence (struct oval_test *)
 Returns attribute oval_test->existence.
oval_check_t oval_test::oval_test_get_check (struct oval_test *)
 Returns attribute oval_test->check.
struct oval_objectoval_test::oval_test_get_object (struct oval_test *)
 Returns attribute oval_test->object.
struct oval_stateoval_test::oval_test_get_state (struct oval_test *)
 Returns attribute oval_test->state.
bool oval_test::oval_test_is_locked (struct oval_test *test)
 return true if the test instance is locked.
oval_family_t oval_object::oval_object_get_family (struct oval_object *)
 Returns attribute oval_object->family.
const char * oval_object::oval_object_get_name (struct oval_object *)
 Returns the name of an oval_object.
oval_subtype_t oval_object::oval_object_get_subtype (struct oval_object *)
 Returns attribute oval_object->subtype.
struct oval_string_iteratoroval_object::oval_object_get_notes (struct oval_object *)
 Returns attribute oval_object->notes.
char * oval_object::oval_object_get_comment (struct oval_object *)
 Returns attribute oval_object->comment.
char * oval_object::oval_object_get_id (struct oval_object *)
 Returns attribute oval_object->id.
bool oval_object::oval_object_get_deprecated (struct oval_object *)
 Returns attribute oval_object->deprecated.
int oval_object::oval_object_get_version (struct oval_object *)
 Returns attribute oval_object->version.
struct
oval_object_content_iterator
oval_object::oval_object_get_object_contents (struct oval_object *)
 Returns attribute oval_object->contents.
struct oval_behavior_iteratoroval_object::oval_object_get_behaviors (struct oval_object *)
 Returns attribute oval_object->behaviors.
bool oval_object::oval_object_is_locked (struct oval_object *object)
 return true if the object instance is locked.
oval_family_t oval_state::oval_state_get_family (struct oval_state *)
 Returns attribute oval_state->family.
const char * oval_state::oval_state_get_name (struct oval_state *)
 Returns the name of an oval_state.
oval_subtype_t oval_state::oval_state_get_subtype (struct oval_state *)
 Returns attribute oval_state->subtype.
struct oval_string_iteratoroval_state::oval_state_get_notes (struct oval_state *)
 Returns attribute oval_state->notes.
char * oval_state::oval_state_get_comment (struct oval_state *)
 Returns attribute oval_state->comment.
char * oval_state::oval_state_get_id (struct oval_state *)
 Returns attribute oval_state->id.
bool oval_state::oval_state_get_deprecated (struct oval_state *)
 Returns attribute oval_state->deprecated.
int oval_state::oval_state_get_version (struct oval_state *)
 Returns attribute oval_state->version.
int oval_state::oval_state_get_operator (struct oval_state *)
 Returns attribute oval_state->operator.
struct
oval_state_content_iterator
oval_state::oval_state_get_contents (struct oval_state *)
 Returns attribute oval_state->contents.
bool oval_state::oval_state_is_locked (struct oval_state *state)
 return true if the state instance is locked.
char * oval_variable::oval_variable_get_id (struct oval_variable *)
 Returns attribute oval_variable->id.
char * oval_variable::oval_variable_get_comment (struct oval_variable *)
 Returns attribute oval_variable->comment.
int oval_variable::oval_variable_get_version (struct oval_variable *)
 Returns attribute oval_variable->version.
bool oval_variable::oval_variable_get_deprecated (struct oval_variable *)
 Returns attribute oval_variable->deprecated.
oval_variable_type_t oval_variable::oval_variable_get_type (struct oval_variable *)
 Returns attribute oval_variable->type.
oval_datatype_t oval_variable::oval_variable_get_datatype (struct oval_variable *)
 Returns attribute oval_variable->datatype.
struct oval_value_iteratoroval_variable::oval_variable_get_values (struct oval_variable *)
 Returns attribute Oval_external/Oval_constant->values.
struct oval_componentoval_variable::oval_variable_get_component (struct oval_variable *)
 Returns attribute Oval_local->component.
const char * oval_variable::oval_component_type_get_text (oval_component_type_t type)
 Returns attribute Oval_component_type->text.
bool oval_variable::oval_variable_is_locked (struct oval_variable *variable)
 return true if the variable instance is locked.
oval_affected_family_t oval_affected::oval_affected_get_family (struct oval_affected *)
 Get member value oval_affected family.
struct oval_string_iteratoroval_affected::oval_affected_get_platforms (struct oval_affected *)
 Get member values oval_affected platform_names.
struct oval_string_iteratoroval_affected::oval_affected_get_products (struct oval_affected *)
 Get member values oval_affected product_names.
bool oval_affected::oval_affected_is_locked (struct oval_affected *)
 Return true if the instance of oval_affected is locked.
char * oval_reference::oval_reference_get_source (struct oval_reference *)
 Get OVAL reference source.
char * oval_reference::oval_reference_get_id (struct oval_reference *)
 Get OVAL reference ID.
char * oval_reference::oval_reference_get_url (struct oval_reference *)
 Get OVAL reference URL.
bool oval_reference::oval_reference_is_locked (struct oval_reference *reference)
 return true if the reference instance is locked.
oval_criteria_node_type_t oval_criteria_node::oval_criteria_node_get_type (struct oval_criteria_node *)
 Returns attribute Oval_criteria_node->type.
bool oval_criteria_node::oval_criteria_node_get_negate (struct oval_criteria_node *)
 Returns attribute Oval_criteria_node->negate.
char * oval_criteria_node::oval_criteria_node_get_comment (struct oval_criteria_node *)
 Returns attribute Oval_criteria_node->comment.
oval_operator_t oval_criteria_node::oval_criteria_node_get_operator (struct oval_criteria_node *)
 Returns attribute Oval_criteria->operator HOWDI.
struct
oval_criteria_node_iterator
oval_criteria_node::oval_criteria_node_get_subnodes (struct oval_criteria_node *)
 Returns attribute Oval_criteria_node->subnodes.
struct oval_testoval_criteria_node::oval_criteria_node_get_test (struct oval_criteria_node *)
 Returns attribute Oval_criterion->test.
struct oval_definitionoval_criteria_node::oval_criteria_node_get_definition (struct oval_criteria_node *)
 Returns attribute Oval_extends->definition.
bool oval_criteria_node::oval_criteria_node_is_locked (struct oval_criteria_node *)
 Return true if the instance of Oval_criteria_node is locked.
char * oval_object_content::oval_object_content_get_field_name (struct oval_object_content *)
 Get field name of a object content.
oval_object_content_type_t oval_object_content::oval_object_content_get_type (struct oval_object_content *)
 Get type of a object content (entity or set).
struct oval_entityoval_object_content::oval_object_content_get_entity (struct oval_object_content *)
 Get entity of a simple object content.
oval_check_t oval_object_content::oval_object_content_get_varCheck (struct oval_object_content *)
 Get varCheck of a simple object content.
struct oval_setobjectoval_object_content::oval_object_content_get_setobject (struct oval_object_content *)
 Get setobject of a set object content.
bool oval_object_content::oval_object_content_is_locked (struct oval_object_content *object_content)
 return true if the object_content instance is locked.
char * oval_behavior::oval_behavior_get_key (struct oval_behavior *)
 Get OVAL behavior name.
char * oval_behavior::oval_behavior_get_value (struct oval_behavior *)
 Get OVAL behavior value.
bool oval_behavior::oval_behavior_is_locked (struct oval_behavior *behavior)
 return true if the behavior instance is locked.
struct oval_entityoval_state_content::oval_state_content_get_entity (struct oval_state_content *)
 Get entity of a state content.
oval_check_t oval_state_content::oval_state_content_get_var_check (struct oval_state_content *)
 Get multipe variable values processing of a state content.
oval_check_t oval_state_content::oval_state_content_get_ent_check (struct oval_state_content *)
 Get multipe entities processing of a state content.
bool oval_state_content::oval_state_content_is_locked (struct oval_state_content *)
 Return true if the setobject instance is locked.
oval_datatype_t oval_value::oval_value_get_datatype (struct oval_value *)
 Get OVAL value datatype.
char * oval_value::oval_value_get_text (struct oval_value *)
 Get OVAL value as a text.
unsigned char * oval_value::oval_value_get_binary (struct oval_value *)
 Get OVAL value as a piece of raw binary data.
bool oval_value::oval_value_get_boolean (struct oval_value *)
 Get OVAL value as a boolean.
float oval_value::oval_value_get_float (struct oval_value *)
 Get OVAL value as a floating point number.
long oval_value::oval_value_get_integer (struct oval_value *)
 Get OVAL value as an integer.
bool oval_value::oval_value_is_locked (struct oval_value *value)
 return true if the value instance is locked.
char * oval_entity::oval_entity_get_name (struct oval_entity *)
 Get OVAL entity name.
oval_entity_type_t oval_entity::oval_entity_get_type (struct oval_entity *)
 Get OVAL entity type.
oval_datatype_t oval_entity::oval_entity_get_datatype (struct oval_entity *)
 Get OVAL entity datatype.
oval_operation_t oval_entity::oval_entity_get_operation (struct oval_entity *)
 Get OVAL entity operation type.
struct oval_variableoval_entity::oval_entity_get_variable (struct oval_entity *)
 Get OVAL entity varref variable.
struct oval_valueoval_entity::oval_entity_get_value (struct oval_entity *)
 Get OVAL entity value.
int oval_entity::oval_entity_get_mask (struct oval_entity *)
 Get OVAL entity mask.
oval_entity_varref_type_t oval_entity::oval_entity_get_varref_type (struct oval_entity *)
 Get OVAL entity varref type.
bool oval_entity::oval_entity_is_locked (struct oval_entity *entity)
 return true if the entity instance is locked.
oval_setobject_type_t oval_setobject::oval_setobject_get_type (struct oval_setobject *)
 Get OVAL set object type.
oval_setobject_operation_t oval_setobject::oval_setobject_get_operation (struct oval_setobject *)
 Get OVAL set object operation type.
struct oval_setobject_iterator * oval_setobject::oval_setobject_get_subsets (struct oval_setobject *)
 Get OVAL set object subsets.
struct oval_object_iteratoroval_setobject::oval_setobject_get_objects (struct oval_setobject *)
 Get OVAL set object referenced objects.
struct oval_state_iteratoroval_setobject::oval_setobject_get_filters (struct oval_setobject *)
 Get OVAL set object filters.
bool oval_setobject::oval_setobject_is_locked (struct oval_setobject *setobject)
 return true if the setobject instance is locked.
oval_component_type_t oval_component::oval_component_get_type (struct oval_component *)
 Returns attribute Oval_component->type.
struct oval_objectoval_component::oval_component_get_object (struct oval_component *)
 Returns attribute Oval_component_object->object.
char * oval_component::oval_component_get_object_field (struct oval_component *)
 Returns attribute Oval_component_object->object_field.
struct oval_variableoval_component::oval_component_get_variable (struct oval_component *)
 Returns attribute Oval_component_variable->variable.
struct oval_component_iteratoroval_component::oval_component_get_function_components (struct oval_component *)
 Returns attribute Oval_function->components.
oval_arithmetic_operation_t oval_component::oval_component_get_arithmetic_operation (struct oval_component *)
 Returns attribute Oval_function_ARITHMETIC->arithmetic_operation.
char * oval_component::oval_component_get_prefix (struct oval_component *)
 Returns attribute Oval_function_BEGIN->prefix.
char * oval_component::oval_component_get_suffix (struct oval_component *)
 Returns attribute Oval_function_END->suffix.
char * oval_component::oval_component_get_split_delimiter (struct oval_component *)
 Returns attribute Oval_function_SPLIT->delimiter.
int oval_component::oval_component_get_substring_start (struct oval_component *)
 Returns attribute Oval_function_SUBSTRING->start.
int oval_component::oval_component_get_substring_length (struct oval_component *)
 Returns attribute Oval_function_SUBSTRING->length.
oval_datetime_format_t oval_component::oval_component_get_timedif_format_1 (struct oval_component *)
 Returns attribute Oval_function_TIMEDIF->timedif_format_1.
oval_datetime_format_t oval_component::oval_component_get_timedif_format_2 (struct oval_component *)
 Returns attribute Oval_function_TIMEDIF->timedif_format_2.
char * oval_component::oval_component_get_regex_pattern (struct oval_component *)
 Returns attribute Oval_function_REGEX_CAPTURE->pattern.
struct oval_valueoval_component::oval_component_get_literal_value (struct oval_component *)
 Returns attribute Oval_literal->literal.
bool oval_component::oval_component_is_locked (struct oval_component *component)
 return true if the component instance is locked.

Evaluators



bool oval_definition_model::oval_definition_model_is_valid (struct oval_definition_model *definition_model)
 Return true if the definition_model instance is valid An oval_definition_model is valid if all the following are true

  • All included definitions are valid
  • All included tests are valid
  • All included objects are valid
  • All included states are valid
  • All included variables are valid.

bool oval_definition::oval_definition_is_valid (struct oval_definition *definition)
 Returns true if the oval_definition is valid.
bool oval_test::oval_test_is_valid (struct oval_test *)
 Returns true if oval_test is valid.
bool oval_object::oval_object_is_valid (struct oval_object *object)
 Return true if the object instance is valid.
bool oval_state::oval_state_is_valid (struct oval_state *state)
 Return true if the state instance is valid An Oval_state is valid if all of the following are true

  • All included state contents are valid.

bool oval_variable::oval_variable_is_valid (struct oval_variable *)
 Returns true if oval_variable is valid.
bool oval_affected::oval_affected_is_valid (struct oval_affected *)
 Returns true.
bool oval_reference::oval_reference_is_valid (struct oval_reference *reference)
 return true if the reference instance is valid
bool oval_criteria_node::oval_criteria_node_is_valid (struct oval_criteria_node *)
 Returns true if Oval_criteria_node is valid.
bool oval_object_content::oval_object_content_is_valid (struct oval_object_content *object_content)
 Return true if the object_content instance is valid An Oval_object_content is valid if one of the following is true:

  • The type attribute is OVAL_OBJECTCONTENT_ENTITY -- AND

bool oval_behavior::oval_behavior_is_valid (struct oval_behavior *behavior)
bool oval_value::oval_value_is_valid (struct oval_value *value)
 Return true if the value instance is valid.
bool oval_entity::oval_entity_is_valid (struct oval_entity *entity)
 Return true if the entity instance is valid.
bool oval_setobject::oval_setobject_is_valid (struct oval_setobject *setobject)
 Return true if the setobject instance is valid An Oval_setobject is valid if one of the following is true:

  • The type attribute is OVAL_SET_AGGREGATE -- AND
    • The subsets attribute is not an empty iterator -- AND
    • Each iterated oval_setobject is valid.

bool oval_component::oval_component_is_valid (struct oval_component *)
 Returns true if the Oval_component is valid.

Iterators



bool oval_definition_iterator::oval_definition_iterator_has_more (struct oval_definition_iterator *)
 Returns true if the iterator contains more instances of oval_definition.
struct oval_definitionoval_definition_iterator::oval_definition_iterator_next (struct oval_definition_iterator *)
 Returns the next iterated instance of oval_definition.
void oval_definition_iterator::oval_definition_iterator_free (struct oval_definition_iterator *)
 Free the iterator.
bool oval_test_iterator::oval_test_iterator_has_more (struct oval_test_iterator *)
 Returns true if the iterator is not exhausted.
struct oval_testoval_test_iterator::oval_test_iterator_next (struct oval_test_iterator *)
 Returns the next instance of oval_test.
void oval_test_iterator::oval_test_iterator_free (struct oval_test_iterator *)
 Frees the iterator.
bool oval_object_iterator::oval_object_iterator_has_more (struct oval_object_iterator *)
 Returns true if the iterator is not exhausted.
struct oval_objectoval_object_iterator::oval_object_iterator_next (struct oval_object_iterator *)
 Returns the next instance of oval_object.
void oval_object_iterator::oval_object_iterator_free (struct oval_object_iterator *)
 Frees the iterator.
bool oval_state_iterator::oval_state_iterator_has_more (struct oval_state_iterator *)
 Returns true if the iterator is not exhausted.
struct oval_stateoval_state_iterator::oval_state_iterator_next (struct oval_state_iterator *)
 Returns the next instance of oval_state.
void oval_state_iterator::oval_state_iterator_free (struct oval_state_iterator *)
 Frees the iterator.
bool oval_variable_iterator::oval_variable_iterator_has_more (struct oval_variable_iterator *)
 Returns true if iterator not exhausted.
struct oval_variableoval_variable_iterator::oval_variable_iterator_next (struct oval_variable_iterator *)
 Returns next instance of oval_variable.
void oval_variable_iterator::oval_variable_iterator_free (struct oval_variable_iterator *)
 Free iterator.
bool oval_affected_iterator::oval_affected_iterator_has_more (struct oval_affected_iterator *)
 Return true if iterator has more oval_affected.
struct oval_affectedoval_affected_iterator::oval_affected_iterator_next (struct oval_affected_iterator *)
 Return next instance of oval_affected from iterator.
void oval_affected_iterator::oval_affected_iterator_free (struct oval_affected_iterator *)
 Release instance of oval_affected_ iterator.
bool oval_reference_iterator::oval_reference_iterator_has_more (struct oval_reference_iterator *)
struct oval_referenceoval_reference_iterator::oval_reference_iterator_next (struct oval_reference_iterator *)
void oval_reference_iterator::oval_reference_iterator_free (struct oval_reference_iterator *)
bool oval_criteria_node_iterator::oval_criteria_node_iterator_has_more (struct oval_criteria_node_iterator *)
 Returns true if the iterator is not exhausted.
struct oval_criteria_nodeoval_criteria_node_iterator::oval_criteria_node_iterator_next (struct oval_criteria_node_iterator *)
 Returns the next instance of Oval_criteria_node from the iterator.
void oval_criteria_node_iterator::oval_criteria_node_iterator_free (struct oval_criteria_node_iterator *)
 Free the iterator.
bool oval_object_content_iterator::oval_object_content_iterator_has_more (struct oval_object_content_iterator *)
struct oval_object_contentoval_object_content_iterator::oval_object_content_iterator_next (struct oval_object_content_iterator *)
void oval_object_content_iterator::oval_object_content_iterator_free (struct oval_object_content_iterator *)
bool oval_behavior_iterator::oval_behavior_iterator_has_more (struct oval_behavior_iterator *)
struct oval_behavioroval_behavior_iterator::oval_behavior_iterator_next (struct oval_behavior_iterator *)
void oval_behavior_iterator::oval_behavior_iterator_free (struct oval_behavior_iterator *)
bool oval_state_content_iterator::oval_state_content_iterator_has_more (struct oval_state_content_iterator *)
struct oval_state_contentoval_state_content_iterator::oval_state_content_iterator_next (struct oval_state_content_iterator *)
void oval_state_content_iterator::oval_state_content_iterator_free (struct oval_state_content_iterator *)
bool oval_value_iterator::oval_value_iterator_has_more (struct oval_value_iterator *)
struct oval_valueoval_value_iterator::oval_value_iterator_next (struct oval_value_iterator *)
int oval_value_iterator::oval_value_iterator_remaining (struct oval_value_iterator *iterator)
void oval_value_iterator::oval_value_iterator_free (struct oval_value_iterator *)
bool oval_entity_iterator::oval_entity_iterator_has_more (struct oval_entity_iterator *)
struct oval_entityoval_entity_iterator::oval_entity_iterator_next (struct oval_entity_iterator *)
void oval_entity_iterator::oval_entity_iterator_free (struct oval_entity_iterator *)
bool oval_component_iterator::oval_component_iterator_has_more (struct oval_component_iterator *)
 Return true if the iterator is not exhausted.
struct oval_componentoval_component_iterator::oval_component_iterator_next (struct oval_component_iterator *)
 return the next instance of Oval_component.
void oval_component_iterator::oval_component_iterator_free (struct oval_component_iterator *)
 Free the iterator.
int oval_component_iterator::oval_component_iterator_remaining (struct oval_component_iterator *)
 How many remains.
bool oval_string_iterator::oval_string_iterator_has_more (struct oval_string_iterator *)
 Returns true if the iterator is not exhausted.
char * oval_string_iterator::oval_string_iterator_next (struct oval_string_iterator *)
 Returns the next instance of char *.
int oval_string_iterator::oval_string_iterator_remaining (struct oval_string_iterator *)
 Return number for remaining char * elements.
void oval_string_iterator::oval_string_iterator_free (struct oval_string_iterator *)
 Frees the iterator.

Detailed Description

Interface for Definition model.

Class diagram

definition_model.png

Enumeration Type Documentation

Affected family enumeration.

Since new family values can only be added with new version of the schema, the value OVAL_AFCFML_UNDEFINED is to be used when the desired family is not available

Definition classes.

Enumerator:
OVAL_CLASS_UNKNOWN 

Not valid.

OVAL_CLASS_COMPLIANCE 

Valid.

OVAL_CLASS_INVENTORY 

Valid.

OVAL_CLASS_MISCELLANEOUS 

Valid.

OVAL_CLASS_PATCH 

Valid.

OVAL_CLASS_VULNERABILITY 

Valid.


Function Documentation

struct oval_affected * oval_affected_clone ( struct oval_definition_model new_model,
struct oval_affected old_affected 
) [read, inherited]

Clone instance of oval_affected.

Returns:
A copy of the specified oval_affected.
oval_affected_family_t oval_affected_get_family ( struct oval_affected  )  [inherited]

Get member value oval_affected family.

Note:
A family value of OVAL_AFCFML_UNDEFINED signifies some family other than one of the defined values is targeted.
struct oval_string_iterator * oval_affected_get_platforms ( struct oval_affected  )  [read, inherited]

Get member values oval_affected platform_names.

If the returned iterator is empty, then the associated Oval_definition is not constrained to a specific platform choice.

Returns:
A new iterator for the platforms attribute of the specified oval_affected. It should be freed after use by the calling application.
struct oval_string_iterator * oval_affected_get_products ( struct oval_affected  )  [read, inherited]

Get member values oval_affected product_names.

If the returned iterator is empty, then the associated Oval_definition is not constrained to a specific product choice.

Returns:
A new iterator for the products attribute of the specified oval_affected. It should be freed after use by the calling application.
bool oval_affected_is_locked ( struct oval_affected  )  [inherited]

Return true if the instance of oval_affected is locked.

The state of a locked instance cannot be changed.

struct oval_behavior * oval_behavior_clone ( struct oval_definition_model new_model,
struct oval_behavior old_behavior 
) [read, inherited]
Returns:
A copy of the specified oval_behavior.
char * oval_behavior_get_key ( struct oval_behavior  )  [inherited]

Get OVAL behavior name.

Returns:
A pointer to the key attribute of the specified oval_behavior.
char * oval_behavior_get_value ( struct oval_behavior  )  [inherited]

Get OVAL behavior value.

Returns:
A pointer to the value attribute of the specified oval_behavior.
bool oval_behavior_is_locked ( struct oval_behavior behavior  )  [inherited]

return true if the behavior instance is locked.

The state of a locked instance cannot be changed.

bool oval_behavior_is_valid ( struct oval_behavior behavior  )  [inherited]

Return true if the behavior instance is valid

void oval_component_add_function_component ( struct oval_component ,
struct oval_component  
) [inherited]

set attribute Oval_component_object->object_field.

IF component->type <> OVAL_COMPONENT_OBJECTREF OR component->object_field <> NULL, this method does nothing. OTHERWISE the method uses a copy of the field parameter to set component->object_field

struct oval_component * oval_component_clone ( struct oval_definition_model new_model,
struct oval_component old_component 
) [read, inherited]

Clone instance of Oval_component.

Returns:
A copy of the specified oval_component.
oval_arithmetic_operation_t oval_component_get_arithmetic_operation ( struct oval_component  )  [inherited]

Returns attribute Oval_function_ARITHMETIC->arithmetic_operation.

IF component->type <> OVAL_FUNCTION_ARITHMETIC, this method shall return OVAL_ARITHMETIC_UNKNOWN.

struct oval_component_iterator * oval_component_get_function_components ( struct oval_component  )  [read, inherited]

Returns attribute Oval_function->components.

IF component->type < OVAL_COMPONENT_FUNCTION, this method shall return NULL.

Returns:
A new iterator for the function_components attribute of the specified oval_component. It should be freed after use by the calling application.
struct oval_value * oval_component_get_literal_value ( struct oval_component  )  [read, inherited]

Returns attribute Oval_literal->literal.

IF component->type <> OVAL_COMPONENT_LITERAL, this method shall return NULL

Returns:
A pointer to the value attribute of the specified oval_component.
Note:
applications should not free the Oval_value returned by this method
struct oval_object * oval_component_get_object ( struct oval_component  )  [read, inherited]

Returns attribute Oval_component_object->object.

IF component->type <> OVAL_COMPONENT_OBJECTREF, this method shall return NULL.

Returns:
A pointer to the object attribute of the specified oval_component.
Note:
applications should not free the Oval_object returned by this method
char * oval_component_get_object_field ( struct oval_component  )  [inherited]

Returns attribute Oval_component_object->object_field.

IF component->type <> OVAL_COMPONENT_OBJECTREF, this method shall return NULL.

Returns:
A pointer to the object_field attribute of the specified oval_component.
Note:
applications should not free the char* returned by this method
char * oval_component_get_prefix ( struct oval_component  )  [inherited]

Returns attribute Oval_function_BEGIN->prefix.

IF component->type <> OVAL_FUNCTION_BEGIN, this method shall return NULL

Returns:
A pointer to the attribute of the specified oval_component.
Note:
applications should not free the char* returned by this method
char * oval_component_get_regex_pattern ( struct oval_component  )  [inherited]

Returns attribute Oval_function_REGEX_CAPTURE->pattern.

IF component->type <> OVAL_FUNCTION_REGEX_CAPTURE, this method shall return NULL

Returns:
A pointer to the attribute of the specified oval_component.
Note:
applications should not free the char* returned by this method
char * oval_component_get_split_delimiter ( struct oval_component  )  [inherited]

Returns attribute Oval_function_SPLIT->delimiter.

IF component->type <> OVAL_FUNCTION_SPLIT, this method shall return NULL

Returns:
A pointer to the attribute of the specified oval_component.
Note:
applications should not free the char* returned by this method
int oval_component_get_substring_length ( struct oval_component  )  [inherited]

Returns attribute Oval_function_SUBSTRING->length.

IF component->type <> OVAL_FUNCTION_SUBSTRING, this method shall return 0

int oval_component_get_substring_start ( struct oval_component  )  [inherited]

Returns attribute Oval_function_SUBSTRING->start.

IF component->type <> OVAL_FUNCTION_SUBSTRING, this method shall return 0

char * oval_component_get_suffix ( struct oval_component  )  [inherited]

Returns attribute Oval_function_END->suffix.

IF component->type <> OVAL_FUNCTION_END, this method shall return NULL

Returns:
A pointer to the attribute of the specified oval_component.
Note:
applications should not free the char* returned by this method
oval_datetime_format_t oval_component_get_timedif_format_1 ( struct oval_component  )  [inherited]

Returns attribute Oval_function_TIMEDIF->timedif_format_1.

IF component->type <> OVAL_FUNCTION_TIMEDIF, this method shall return OVAL_TIMEDATE_UNKNOWN

oval_datetime_format_t oval_component_get_timedif_format_2 ( struct oval_component  )  [inherited]

Returns attribute Oval_function_TIMEDIF->timedif_format_2.

IF component->type <> OVAL_FUNCTION_TIMEDIF, this method shall return OVAL_TIMEDATE_UNKNOWN

struct oval_variable * oval_component_get_variable ( struct oval_component  )  [read, inherited]

Returns attribute Oval_component_variable->variable.

IF component->type <> OVAL_COMPONENT_VARREF, this method shall return NULL.

Returns:
A pointer to the variable attribute of the specified oval_component.
Note:
applications should not free the Oval_variable returned by this method
bool oval_component_is_locked ( struct oval_component component  )  [inherited]

return true if the component instance is locked.

The state of a locked instance cannot be changed.

bool oval_component_is_valid ( struct oval_component  )  [inherited]

Returns true if the Oval_component is valid.

An Oval_component is valid if one of the following is true:

  • type == OVAL_FUNCTION_CONCAT AND components.length > 0 AND all appended components are valid
  • type == OVAL_FUNCTION_ARITHMETIC AND arithmetic_operation <> OVAL_ARITHMETIC_UNKNOWN AND components.length at least 2 AND all appended components are valid
  • type == OVAL_FUNCTION_BEGIN AND prefix <> NULL AMD components.length == 1 AND the appended component is valid
  • type == OVAL_FUNCTION_END AND suffix <> NULL components.length == 1 AND the appended component is valid
  • type == OVAL_FUNCTION_SPLIT AND delimiter <> NULL components.length == 1 AND the appended component is valid
  • type == OVAL_FUNCTION_SUBSTRING AND start > 0 AND length > 0 components.length == 1 AND the appended component is valid
  • type == OVAL_FUNCTION_TIMEDIF AND timedif_format_1 <> OVAL_DATETIME_FORMAT_UNKNOWN AND components.length > 0 AND all appended components are valid AND IF timedif_format_2 <> OVAL_DATETIME_FORMAT_UNKNOWN THEN components.length is divisible by 2
  • type == OVAL_FUNCTION_REGEX_CAPTURE AND pattern <> NULL components.length == 1 AND the appended component is valid
  • type == OVAL_FUNCTION_ESCAPE_REGEX AND components.length == 1 AND the appended component is valid
  • type == OVAL_COMPONENT_LITERAL AND literal <> NULL
  • type == OVAL_COMPONENT_OBJECTREF object <> NULL AND object is a valid Oval_object AND object_field <> NULL
  • type == OVAL_COMPONENT_VARREF variable <> NULL AND variable is a valid Oval_variable
struct oval_component * oval_component_iterator_next ( struct oval_component_iterator  )  [read, inherited]

return the next instance of Oval_component.

If the iterator is exhausted this method shall return NULL.

struct oval_component * oval_component_new ( struct oval_definition_model ,
oval_component_type_t  type 
) [read, inherited]

Construct new intance of Oval_component.

Attribute values shall be initialized:

  • type -- initialized to the value of the type parameter.
  • If type == OVAL_FUNCTION_CONCAT
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_ESCAPE_REGEX
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_ARITHMETIC
    • arithmetic_operation -- initialized to OVAL_ARITHMETIC_UNKNOWN
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_BEGIN
    • prefix -- initialized to NULL
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_END
    • suffix -- initialized to NULL
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_SPLIT
    • delimiter -- initialized to NULL
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_SUBSTRING
    • start, length -- initialized to zero
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_TIMEDIF
    • timedif_format_1, timedif_format_2 -- initialized to OVAL_DATETIME_UNKNOWN
    • components -- initialized to empty iterator
  • If type == OVAL_FUNCTION_REGEX_CAPTURE
    • pattern -- initialized to NULL
    • components -- initialized to empty iterator
  • If type == OVAL_COMPONENT_LITERAL
    • literal -- initialized to NULL
  • If type == OVAL_COMPONENT_OBJECTREF
    • object -- initialized to NULL
    • object_field -- initialized to NULL
  • If type == OVAL_COMPONENT_VARREF
    • variable -- initialized to NULL

This method shall not construct a new instance of Oval_object and shall return NULL if the type parameter is entered as OVAL_COMPONENT_UNKNOWN.

Parameters:
type - the required component type.
void oval_component_set_object ( struct oval_component ,
struct oval_object object 
) [inherited]

set attribute Oval_component_object->object.

IF component->type <> OVAL_COMPONENT_OBJECTREF OR component->object <> NULL, this method does nothing .

void oval_component_set_object_field ( struct oval_component ,
char *  field 
) [inherited]

set attribute Oval_component_object->object_field.

IF component->type <> OVAL_COMPONENT_OBJECTREF OR component->object_field <> NULL, this method does nothing. OTHERWISE the method uses a copy of the field parameter to set component->object_field

void oval_component_set_variable ( struct oval_component ,
struct oval_variable variable 
) [inherited]

set attribute Oval_component_object->variable.

IF component->type <> OVAL_COMPONENT_OBJECTREF OR component->variable <> NULL, this method does nothing.

void oval_criteria_node_add_subnode ( struct oval_criteria_node ,
struct oval_criteria_node node 
) [inherited]

Append instance of Oval_criteria_node to attribute Oval_criteria->subnodes.

If Oval_criteria_node->type <> OVAL_NODETYPE_CRITERIA, this method shall return without changing the Oval_criteria_node state.

Note:
Instances of Oval_criteria_node bound to an Oval_criteria by this method should not be subsequently freed by the application using oval_criteria_node_free. These instances shall be freed by the API when the Oval_criteria is freed.
An application should not bind a given Oval_criteria_node as a subnode to more than one Oval_criteria, nor should a given Oval_criteria_node be bound more than once to a single Oval_criteria.
Parameters:
- (Not NULL) the subnode to be appended.
struct oval_criteria_node * oval_criteria_node_clone ( struct oval_definition_model new_model,
struct oval_criteria_node old_node 
) [read, inherited]

Clone an instance of oval_criteria_node.

Returns:
A copy of the specified oval_criteria_node.
char * oval_criteria_node_get_comment ( struct oval_criteria_node  )  [inherited]

Returns attribute Oval_criteria_node->comment.

Returns:
A pointer to the comment attribute of the specified oval_criteria_node.
struct oval_definition * oval_criteria_node_get_definition ( struct oval_criteria_node  )  [read, inherited]

Returns attribute Oval_extends->definition.

If Oval_criteria_node->type <> OVAL_NODETYPE_EXTENDDEF, this method shall return NULL.

Returns:
A pointer to the definition attribute of the specified oval_criteria_node.
oval_operator_t oval_criteria_node_get_operator ( struct oval_criteria_node  )  [inherited]

Returns attribute Oval_criteria->operator HOWDI.

Note:
If Oval_criteria_node->type <> OVAL_NODETYPE_CRITERIA, this method shall return OVAL_OPERATOR_UNKNOWN.
struct oval_criteria_node_iterator * oval_criteria_node_get_subnodes ( struct oval_criteria_node  )  [read, inherited]

Returns attribute Oval_criteria_node->subnodes.

If Oval_criteria_node->type <> OVAL_NODETYPE_CRITERIA, this method shall return NULL.

Returns:
A new iterator for the subnodes attribute of the specified oval_criteria_node. It should be freed after use by the calling application.
struct oval_test * oval_criteria_node_get_test ( struct oval_criteria_node  )  [read, inherited]

Returns attribute Oval_criterion->test.

If Oval_criteria_node->type <> OVAL_NODETYPE_CRITERION, this method shall return NULL.

Returns:
A pointer to the test attribute of the specified oval_criteria_node.
bool oval_criteria_node_is_locked ( struct oval_criteria_node  )  [inherited]

Return true if the instance of Oval_criteria_node is locked.

The state of a locked instance cannot be changed.

bool oval_criteria_node_is_valid ( struct oval_criteria_node  )  [inherited]

Returns true if Oval_criteria_node is valid.

An Oval_criteria_node is valid if one of the following is true:

  • The type attribute is OVAL_NODETYPE_CRITERIA (Oval_criteria)-- AND
    • The subnode attribute is not an empty iterator -- AND
    • Each iterated Oval_criteria_node is valid.
  • The type attribute is OVAL_NODETYPE_CRITERION (Oval_criterion) -- AND
    • The referenced test is valid.
  • The type attribute is OVAL_NODETYPE_EXTENDDEF (Oval_extends) -- AND
    • The referenced definition is valid.
struct oval_criteria_node * oval_criteria_node_iterator_next ( struct oval_criteria_node_iterator  )  [read, inherited]

Returns the next instance of Oval_criteria_node from the iterator.

Returns NULL if the iterator is exhausted.

struct oval_criteria_node * oval_criteria_node_new ( struct oval_definition_model ,
oval_criteria_node_type_t  type 
) [read, inherited]

Construct an instance of oval_criteria_node.

Initialized attribute values are:

  • type initialized to value of type parameter.
  • negate -- initialized to false
  • comment -- initialized to NULL
  • If type == OVAL_NODETYPE_CRITERIA (Oval_criteria):
    • operator -- initialized to OVAL_OPERATOR_UNKNOWN
    • subnodes -- initialized to empty iterator
  • If type == OVAL_NODETYPE_CRITERION (Oval_criterion):
    • test -- initialized to NULL
  • If type == OVAL_NODETYPE_EXTENDDEF (Oval_extends):
    • definition -- initialized to NULL Careful ! Calling this function with inappropriate number of arguments will cause undefined behavior !

If the type parameter is entered as OVAL_NODETYPE_UNKNOWN, no instance shall be constructed and the method shall return NULL.

Parameters:
type - the required node type.
void oval_criteria_node_set_comment ( struct oval_criteria_node ,
char *  comment 
) [inherited]

set attribute Oval_criteria_node->comment.

Parameters:
comm - (Not NULL) a copy of the comment parameter is set as the comment attribute.
void oval_criteria_node_set_definition ( struct oval_criteria_node ,
struct oval_definition  
) [inherited]

Sets attribute Oval_extends->definition.

If Oval_criteria_node->type == OVAL_NODETYPE_EXTENDDEF and the value of the definition attribute is NULL, this method shall overwrite the definition attribute value with the definition parameter. Otherwise the Oval_criteria_node state shall not be changed by this method.

void oval_criteria_node_set_negate ( struct oval_criteria_node ,
bool  negate 
) [inherited]

Set attribute Oval_criteria_node->negate.

Parameters:
negate - the required value of the negate attribute
void oval_criteria_node_set_operator ( struct oval_criteria_node ,
oval_operator_t  op 
) [inherited]

Set attribute Oval_criteria->operator.

If Oval_criteria_node->type == OVAL_NODETYPE_CRITERIA and the value of the operator attribute is OVAL_OPERATOR_UNKNOWN, this method shall overwrite the operator attribute value with the operator parameter. Otherwise the Oval_criteria_node state shall not be changed by this method.

void oval_criteria_node_set_test ( struct oval_criteria_node ,
struct oval_test  
) [inherited]

Sets attribute Oval_criterion->test.

If Oval_criteria_node->type == OVAL_NODETYPE_CRITERION and the value of the test attribute is NULL, this method shall overwrite the test attribute value with the test parameter. Otherwise the Oval_criteria_node state shall not be changed by this method.

void oval_criteria_set_node_type ( struct oval_criteria_node node,
oval_criteria_node_type_t  type 
) [inherited]

Set attribute Oval_criteria_node->type.

Parameters:
type - the required value of the type attribute
void oval_definition_add_affected ( struct oval_definition ,
struct oval_affected affected 
) [inherited]

Append instance of oval_affected to attribute oval_definition->affected.

Note:
Instances of Oval_affected bound to Oval_definition by this method should not be subsequently freed by the application using oval_affected_free. These instances shall be freed by the API when the Oval_definition is freed.
A given instance of Oval_affected should not be appended by an application to more than one instance of Oval_definition, nor should the given instance of Oval_affected be appended more than once to a single instance of Oval_definition.
Parameters:
affected - appended instance of Oval_affected.
void oval_definition_add_note ( struct oval_definition ,
char *  note 
) [inherited]

Append a copy of the note parameter to attribute Oval_definition->notes.

Parameters:
note - the note text.
void oval_definition_add_reference ( struct oval_definition ,
struct oval_reference reference 
) [inherited]

Append instance of oval_reference to attribute oval_definition->references.

Note:
Instances of Oval_reference bound to Oval_definition by this method should not be subsequently freed by the application using oval_reference_free. These instances shall be freed by the API when the Oval_definition is freed.
A given instance of Oval_reference should not be appended by an application to more than one instance of Oval_definition, nor should the given instance of Oval_reference be appended more than once to a single instance of Oval_definition.
Parameters:
reference - appended instance of Oval_reference.
struct oval_definition * oval_definition_clone ( struct oval_definition_model new_model,
struct oval_definition old_definition 
) [read, inherited]

Clone instance of oval_definition and add it to the specified oval_definition_model.

Returns:
A copy of the specified oval_definition.
void oval_definition_free ( struct oval_definition  )  [inherited]

Release an instance of oval_definition.

All attributes of the Oval_definition are also released.

Note:
Applications should not call this method to free an Oval_definition that is bound to an instance of OVALDEF. These bound definitions are released when the OVALDEF are released.
struct oval_affected_iterator * oval_definition_get_affected ( struct oval_definition  )  [read, inherited]

Returns attribute oval_definition->affected.

Returns:
A new iterator for the affected attribute of the specified oval_definition. It should be freed after use by the calling application.
struct oval_criteria_node * oval_definition_get_criteria ( struct oval_definition  )  [read, inherited]

Returns attribute oval_definition->criteria.

Returns:
A pointer to the criteria attribute of the specified oval_definition.
char * oval_definition_get_description ( struct oval_definition  )  [inherited]

Returns attribute oval_definition->description.

Returns:
A pointer to the description attribute of the specified oval_definition.
struct oval_string_iterator * oval_definition_get_notes ( struct oval_definition  )  [read, inherited]

Returns attribute oval_definition->notes.

Returns:
A new iterator for the notes attribute of the specified oval_definition. It should be freed after use by the calling application.
struct oval_reference_iterator * oval_definition_get_references ( struct oval_definition  )  [read, inherited]

Returns attribute oval_definition->references.

Returns:
A new iterator for the reference attribute of the specified oval_definition. It should be freed after use by the calling application.
char * oval_definition_get_title ( struct oval_definition  )  [inherited]

Returns attribute oval_definition->title.

Returns:
A pointer to the title attribute of the specified oval_definition.
int oval_definition_get_version ( struct oval_definition  )  [inherited]

Returns attribute oval_definition->version.

Returns:
A pointer to the id attribute of the specified oval_definition.
bool oval_definition_is_locked ( struct oval_definition definition  )  [inherited]

return true if the definition instance is locked.

The state of a locked instance cannot be changed.

bool oval_definition_is_valid ( struct oval_definition definition  )  [inherited]

Returns true if the oval_definition is valid.

An Oval_definition is valid if all the following are true

  • attribute criteria is bound to a valid instance of Oval_criteria.
struct oval_definition * oval_definition_iterator_next ( struct oval_definition_iterator  )  [read, inherited]

Returns the next iterated instance of oval_definition.

NULL is returned if the iterator is exhausted (oval_definition_iterator_has_more == false)

struct oval_definition_model * oval_definition_model_clone ( struct oval_definition_model  )  [read, inherited]

Copy an oval_definition_model.

Returns:
A copy of the specified oval_definition_model.
struct oval_definition * oval_definition_model_get_definition ( struct oval_definition_model ,
const char *  id 
) [read, inherited]

Returns the appended oval_definition having the specified id.

IF the specified id does not resolve to an appended Oval_definition the method shall return NULL.

See also:
oval_definition_add_definition
Parameters:
id the definition id.
struct oval_object * oval_definition_model_get_object ( struct oval_definition_model model,
const char *  id 
) [read, inherited]

Get OVAL object by ID.

Return a designated oval_object from the specified oval_definition_model. If the specified id does not resolve to an oval_object the function returns NULL.

Parameters:
model the queried model.
id the object id.
struct oval_object_iterator * oval_definition_model_get_objects ( struct oval_definition_model model  )  [read, inherited]

Get OVAL objects.

Return all oval_objects from the specified oval_definition_model.

Parameters:
model the queried model.
struct oval_state * oval_definition_model_get_state ( struct oval_definition_model model,
const char *  id 
) [read, inherited]

Get OVAL state by ID.

Return a designated oval_state from the specified oval_definition_model. If the specified id does not resolve to an oval_state the function returns NULL.

Parameters:
model the queried model.
id the state id.
struct oval_state_iterator * oval_definition_model_get_states ( struct oval_definition_model model  )  [read, inherited]

Get OVAL states.

Return all oval_states from the specified oval_definition_model.

Parameters:
model the queried model.
struct oval_test * oval_definition_model_get_test ( struct oval_definition_model model,
const char *  id 
) [read, inherited]

Get oval test by ID.

Return a designated oval_test from the specified oval_definition_model. If the specified id does not resolve to an oval_test the function returns NULL.

Parameters:
model the queried model.
id the test id.
struct oval_test_iterator * oval_definition_model_get_tests ( struct oval_definition_model model  )  [read, inherited]

Get OVAL tests.

Return all oval_tests from the specified oval_definition_model.

Parameters:
model the queried model.
struct oval_variable * oval_definition_model_get_variable ( struct oval_definition_model model,
const char *  id 
) [read, inherited]

Get OVAL variable by ID.

Return a designated oval_variable from the specified oval_definition_model. If the specified id does not resolve to an oval_variable the function returns NULL.

Parameters:
model the queried model.
id the variable id.
struct oval_variable_iterator * oval_definition_model_get_variables ( struct oval_definition_model model  )  [read, inherited]

Get OVAL variables.

Return all oval_variables from the specified oval_definition_model.

Parameters:
model the queried model.
struct oval_definition_model * oval_definition_model_import ( const char *  file  )  [read, inherited]

Import the content from the file into an oval_definition_model.

Parameters:
file filename
Returns:
new oval_definition_model, or NULL if an error occurred
bool oval_definition_model_is_locked ( struct oval_definition_model definition_model  )  [inherited]

Return true if the definition_model instance is locked.

The state of a locked instance cannot be changed.

void oval_definition_model_lock ( struct oval_definition_model definition_model  )  [inherited]

Lock the definition_model instance.

The state of a locked instance cannot be changed. This operation has no effect if the model is already locked.

int oval_definition_model_merge ( struct oval_definition_model model,
const char *  file 
) [inherited]

Merge the content from the file with specified oval_definition_model.

If imported content specifies a model entity that is already registered within the model its content is overwritten.

Parameters:
model the merge target model
file filename
Returns:
-1 if an error occurred
const char * oval_definition_model_supported ( void   )  [inherited]

Get supported version of OVAL XML.

Returns:
version of XML file format
struct oval_definition * oval_definition_new ( struct oval_definition_model ,
const char *  id 
) [read, inherited]

Construct an instance of oval_definition.

Initialized attribute values are

  • id bound to value specified by id parameter.
  • version bound to 0.
  • class bound to OVAL_CLASS_UNKNOWN
  • deprecated bound to false
  • title bound to NULL
  • description bound to NULL
  • criteria bound to NULL
  • affected bound to empty iterator
  • references bound to empty iterator
  • notes bound to empty iterator
    Parameters:
    id - (non-NULL) A copy of this string is bound to the id attribute of the created instance.
void oval_definition_set_class ( struct oval_definition ,
oval_definition_class_t   
) [inherited]

Set attribute oval_definition->class.

This method shall overwrite a OVAL_CLASS_UNKNOWN class attribute value with the value of the class parameter. Valid values of the class attribute shall not be overwritten by this method.

Parameters:
class - the required class
void oval_definition_set_criteria ( struct oval_definition ,
struct oval_criteria_node criteria 
) [inherited]

Set attribute oval_definition->criteria.

This method shall overwrite a NULL criteria attribute value with the criteria parameter only if the criteria parameter is an instance of Oval_criteria (i.e. criteria->type == OVAL_NODETYPE_CRITERIA). Other values of the criteria attribute shall not be overwritten by this method.

Note:
Instances of Oval_criteria bound to Oval_definition by this method should not be subsequently freed by the application using oval_criteria_node_free. These instances shall be freed by the API when the Oval_definition is freed.
An application should not bind a given instance of Oval_criteria to more than one instance of Oval_definition, nor should a given instance of Oval_criteria be bound to both an Oval_definition and an Oval_criteria (using oval_criteria_node_add_subnode).
Parameters:
criteria - the required instance of Oval_criteria
void oval_definition_set_deprecated ( struct oval_definition ,
bool  deprecated 
) [inherited]

Set attribute oval_definition->deprecated.

Parameters:
deprecated - the required deprecation toggle.
void oval_definition_set_description ( struct oval_definition ,
char *  description 
) [inherited]

Set attribute oval_definition->description.

This method shall overwrite a NULL description attribute value with a copy of the description parameter. Valid values of the description attribute shall not be overwritten by this method.

Parameters:
description - the required description
void oval_definition_set_title ( struct oval_definition ,
char *  title 
) [inherited]

Set attribute oval_definition->title.

This method shall overwrite a NULL title attribute value with a copy of the title parameter. Valid values of the title attribute shall not be overwritten by this method.

Parameters:
title - the required title
void oval_definition_set_version ( struct oval_definition ,
int  version 
) [inherited]

Set attribute oval_definition->version.

This method shall overwrite a zero version attribute value with the value of the version parameter. Valid values of the version attribute shall not be overwritten by this method.

Parameters:
version - the required version
struct oval_entity * oval_entity_clone ( struct oval_definition_model model,
struct oval_entity old_entity 
) [read, inherited]
Returns:
A copy of the specified oval_entity.
char * oval_entity_get_name ( struct oval_entity  )  [inherited]

Get OVAL entity name.

Returns:
A pointer to the name attribute of the specified oval_entity.
struct oval_value * oval_entity_get_value ( struct oval_entity  )  [read, inherited]

Get OVAL entity value.

Returns:
A pointer to the value attribute of the specified oval_entity.
struct oval_variable * oval_entity_get_variable ( struct oval_entity  )  [read, inherited]

Get OVAL entity varref variable.

Returns:
A pointer to the variable attribute of the specified oval_entity.
bool oval_entity_is_locked ( struct oval_entity entity  )  [inherited]

return true if the entity instance is locked.

The state of a locked instance cannot be changed.

void oval_object_add_behavior ( struct oval_object ,
struct oval_behavior behavior 
) [inherited]

Append instance of oval_behavior to attribute oval_object->behaviors.

Oval_behaviors appended to a given Oval_object shall be freed by the API when the Oval_object is freed.

Note:
A specific instance of Oval_behavior should not be appended to more than one Oval_object, and an instance of Oval_behavior should not be appended more than once to a single Oval_object.
An instance of Oval_behavior that is appended to an Oval_object should not be freed independently by the application using oval_behavior_free.
Parameters:
behavior - (Not NULL) the Oval_behavior to be appended.
void oval_object_add_note ( struct oval_object ,
char *  note 
) [inherited]

Appends a copy of the note parameter to attribute oval_object->notes.

Parameters:
note - (Not NULL) the text of the appended note.
void oval_object_add_object_content ( struct oval_object ,
struct oval_object_content content 
) [inherited]

Append instance of oval_object_content to attribute oval_object->object_contents.

Oval_object_contents appended to a given Oval_object shall be freed by the API when the Oval_object is freed.

Note:
A specific instance of Oval_object_content should not be appended to more than one Oval_object, and an instance of Oval_object_content should not be appended more than once to a single Oval_object.
An instance of Oval_object_content that is appended to an Oval_object should not be freed independently by the application using oval_object_content_free.
Parameters:
content - (Not NULL) the Oval_object_content to be appended.
struct oval_object * oval_object_clone ( struct oval_definition_model new_model,
struct oval_object old_object 
) [read, inherited]

Clone instance of oval_object and add it to the specified oval_definition_model.

Returns:
A copy of the specified oval_object.
struct oval_object_content * oval_object_content_clone ( struct oval_definition_model new_model,
struct oval_object_content old_content 
) [read, inherited]
Returns:
A copy of the specified oval_object_content.
struct oval_entity * oval_object_content_get_entity ( struct oval_object_content  )  [read, inherited]

Get entity of a simple object content.

Returns:
A pointer to the entity attribute of the specified oval_object_content.
char * oval_object_content_get_field_name ( struct oval_object_content  )  [inherited]

Get field name of a object content.

Returns:
A pointer to the fieldName attribute of the specified oval_object_content.
struct oval_setobject * oval_object_content_get_setobject ( struct oval_object_content  )  [read, inherited]

Get setobject of a set object content.

Returns:
A pointer to the set attribute of the specified oval_object_content.
bool oval_object_content_is_locked ( struct oval_object_content object_content  )  [inherited]

return true if the object_content instance is locked.

The state of a locked instance cannot be changed.

bool oval_object_content_is_valid ( struct oval_object_content object_content  )  [inherited]

Return true if the object_content instance is valid An Oval_object_content is valid if one of the following is true:

  • The type attribute is OVAL_OBJECTCONTENT_ENTITY -- AND

  • The type attribute is OVAL_OBJECTCONTENT_SET -- AND
struct oval_behavior_iterator * oval_object_get_behaviors ( struct oval_object  )  [read, inherited]

Returns attribute oval_object->behaviors.

Returns:
A new iterator for the behaviors attribute of the specified oval_object. It should be freed after use by the calling application.
char * oval_object_get_comment ( struct oval_object  )  [inherited]

Returns attribute oval_object->comment.

Returns:
A pointer to the comment attribute of the specified oval_object.
char * oval_object_get_id ( struct oval_object  )  [inherited]

Returns attribute oval_object->id.

Returns:
A pointer to the id attribute of the specified oval_object.
const char * oval_object_get_name ( struct oval_object  )  [inherited]

Returns the name of an oval_object.

This is a convenience method that is equivalent to oval_subtype_get_text (oval_object_get_subtype)+"_object".

struct oval_string_iterator * oval_object_get_notes ( struct oval_object  )  [read, inherited]

Returns attribute oval_object->notes.

Returns:
A new iterator for the notes attribute of the specified oval_object. It should be freed after use by the calling application.
struct oval_object_content_iterator * oval_object_get_object_contents ( struct oval_object  )  [read, inherited]

Returns attribute oval_object->contents.

Returns:
A new iterator for the object_content attribute of the specified oval_object. It should be freed after use by the calling application.
bool oval_object_is_locked ( struct oval_object object  )  [inherited]

return true if the object instance is locked.

The state of a locked instance cannot be changed.

bool oval_object_is_valid ( struct oval_object object  )  [inherited]

Return true if the object instance is valid.

An Oval_object is valid if all of the following are true

  • All included object contents are valid
  • All included behaviors are valid
struct oval_object * oval_object_new ( struct oval_definition_model ,
const char *  id 
) [read, inherited]

Construct new intance of oval_object.

Attribute values shall be initialized:

  • family -- initialized to OVAL_FAMILY_UNKNOWN
  • subtype -- initialized to OVAL_SUBTYPE_UNKNOWN
  • notes -- initialized to empty iterator
  • comment -- initialized to NULL
  • id -- initialized to a copy of the id parameter
  • deprecated -- initialized to false
  • version -- initialized to zero
  • contents -- initialized to empty iterator
  • behaviors -- initialized to empty iterator
Note:
This method shall not construct a new instance of Oval_object and shall return NULL if the text of the id parameter is not matched by the regular expression ^oval:[\.A-Za-z0-9_\-]+:obj:[1-9][0-9]*$.
Parameters:
id - (Not NULL) the text of the required object id.
void oval_object_set_comment ( struct oval_object ,
char *  comment 
) [inherited]

Sets a copy of the comment parameter to attribute oval_object->comment.

Parameters:
comment - (Not NULL) the text of the comment.
void oval_object_set_subtype ( struct oval_object ,
oval_subtype_t  subtype 
) [inherited]

Sets attributes oval_object->subtype and oval_object->family.

If Oval_object->subtype == OVAL_SUBTYPE_UNKNOWN and parameter subtype <> OVAL_SUBTYPE_UNKNOWN, this method shall overwrite Oval_object->subtype with the value of the subtype parameter and Oval_object->family with the value of oval_family_t corresponding to the specified subtype. Otherwise, the state of the Oval_object instance shall not be changed by this method.

Parameters:
subtype - the required subtype value.
void oval_object_set_version ( struct oval_object ,
int  version 
) [inherited]

Sets attribute oval_object->version.

If Oval_object->version == 0 and parameter version >0, this method shall overwrite Oval_object->version with the parameter value. Otherwise, the method shall leave the Oval_object state unchanged.

Parameters:
version - (>0) the required version
struct oval_reference * oval_reference_clone ( struct oval_definition_model new_model,
struct oval_reference old_reference 
) [read, inherited]
Returns:
A copy of the specified oval_reference.
char * oval_reference_get_id ( struct oval_reference  )  [inherited]

Get OVAL reference ID.

Returns:
A pointer to the id attribute of the specified oval_reference.
char * oval_reference_get_source ( struct oval_reference  )  [inherited]

Get OVAL reference source.

Returns:
A pointer to the source attribute of the specified oval_reference.
char * oval_reference_get_url ( struct oval_reference  )  [inherited]

Get OVAL reference URL.

Returns:
A pointer to the url attribute of the specified oval_reference.
bool oval_reference_is_locked ( struct oval_reference reference  )  [inherited]

return true if the reference instance is locked.

The state of a locked instance cannot be changed.

struct oval_setobject * oval_setobject_clone ( struct oval_definition_model new_model,
struct oval_setobject old_setobject 
) [read, inherited]
Returns:
A copy of the specified oval_setobject.
struct oval_state_iterator * oval_setobject_get_filters ( struct oval_setobject  )  [read, inherited]

Get OVAL set object filters.

This works only with sets of OVAL_SET_COLLECTIVE type.

Returns:
A new iterator for the filters attribute of the specified oval_setobject. It should be freed after use by the calling application.
struct oval_object_iterator * oval_setobject_get_objects ( struct oval_setobject  )  [read, inherited]

Get OVAL set object referenced objects.

This works only with sets of OVAL_SET_COLLECTIVE type.

Returns:
A new iterator for the objects attribute of the specified oval_setobject. It should be freed after use by the calling application.
struct oval_setobject_iterator * oval_setobject_get_subsets ( struct oval_setobject  )  [read, inherited]

Get OVAL set object subsets.

This works only with sets of OVAL_SET_AGGREGATE type.

Returns:
A new iterator for the subsets attribute of the specified oval_setobject. It should be freed after use by the calling application.
bool oval_setobject_is_locked ( struct oval_setobject setobject  )  [inherited]

return true if the setobject instance is locked.

The state of a locked instance cannot be changed.

bool oval_setobject_is_valid ( struct oval_setobject setobject  )  [inherited]

Return true if the setobject instance is valid An Oval_setobject is valid if one of the following is true:

  • The type attribute is OVAL_SET_AGGREGATE -- AND
    • The subsets attribute is not an empty iterator -- AND
    • Each iterated oval_setobject is valid.

  • The type attribute is OVAL_SET_COLLECTIVE -- AND
    • The objects attribute is not an empty iterator -- AND
    • Each iterated oval_object is valid.
    • The filters attribute is not an empty iterator -- AND
    • Each iterated oval_state is valid.
void oval_state_add_content ( struct oval_state ,
struct oval_state_content content 
) [inherited]

Append instance of oval_state_content to attribute oval_state->state_contents.

oval_state_contents appended to a given oval_state shall be freed by the API when the oval_state is freed.

Note:
A specific instance of oval_state_content should not be appended to more than one oval_state, and an instance of oval_state_content should not be appended more than once to a single oval_state.
An instance of oval_state_content that is appended to an oval_state should not be freed independently by the application using oval_state_content_free.
Parameters:
content - (Not NULL) the oval_state_content to be appended.
void oval_state_add_note ( struct oval_state ,
char *  note 
) [inherited]

Appends a copy of the note parameter to attribute oval_state->notes.

Parameters:
note - (Not NULL) the text of the appended note.
struct oval_state * oval_state_clone ( struct oval_definition_model new_model,
struct oval_state old_state 
) [read, inherited]

Clone instance of oval_state and add it to the specified oval_definition_model.

Returns:
A copy of the specified oval_state.
struct oval_state_content * oval_state_content_clone ( struct oval_definition_model new_model,
struct oval_state_content old_content 
) [read, inherited]
Returns:
A copy of the specified oval_state_content.
struct oval_entity * oval_state_content_get_entity ( struct oval_state_content  )  [read, inherited]

Get entity of a state content.

Returns:
A pointer to the entity attribute of the specified oval_state_content.
bool oval_state_content_is_locked ( struct oval_state_content  )  [inherited]

Return true if the setobject instance is locked.

The state of a locked instance cannot be changed.

char * oval_state_get_comment ( struct oval_state  )  [inherited]

Returns attribute oval_state->comment.

Returns:
A pointer to the comment attribute of the specified oval_state.
struct oval_state_content_iterator * oval_state_get_contents ( struct oval_state  )  [read, inherited]

Returns attribute oval_state->contents.

Returns:
A new iterator for the contents attribute of the specified oval_state. It should be freed after use by the calling application.
char * oval_state_get_id ( struct oval_state  )  [inherited]

Returns attribute oval_state->id.

Returns:
A pointer to the id attribute of the specified oval_state.
const char * oval_state_get_name ( struct oval_state  )  [inherited]

Returns the name of an oval_state.

This is a convenience method that is equivalent to oval_subtype_get_text (oval_state_get_subtype)+"_state".

struct oval_string_iterator * oval_state_get_notes ( struct oval_state  )  [read, inherited]

Returns attribute oval_state->notes.

Returns:
A new iterator for the notes attribute of the specified oval_state. It should be freed after use by the calling application.
bool oval_state_is_locked ( struct oval_state state  )  [inherited]

return true if the state instance is locked.

The state of a locked instance cannot be changed.

struct oval_state * oval_state_new ( struct oval_definition_model ,
const char *  id 
) [read, inherited]

Construct new intance of oval_state.

Attribute values shall be initialized:

  • family -- initialized to OVAL_FAMILY_UNKNOWN
  • subtype -- initialized to OVAL_SUBTYPE_UNKNOWN
  • notes -- initialized to empty iterator
  • comment -- initialized to NULL
  • id -- initialized to a copy of the id parameter
  • deprecated -- initialized to false
  • version -- initialized to zero
  • operator -- initialized to OVAL_OPERATOR_AND
  • contents -- initialized to empty iterator
Note:
This method shall not construct a new instance of Oval_state and shall return NULL if the text of the id parameter is not matched by the regular expression ^oval:[\.A-Za-z0-9_\-]+:stt:[1-9][0-9]*$.
Parameters:
id - (Not NULL) the text of the required state id.
void oval_state_set_comment ( struct oval_state ,
char *  comment 
) [inherited]

Sets a copy of the comment parameter to attribute oval_state->comment.

Parameters:
comment - (Not NULL) the text of the comment.
void oval_state_set_subtype ( struct oval_state ,
oval_subtype_t  subtype 
) [inherited]

Sets attributes oval_state->subtype and oval_state->family.

If oval_state->subtype == OVAL_SUBTYPE_UNKNOWN and parameter subtype <> OVAL_SUBTYPE_UNKNOWN, this method shall overwrite oval_state->subtype with the value of the subtype parameter and oval_state->family with the value of oval_family_t corresponding to the specified subtype. Otherwise, the state of the oval_state instance shall not be changed by this method.

Parameters:
subtype - the required subtype value.
void oval_state_set_version ( struct oval_state ,
int  version 
) [inherited]

Sets attribute oval_state->version.

If oval_state->version == 0 and parameter version >0, this method shall overwrite oval_state->version with the parameter value. Otherwise, the method shall leave the oval_state state unchanged.

Parameters:
version - (>0) the required version
void oval_test_add_note ( struct oval_test ,
char *  note 
) [inherited]

Appends a copy of the note parameter to attribute oval_test->notes.

Parameters:
note - (Not NULL) the text of the appended note.
struct oval_test * oval_test_clone ( struct oval_definition_model new_model,
struct oval_test old_test 
) [read, inherited]

Clone instance of oval_test and add it to the specified oval_definition_model.

Returns:
A copy of the specified oval_test.
char * oval_test_get_comment ( struct oval_test  )  [inherited]

Returns attribute Oval_test->comment.

Returns:
A pointer to the comment attribute of the specified oval_test.
char * oval_test_get_id ( struct oval_test  )  [inherited]

Returns attribute oval_test->id.

Returns:
A pointer to the id attribute of the specified oval_test.
struct oval_string_iterator * oval_test_get_notes ( struct oval_test  )  [read, inherited]

Returns attribute oval_test->notes.

Returns:
A new iterator for the notes attribute of the specified oval_test. It should be freed after use by the calling application.
struct oval_object * oval_test_get_object ( struct oval_test  )  [read, inherited]

Returns attribute oval_test->object.

Returns:
A pointer to the object attribute of the specified oval_test.
struct oval_state * oval_test_get_state ( struct oval_test  )  [read, inherited]

Returns attribute oval_test->state.

Returns:
A pointer to the state attribute of the specified oval_test.
bool oval_test_is_locked ( struct oval_test test  )  [inherited]

return true if the test instance is locked.

The state of a locked instance cannot be changed.

bool oval_test_is_valid ( struct oval_test  )  [inherited]

Returns true if oval_test is valid.

An Oval_test is valid if the test subtype is OVAL_INDEPENDENT_UNKNOWN or if all of the following are true:

  • The object attribute is valid
  • If the state attribute is not NULL
    • the state attribute is valid
struct oval_test * oval_test_new ( struct oval_definition_model ,
const char *  id 
) [read, inherited]

Construct new instance of oval_test.

Attribute values shall be initialized:

  • family -- initialized to OVAL_FAMILY_UNKNOWN
  • subtype -- initialized to OVAL_SUBTYPE_UNKNOWN
  • notes -- initialized to empty iterator.
  • comment -- initialized to NULL
  • id -- initialized to a copy of the id parameter
  • deprecated -- initialized to false
  • version -- initialized to zero
  • existence -- initialized to OVAL_CHECK_UNKNOWN
  • check -- initialized to OVAL_CHECK_UNKNOWN
  • object -- initialized to NULL
  • state -- initialized to NULL
Note:
This method shall not construct a new instance of Oval_test and shall return NULL if the text of the id parameter is not matched by the regular expression ^oval:[\.A-Za-z0-9_\-]+:tst:[1-9][0-9]*$.
Parameters:
id - (Not NULL) the text of the required test id.
void oval_test_set_check ( struct oval_test ,
oval_check_t   
) [inherited]

Sets attribute oval_test->check.

If Oval_test->check == OVAL_CHECK_UNKNOWN and parameter check <> OVAL_CHECK_UNKNOWN, this method shall overwrite Oval_test->check with the parameter check. Otherwise, the method shall leave the Oval_test state unchanged.

Note:
If Oval_test->state == NULL, the value of Oval_test->check is ignored.
Parameters:
check - (<> OVAL_CHECK_UNKNOWN) the required check
void oval_test_set_comment ( struct oval_test ,
char *  comment 
) [inherited]

Sets a copy of the comment parameter to attribute oval_test->comment.

Parameters:
comment - (Not NULL) the text of the comment.
void oval_test_set_existence ( struct oval_test ,
oval_existence_t   
) [inherited]

Sets attribute oval_test->existence.

If Oval_test->existence == OVAL_CHECK_UNKNOWN and parameter existence <> OVAL_CHECK_UNKNOWN, this method shall overwrite Oval_test->existence with the parameter value. Otherwise, the method shall leave the Oval_test state unchanged.

Parameters:
existence - (<> OVAL_CHECK_UNKNOWN) the required existence
void oval_test_set_object ( struct oval_test ,
struct oval_object  
) [inherited]

Sets attribute oval_test->object.

If Oval_test->object == NULL and parameter object <> NULL, this method shall overwrite Oval_test->object with the parameter object. Otherwise, the method shall leave the Oval_test state unchanged.

Parameters:
object - (<> NULL) the required object
void oval_test_set_state ( struct oval_test ,
struct oval_state state 
) [inherited]

Sets attribute oval_test->state.

If Oval_test->state == NULL and parameter state <> NULL, this method shall overwrite Oval_test->state with the parameter state. Otherwise, the method shall leave the Oval_test state unchanged.

Parameters:
state - (<> NULL) the required state
void oval_test_set_subtype ( struct oval_test ,
oval_subtype_t  subtype 
) [inherited]

Sets attributes oval_test->subtype and Oval_test->family.

If Oval_test->subtype == OVAL_SUBTYPE_UNKNOWN and parameter subtype <> OVAL_SUBTYPE_UNKNOWN, this method shall overwrite Oval_test->subtype with the value of the subtype parameter and Oval_test->family with the value of oval_family_t corresponding to the specified subtype. Otherwise, the state of the Oval_test instance shall not be changed by this method.

Parameters:
subtype - the required subtype value.
void oval_test_set_version ( struct oval_test ,
int  version 
) [inherited]

Sets attribute oval_test->version.

If Oval_test->version == 0 and parameter version >0, this method shall overwrite Oval_test->version with the parameter value. Otherwise, the method shall leave the Oval_test state unchanged.

Parameters:
version - (>0) the required version
struct oval_value * oval_value_clone ( struct oval_value old_value  )  [read, inherited]
Returns:
A copy of the specified oval_value.
char * oval_value_get_text ( struct oval_value  )  [inherited]

Get OVAL value as a text.

Returns:
A pointer to the text attribute of the specified oval_value.
bool oval_value_is_locked ( struct oval_value value  )  [inherited]

return true if the value instance is locked.

The state of a locked instance cannot be changed.

void oval_variable_add_value ( struct oval_variable ,
struct oval_value  
) [inherited]

Append an instance of Oval_value to the attribute Oval_constant->values.

If attribute type <> OVAL_VARIABLE_CONSTANT or the value parameter is NULL the state of the oval_variable shall not be changed by this method. Otherwise, The value parameter shall be appended and shall be freed by the API when the Oval_constant is freed

Note:
When a value is appended to an Oval_constant by an application, that value should not be subsequently freed by the application using oval_value_free.
An application should not append an Oval_value to more than one Oval_constant, and that an Oval_value should not be bound more than once to a single Oval_constant.
Parameters:
value - the required value.
struct oval_variable * oval_variable_clone ( struct oval_definition_model new_model,
struct oval_variable old_variable 
) [read, inherited]

Clone instance of oval_variable and add it to the specified oval_definition_model.

Returns:
A copy of the specified oval_variable.
char * oval_variable_get_comment ( struct oval_variable  )  [inherited]

Returns attribute oval_variable->comment.

Returns:
A pointer to the comment attribute of the specified oval_variable.
struct oval_component * oval_variable_get_component ( struct oval_variable  )  [read, inherited]

Returns attribute Oval_local->component.

If attribute type <> OVAL_VARIABLE_LOCAL this method shall return NULL.

Returns:
A pointer to the component attribute of the specified oval_variable.
char * oval_variable_get_id ( struct oval_variable  )  [inherited]

Returns attribute oval_variable->id.

Returns:
A pointer to the id attribute of the specified oval_variable.
struct oval_value_iterator * oval_variable_get_values ( struct oval_variable  )  [read, inherited]

Returns attribute Oval_external/Oval_constant->values.

If attribute type == OVAL_VARIABLE_LOCAL or OVAL_VARIABLE_UNKNOWN, this method shall return NULL

Returns:
A new iterator for the values attribute of the specified oval_variable. It should be freed after use by the calling application.
bool oval_variable_is_locked ( struct oval_variable variable  )  [inherited]

return true if the variable instance is locked.

The state of a locked instance cannot be changed.

bool oval_variable_is_valid ( struct oval_variable  )  [inherited]

Returns true if oval_variable is valid.

An oval_variable is valid if all of the following are true:

  • The value of the id attribute is matched by the regular expression ^oval:[\.A-Za-z0-9_\-]+:var:[1-9][0-9]*$
  • The value of the type attribute is not OVAL_VARIABLE_UNKNOWN
  • The value of the version attribute is a positive integer
  • The value of the datatype attribute is not OVAL_DATATYPE_UNKNOWN
  • If type == OVAL_VARIABLE_CONSTANT
    • At least one Oval_value is appended to the values attribute.
  • If type == OVAL_VARIABLE_LOCAL
    • The component attribute is not NULL.
    • The bound Oval_component is valid (oval_component_is_valid).
struct oval_variable * oval_variable_new ( struct oval_definition_model model,
const char *  id,
oval_variable_type_t  type 
) [read, inherited]

Construct new instance of oval_variable.

Attribute values shall be initialized:

  • id -- initialized to a copy of the id parameter
  • type -- initialized to the type parameter
  • version -- initialized to zero
  • deprecated -- initialized to false
  • comment -- initialized to NULL
  • datatype -- initialzed to OVAL_DATATYPE_UNKNOWN
  • If type == OVAL_VARIABLE_CONSTANT
    • values -- initialized to empty iterator
  • If type == OVAL_VARIABLE_EXTERNAL
    • values -- initialized to NULL
  • If type == OVAL_VARIABLE_LOCAL
    • component -- initialized to NULL

This method shall not construct a new instance of oval_variable and shall return NULL

  • if the text of the id parameter is not matched by the regular expression ^oval:[\.A-Za-z0-9_\-]+:var:[1-9][0-9]*$.
  • if the value of the type parameter is OVAL_VARIABLE_UNKNOWN.
Parameters:
id - (Not NULL) the text of the required variable id.
type - (Not OVAL_VARIABLE_UNKNOWN) the required type.
void oval_variable_set_comment ( struct oval_variable ,
char *  comment 
) [inherited]

set attribute oval_variable->comment.

If attribute oval_variable->comment == NULL this method shall overwrite the attribute with a copy of the comment parameter. Otherwise the variable state shall be unchanged.

Parameters:
comm - (Not NULL) a copy of the comment parameter is set as the comment attribute.
void oval_variable_set_component ( struct oval_variable ,
struct oval_component component 
) [inherited]

Bind an instance of Oval_component to the attribute Oval_local->component.

If attribute type <> OVAL_VARIABLE_LOCAL, the component attribute <> NULL or the component parameter is NULL the state of the oval_variable shall not be changed by this method. Otherwise, The component parameter shall be bound to the component attribute and shall be freed by the API when the Oval_local is freed

Note:
When an Oval_component is bound to an Oval_local by an application, the Oval_component should not be subsequently freed by the application using oval_component_free.
An application should not bind a single Oval_component to more than one Oval_local or to an Oval_local and an Oval_function.
Parameters:
component - the required component.
void oval_variable_set_datatype ( struct oval_variable ,
oval_datatype_t   
) [inherited]

set attribute oval_variable->datatype.

If attribute oval_variable->datatype == OVAL_DATATYPE_UNKNOWN this method shall overwrite the attribute with the datatype parameter. Otherwise the variable state shall be unchanged.

Parameters:
datatype - (Not OVAL_DATATYPE_UNKNOWN) a the required datatype.
void oval_variable_set_deprecated ( struct oval_variable ,
bool  deprecated 
) [inherited]

set attribute oval_variable->deprecated.

Parameters:
deprecated - the required deprecation toggle.
void oval_variable_set_version ( struct oval_variable ,
int  version 
) [inherited]

set attribute oval_variable->version.

If attribute oval_variable->version == 0 this method shall overwrite the attribute with the version parameter. Otherwise the variable state shall be unchanged.

Parameters:
version - (>0) the required version.

Generated on 14 Jul 2010 for Open SCAP Library by  doxygen 1.6.1