The following is a description of the elements, types, and attributes that compose the core schema for encoding Open Vulnerability and Assessment Language (OVAL) Definitions. Some of the objects defined here are extended and enhanced by individual component schemas, which are described in separate documents. Each of the elements, types, and attributes that make up the Core Definition Schema are described in detail and should provide the information necessary to understand what each represents. This document is intended for developers and assumes some familiarity with XML. A high level description of the interaction between these objects is not outlined here.
The OVAL Schema is maintained by The MITRE Corporation and developed by the public OVAL Community. For more information, including how to get involved in the project and how to submit change requests, please visit the OVAL website at http://oval.mitre.org.
The oval_definitions element is the root of an OVAL Definition Document. Its purpose is to bind together the major sections of a document - generator, definitions, tests, objects, states, and variables - which are the children of the root element.
<xsd:element name="oval_definitions"><xsd:annotation><xsd:documentation>The oval_definitions element is the root of an OVAL Definition Document. Its purpose is to bind together the major sections of a document - generator, definitions, tests, objects, states, and variables - which are the children of the root element.</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_empty_def_doc"><sch:rule context="oval-def:oval_definitions"><sch:assert test="oval-def:definitions or oval-def:tests or oval-def:objects or oval-def:states or oval-def:variables">A valid OVAL Definition document must contain at least one definitions, tests, objects, states, or variables element. The optional definitions, tests, objects, states, and variables sections define the specific characteristics that should be evaluated on a system to determine the truth values of the OVAL Definition Document. To be valid though, at least one definitions, tests, objects, states, or variables element must be present.</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:complexType><xsd:sequence><xsd:element name="generator" type="oval:GeneratorType"><xsd:annotation><xsd:documentation>The required generator section provides information about when the definition file was compiled and under what version.</xsd:documentation></xsd:annotation></xsd:element><xsd:element name="definitions" type="oval-def:DefinitionsType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional definitions section contains 1 or more definitions.</xsd:documentation></xsd:annotation></xsd:element><xsd:element name="tests" type="oval-def:TestsType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional tests section contains 1 or more tests.</xsd:documentation></xsd:annotation></xsd:element><xsd:element name="objects" type="oval-def:ObjectsType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional objects section contains 1 or more objects.</xsd:documentation></xsd:annotation></xsd:element><xsd:element name="states" type="oval-def:StatesType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional states section contains 1 or more states.</xsd:documentation></xsd:annotation></xsd:element><xsd:element name="variables" type="oval-def:VariablesType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional variables section contains 1 or more variables.</xsd:documentation></xsd:annotation></xsd:element><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional Signature element allows an XML Signature as defined by the W3C to be attached to the document. This allows authentication and data integrity to be provided to the user. Enveloped signatures are supported. More information about the official W3C Recommendation regarding XML digital signatures can be found at http://www.w3.org/TR/xmldsig-core/.</xsd:documentation></xsd:annotation></xsd:element></xsd:sequence></xsd:complexType><xsd:key name="definitionKey"><xsd:annotation><xsd:documentation>Enforce uniqueness amongst the ids differentiating the individual definition elements.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:definitions/oval-def:definition"/><xsd:field xpath="@id"/></xsd:key><xsd:key name="testKey"><xsd:annotation><xsd:documentation>Enforce uniqueness amongst the ids differentiating the individual test elements.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:tests/*"/><xsd:field xpath="@id"/></xsd:key><xsd:key name="objectKey"><xsd:annotation><xsd:documentation>Enforce uniqueness amongst the ids differentiating the individual object elements.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:objects/*"/><xsd:field xpath="@id"/></xsd:key><xsd:key name="stateKey"><xsd:annotation><xsd:documentation>Enforce uniqueness amongst the ids differentiating the individual state elements.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:states/*"/><xsd:field xpath="@id"/></xsd:key><xsd:key name="variableKey"><xsd:annotation><xsd:documentation>Enforce uniqueness amongst the ids differentiating the individual variable elements.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:variables/*"/><xsd:field xpath="@id"/></xsd:key><xsd:keyref name="extendKeyRef" refer="oval-def:definitionKey"><xsd:annotation><xsd:documentation>Requires each definition reference to refer to a valid definition id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//*"/><xsd:field xpath="@definition_ref"/></xsd:keyref><xsd:keyref name="testKeyRef" refer="oval-def:testKey"><xsd:annotation><xsd:documentation>Requires each test reference to refer to a valid test id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//*"/><xsd:field xpath="@test_ref"/></xsd:keyref><xsd:keyref name="objectKeyRef" refer="oval-def:objectKey"><xsd:annotation><xsd:documentation>Requires each object reference to refer to a valid object id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//*"/><xsd:field xpath="@object_ref"/></xsd:keyref><xsd:keyref name="stateKeyRef" refer="oval-def:stateKey"><xsd:annotation><xsd:documentation>Requires each state reference to refer to a valid state id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//*"/><xsd:field xpath="@state_ref"/></xsd:keyref><xsd:keyref name="variableKeyRef" refer="oval-def:variableKey"><xsd:annotation><xsd:documentation>Requires each variable reference to refer to a valid variable id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//*"/><xsd:field xpath="@var_ref"/></xsd:keyref><xsd:keyref name="object_referenceKeyRef" refer="oval-def:objectKey"><xsd:annotation><xsd:documentation>Require each object reference in a set element to refer to a valid object id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//oval-def:object_reference"/><xsd:field xpath="."/></xsd:keyref><xsd:keyref name="filterKeyRef" refer="oval-def:stateKey"><xsd:annotation><xsd:documentation>Require each filter in a set element to refer to a valid state id.</xsd:documentation></xsd:annotation><xsd:selector xpath=".//oval-def:filter"/><xsd:field xpath="."/></xsd:keyref></xsd:element>
<xsd:element name="generator" type="oval:GeneratorType"><xsd:annotation><xsd:documentation>The required generator section provides information about when the definition file was compiled and under what version.</xsd:documentation></xsd:annotation></xsd:element>
The definition element represents the globally defined element of type DefinitionType. For more information please see the documentation on the DefinitionType.
<xsd:element name="definition" type="oval-def:DefinitionType"><xsd:annotation><xsd:documentation>The definition element represents the globally defined element of type DefinitionType. For more information please see the documentation on the DefinitionType.</xsd:documentation></xsd:annotation></xsd:element>
<xsd:element name="metadata" type="oval-def:MetadataType"><xsd:unique name="UniqueAffectedFamily"><xsd:annotation><xsd:documentation>Each affected element must have a unique family attribute value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:affected"/><xsd:field xpath="@family"/></xsd:unique></xsd:element>
<xsd:element name="affected" type="oval-def:AffectedType" minOccurs="0" maxOccurs="unbounded"><xsd:unique name="UniqueAffectedPlatform"><xsd:annotation><xsd:documentation>Each affected platform element must have a unique value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:platform"/><xsd:field xpath="."/></xsd:unique><xsd:unique name="UniqueAffectedProduct"><xsd:annotation><xsd:documentation>Each affected product element must have a unique value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:product"/><xsd:field xpath="."/></xsd:unique></xsd:element>
The test element is an abstract element that is meant to be extended (via substitution groups) by the individual tests found in the component schemas. An OVAL Test is used to compare an object(s) against a defined state. An actual test element is not valid. The use of this abstract class simplifies the OVAL schema by allowing individual tests to inherit the optional notes child element, and the id and comment attributes from the base TestType. Please refer to the description of the TestType complex type for more information.
<xsd:element name="test" type="oval-def:TestType" abstract="true"><xsd:annotation><xsd:documentation>The test element is an abstract element that is meant to be extended (via substitution groups) by the individual tests found in the component schemas. An OVAL Test is used to compare an object(s) against a defined state. An actual test element is not valid. The use of this abstract class simplifies the OVAL schema by allowing individual tests to inherit the optional notes child element, and the id and comment attributes from the base TestType. Please refer to the description of the TestType complex type for more information.</xsd:documentation></xsd:annotation></xsd:element>
The object element is an abstract element that is meant to be extended (via substitution groups) by the objects found in the component schemas. An actual object element is not valid. The use of this abstract element simplifies the OVAL schema by allowing individual objects to inherit any common elements and attributes from the base ObjectType. Please refer to the description of the ObjectType complex type for more information.
An object is used to identify a set of items to collect. The author of a schema object must define sufficient object entities to allow a user to identify a unique item to be collected.
A simple object typically results in a single file, process, etc being identified. But through the use of pattern matches, sets, and variables, multiple matching items can be identified. The set of items matching the object can then be used by an OVAL test and compared against an OVAL state.
<xsd:element name="object" type="oval-def:ObjectType" abstract="true"><xsd:annotation><xsd:documentation>The object element is an abstract element that is meant to be extended (via substitution groups) by the objects found in the component schemas. An actual object element is not valid. The use of this abstract element simplifies the OVAL schema by allowing individual objects to inherit any common elements and attributes from the base ObjectType. Please refer to the description of the ObjectType complex type for more information.</xsd:documentation><xsd:documentation>An object is used to identify a set of items to collect. The author of a schema object must define sufficient object entities to allow a user to identify a unique item to be collected.</xsd:documentation><xsd:documentation>A simple object typically results in a single file, process, etc being identified. But through the use of pattern matches, sets, and variables, multiple matching items can be identified. The set of items matching the object can then be used by an OVAL test and compared against an OVAL state.</xsd:documentation></xsd:annotation></xsd:element>
<xsd:element name="states" type="oval-def:StatesType" minOccurs="0" maxOccurs="1"><xsd:annotation><xsd:documentation>The optional states section contains 1 or more states.</xsd:documentation></xsd:annotation></xsd:element>
The state element is an abstract element that is meant to be extended (via substitution groups) by the states found in the component schemas. An actual state element is not valid. The use of this abstract class simplifies the OVAL schema by allowing individual states to inherit the optional notes child element, and the id and operator attributes from the base StateType. Please refer to the description of the StateType complex type for more information.
An OVAL State is a collection of one or more characteristics pertaining to a specific object type. The OVAL State is used by an OVAL Test to determine if a unique set of items identified on a system meet certain characteristics.
<xsd:element name="state" type="oval-def:StateType" abstract="true"><xsd:annotation><xsd:documentation>The state element is an abstract element that is meant to be extended (via substitution groups) by the states found in the component schemas. An actual state element is not valid. The use of this abstract class simplifies the OVAL schema by allowing individual states to inherit the optional notes child element, and the id and operator attributes from the base StateType. Please refer to the description of the StateType complex type for more information.</xsd:documentation><xsd:documentation>An OVAL State is a collection of one or more characteristics pertaining to a specific object type. The OVAL State is used by an OVAL Test to determine if a unique set of items identified on a system meet certain characteristics.</xsd:documentation></xsd:annotation></xsd:element>
The variable element is an abstract element that is meant to be extended (via substitution groups) by the different types of variables. An actual variable element is not valid. The different variable types describe different sources for obtaining a value(s) for the variable. There are currently three types of variables; local, external, and constant. Please refer to the description of each one for more specific information. The value(s) of a variable is treated as if it were inserted where referenced. One of the main benefits of variables is that they allow tests to evaluate user-defined policy. For example, an OVAL Test might check to see if a password is at least a certain number of characters long, but this number depends upon the individual policy of the user. To solve this, the test for password length can be written to refer to a variable element that defines the length.
If a variable defines an array of values, any entity that references the variable will evaluate to true depending on the value of the var_check attribute. For example, if an entity 'size' with an operation of 'less than' references a variable that returns five different integers, and the var_check attribute has a value of 'all', then the 'size' entity returns true only if the actual size is less than each of the five integers defined by the variable. If a variable does not return any value, then an error should be reported during OVAL analysis.
<xsd:element name="variable" type="oval-def:VariableType" abstract="true"><xsd:annotation><xsd:documentation>The variable element is an abstract element that is meant to be extended (via substitution groups) by the different types of variables. An actual variable element is not valid. The different variable types describe different sources for obtaining a value(s) for the variable. There are currently three types of variables; local, external, and constant. Please refer to the description of each one for more specific information. The value(s) of a variable is treated as if it were inserted where referenced. One of the main benefits of variables is that they allow tests to evaluate user-defined policy. For example, an OVAL Test might check to see if a password is at least a certain number of characters long, but this number depends upon the individual policy of the user. To solve this, the test for password length can be written to refer to a variable element that defines the length.</xsd:documentation><xsd:documentation>If a variable defines an array of values, any entity that references the variable will evaluate to true depending on the value of the var_check attribute. For example, if an entity 'size' with an operation of 'less than' references a variable that returns five different integers, and the var_check attribute has a value of 'all', then the 'size' entity returns true only if the actual size is less than each of the five integers defined by the variable. If a variable does not return any value, then an error should be reported during OVAL analysis.</xsd:documentation></xsd:annotation></xsd:element>
The set element enables complex objects to be described. It is a recursive element in that each set element can contain additional set elements as children. Each set element defines characteristics that produce a matching unique set of items. This set of items is defined by one or two references to OVAL Objects that provide the criteria needed to collect a set of system items. These items can have one or more filters applied to allow a subset of those items to be specifically included or excluded from the overall set of items.
The set element's object_reference refers to an existing OVAL Object. The set element's filter element provides a reference to an existing OVAL State and includes an optional action attribute. The filter's action attribute allows the author to specify whether matching items should be included or excluded from the overall set. The default filter action is to exclude all matching items. In other words, the filter can be thought of filtering items out by default.
Each filter is applied to the items identified by each OVAL Object before the set_operator is applied. For example, if an object_reference points to an OVAL Object that identifies every file in a certain directory, a filter might be set up to limit the object set to only those files with a size less than 10 KB. If multiple filters are provided, then each filter is applied to the set of items identified by the OVAL Object. Care must be taken to ensure that conflicting filters are not applied. It is possible to exclude all items with a size of 10 KB and then include only items with a size of 10 KB. This example would result in the empty set.
The required set_operator attribute defines how different child sets are combined to form the overall unique set of objects. For example, does one take the union of different sets or the intersection? For a description of the valid values please refer to the SetOperatorEnumeration simple type.
<xsd:element name="set"><xsd:annotation><xsd:documentation>The set element enables complex objects to be described. It is a recursive element in that each set element can contain additional set elements as children. Each set element defines characteristics that produce a matching unique set of items. This set of items is defined by one or two references to OVAL Objects that provide the criteria needed to collect a set of system items. These items can have one or more filters applied to allow a subset of those items to be specifically included or excluded from the overall set of items.</xsd:documentation><xsd:documentation>The set element's object_reference refers to an existing OVAL Object. The set element's filter element provides a reference to an existing OVAL State and includes an optional action attribute. The filter's action attribute allows the author to specify whether matching items should be included or excluded from the overall set. The default filter action is to exclude all matching items. In other words, the filter can be thought of filtering items out by default.</xsd:documentation><xsd:documentation>Each filter is applied to the items identified by each OVAL Object before the set_operator is applied. For example, if an object_reference points to an OVAL Object that identifies every file in a certain directory, a filter might be set up to limit the object set to only those files with a size less than 10 KB. If multiple filters are provided, then each filter is applied to the set of items identified by the OVAL Object. Care must be taken to ensure that conflicting filters are not applied. It is possible to exclude all items with a size of 10 KB and then include only items with a size of 10 KB. This example would result in the empty set.</xsd:documentation><xsd:documentation>The required set_operator attribute defines how different child sets are combined to form the overall unique set of objects. For example, does one take the union of different sets or the intersection? For a description of the valid values please refer to the SetOperatorEnumeration simple type.</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_setobjref"><sch:rule context="oval-def:oval_definitions/oval-def:objects/*/oval-def:set/oval-def:object_reference"><sch:assert test="name(./../..) = name(ancestor::oval-def:oval_definitions/oval-def:objects/*[@id=current()])"><sch:value-of select="../../@id"/>- Each object referenced by the set must be of the same type as parent object</sch:assert></sch:rule><sch:rule context="oval-def:oval_definitions/oval-def:objects/*/oval-def:set/oval-def:set/oval-def:object_reference"><sch:assert test="name(./../../..) = name(ancestor::oval-def:oval_definitions/oval-def:objects/*[@id=current()])"><sch:value-of select="../../../@id"/>- Each object referenced by the set must be of the same type as parent object</sch:assert></sch:rule><sch:rule context="oval-def:oval_definitions/oval-def:objects/*/oval-def:set/oval-def:set/oval-def:set/oval-def:object_reference"><sch:assert test="name(./../../../..) = name(ancestor::oval-def:oval_definitions/oval-def:objects/*[@id=current()])"><sch:value-of select="../../../../@id"/>- Each object referenced by the set must be of the same type as parent object</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:complexType><xsd:choice><xsd:sequence><xsd:element ref="oval-def:set" minOccurs="1" maxOccurs="2"/></xsd:sequence><xsd:sequence><xsd:element name="object_reference" type="oval:ObjectIDPattern" minOccurs="1" maxOccurs="2"/><xsd:element ref="oval-def:filter" minOccurs="0" maxOccurs="unbounded"/></xsd:sequence></xsd:choice><xsd:attribute name="set_operator" type="oval-def:SetOperatorEnumeration" use="optional" default="UNION"/></xsd:complexType></xsd:element>
The filter element provides a reference to an existing OVAL State and includes an optional action attribute. The action attribute is used to specify whether items that match the referenced OVAL State will be included in the resulting set or excluded from the resulting set.
<xsd:element name="filter"><xsd:annotation><xsd:documentation>The filter element provides a reference to an existing OVAL State and includes an optional action attribute. The action attribute is used to specify whether items that match the referenced OVAL State will be included in the resulting set or excluded from the resulting set.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:simpleContent><xsd:extension base="oval:StateIDPattern"><xsd:attribute name="action" type="oval-def:FilterActionEnumeration" use="optional" default="exclude"/></xsd:extension></xsd:simpleContent></xsd:complexType></xsd:element>
The external_variable element extends the VariableType and defines a variable with some external source. The actual value(s) for the variable is not provided within the OVAL file, but rather it is retrieved during the evaluation of the OVAL Definition from an external source. An unbounded set of possible-value and possible_restriction child elements can be specified that together specify the list of all possible values that an external source is allowed to supply for the external variable. In other words, the value assigned by an external source must match one of the possible_value or possible_restriction elements specified. Each possible_value element contains a single value that could be assigned to the given external_variable while each possible_restriction element outlines a range of possible values. Note that it is not necessary to declare a variable's possible values, but the option is available if desired. If no possible child elements are specified, then the valid values are only bound to the specified datatype of the external variable. Please refer to the description of the PossibleValueType and PossibleRestrictionType complex types for more information.
<xsd:element name="external_variable" substitutionGroup="oval-def:variable"><xsd:annotation><xsd:documentation>The external_variable element extends the VariableType and defines a variable with some external source. The actual value(s) for the variable is not provided within the OVAL file, but rather it is retrieved during the evaluation of the OVAL Definition from an external source. An unbounded set of possible-value and possible_restriction child elements can be specified that together specify the list of all possible values that an external source is allowed to supply for the external variable. In other words, the value assigned by an external source must match one of the possible_value or possible_restriction elements specified. Each possible_value element contains a single value that could be assigned to the given external_variable while each possible_restriction element outlines a range of possible values. Note that it is not necessary to declare a variable's possible values, but the option is available if desired. If no possible child elements are specified, then the valid values are only bound to the specified datatype of the external variable. Please refer to the description of the PossibleValueType and PossibleRestrictionType complex types for more information.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="oval-def:VariableType"><xsd:choice minOccurs="0" maxOccurs="unbounded"><xsd:element name="possible_value" type="oval-def:PossibleValueType"/><xsd:element name="possible_restriction" type="oval-def:PossibleRestrictionType"/></xsd:choice></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The constant_variable element extends the VariableType and defines a variable with a constant value(s). Each constant_variable defines either a single value or an array of values to be used throughout the evaluation of the OVAL Definition File in which it has been defined. Constant variables cannot be over-ridden by an external source. The actual value of a constant variable is defined by the required value child element. An array of values can be specified by including multiple instances of the value element. Please refer to the description of the ValueType complex type for more information.
<xsd:element name="constant_variable" substitutionGroup="oval-def:variable"><xsd:annotation><xsd:documentation>The constant_variable element extends the VariableType and defines a variable with a constant value(s). Each constant_variable defines either a single value or an array of values to be used throughout the evaluation of the OVAL Definition File in which it has been defined. Constant variables cannot be over-ridden by an external source. The actual value of a constant variable is defined by the required value child element. An array of values can be specified by including multiple instances of the value element. Please refer to the description of the ValueType complex type for more information.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="oval-def:VariableType"><xsd:sequence><xsd:element name="value" type="oval-def:ValueType" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The local_variable element extends the VariableType and defines a variable with some local source. The actual value(s) for the variable is not provided in the OVAL Definition document but rather it is retrieved during the evaluation of the OVAL Definition. Each local variable is defined by either a single component or a complex function, meaning that a value can be as simple as a literal string or as complex as multiple registry keys concatenated together. Note that if an individual component is used and it returns multiple values, then there will be multiple values associated with the local_variable. For example, if an object_component is used and it references a file object that identifies a set of 5 files, then the local variable would represent these 5 values. Please refer to the description of the ComponentGroup for more information.
<xsd:element name="local_variable" substitutionGroup="oval-def:variable"><xsd:annotation><xsd:documentation>The local_variable element extends the VariableType and defines a variable with some local source. The actual value(s) for the variable is not provided in the OVAL Definition document but rather it is retrieved during the evaluation of the OVAL Definition. Each local variable is defined by either a single component or a complex function, meaning that a value can be as simple as a literal string or as complex as multiple registry keys concatenated together. Note that if an individual component is used and it returns multiple values, then there will be multiple values associated with the local_variable. For example, if an object_component is used and it references a file object that identifies a set of 5 files, then the local variable would represent these 5 values. Please refer to the description of the ComponentGroup for more information.</xsd:documentation></xsd:annotation><xsd:complexType><xsd:complexContent><xsd:extension base="oval-def:VariableType"><xsd:sequence><xsd:group ref="oval-def:ComponentGroup"/></xsd:sequence></xsd:extension></xsd:complexContent></xsd:complexType></xsd:element>
The optional datatype attribute specifies how the given operation should be applied to the data. Since we are dealing with XML everything is technically a string, but often the value is meant to represent some other datatype and this affects the way an operation is performed. For example, with the statement 'is 123 less than 98'. If the data is treated as integers the answer is no, but if the data is treated as strings, then the answer is yes. Specifying a datatype defines how the less than operation should be performed. Another way of thinking of things is that the datatype attribute specifies how the data should be cast before performing the operation (note that the default datatype is 'string'). In the previous example, if the datatype is set to int, then '123' and '98' should be cast as integers. Another example is applying the 'equals' operation to '1.0.0.0' and '1.0'. With datatype 'string' they are not equal, with datatype 'version' they are. Note that there are certain cases where a cast from one datatype to another is not possible. If a cast cannot be made, (trying to cast 'abc' to an integer) then an error should be reported. For example, if the datatype is set to 'integer' and the value is the empty string. There is no way to cast the empty string (or NULL) to an integer, and in cases like this an error should be reported.
The optional mask attribute is used to identify values that have been hidden for sensitivity concerns. This is used by the result file which uses the system characteristic schema to format the information found on a specific system. If the mask attribute is set to 'true', then the observed value of this field must not be presented in the results file. A system characteristics file that is not held within a results file must not use the mask attribute. It is possible for masking conflicts to occur where one entity has mask set to true and another entity has mask set to false. A conflict will occur when the mask attribute is set differently on an OVAL Object and matching OVAL State or when more than one OVAL Objects identify the same OVAL Item(s). When such a conflict occurs the result is always to mask the entity.
The optional var_check attribute specifies how data collection or state evaluation should proceed when an element uses a var_ref attribute, and the associated variable defines more than one value. For example, if an object entity 'filename' with an operation of 'not equal' references a variable that returns five different values, and the var_check attribute has a value of 'all', then an actual file on the system matches only if the actual filename does not equal any of the variable values. As another example, if a state entity 'size' with an operation of 'less than' references a variable that has five different integer values, and the var_check attribute has a value of 'all', then the 'size' state entity evaluates to true only if the corresponding 'size' item entity is less than each of the five integers defined by the variable. If a variable does not have any value value when referenced by an OVAL Object the object should be considered to not exist. If a variable does not have any value when referenced by an OVAL State an error should be reported during OVAL analysis. When an OVAL State uses a var_ref, if both the state entity and a corresponding item entity have multiple values, the var_check is applied to each value of the item entity individually, and all must evaluate to true for the state entity to evaluate to true. In this condition, there is no value of var_check which enables an element-wise comparison, and so there is no way to determine whether two multi-valued entities are truly 'equal' in that sense. If var_ref is present but var_check is not, the element should be processed as if var_check has the value "all".
The optional var_ref attribute refers the value of the element to a variable element. When supplied, the value(s) associated with the OVAL Variable should be used as the value(s) of the element. If there is an error computing the value of the variable, then that error should be passed up to the element referencing it. If the variable being referenced does not have a value (for example, if the variable pertains to the size of a file, but the file does not exist) then one of two results are possible. If the element is part of an object declaration, then the object element referencing it is considered to not exist. If the element is part of a state declaration, then the state element referencing it will evaluate to error.
The optional datatype attribute specifies how the given operation should be applied to the data. Since we are dealing with XML everything is technically a string, but often the value is meant to represent some other datatype and this affects the way an operation is performed. For example, with the statement 'is 123 less than 98'. If the data is treated as integers the answer is no, but if the data is treated as strings, then the answer is yes. Specifying a datatype defines how the less than operation should be performed. Another way of thinking of things is that the datatype attribute specifies how the data should be cast before performing the operation (note that the default datatype is 'string'). In the previous example, if the datatype is set to int, then '123' and '98' should be cast as integers. Another example is applying the 'equals' operation to '1.0.0.0' and '1.0'. With datatype 'string' they are not equal, with datatype 'version' they are. Note that there are certain cases where a cast from one datatype to another is not possible. If a cast cannot be made, (trying to cast 'abc' to an integer) then an error should be reported. For example, if the datatype is set to 'integer' and the value is the empty string. There is no way to cast the empty string (or NULL) to an integer, and in cases like this an error should be reported.
The optional mask attribute is used to identify values that have been hidden for sensitivity concerns. This is used by the result file which uses the system characteristic schema to format the information found on a specific system. If the mask attribute is set to 'true', then the observed value of this field must not be presented in the results file. A system characteristics file that is not held within a results file must not use the mask attribute. It is possible for masking conflicts to occur where one entity has mask set to true and another entity has mask set to false. A conflict will occur when the mask attribute is set differently on an OVAL Object and matching OVAL State or when more than one OVAL Objects identify the same OVAL Item(s). When such a conflict occurs the result is always to mask the entity.
The optional var_check attribute specifies how data collection or state evaluation should proceed when an element uses a var_ref attribute, and the associated variable defines more than one value. For example, if an object entity 'filename' with an operation of 'not equal' references a variable that returns five different values, and the var_check attribute has a value of 'all', then an actual file on the system matches only if the actual filename does not equal any of the variable values. As another example, if a state entity 'size' with an operation of 'less than' references a variable that has five different integer values, and the var_check attribute has a value of 'all', then the 'size' state entity evaluates to true only if the corresponding 'size' item entity is less than each of the five integers defined by the variable. If a variable does not have any value value when referenced by an OVAL Object the object should be considered to not exist. If a variable does not have any value when referenced by an OVAL State an error should be reported during OVAL analysis. When an OVAL State uses a var_ref, if both the state entity and a corresponding item entity have multiple values, the var_check is applied to each value of the item entity individually, and all must evaluate to true for the state entity to evaluate to true. In this condition, there is no value of var_check which enables an element-wise comparison, and so there is no way to determine whether two multi-valued entities are truly 'equal' in that sense. If var_ref is present but var_check is not, the element should be processed as if var_check has the value "all".
The optional var_ref attribute refers the value of the element to a variable element. When supplied, the value(s) associated with the OVAL Variable should be used as the value(s) of the element. If there is an error computing the value of the variable, then that error should be passed up to the element referencing it. If the variable being referenced does not have a value (for example, if the variable pertains to the size of a file, but the file does not exist) then one of two results are possible. If the element is part of an object declaration, then the object element referencing it is considered to not exist. If the element is part of a state declaration, then the state element referencing it will evaluate to error.
The DefinitionsType complex type is a container for one or more definition elements. Each definition element describes a single OVAL Definition. Please refer to the description of the DefinitionType for more information about an individual definition.
<xsd:complexType name="DefinitionsType"><xsd:annotation><xsd:documentation>The DefinitionsType complex type is a container for one or more definition elements. Each definition element describes a single OVAL Definition. Please refer to the description of the DefinitionType for more information about an individual definition.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="oval-def:definition" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The DefinitionType defines a single OVAL Definition. A definition is the key structure in OVAL. It is analogous to the logical sentence or proposition: if a computer's state matches the configuration parameters laid out in the criteria, then that computer exhibits the state described. The DefinitionType contains a section for various metadata related elements that describe the definition. This includes a description, version, affected system types, and reference information. The notes section of a definition should be used to hold information that might be helpful to someone examining the technical aspects of the definition. For example, why certain tests have been included in the criteria, or maybe a link to where further information can be found. The DefinitionType also (unless the definition is deprecated) contains a criteria child element that joins individual tests together with a logical operator to specify the specific computer state being described.
The required id attribute is the OVAL-ID of the Definition. The form of an OVAL-ID must follow the specific format described by the oval:DefinitionIDPattern. The required version attribute holds the current version of the definition. Versions are integers, starting at 1 and incrementing every time a definition is modified. The required class attribute indicates the specific class to which the definition belongs. The class gives a hint to a user so they can know what the definition writer is trying to say. See the definition of oval-def:ClassEnumeration for more information about the different valid classes. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.
When the deprecated attribute is set to true, the definition is considered to be deprecated. The criteria child element of a deprecated definition is optional. If a deprecated definition does not contain a criteria child element, the definition must evaluate to "not evaluated". If a deprecated definition contains a criteria child element, an interpreter should evaluate the definition as if it were not deprecated, but an interpreter may evaluate the definition to "not evaluated".
<xsd:complexType name="DefinitionType"><xsd:annotation><xsd:documentation>The DefinitionType defines a single OVAL Definition. A definition is the key structure in OVAL. It is analogous to the logical sentence or proposition: if a computer's state matches the configuration parameters laid out in the criteria, then that computer exhibits the state described. The DefinitionType contains a section for various metadata related elements that describe the definition. This includes a description, version, affected system types, and reference information. The notes section of a definition should be used to hold information that might be helpful to someone examining the technical aspects of the definition. For example, why certain tests have been included in the criteria, or maybe a link to where further information can be found. The DefinitionType also (unless the definition is deprecated) contains a criteria child element that joins individual tests together with a logical operator to specify the specific computer state being described.</xsd:documentation><xsd:documentation>The required id attribute is the OVAL-ID of the Definition. The form of an OVAL-ID must follow the specific format described by the oval:DefinitionIDPattern. The required version attribute holds the current version of the definition. Versions are integers, starting at 1 and incrementing every time a definition is modified. The required class attribute indicates the specific class to which the definition belongs. The class gives a hint to a user so they can know what the definition writer is trying to say. See the definition of oval-def:ClassEnumeration for more information about the different valid classes. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.</xsd:documentation><xsd:documentation>When the deprecated attribute is set to true, the definition is considered to be deprecated. The criteria child element of a deprecated definition is optional. If a deprecated definition does not contain a criteria child element, the definition must evaluate to "not evaluated". If a deprecated definition contains a criteria child element, an interpreter should evaluate the definition as if it were not deprecated, but an interpreter may evaluate the definition to "not evaluated".</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_required_criteria"><sch:rule context="oval-def:oval_definitions/oval-def:definitions/oval-def:definition[(@deprecated='false' or @deprecated='0') or not(@deprecated)]"><sch:assert test="oval-def:criteria">A valid OVAL Definition must contain a criteria unless the definition is a deprecated definition.</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:sequence><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"/><xsd:element name="metadata" type="oval-def:MetadataType"><xsd:unique name="UniqueAffectedFamily"><xsd:annotation><xsd:documentation>Each affected element must have a unique family attribute value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:affected"/><xsd:field xpath="@family"/></xsd:unique></xsd:element><xsd:element name="notes" type="oval-def:NotesType" minOccurs="0" maxOccurs="1"/><xsd:element name="criteria" type="oval-def:CriteriaType" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="id" type="oval:DefinitionIDPattern" use="required"/><xsd:attribute name="version" type="xsd:nonNegativeInteger" use="required"/><xsd:attribute name="class" type="oval:ClassEnumeration" use="required"/><xsd:attribute name="deprecated" type="xsd:boolean" use="optional" default="false"/></xsd:complexType>
The MetadataType complex type contains all the metadata available to an OVAL Definition. This metadata is for informational purposes only and is not part of the criteria used to evaluate machine state. The required title child element holds a short string that is used to quickly identify the definition to a human user. The affected metadata item contains information about the system(s) for which the definition has been written. Remember that this is just metadata and not part of the criteria. Please refer to the AffectedType description for more information. The required description element contains a textual description of the configuration state being addressed by the OVAL Definition. In the case of a definition from the vulnerability class, the reference is usually the Common Vulnerability and Exposures (CVE) Identifier, and this description field corresponds with the CVE description.
Additional metadata is also allowed although it is not part of the official OVAL Schema. Individual organizations can place metadata items that they feel are important and these will be skipped during the validation. All OVAL really cares about is that the stated metadata items are there.
<xsd:complexType name="MetadataType"><xsd:annotation><xsd:documentation>The MetadataType complex type contains all the metadata available to an OVAL Definition. This metadata is for informational purposes only and is not part of the criteria used to evaluate machine state. The required title child element holds a short string that is used to quickly identify the definition to a human user. The affected metadata item contains information about the system(s) for which the definition has been written. Remember that this is just metadata and not part of the criteria. Please refer to the AffectedType description for more information. The required description element contains a textual description of the configuration state being addressed by the OVAL Definition. In the case of a definition from the vulnerability class, the reference is usually the Common Vulnerability and Exposures (CVE) Identifier, and this description field corresponds with the CVE description.</xsd:documentation><xsd:documentation>Additional metadata is also allowed although it is not part of the official OVAL Schema. Individual organizations can place metadata items that they feel are important and these will be skipped during the validation. All OVAL really cares about is that the stated metadata items are there.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="title" type="xsd:string"/><xsd:element name="affected" type="oval-def:AffectedType" minOccurs="0" maxOccurs="unbounded"><xsd:unique name="UniqueAffectedPlatform"><xsd:annotation><xsd:documentation>Each affected platform element must have a unique value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:platform"/><xsd:field xpath="."/></xsd:unique><xsd:unique name="UniqueAffectedProduct"><xsd:annotation><xsd:documentation>Each affected product element must have a unique value.</xsd:documentation></xsd:annotation><xsd:selector xpath="oval-def:product"/><xsd:field xpath="."/></xsd:unique></xsd:element><xsd:element name="reference" type="oval-def:ReferenceType" minOccurs="0" maxOccurs="unbounded"/><xsd:element name="description" type="xsd:string"/><xsd:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/><!-- For the next major release of OVAL, the xsd:any tag above will be modified to
only allow elements from namespaces other than the default namespace. This
fixes a bug in the current schema where the affected or reference element can
appear after the description element and still produce a vailid document.
<xsd:any minOccurs="0" maxOccurs="unbounded" namespace="##other" processContents="lax"/>
--></xsd:sequence></xsd:complexType>
Each OVAL Definition is written to evaluate a certain type of system(s). The family, platform(s), and product(s) of this target are described by the AffectedType whose main purpose is to provide hints for tools using OVAL Definitions. For instance, to help a reporting tool only use Windows definitions, or to preselect only Red Hat definitions to be evaluated. Note, the inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section.
The AffectedType complex type details the specific system, application, subsystem, library, etc. for which a definition has been written. If a definition is not tied to a specific product, then this element should not be included. The absence of the platform or product element can be thought of as definition applying to all platforms or products. The inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section. To increase the utility of this element, care should be taken when assigning and using strings for product names. The schema places no restrictions on the values that can be assigned, potentially leading to many different representations of the same value. For example, 'Internet Explorer' and 'IE' might be used to refer to the same product. The current convention is to fully spell out all terms, and avoid the use of abbreviations at all costs.
Please note that the AffectedType will change in future versions of OVAL in order to support the Common Platform Enumeration (CPE).
<xsd:complexType name="AffectedType"><xsd:annotation><xsd:documentation>Each OVAL Definition is written to evaluate a certain type of system(s). The family, platform(s), and product(s) of this target are described by the AffectedType whose main purpose is to provide hints for tools using OVAL Definitions. For instance, to help a reporting tool only use Windows definitions, or to preselect only Red Hat definitions to be evaluated. Note, the inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section.</xsd:documentation><xsd:documentation>The AffectedType complex type details the specific system, application, subsystem, library, etc. for which a definition has been written. If a definition is not tied to a specific product, then this element should not be included. The absence of the platform or product element can be thought of as definition applying to all platforms or products. The inclusion of a particular platform or product does not mean the definition is physically checking for the existence of the platform or product. For the actual test to be performed, the correct test must still be included in the definition's criteria section. To increase the utility of this element, care should be taken when assigning and using strings for product names. The schema places no restrictions on the values that can be assigned, potentially leading to many different representations of the same value. For example, 'Internet Explorer' and 'IE' might be used to refer to the same product. The current convention is to fully spell out all terms, and avoid the use of abbreviations at all costs.</xsd:documentation><xsd:documentation>Please note that the AffectedType will change in future versions of OVAL in order to support the Common Platform Enumeration (CPE).</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="platform" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/><xsd:element name="product" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/></xsd:sequence><xsd:attribute name="family" type="oval:FamilyEnumeration" use="required"/></xsd:complexType>
The ReferenceType complex type links the OVAL Definition to a definitive external reference. For example, CVE Identifiers are used for referencing vulnerabilities. The intended purpose for this reference is to link the definition to a variety of other sources that address the same issue being specified by the OVAL Definition.
The required source attribute specifies where the reference is coming from. In other words, it identifies the reference repository being used. The required ref_id attribute is the external id of the reference. The optional ref_url attribute is the URL to the reference.
<xsd:complexType name="ReferenceType"><xsd:annotation><xsd:documentation>The ReferenceType complex type links the OVAL Definition to a definitive external reference. For example, CVE Identifiers are used for referencing vulnerabilities. The intended purpose for this reference is to link the definition to a variety of other sources that address the same issue being specified by the OVAL Definition.</xsd:documentation><xsd:documentation>The required source attribute specifies where the reference is coming from. In other words, it identifies the reference repository being used. The required ref_id attribute is the external id of the reference. The optional ref_url attribute is the URL to the reference.</xsd:documentation></xsd:annotation><xsd:attribute name="source" type="xsd:string" use="required"/><xsd:attribute name="ref_id" type="xsd:string" use="required"/><xsd:attribute name="ref_url" type="xsd:anyURI" use="optional"/></xsd:complexType>
The NotesType complex type is a container for one or more note child elements. Each note contains some information about the definition or tests that it references. A note may record an unresolved question about the definition or test or present the reason as to why a particular approach was taken.
<xsd:complexType name="NotesType"><xsd:annotation><xsd:documentation>The NotesType complex type is a container for one or more note child elements. Each note contains some information about the definition or tests that it references. A note may record an unresolved question about the definition or test or present the reason as to why a particular approach was taken.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="note" type="xsd:string" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The CriteriaType complex type describes a container for a set of sub criteria, criteria, criterion, or extend_definition elements allowing complex logical trees to be constructed. Each referenced test is represented by a criterion element. Please refer to the description of the CriterionType for more information about and individual criterion element. The optional extend_definition element allows existing definitions to be included in the criteria. Refer to the description of the ExtendDefinitionType for more information.
The required operator attribute provides the logical operator that binds the different statements inside a criteria together. The optional negate attribute signifies that the result of the criteria as a whole should be negated during analysis. For example, consider a criteria that evaluates to TRUE if certain software is installed. By negating this test, it now evaluates to TRUE if the software is NOT installed. The optional comment attribute provides a short description of the criteria.
The optional applicability_check attribute provides a Boolean flag that when true indicates that the criteria is being used to determine whether the OVAL Definition applies to a given system.
<xsd:complexType name="CriteriaType"><xsd:annotation><xsd:documentation>The CriteriaType complex type describes a container for a set of sub criteria, criteria, criterion, or extend_definition elements allowing complex logical trees to be constructed. Each referenced test is represented by a criterion element. Please refer to the description of the CriterionType for more information about and individual criterion element. The optional extend_definition element allows existing definitions to be included in the criteria. Refer to the description of the ExtendDefinitionType for more information.</xsd:documentation><xsd:documentation>The required operator attribute provides the logical operator that binds the different statements inside a criteria together. The optional negate attribute signifies that the result of the criteria as a whole should be negated during analysis. For example, consider a criteria that evaluates to TRUE if certain software is installed. By negating this test, it now evaluates to TRUE if the software is NOT installed. The optional comment attribute provides a short description of the criteria.</xsd:documentation><xsd:documentation>The optional applicability_check attribute provides a Boolean flag that when true indicates that the criteria is being used to determine whether the OVAL Definition applies to a given system.</xsd:documentation></xsd:annotation><xsd:choice minOccurs="1" maxOccurs="unbounded"><xsd:element name="criteria" type="oval-def:CriteriaType"/><xsd:element name="criterion" type="oval-def:CriterionType"/><xsd:element name="extend_definition" type="oval-def:ExtendDefinitionType"/></xsd:choice><xsd:attribute name="applicability_check" type="xsd:boolean" use="optional"/><xsd:attribute name="operator" type="oval:OperatorEnumeration" use="optional" default="AND"/><xsd:attribute name="negate" type="xsd:boolean" use="optional" default="false"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="optional"/></xsd:complexType>
The CriterionType complex type identifies a specific test to be included in the definition's criteria.
The required test_ref attribute is the actual id of the test being referenced. The optional negate attribute signifies that the result of an individual test should be negated during analysis. For example, consider a test that evaluates to TRUE if a specific patch is installed. By negating this test, it now evaluates to TRUE if the patch is NOT installed. The optional comment attribute provides a short description of the specified test and should mirror the comment attribute of the actual test.
The optional applicability_check attribute provides a Boolean flag that when true indicates that the criterion is being used to determine whether the OVAL Definition applies to a given system.
<xsd:complexType name="CriterionType"><xsd:annotation><xsd:documentation>The CriterionType complex type identifies a specific test to be included in the definition's criteria.</xsd:documentation><xsd:documentation>The required test_ref attribute is the actual id of the test being referenced. The optional negate attribute signifies that the result of an individual test should be negated during analysis. For example, consider a test that evaluates to TRUE if a specific patch is installed. By negating this test, it now evaluates to TRUE if the patch is NOT installed. The optional comment attribute provides a short description of the specified test and should mirror the comment attribute of the actual test.</xsd:documentation><xsd:documentation>The optional applicability_check attribute provides a Boolean flag that when true indicates that the criterion is being used to determine whether the OVAL Definition applies to a given system.</xsd:documentation></xsd:annotation><xsd:attribute name="applicability_check" type="xsd:boolean" use="optional"/><xsd:attribute name="test_ref" type="oval:TestIDPattern" use="required"/><xsd:attribute name="negate" type="xsd:boolean" use="optional" default="false"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="optional"/></xsd:complexType>
The ExtendDefinitionType complex type allows existing definitions to be extended by another definition. This works by evaluating the extended definition and then using the result within the logical context of the extending definition.
The required definition_ref attribute is the actual id of the definition being extended. The optional negate attribute signifies that the result of an extended definition should be negated during analysis. For example, consider a definition that evaluates TRUE if certainsoftware is installed. By negating the definition, it now evaluates to TRUE if the software is NOT installed. The optional comment attribute provides a short description of the specified definition and should mirror the title metadata of the extended definition.
The optional applicability_check attribute provides a Boolean flag that when true indicates that the extend_definition is being used to determine whether the OVAL Definition applies to a given system.
<xsd:complexType name="ExtendDefinitionType"><xsd:annotation><xsd:documentation>The ExtendDefinitionType complex type allows existing definitions to be extended by another definition. This works by evaluating the extended definition and then using the result within the logical context of the extending definition.</xsd:documentation><xsd:documentation>The required definition_ref attribute is the actual id of the definition being extended. The optional negate attribute signifies that the result of an extended definition should be negated during analysis. For example, consider a definition that evaluates TRUE if certainsoftware is installed. By negating the definition, it now evaluates to TRUE if the software is NOT installed. The optional comment attribute provides a short description of the specified definition and should mirror the title metadata of the extended definition.</xsd:documentation><xsd:documentation>The optional applicability_check attribute provides a Boolean flag that when true indicates that the extend_definition is being used to determine whether the OVAL Definition applies to a given system.</xsd:documentation></xsd:annotation><xsd:attribute name="applicability_check" type="xsd:boolean" use="optional"/><xsd:attribute name="definition_ref" type="oval:DefinitionIDPattern" use="required"/><xsd:attribute name="negate" type="xsd:boolean" use="optional" default="false"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="optional"/></xsd:complexType>
The TestsType complex type is a container for one or more test child elements. Each test element describes a single OVAL Test. Please refer to the description of the TestType for more information about an individual test.
<xsd:complexType name="TestsType"><xsd:annotation><xsd:documentation>The TestsType complex type is a container for one or more test child elements. Each test element describes a single OVAL Test. Please refer to the description of the TestType for more information about an individual test.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="oval-def:test" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The base type of every test includes an optional notes element and several attributes. The notes section of a test should be used to hold information that might be helpful to someone examining the technical aspects of the test. For example, why certain values have been used by the test, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element. The required comment attribute provides a short description of the test. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.
The required id attribute uniquely identifies each test, and must conform to the format specified by the TestIdPattern simple type. The required version attribute holds the current version of the test. Versions are integers, starting at 1 and incrementing every time a test is modified.
The optional check_existence attribute specifies how many items in the set defined by the OVAL Object must exist for the test to evaluate to true. The default value for this attribute is 'at_least_one_exists' indicating that by default the test may evaluate to true if at least one item defined by the OVAL Object exists on the system. For example, if a value of 'all_exist' is given, every item defined by the OVAL Object must exist on the system for the test to evaluate to true. If the OVAL Object uses a variable reference, then every value of that variable must exist. Note that a pattern match defines a unique set of matching items found on a system. So when check_existence = 'all_exist' and a regex matches anything on a system the test will evaluate to true (since all matching objects on the system were found on the system). When check_existence = 'all_exist' and a regex does not match anything on a system the test will evaluate to false.
The required check attribute specifies how many items in the set defined by the OVAL Object (ignoring items with a status of Does Not Exist) must satisfy the state requirements. For example, should the test check that all matching files have a specified version or that at least one file has the specified version? The valid check values are explained in the description of the CheckEnumeration simple type. Note that if the test does not contain any references to OVAL States, then the check attribute has no meaning and can be ignored during evaluation.
An OVAL Test evaluates to true if both the check_existence and check attributes are satisfied during evaluation. The evaluation result for a test is determined by first evaluating the check_existence attribute. If the result of evaluating the check_existence attribute is true then the check attribute is evaluated. An interpreter may choose to always evaluate both the check_existence and the check attributes, but once the check_existence attribute evaluation has resulted in false the overall test result after evaluating the check attribute will not be affected.
The optional state_operator attribute provides the logical operator that combines the evaluation results from each referenced state on a per item basis. Each matching item is compared to each referenced state. The result of comparing each state to a single item is combined based on the specified state_operator value to determine one result for each item. Finally, the results for each item are combined based on the specified check value. Note that if the test does not contain any references to OVAL States, then the state_operator attribute has no meaning and can be ignored during evaluation. Referencing multiple states in one test allows ranges of possible values to be expressed. For example, one state can check that a value greater than 8 is found and another state can check that a value of less than 16 is found. In this example the referenced states are combined with a state_operator = 'AND' indicating that the conditions of all referenced states must be satisfied and that the value must be between 8 AND 16. The valid state_operation values are explained in the description of the OperatorEnumeration simple type.
<xsd:complexType name="TestType"><xsd:annotation><xsd:documentation>The base type of every test includes an optional notes element and several attributes. The notes section of a test should be used to hold information that might be helpful to someone examining the technical aspects of the test. For example, why certain values have been used by the test, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element. The required comment attribute provides a short description of the test. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.</xsd:documentation><xsd:documentation>The required id attribute uniquely identifies each test, and must conform to the format specified by the TestIdPattern simple type. The required version attribute holds the current version of the test. Versions are integers, starting at 1 and incrementing every time a test is modified.</xsd:documentation><xsd:documentation>The optional check_existence attribute specifies how many items in the set defined by the OVAL Object must exist for the test to evaluate to true. The default value for this attribute is 'at_least_one_exists' indicating that by default the test may evaluate to true if at least one item defined by the OVAL Object exists on the system. For example, if a value of 'all_exist' is given, every item defined by the OVAL Object must exist on the system for the test to evaluate to true. If the OVAL Object uses a variable reference, then every value of that variable must exist. Note that a pattern match defines a unique set of matching items found on a system. So when check_existence = 'all_exist' and a regex matches anything on a system the test will evaluate to true (since all matching objects on the system were found on the system). When check_existence = 'all_exist' and a regex does not match anything on a system the test will evaluate to false.</xsd:documentation><xsd:documentation>The required check attribute specifies how many items in the set defined by the OVAL Object (ignoring items with a status of Does Not Exist) must satisfy the state requirements. For example, should the test check that all matching files have a specified version or that at least one file has the specified version? The valid check values are explained in the description of the CheckEnumeration simple type. Note that if the test does not contain any references to OVAL States, then the check attribute has no meaning and can be ignored during evaluation.</xsd:documentation><xsd:documentation>An OVAL Test evaluates to true if both the check_existence and check attributes are satisfied during evaluation. The evaluation result for a test is determined by first evaluating the check_existence attribute. If the result of evaluating the check_existence attribute is true then the check attribute is evaluated. An interpreter may choose to always evaluate both the check_existence and the check attributes, but once the check_existence attribute evaluation has resulted in false the overall test result after evaluating the check attribute will not be affected.</xsd:documentation><xsd:documentation>The optional state_operator attribute provides the logical operator that combines the evaluation results from each referenced state on a per item basis. Each matching item is compared to each referenced state. The result of comparing each state to a single item is combined based on the specified state_operator value to determine one result for each item. Finally, the results for each item are combined based on the specified check value. Note that if the test does not contain any references to OVAL States, then the state_operator attribute has no meaning and can be ignored during evaluation. Referencing multiple states in one test allows ranges of possible values to be expressed. For example, one state can check that a value greater than 8 is found and another state can check that a value of less than 16 is found. In this example the referenced states are combined with a state_operator = 'AND' indicating that the conditions of all referenced states must be satisfied and that the value must be between 8 AND 16. The valid state_operation values are explained in the description of the OperatorEnumeration simple type.</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_test_type"><sch:rule context="oval-def:oval_definitions/oval-def:tests/*[@check_existence='none_exist']"><sch:assert test="not(*[local-name()='state'])"><sch:value-of select="@id"/>- No state should be referenced when check_existence has a value of 'none_exist'.</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:sequence><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"/><xsd:element name="notes" type="oval-def:NotesType" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="id" type="oval:TestIDPattern" use="required"/><xsd:attribute name="version" type="xsd:nonNegativeInteger" use="required"/><xsd:attribute name="check_existence" type="oval:ExistenceEnumeration" use="optional" default="at_least_one_exists"/><xsd:attribute name="check" type="oval:CheckEnumeration" use="required"/><xsd:attribute name="state_operator" type="oval:OperatorEnumeration" use="optional" default="AND"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="required"/><xsd:attribute name="deprecated" type="xsd:boolean" use="optional" default="false"/></xsd:complexType>
The ObjectsType complex type is a container for one or more object child elements. Each object element provides details that define a unique set of matching items to be used by an OVAL Test. Please refer to the description of the object element for more information about an individual object.
<xsd:complexType name="ObjectsType"><xsd:annotation><xsd:documentation>The ObjectsType complex type is a container for one or more object child elements. Each object element provides details that define a unique set of matching items to be used by an OVAL Test. Please refer to the description of the object element for more information about an individual object.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="oval-def:object" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The base type of every object includes an optional notes element. The notes element of an object should be used to hold information that might be helpful to someone examining the technical aspects of the object. For example, why certain values have been used, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element.
The required id attribute uniquely identifies each object, and must conform to the format specified by the ObjectIdPattern simple type. The required version attribute holds the current version of the object element. Versions are integers, starting at 1 and incrementing every time an object is modified. The optional comment attribute provides a short description of the object. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.
<xsd:complexType name="ObjectType"><xsd:annotation><xsd:documentation>The base type of every object includes an optional notes element. The notes element of an object should be used to hold information that might be helpful to someone examining the technical aspects of the object. For example, why certain values have been used, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element.</xsd:documentation><xsd:documentation>The required id attribute uniquely identifies each object, and must conform to the format specified by the ObjectIdPattern simple type. The required version attribute holds the current version of the object element. Versions are integers, starting at 1 and incrementing every time an object is modified. The optional comment attribute provides a short description of the object. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"/><xsd:element name="notes" type="oval-def:NotesType" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="id" type="oval:ObjectIDPattern" use="required"/><xsd:attribute name="version" type="xsd:nonNegativeInteger" use="required"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="optional"/><xsd:attribute name="deprecated" type="xsd:boolean" use="optional" default="false"/></xsd:complexType>
The StatesType complex type is a container for one or more state child elements. Each state provides details about specific characteristics that can be used during an evaluation of an object. Please refer to the description of the state element for more information about an individual state.
<xsd:complexType name="StatesType"><xsd:annotation><xsd:documentation>The StatesType complex type is a container for one or more state child elements. Each state provides details about specific characteristics that can be used during an evaluation of an object. Please refer to the description of the state element for more information about an individual state.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="oval-def:state" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The base type of every state includes an optional notes element and two attributes. The notes section of a state should be used to hold information that might be helpful to someone examining the technical aspects of the state. For example, why certain values have been used by the state, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element.
The required id attribute uniquely identifies each state, and must conform to the format specified by the StateIdPattern simple type. The required version attribute holds the current version of the state. Versions are integers, starting at 1 and incrementing every time a state is modified. The required operator attribute provides the logical operator that binds the different characteristics inside a state together. The optional comment attribute provides a short description of the state. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.
When evaluating a particular state against an object, one should evaluate each individual entity separately. The individual results are then combined by the operator to produce an overall result. This process holds true even when there are multiple instances of the same entity. Evaluate each instance separately, taking the entity check attribute into account, and then combine everything using the operator.
<xsd:complexType name="StateType"><xsd:annotation><xsd:documentation>The base type of every state includes an optional notes element and two attributes. The notes section of a state should be used to hold information that might be helpful to someone examining the technical aspects of the state. For example, why certain values have been used by the state, or maybe a link to where further information can be found. Please refer to the description of the NotesType complex type for more information about the notes element.</xsd:documentation><xsd:documentation>The required id attribute uniquely identifies each state, and must conform to the format specified by the StateIdPattern simple type. The required version attribute holds the current version of the state. Versions are integers, starting at 1 and incrementing every time a state is modified. The required operator attribute provides the logical operator that binds the different characteristics inside a state together. The optional comment attribute provides a short description of the state. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.</xsd:documentation><xsd:documentation>When evaluating a particular state against an object, one should evaluate each individual entity separately. The individual results are then combined by the operator to produce an overall result. This process holds true even when there are multiple instances of the same entity. Evaluate each instance separately, taking the entity check attribute into account, and then combine everything using the operator.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"/><xsd:element name="notes" type="oval-def:NotesType" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="id" type="oval:StateIDPattern" use="required"/><xsd:attribute name="version" type="xsd:nonNegativeInteger" use="required"/><xsd:attribute name="operator" type="oval:OperatorEnumeration" use="optional" default="AND"/><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="optional"/><xsd:attribute name="deprecated" type="xsd:boolean" use="optional" default="false"/></xsd:complexType>
The VariablesType complex type is a container for one or more variable child elements. Each variable element is a way to define one or more values to be obtained at the time a definition is evaluated.
<xsd:complexType name="VariablesType"><xsd:annotation><xsd:documentation>The VariablesType complex type is a container for one or more variable child elements. Each variable element is a way to define one or more values to be obtained at the time a definition is evaluated.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="oval-def:variable" minOccurs="1" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
The VariableType complex type defines attributes associated with each OVAL Variable. The required id attribute uniquely identifies each variable, and must conform to the format specified by the VariableIDPattern simple type. The required version attribute holds the current version of the variable. Versions are integers, starting at 1 and incrementing every time a variable is modified. The required comment attribute provides a short description of the variable. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.
The required datatype attribute specifies the type of value being defined. The set of values identified by a variable must comply with the specified datatype, otherwise an error should be reported. Please see the DatatypeEnumeration for details about each valid datatype. For example, if the datatype of the variable is specified as boolean then the value(s) returned by the component / function should be "true", "false", "1", or "0".
Note that the 'record' datatype is not permitted on variables.
<xsd:complexType name="VariableType"><xsd:annotation><xsd:documentation>The VariableType complex type defines attributes associated with each OVAL Variable. The required id attribute uniquely identifies each variable, and must conform to the format specified by the VariableIDPattern simple type. The required version attribute holds the current version of the variable. Versions are integers, starting at 1 and incrementing every time a variable is modified. The required comment attribute provides a short description of the variable. The optional deprecated attribute signifies that an id is no longer to be used or referenced but the information has been kept around for historic purposes.</xsd:documentation><xsd:documentation>The required datatype attribute specifies the type of value being defined. The set of values identified by a variable must comply with the specified datatype, otherwise an error should be reported. Please see the DatatypeEnumeration for details about each valid datatype. For example, if the datatype of the variable is specified as boolean then the value(s) returned by the component / function should be "true", "false", "1", or "0".</xsd:documentation><xsd:documentation>Note that the 'record' datatype is not permitted on variables.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element ref="ds:Signature" minOccurs="0" maxOccurs="1"/></xsd:sequence><xsd:attribute name="id" type="oval:VariableIDPattern" use="required"/><xsd:attribute name="version" type="xsd:nonNegativeInteger" use="required"/><xsd:attribute name="datatype" use="required" type="oval:SimpleDatatypeEnumeration"><xsd:annotation><xsd:documentation>Note that the 'record' datatype is not permitted on variables.</xsd:documentation></xsd:annotation></xsd:attribute><xsd:attribute name="comment" type="oval:NonEmptyStringType" use="required"/><xsd:attribute name="deprecated" type="xsd:boolean" use="optional" default="false"/></xsd:complexType>
The ObjectRefType complex type defines an object reference to be used by OVAL Tests that are defined in the component schemas. The required object_ref attribute specifies the id of the OVAL Object being referenced.
<xsd:complexType name="ObjectRefType"><xsd:annotation><xsd:documentation>The ObjectRefType complex type defines an object reference to be used by OVAL Tests that are defined in the component schemas. The required object_ref attribute specifies the id of the OVAL Object being referenced.</xsd:documentation></xsd:annotation><xsd:attribute name="object_ref" type="oval:ObjectIDPattern" use="required"/></xsd:complexType>
The StateRefType complex type defines a state reference to be used by OVAL Tests that are defined in the component schemas. The required state_ref attribute specifies the id of the OVAL State being referenced.
<xsd:complexType name="StateRefType"><xsd:annotation><xsd:documentation>The StateRefType complex type defines a state reference to be used by OVAL Tests that are defined in the component schemas. The required state_ref attribute specifies the id of the OVAL State being referenced.</xsd:documentation></xsd:annotation><xsd:attribute name="state_ref" type="oval:StateIDPattern" use="required"/></xsd:complexType>
<xsd:simpleType name="FilterActionEnumeration"><xsd:annotation><xsd:documentation>The FilterActionEnumeration simple type defines the different options for filtering sets of items.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="exclude"><xsd:annotation><xsd:documentation>The exclude value specifies that all items that match the filter shall be excluded from set that the filter is applied to.</xsd:documentation></xsd:annotation></xsd:enumeration><xsd:enumeration value="include"><xsd:annotation><xsd:documentation>The include value specifies that only items that match the filter shall be included in the set that the filter is applied to.</xsd:documentation></xsd:annotation></xsd:enumeration></xsd:restriction></xsd:simpleType>
The SetOperatorEnumeration simple type defines acceptable set operations. Set operations are used to take multiple different sets of objects within OVAL and merge them into a single unique set. The different operators that guide this merge are defined below. For each operator, if only a single object has been supplied, then the resulting set is simply that complete object.
Diagram
Type
restriction of xsd:string
Facets
enumeration
COMPLEMENT
The complement operator is defined in OVAL as a relative complement. The resulting unique set contains everything that belongs to the first declared set that is not part of the second declared set. If A and B are sets (with A being the first declared set), then the relative complement is the set of elements in A, but not in B, with the duplicates removed.
enumeration
INTERSECTION
The intersection of two sets in OVAL results in a unique set that contains everything that belongs to both sets in the collection, but nothing else. If A and B are sets, then the intersection of A and B contains all the elements of A that also belong to B, but no other elements, with the duplicates removed.
enumeration
UNION
The union of two sets in OVAL results in a unique set that contains everything that belongs to either of the original sets. If A and B are sets, then the union of A and B contains all the elements of A and all elements of B, with the duplicates removed.
<xsd:simpleType name="SetOperatorEnumeration"><xsd:annotation><xsd:documentation>The SetOperatorEnumeration simple type defines acceptable set operations. Set operations are used to take multiple different sets of objects within OVAL and merge them into a single unique set. The different operators that guide this merge are defined below. For each operator, if only a single object has been supplied, then the resulting set is simply that complete object.</xsd:documentation><xsd:appinfo><evaluation_documentation>Below are some tables that outline how different flags are combined with a given set_operator to return a new flag. These tables are needed when computing the flag for collected objects that represent object sets in an OVAL Definition. The top row identifies the flag associated with the first set or object reference. The left column identifies the flag associated with the second set or object reference. The matrix inside the table represent the resulting flag when the given set_operator is applied. (E=error, C=complete, I=incomplete, DNE=does not exist, NC=not collected, NA=not applicable)</evaluation_documentation><evaluation_chart xml:space="preserve">
|| ||
set_operator is || obj 1 flag ||
union || ||
|| E | C | I | DNE | NC | NA ||
-----------------||-----------------------------------||
E || E | E | E | E | E | E ||
obj C || E | C | I | C | I | C ||
2 I || E | I | I | I | I | I ||
flag DNE || E | C | I | DNE | I | DNE ||
NC || E | I | I | I | NC | NC ||
NA || E | C | I | DNE | NC | NA ||
-----------------||-----------------------------------||
</evaluation_chart><evaluation_chart xml:space="preserve">
|| ||
set_operator is || obj 1 flag ||
intersection || ||
|| E | C | I | DNE | NC | NA ||
-----------------||-----------------------------------||
E || E | E | E | DNE | E | E ||
obj C || E | C | I | DNE | NC | C ||
2 I || E | I | I | DNE | NC | I ||
flag DNE || DNE | DNE | DNE | DNE | DNE | DNE ||
NC || E | NC | NC | DNE | NC | NC ||
NA || E | C | I | DNE | NC | NA ||
-----------------||-----------------------------------||
</evaluation_chart><evaluation_chart xml:space="preserve">
|| ||
set_operator is || obj 1 flag ||
complement || ||
|| E | C | I | DNE | NC | NA ||
-----------------||-----------------------------------||
E || E | E | E | DNE | E | E ||
obj C || E | C | I | DNE | NC | E ||
2 I || E | E | E | DNE | NC | E ||
flag DNE || E | C | I | DNE | NC | E ||
NC || E | NC | NC | DNE | NC | E ||
NA || E | E | E | E | E | E ||
-----------------||-----------------------------------||
</evaluation_chart></xsd:appinfo></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="COMPLEMENT"><xsd:annotation><xsd:documentation>The complement operator is defined in OVAL as a relative complement. The resulting unique set contains everything that belongs to the first declared set that is not part of the second declared set. If A and B are sets (with A being the first declared set), then the relative complement is the set of elements in A, but not in B, with the duplicates removed.</xsd:documentation></xsd:annotation></xsd:enumeration><xsd:enumeration value="INTERSECTION"><xsd:annotation><xsd:documentation>The intersection of two sets in OVAL results in a unique set that contains everything that belongs to both sets in the collection, but nothing else. If A and B are sets, then the intersection of A and B contains all the elements of A that also belong to B, but no other elements, with the duplicates removed.</xsd:documentation></xsd:annotation></xsd:enumeration><xsd:enumeration value="UNION"><xsd:annotation><xsd:documentation>The union of two sets in OVAL results in a unique set that contains everything that belongs to either of the original sets. If A and B are sets, then the union of A and B contains all the elements of A and all elements of B, with the duplicates removed.</xsd:documentation></xsd:annotation></xsd:enumeration></xsd:restriction></xsd:simpleType>
The PossibleValueType complex type is used to outline a single expected value of an external variable. The required hint attribute gives a short description of what the value means or represents.
<xsd:complexType name="PossibleValueType"><xsd:annotation><xsd:documentation>The PossibleValueType complex type is used to outline a single expected value of an external variable. The required hint attribute gives a short description of what the value means or represents.</xsd:documentation></xsd:annotation><xsd:simpleContent><xsd:extension base="xsd:anySimpleType"><xsd:attribute name="hint" type="xsd:string" use="required"/></xsd:extension></xsd:simpleContent></xsd:complexType>
The PossibleRestrictionType complex type outlines a range of possible expected value of an external variable. Each possible_restriction element contains an unbounded list of child restriction elements that each specify a range that an actual value may fall in. For example, a restriction element may specify that a value must be less than 10. When multiple restriction elements are present, a valid possible value would have to meet every restriction. One can think of the possible_value and possible_restriction elements as an OR'd list of possible values, and the restriction elements as an AND'd list of value descriptions. Please refer to the description of the RestrictionType complex type for more information. The required hint attribute gives a short description of what the value means or represents.
<xsd:complexType name="PossibleRestrictionType"><xsd:annotation><xsd:documentation>The PossibleRestrictionType complex type outlines a range of possible expected value of an external variable. Each possible_restriction element contains an unbounded list of child restriction elements that each specify a range that an actual value may fall in. For example, a restriction element may specify that a value must be less than 10. When multiple restriction elements are present, a valid possible value would have to meet every restriction. One can think of the possible_value and possible_restriction elements as an OR'd list of possible values, and the restriction elements as an AND'd list of value descriptions. Please refer to the description of the RestrictionType complex type for more information. The required hint attribute gives a short description of what the value means or represents.</xsd:documentation></xsd:annotation><xsd:choice><xsd:element name="restriction" type="oval-def:RestrictionType" minOccurs="1" maxOccurs="unbounded"/></xsd:choice><xsd:attribute name="hint" type="xsd:string" use="required"/></xsd:complexType>
The RestrictionType complex type outlines a restriction that is placed on expected values for an external variable. For example, a possible value may be restricted to a integer less than 10. Please refer to the operationEnumeration simple type for a description of the valid operations. The required hint attribute gives a short description of what the value means or represents.
<xsd:complexType name="RestrictionType"><xsd:annotation><xsd:documentation>The RestrictionType complex type outlines a restriction that is placed on expected values for an external variable. For example, a possible value may be restricted to a integer less than 10. Please refer to the operationEnumeration simple type for a description of the valid operations. The required hint attribute gives a short description of what the value means or represents.</xsd:documentation></xsd:annotation><xsd:simpleContent><xsd:extension base="xsd:anySimpleType"><xsd:attribute name="operation" type="oval:OperationEnumeration" use="required"/></xsd:extension></xsd:simpleContent></xsd:complexType>
The ValueType complex type holds the actual value of the variable when dealing with a constant variable. This value should be used by all tests that reference this variable. The value cannot be over-ridden by an external source.
<xsd:complexType name="ValueType"><xsd:annotation><xsd:documentation>The ValueType complex type holds the actual value of the variable when dealing with a constant variable. This value should be used by all tests that reference this variable. The value cannot be over-ridden by an external source.</xsd:documentation></xsd:annotation><xsd:simpleContent><xsd:extension base="xsd:anySimpleType"/></xsd:simpleContent></xsd:complexType>
The ObjectComponentType complex type defines a specific value or set of values on the local system to obtain.
The required object_ref attribute provides a reference to an existing OVAL Object declaration. The referenced OVAL Object specifies a set of OVAL Items to collect. Note that an OVAL Object might identify 0, 1, or many OVAL Items on a system. If no items are found on the system then an error should be reported when determining the value of an ObjectComponentType. If 1 or more OVAL Items are found then each OVAL Item will be considered and the ObjectComponentType may have one or more values.
The required item_field attribute specifies the name of the entity whose value will be retrieved from each OVAL Item collected by the referenced OVAL Object. For example, if the object_ref references a win-def:file_object, the item_field may specify the 'version' entity as the field to use as the value of the ObjectComponentType. Note that an OVAL Item may have 0, 1, or many entities whose name matches the specified item_field value. If an entity is not found with a name that matches the value of the item_field an error should be reported when determining the value of an ObjectComponentType. If 1 or more matching entities are found in a single OVAL Item the value of the ObjectComponentType is the list of the values from each of the matching entities.
The optional record_field attribute specifies the name of a field in a record entity in an OVAL Item. The record_field attribute allows the value of a specific field to be retrieved from an entity with a datatype of 'record'. If a field with a matching name attribute value is not found in the referenced OVAL Item entity an error should be reported when determining the value of the ObjectComponentType.
<xsd:complexType name="ObjectComponentType"><xsd:annotation><xsd:documentation>The ObjectComponentType complex type defines a specific value or set of values on the local system to obtain.</xsd:documentation><xsd:documentation>The required object_ref attribute provides a reference to an existing OVAL Object declaration. The referenced OVAL Object specifies a set of OVAL Items to collect. Note that an OVAL Object might identify 0, 1, or many OVAL Items on a system. If no items are found on the system then an error should be reported when determining the value of an ObjectComponentType. If 1 or more OVAL Items are found then each OVAL Item will be considered and the ObjectComponentType may have one or more values.</xsd:documentation><xsd:documentation>The required item_field attribute specifies the name of the entity whose value will be retrieved from each OVAL Item collected by the referenced OVAL Object. For example, if the object_ref references a win-def:file_object, the item_field may specify the 'version' entity as the field to use as the value of the ObjectComponentType. Note that an OVAL Item may have 0, 1, or many entities whose name matches the specified item_field value. If an entity is not found with a name that matches the value of the item_field an error should be reported when determining the value of an ObjectComponentType. If 1 or more matching entities are found in a single OVAL Item the value of the ObjectComponentType is the list of the values from each of the matching entities.</xsd:documentation><xsd:documentation>The optional record_field attribute specifies the name of a field in a record entity in an OVAL Item. The record_field attribute allows the value of a specific field to be retrieved from an entity with a datatype of 'record'. If a field with a matching name attribute value is not found in the referenced OVAL Item entity an error should be reported when determining the value of the ObjectComponentType.</xsd:documentation></xsd:annotation><xsd:attribute name="object_ref" type="oval:ObjectIDPattern" use="required"/><xsd:attribute name="item_field" type="oval:NonEmptyStringType" use="required"/><xsd:attribute name="record_field" type="oval:NonEmptyStringType" use="optional"/></xsd:complexType>
The VariableComponentType complex type defines a specific value obtained by looking at the value of another OVAL Variable. The required var_ref attribute provides a reference to the variable. One must make sure that the variable reference does not point to the parent variable that uses this component to avoid a race condition.
<xsd:complexType name="VariableComponentType"><xsd:annotation><xsd:documentation>The VariableComponentType complex type defines a specific value obtained by looking at the value of another OVAL Variable. The required var_ref attribute provides a reference to the variable. One must make sure that the variable reference does not point to the parent variable that uses this component to avoid a race condition.</xsd:documentation></xsd:annotation><xsd:attribute name="var_ref" type="oval:VariableIDPattern" use="required"/></xsd:complexType>
The LiteralComponentType complex type defines a literal value to be used as a component. The optional datatype attribute defines the type of data expected. The default datatype is 'string'.
<xsd:complexType name="LiteralComponentType"><xsd:annotation><xsd:documentation>The LiteralComponentType complex type defines a literal value to be used as a component. The optional datatype attribute defines the type of data expected. The default datatype is 'string'.</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_literal_component"><sch:rule context="oval-def:literal_component"><sch:assert test="not(@datatype='record')"><sch:value-of select="ancestor::*/@id"/>- The 'record' datatype is prohibited on variables.</sch:assert></sch:rule><!--
<sch:rule context="oval-def:literal_component/*/*[not(@datatype)]">
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='binary']">
<sch:assert test="matches(., '^[0-9a-fA-F]*$')"><sch:value-of select="../@id"/> - A value of '<sch:value-of select="."/>' for the <sch:value-of select="name()"/> entity is not valid given a datatype of binary.</sch:assert>
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='boolean']">
<sch:assert test="matches(., '^true$|^false$|^1$|^0$')"><sch:value-of select="../@id"/> - A value of '<sch:value-of select="."/>' for the <sch:value-of select="name()"/> entity is not valid given a datatype of boolean.</sch:assert>
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='evr_string']">
<sch:assert test="matches(., '^[^:\-]*:[^:\-]*-[^:\-]*$')"><sch:value-of select="../@id"/> - A value of '<sch:value-of select="."/>' for the <sch:value-of select="name()"/> entity is not valid given a datatype of evr_string.</sch:assert>
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='fileset_revision']">
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='float']">
<sch:assert test="matches(., '^[+\-]?[0-9]+([\.][0-9]+)?([eE][+\-]?[0-9]+)?$|^NaN$|^INF$|^\-INF$')"><sch:value-of select="../@id"/> - A value of '<sch:value-of select="."/>' for the <sch:value-of select="name()"/> entity is not valid given a datatype of float.</sch:assert>
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='ios_version']">
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='int']">
<sch:assert test="matches(., '^[+\-]?[0-9]+$')"><sch:value-of select="../@id"/> - A value of '<sch:value-of select="."/>' for the <sch:value-of select="name()"/> entity is not valid given a datatype of int.</sch:assert>
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='string']">
</sch:rule>
<sch:rule context="oval-def:literal_component[@datatype='version']">
</sch:rule>
--></sch:pattern></xsd:appinfo></xsd:annotation><xsd:simpleContent><xsd:extension base="xsd:anySimpleType"><xsd:attribute name="datatype" type="oval:SimpleDatatypeEnumeration" use="optional" default="string"/></xsd:extension></xsd:simpleContent></xsd:complexType>
The arithmetic function takes two or more integer or float components and performs a basic mathematical function on them. The result of this function is a single integer or float unless one of the components returns multiple values. In this case the specified arithmetic function would be performed multiple times and the end result would be an array of values for the local variable. For example assume a local_variable specifies the arithmetic function with an arithmetic_operation of "add" and has two sub-components under this function: the first component returns multiple values "1" and "2", and the second component returns multiple values "3" and "4" and "5". The local_variable element would be evaluated to have six values: 1+3, 1+4, 1+5, 2+3, 2+4, and 2+5.
Note that if both an integer and float components are used then the result is a float.
<xsd:complexType name="ArithmeticFunctionType"><xsd:annotation><xsd:documentation>The arithmetic function takes two or more integer or float components and performs a basic mathematical function on them. The result of this function is a single integer or float unless one of the components returns multiple values. In this case the specified arithmetic function would be performed multiple times and the end result would be an array of values for the local variable. For example assume a local_variable specifies the arithmetic function with an arithmetic_operation of "add" and has two sub-components under this function: the first component returns multiple values "1" and "2", and the second component returns multiple values "3" and "4" and "5". The local_variable element would be evaluated to have six values: 1+3, 1+4, 1+5, 2+3, 2+4, and 2+5.</xsd:documentation><xsd:documentation>Note that if both an integer and float components are used then the result is a float.</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_arithmeticfunctionrules"><sch:rule context="oval-def:arithmetic/oval-def:literal_component"><sch:assert test="@datatype='float' or @datatype='int'">A literal_component used by an arithmetic function must have a datatype of float or int.</sch:assert></sch:rule><sch:rule context="oval-def:arithmetic/oval-def:variable_component"><sch:let name="var_ref" value="@var_ref"/><sch:assert test="ancestor::oval-def:oval_definitions/oval-def:variables/*[@id=$var_ref]/@datatype='float' or ancestor::oval-def:oval_definitions/oval-def:variables/*[@id=$var_ref]/@datatype='int'">The variable referenced by the arithmetic function must have a datatype of float or int.</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:sequence minOccurs="2" maxOccurs="unbounded"><xsd:group ref="oval-def:ComponentGroup"/></xsd:sequence><xsd:attribute name="arithmetic_operation" type="oval-def:ArithmeticEnumeration" use="required"/></xsd:complexType>
<xsd:simpleType name="ArithmeticEnumeration"><xsd:annotation><xsd:documentation>The ArithmeticEnumeration simple type defines basic arithmetic operations. Currently add and multiply are defined.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="add"/><xsd:enumeration value="multiply"/><!--
NOTE - we need to add a required position attribute to the components before we
can have a subtract or divide function. This will have to wait for the next
major release
<xsd:enumeration value="divide"/>
<xsd:enumeration value="subtract"/>
--></xsd:restriction></xsd:simpleType>
The begin function takes a single string component and defines a character (or string) that the component string should start with. The character attribute defines the specific character (or string). The character (or string) is only added to the component string if the component string does not already start with the specified character (or string). If the component string does not start with the specified character (or string) the entire character (or string) will be prepended to the component string..
<xsd:complexType name="BeginFunctionType"><xsd:annotation><xsd:documentation>The begin function takes a single string component and defines a character (or string) that the component string should start with. The character attribute defines the specific character (or string). The character (or string) is only added to the component string if the component string does not already start with the specified character (or string). If the component string does not start with the specified character (or string) the entire character (or string) will be prepended to the component string..</xsd:documentation><xsd:appinfo><sch:pattern id="oval-def_beginfunctionrules"><sch:rule context="oval-def:begin/oval-def:literal_component"><sch:assert test="not(@datatype) or @datatype='string'">A literal_component used by the begin function must have a datatype of string.</sch:assert></sch:rule><sch:rule context="oval-def:begin/oval-def:variable_component"><sch:let name="var_ref" value="@var_ref"/><sch:assert test="ancestor::oval-def:oval_definitions/oval-def:variables/*[@id=$var_ref]/@datatype = 'string'">The variable referenced by the begin function must have a datatype of string.</sch:assert></sch:rule></sch:pattern></xsd:appinfo></xsd:annotation><xsd:sequence><xsd:group ref="oval-def:ComponentGroup"/></xsd:sequence><xsd:attribute name="character" type="xsd:string" use="required"/></xsd:complexType>
The concat function takes two or more components and concatenates them together to form a single string. The first component makes up the beginning of the resulting string and any following components are added to the end it. If one of the components returns multiple values then the concat function would be performed multiple times and the end result would be an array of values for the local variable. For example assume a local variable has two sub-components: a basic component element returns the values "abc" and "def", and a literal component element that has a value of "xyz". The local_variable element would be evaluated to have two values, "abcxyz" and "defxyz". If one of the components does not exist, then the result of the concat operation should be does not exist.
