XCCDF

Modules

 Xccdf_item
 Xccdf_benchmark
 Xccdf_profile
 Xccdf_rule
 Xccdf_group
 Xccdf_value
 Xccdf_result
 Xccdf_notice
 Xccdf_status
 Xccdf_model
 Xccdf_warning
 Xccdf_select
 Xccdf_set_value
 Xccdf_refine_value
 Xccdf_refine_rule
 Xccdf_ident
 Xccdf_check
 Xccdf_check_content_ref
 Xccdf_profile_note
 Xccdf_check_import
 Xccdf_check_export
 Xccdf_fix
 Xccdf_fixtext
 Xccdf_reference
 Xccdf_refile_value

Files

file  xccdf.h
 

Open-scap XCCDF library interface.


Typedefs

typedef float xccdf_numeric
 Type of a numerical content for a XCCDF value.

Enumerations

enum  xccdf_type_t {
  XCCDF_BENCHMARK = 0x0100, XCCDF_PROFILE = 0x0200, XCCDF_RESULT = 0x0400, XCCDF_RULE = 0x1000,
  XCCDF_GROUP = 0x2000, XCCDF_VALUE = 0x4000, XCCDF_CONTENT = XCCDF_RULE | XCCDF_GROUP, XCCDF_ITEM = XCCDF_RULE | XCCDF_GROUP | XCCDF_VALUE,
  XCCDF_OBJECT = XCCDF_ITEM | XCCDF_PROFILE | XCCDF_BENCHMARK | XCCDF_RESULT
}
 

Type of an XCCDF object.

More...
enum  xccdf_interface_hint_t {
  XCCDF_IFACE_HINT_NONE, XCCDF_IFACE_HINT_CHOICE, XCCDF_IFACE_HINT_TEXTLINE, XCCDF_IFACE_HINT_TEXT,
  XCCDF_IFACE_HINT_DATE, XCCDF_IFACE_HINT_DATETIME
}
 

Interface hint.

More...
enum  xccdf_status_type_t {
  XCCDF_STATUS_NOT_SPECIFIED, XCCDF_STATUS_ACCEPTED, XCCDF_STATUS_DEPRECATED, XCCDF_STATUS_DRAFT,
  XCCDF_STATUS_INCOMPLETE, XCCDF_STATUS_INTERIM
}
 

Status of an XCCDF item.

More...
enum  xccdf_value_type_t { XCCDF_TYPE_NUMBER = 1, XCCDF_TYPE_STRING, XCCDF_TYPE_BOOLEAN }
 

Type of an xccdf_value.

More...
enum  xccdf_operator_t {
  XCCDF_OPERATOR_EQUALS = 1, XCCDF_OPERATOR_NOT_EQUAL, XCCDF_OPERATOR_GREATER, XCCDF_OPERATOR_GREATER_EQUAL,
  XCCDF_OPERATOR_LESS, XCCDF_OPERATOR_LESS_EQUAL, XCCDF_OPERATOR_PATTERN_MATCH
}
 

Operator to be applied on an xccdf_value.

More...
enum  xccdf_bool_operator_t {
  XCCDF_OPERATOR_AND = 0x0002, XCCDF_OPERATOR_OR = 0x0003, XCCDF_OPERATOR_NOT = 0x0100, XCCDF_OPERATOR_NAND = XCCDF_OPERATOR_AND | XCCDF_OPERATOR_NOT,
  XCCDF_OPERATOR_NOR = XCCDF_OPERATOR_OR | XCCDF_OPERATOR_NOT, XCCDF_OPERATOR_MASK = 0x00ff
}
 

Boolean operators for logical expressions.

More...
enum  xccdf_level_t {
  XCCDF_UNKNOWN = 1, XCCDF_INFO, XCCDF_LOW, XCCDF_MEDIUM,
  XCCDF_HIGH
}
 

XCCDF error, complexity, disruption, or severity level.

More...
enum  xccdf_message_severity_t { XCCDF_MSG_INFO = XCCDF_INFO, XCCDF_MSG_WARNING = XCCDF_LOW, XCCDF_MSG_ERROR = XCCDF_HIGH }
 

Severity of an xccdf_message.

More...
enum  xccdf_role_t { XCCDF_ROLE_FULL = 1, XCCDF_ROLE_UNSCORED, XCCDF_ROLE_UNCHECKED }
 

XCCDF role.

More...
enum  xccdf_warning_category_t {
  XCCDF_WARNING_GENERAL = 1, XCCDF_WARNING_FUNCTIONALITY, XCCDF_WARNING_PERFORMANCE, XCCDF_WARNING_HARDWARE,
  XCCDF_WARNING_LEGAL, XCCDF_WARNING_REGULATORY, XCCDF_WARNING_MANAGEMENT, XCCDF_WARNING_AUDIT,
  XCCDF_WARNING_DEPENDENCY
}
 

Category of xccdf_warning.

More...
enum  xccdf_strategy_t {
  XCCDF_STRATEGY_UNKNOWN, XCCDF_STRATEGY_CONFIGURE, XCCDF_STRATEGY_DISABLE, XCCDF_STRATEGY_ENABLE,
  XCCDF_STRATEGY_PATCH, XCCDF_STRATEGY_POLICY, XCCDF_STRATEGY_RESTRICT, XCCDF_STRATEGY_UPDATE,
  XCCDF_STRATEGY_COMBINATION
}
 

Fix strategy type.

More...
enum  xccdf_test_result_type_t {
  XCCDF_RESULT_PASS = 1, XCCDF_RESULT_FAIL, XCCDF_RESULT_ERROR, XCCDF_RESULT_UNKNOWN,
  XCCDF_RESULT_NOT_APPLICABLE, XCCDF_RESULT_NOT_CHECKED, XCCDF_RESULT_NOT_SELECTED, XCCDF_RESULT_INFORMATIONAL,
  XCCDF_RESULT_FIXED
}
 

Test result.

More...

Functions

const char * xccdf_value_get_id (const struct xccdf_value *value)
const char * xccdf_value_get_title (const struct xccdf_value *value)
const char * xccdf_value_get_version (const struct xccdf_value *value)
const char * xccdf_value_get_question (const struct xccdf_value *value)
const char * xccdf_value_get_rationale (const struct xccdf_value *value)
const char * xccdf_value_get_cluster_id (const struct xccdf_value *value)
const char * xccdf_value_get_description (const struct xccdf_value *value)
const char * xccdf_value_get_version_update (const struct xccdf_value *value)
time_t xccdf_value_get_version_time (const struct xccdf_value *value)
float xccdf_value_get_weight (const struct xccdf_value *value)
struct xccdf_benchmarkxccdf_value_get_benchmark (const struct xccdf_value *value)
struct oscap_string_iteratorxccdf_value_get_platforms (const struct xccdf_value *value)
struct oscap_string_iteratorxccdf_value_get_sources (const struct xccdf_value *value)
bool xccdf_value_get_resolved (const struct xccdf_value *value)
bool xccdf_value_get_hidden (const struct xccdf_value *value)
bool xccdf_value_get_selected (const struct xccdf_value *value)
bool xccdf_value_get_multiple (const struct xccdf_value *value)
bool xccdf_value_get_prohibit_changes (const struct xccdf_value *value)
bool xccdf_value_get_abstract (const struct xccdf_value *value)
bool xccdf_value_get_interactive (const struct xccdf_value *value)
const char * xccdf_item_get_id (const struct xccdf_item *item)
const char * xccdf_item_get_title (const struct xccdf_item *item)
const char * xccdf_item_get_version (const struct xccdf_item *item)
const char * xccdf_item_get_question (const struct xccdf_item *item)
const char * xccdf_item_get_rationale (const struct xccdf_item *item)
const char * xccdf_item_get_cluster_id (const struct xccdf_item *item)
const char * xccdf_item_get_description (const struct xccdf_item *item)
const char * xccdf_item_get_version_update (const struct xccdf_item *item)
time_t xccdf_item_get_version_time (const struct xccdf_item *item)
float xccdf_item_get_weight (const struct xccdf_item *item)
struct xccdf_benchmarkxccdf_item_get_benchmark (const struct xccdf_item *item)
struct oscap_string_iteratorxccdf_item_get_platforms (const struct xccdf_item *item)
bool xccdf_benchmark_get_resolved (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_hidden (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_selected (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_multiple (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_prohibit_changes (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_abstract (const struct xccdf_benchmark *benchmark)
bool xccdf_benchmark_get_interactive (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_title (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_version (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_question (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_rationale (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_cluster_id (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_description (const struct xccdf_benchmark *benchmark)
const char * xccdf_benchmark_get_version_update (const struct xccdf_benchmark *benchmark)
time_t xccdf_benchmark_get_version_time (const struct xccdf_benchmark *benchmark)
float xccdf_benchmark_get_weight (const struct xccdf_benchmark *benchmark)
struct xccdf_benchmarkxccdf_benchmark_get_benchmark (const struct xccdf_benchmark *benchmark)
struct xccdf_itemxccdf_benchmark_get_parent (const struct xccdf_benchmark *benchmark)
const char * xccdf_profile_get_id (const struct xccdf_profile *profile)
const char * xccdf_profile_get_title (const struct xccdf_profile *profile)
const char * xccdf_profile_get_version (const struct xccdf_profile *profile)
const char * xccdf_profile_get_question (const struct xccdf_profile *profile)
const char * xccdf_profile_get_rationale (const struct xccdf_profile *profile)
const char * xccdf_profile_get_cluster_id (const struct xccdf_profile *profile)
const char * xccdf_profile_get_description (const struct xccdf_profile *profile)
const char * xccdf_profile_get_version_update (const struct xccdf_profile *profile)
time_t xccdf_profile_get_version_time (const struct xccdf_profile *profile)
float xccdf_profile_get_weight (const struct xccdf_profile *profile)
struct xccdf_itemxccdf_profile_get_parent (const struct xccdf_profile *profile)
const char * xccdf_profile_get_note_tag (const struct xccdf_profile *profile)
bool xccdf_profile_get_resolved (const struct xccdf_profile *profile)
bool xccdf_profile_get_hidden (const struct xccdf_profile *profile)
bool xccdf_profile_get_selected (const struct xccdf_profile *profile)
bool xccdf_profile_get_multiple (const struct xccdf_profile *profile)
bool xccdf_profile_get_prohibit_changes (const struct xccdf_profile *profile)
bool xccdf_profile_get_abstract (const struct xccdf_profile *profile)
bool xccdf_profile_get_interactive (const struct xccdf_profile *profile)
const char * xccdf_rule_get_id (const struct xccdf_rule *rule)
const char * xccdf_rule_get_title (const struct xccdf_rule *rule)
const char * xccdf_rule_get_version (const struct xccdf_rule *rule)
const char * xccdf_rule_get_question (const struct xccdf_rule *rule)
const char * xccdf_rule_get_rationale (const struct xccdf_rule *rule)
const char * xccdf_rule_get_cluster_id (const struct xccdf_rule *rule)
const char * xccdf_rule_get_description (const struct xccdf_rule *rule)
const char * xccdf_rule_get_version_update (const struct xccdf_rule *rule)
time_t xccdf_rule_get_version_time (const struct xccdf_rule *rule)
float xccdf_rule_get_weight (const struct xccdf_rule *rule)
struct xccdf_benchmarkxccdf_rule_get_benchmark (const struct xccdf_rule *rule)
struct oscap_string_iteratorxccdf_rule_get_platforms (const struct xccdf_rule *rule)
bool xccdf_rule_get_resolved (const struct xccdf_rule *rule)
bool xccdf_rule_get_interactive (const struct xccdf_rule *rule)
bool xccdf_group_get_resolved (const struct xccdf_group *group)
bool xccdf_group_get_hidden (const struct xccdf_group *group)
bool xccdf_group_get_selected (const struct xccdf_group *group)
bool xccdf_group_get_multiple (const struct xccdf_group *group)
bool xccdf_group_get_prohibit_changes (const struct xccdf_group *group)
bool xccdf_group_get_abstract (const struct xccdf_group *group)
bool xccdf_group_get_interactive (const struct xccdf_group *group)
time_t xccdf_group_get_version_time (const struct xccdf_group *group)
const char * xccdf_group_get_version_update (const struct xccdf_group *group)
float xccdf_group_get_weight (const struct xccdf_group *group)
struct xccdf_benchmarkxccdf_group_get_benchmark (const struct xccdf_group *group)
struct
xccdf_check_import_iterator
xccdf_check_get_imports (const struct xccdf_check *check)
struct
xccdf_check_export_iterator
xccdf_check_get_exports (const struct xccdf_check *check)
struct
xccdf_check_content_ref_iterator
xccdf_check_get_content_refs (const struct xccdf_check *check)
const char * xccdf_fixtext_get_content (const struct xccdf_fixtext *fixtext)
void xccdf_cleanup (void)
 Release library internal caches.
xccdf_type_t xccdf_item::xccdf_item_get_type (const struct xccdf_item *item)
 Get item type.
const char * xccdf_item::xccdf_item_get_id (const struct xccdf_item *item)
 Get item ID.
const char * xccdf_item::xccdf_item_get_title (const struct xccdf_item *item)
 Get item title.
const char * xccdf_item::xccdf_item_get_description (const struct xccdf_item *item)
 Get item description.
const char * xccdf_item::xccdf_item_get_version (const struct xccdf_item *item)
 Get item version.
struct xccdf_itemxccdf_item::xccdf_item_get_extends (const struct xccdf_item *item)
 Return item's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_item::xccdf_item_get_parent (const struct xccdf_item *item)
 Return item's parent in the grouping hierarchy.
struct xccdf_status_iteratorxccdf_item::xccdf_item_get_statuses (const struct xccdf_item *item)
 Get an iterator to item statuses.
struct xccdf_reference_iteratorxccdf_item::xccdf_item_get_references (const struct xccdf_item *item)
 Get an iterator to the XCCDF references of the item.
xccdf_status_type_t xccdf_item::xccdf_item_get_current_status (const struct xccdf_item *item)
 Get item current status.
struct xccdf_benchmarkxccdf_benchmark::xccdf_benchmark_parse_xml (const char *filename)
 Convert the item to a benchmark.
const char * xccdf_benchmark::xccdf_benchmark_get_id (const struct xccdf_benchmark *benchmark)
 Get benchmark ID.
bool xccdf_benchmark::xccdf_benchmark_get_resolved (const struct xccdf_benchmark *benchmark)
 Check benchmark resolved property.
const char * xccdf_benchmark::xccdf_benchmark_get_title (const struct xccdf_benchmark *benchmark)
 Get benchmark title.
const char * xccdf_benchmark::xccdf_benchmark_get_description (const struct xccdf_benchmark *benchmark)
 Get benchmark description.
const char * xccdf_benchmark::xccdf_benchmark_get_version (const struct xccdf_benchmark *benchmark)
 Get benchmark version.
const char * xccdf_benchmark::xccdf_benchmark_get_style (const struct xccdf_benchmark *benchmark)
 Get benchmark inline stylesheet.
const char * xccdf_benchmark::xccdf_benchmark_get_style_href (const struct xccdf_benchmark *benchmark)
 Get benchmark stylesheet URL.
const char * xccdf_benchmark::xccdf_benchmark_get_front_matter (const struct xccdf_benchmark *benchmark)
 Get benchmark front matter.
const char * xccdf_benchmark::xccdf_benchmark_get_rear_matter (const struct xccdf_benchmark *benchmark)
 Get benchmark rear matter.
const char * xccdf_benchmark::xccdf_benchmark_get_metadata (const struct xccdf_benchmark *benchmark)
 Get benchmark metadata.
const char * xccdf_benchmark::xccdf_benchmark_get_plain_text (const struct xccdf_benchmark *benchmark, const char *id)
 Get a plain text by ID.
struct xccdf_itemxccdf_benchmark::xccdf_benchmark_get_item (const struct xccdf_benchmark *benchmark, const char *id)
 Get benchmark item by ID.
struct xccdf_status_iteratorxccdf_benchmark::xccdf_benchmark_get_statuses (const struct xccdf_benchmark *benchmark)
 Get an iterator to benchmark statuses.
struct xccdf_reference_iteratorxccdf_benchmark::xccdf_benchmark_get_references (const struct xccdf_benchmark *benchmark)
 Get an iterator to the XCCDF references of the benchmark.
struct oscap_string_iteratorxccdf_benchmark::xccdf_benchmark_get_platforms (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark platforms.
struct xccdf_notice_iteratorxccdf_benchmark::xccdf_benchmark_get_notices (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark legal notices.
struct xccdf_model_iteratorxccdf_benchmark::xccdf_benchmark_get_models (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark scoring models.
struct xccdf_profile_iteratorxccdf_benchmark::xccdf_benchmark_get_profiles (const struct xccdf_benchmark *benchmark)
 Get an iterator to the benchmark XCCDF profiles.
struct xccdf_item_iteratorxccdf_benchmark::xccdf_benchmark_get_content (const struct xccdf_benchmark *benchmark)
 Get an iterator to the bencmark content.
xccdf_status_type_t xccdf_benchmark::xccdf_benchmark_get_status_current (const struct xccdf_benchmark *benchmark)
 Get benchmark current status.
void xccdf_benchmark::xccdf_benchmark_free (struct xccdf_benchmark *benchmark)
 Delete the benchmark.
const char * xccdf_profile::xccdf_profile_get_id (const struct xccdf_profile *profile)
 Get profile ID.
const char * xccdf_profile::xccdf_profile_get_title (const struct xccdf_profile *profile)
 Get profile title.
const char * xccdf_profile::xccdf_profile_get_description (const struct xccdf_profile *profile)
 Get profile description.
const char * xccdf_profile::xccdf_profile_get_version (const struct xccdf_profile *profile)
 Get profile version.
struct xccdf_profilexccdf_profile::xccdf_profile_get_extends (const struct xccdf_profile *profile)
 Return profile's parent in the inheritance hierarchy.
struct xccdf_benchmarkxccdf_profile::xccdf_profile_get_benchmark (const struct xccdf_profile *profile)
 Return a benchmark containing this profile.
bool xccdf_profile::xccdf_profile_get_abstract (const struct xccdf_profile *profile)
 Return whether the profile is abstract.
bool xccdf_profile::xccdf_profile_get_prohibit_changes (const struct xccdf_profile *profile)
 Return whether the profile has the prohibit changes flag set to true.
struct oscap_string_iteratorxccdf_profile::xccdf_profile_get_platforms (const struct xccdf_profile *profile)
 Get an iterator to profile platforms.
struct xccdf_status_iteratorxccdf_profile::xccdf_profile_get_statuses (const struct xccdf_profile *profile)
 Get an iterator to profile statuses.
struct xccdf_reference_iteratorxccdf_profile::xccdf_profile_get_references (const struct xccdf_profile *profile)
 Get an iterator to the XCCDF references of the profile.
xccdf_status_type_t xccdf_profile::xccdf_profile_get_status_current (const struct xccdf_profile *profile)
 Get profile current status.
struct xccdf_select_iteratorxccdf_profile::xccdf_profile_get_selects (const struct xccdf_profile *profile)
 Get profile note tag.
struct xccdf_set_value_iteratorxccdf_profile::xccdf_profile_get_set_values (const struct xccdf_profile *profile)
 Get an iterator to the set value options of the profile.
struct
xccdf_refine_value_iterator
xccdf_profile::xccdf_profile_get_refine_values (const struct xccdf_profile *profile)
 Get an iterator to the refine value options of the profile.
struct xccdf_refine_rule_iteratorxccdf_profile::xccdf_profile_get_refine_rules (const struct xccdf_profile *profile)
 Get an iterator to the refine rule options of the profile.
const char * xccdf_rule::xccdf_rule_get_id (const struct xccdf_rule *rule)
 Get rule ID.
const char * xccdf_rule::xccdf_rule_get_title (const struct xccdf_rule *rule)
 Get rule title.
const char * xccdf_rule::xccdf_rule_get_description (const struct xccdf_rule *rule)
 Get rule description.
const char * xccdf_rule::xccdf_rule_get_version (const struct xccdf_rule *rule)
 Get rule version.
const char * xccdf_rule::xccdf_rule_get_question (const struct xccdf_rule *rule)
 Get rule question.
const char * xccdf_rule::xccdf_rule_get_rationale (const struct xccdf_rule *rule)
 Get rule rationale.
const char * xccdf_rule::xccdf_rule_get_cluster_id (const struct xccdf_rule *rule)
 Get rule cluster ID.
struct xccdf_checkxccdf_rule::xccdf_rule_get_check (const struct xccdf_rule *rule)
 Get rule's currently selected check.
float xccdf_rule::xccdf_rule_get_weight (const struct xccdf_rule *rule)
 Get rule scoring weight.
struct xccdf_rulexccdf_rule::xccdf_rule_get_extends (const struct xccdf_rule *rule)
 Return rule's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_rule::xccdf_rule_get_parent (const struct xccdf_rule *rule)
 Return rule's parent in the grouping hierarchy.
bool xccdf_rule::xccdf_rule_get_abstract (const struct xccdf_rule *rule)
 Return whether the rule is abstract.
bool xccdf_rule::xccdf_rule_get_prohibit_changes (const struct xccdf_rule *rule)
 Return whether the rule has the prohibit changes flag set to true.
bool xccdf_rule::xccdf_rule_get_hidden (const struct xccdf_rule *rule)
 Return whether the rule has the hidden flag set to true.
bool xccdf_rule::xccdf_rule_get_selected (const struct xccdf_rule *rule)
 Return whether the rule is selected.
bool xccdf_rule::xccdf_rule_get_multiple (const struct xccdf_rule *rule)
 Return whether the rule has the multiple flag set to true.
struct oscap_string_iteratorxccdf_rule::xccdf_rule_get_platforms (const struct xccdf_rule *rule)
 Get an iterator to rule platforms.
struct xccdf_status_iteratorxccdf_rule::xccdf_rule_get_statuses (const struct xccdf_rule *rule)
 Get an iterator to rule statuses.
struct xccdf_reference_iteratorxccdf_rule::xccdf_rule_get_references (const struct xccdf_rule *rule)
 Get an iterator to the XCCDF references of the rule.
xccdf_status_type_t xccdf_rule::xccdf_rule_get_status_current (const struct xccdf_rule *rule)
 Get rule current status.
const char * xccdf_rule::xccdf_rule_get_impact_metric (const struct xccdf_rule *rule)
 Get rule impact metric.
xccdf_role_t xccdf_rule::xccdf_rule_get_role (const struct xccdf_rule *rule)
 Get rule role.
xccdf_level_t xccdf_rule::xccdf_rule_get_severity (const struct xccdf_rule *rule)
 Get rule severity level.
struct xccdf_ident_iteratorxccdf_rule::xccdf_rule_get_idents (const struct xccdf_rule *rule)
 Get an iterator to the idents of the rule.
struct xccdf_check_iteratorxccdf_rule::xccdf_rule_get_checks (const struct xccdf_rule *rule)
 Get an iterator to the checks of the rule.
struct
xccdf_profile_note_iterator
xccdf_rule::xccdf_rule_get_profile_notes (const struct xccdf_rule *rule)
 Get an iterator to the profile notes of the rule.
struct xccdf_fix_iteratorxccdf_rule::xccdf_rule_get_fixes (const struct xccdf_rule *rule)
 Get an iterator to fixes for the rule.
struct xccdf_fixtext_iteratorxccdf_rule::xccdf_rule_get_fixtexts (const struct xccdf_rule *rule)
 Get an iterator to fix descriptions the rule.
const char * xccdf_group::xccdf_group_get_id (const struct xccdf_group *group)
 Get group ID.
const char * xccdf_group::xccdf_group_get_title (const struct xccdf_group *group)
 Get group title.
const char * xccdf_group::xccdf_group_get_description (const struct xccdf_group *group)
 Get group description.
const char * xccdf_group::xccdf_group_get_version (const struct xccdf_group *group)
 Get group version.
const char * xccdf_group::xccdf_group_get_question (const struct xccdf_group *group)
 Get group question.
const char * xccdf_group::xccdf_group_get_rationale (const struct xccdf_group *group)
 Get group rationale.
const char * xccdf_group::xccdf_group_get_cluster_id (const struct xccdf_group *group)
 Get group cluster ID.
float xccdf_group::xccdf_group_get_weight (const struct xccdf_group *group)
 Get group scoring weight.
struct xccdf_groupxccdf_group::xccdf_group_get_extends (const struct xccdf_group *group)
 Return group's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_group::xccdf_group_get_parent (const struct xccdf_group *group)
 Return group's parent in the grouping hierarchy.
bool xccdf_group::xccdf_group_get_abstract (const struct xccdf_group *group)
 Return whether the group is abstract.
bool xccdf_group::xccdf_group_get_prohibit_changes (const struct xccdf_group *group)
 Return whether the group has the prohibit changes flag set to true.
bool xccdf_group::xccdf_group_get_hidden (const struct xccdf_group *group)
 Return whether the group has the hidden flag set to true.
bool xccdf_group::xccdf_group_get_selected (const struct xccdf_group *group)
 Return whether the group is selected.
struct oscap_string_iteratorxccdf_group::xccdf_group_get_platforms (const struct xccdf_group *group)
 Get an iterator to group platforms.
struct xccdf_status_iteratorxccdf_group::xccdf_group_get_statuses (const struct xccdf_group *group)
 Get an iterator to group statuses.
struct xccdf_reference_iteratorxccdf_group::xccdf_group_get_references (const struct xccdf_group *group)
 Get an iterator to the XCCDF references of the group.
struct xccdf_item_iteratorxccdf_group::xccdf_group_get_content (const struct xccdf_group *benchmark)
 Get an iterator to the group content.
xccdf_status_type_t xccdf_group::xccdf_group_get_status_current (const struct xccdf_group *group)
 Get group current status.
const char * xccdf_value::xccdf_value_get_id (const struct xccdf_value *value)
 Get value ID.
const char * xccdf_value::xccdf_value_get_title (const struct xccdf_value *value)
 Get value title.
const char * xccdf_value::xccdf_value_get_description (const struct xccdf_value *value)
 Get value description.
struct xccdf_valuexccdf_value::xccdf_value_get_extends (const struct xccdf_value *value)
 Return value's parent in the inheritance hierarchy.
struct xccdf_itemxccdf_value::xccdf_value_get_parent (const struct xccdf_value *value)
 Return value's parent in the grouping hierarchy.
bool xccdf_value::xccdf_value_get_abstract (const struct xccdf_value *value)
 Return whether the value is abstract.
bool xccdf_value::xccdf_value_get_prohibit_changes (const struct xccdf_value *value)
 Return whether the value has the prohibit changes flag set to true.
bool xccdf_value::xccdf_value_get_hidden (const struct xccdf_value *value)
 Return whether the value has the hidden flag set to true.
struct xccdf_status_iteratorxccdf_value::xccdf_value_get_statuses (const struct xccdf_value *value)
 Get an iterator to value statuses.
struct xccdf_reference_iteratorxccdf_value::xccdf_value_get_references (const struct xccdf_value *value)
 Get an iterator to the XCCDF references of the value.
xccdf_status_type_t xccdf_value::xccdf_value_get_status_current (const struct xccdf_value *value)
 Get value current status.
xccdf_value_type_t xccdf_value::xccdf_value_get_type (const struct xccdf_value *value)
 Return type of the value.
xccdf_interface_hint_t xccdf_value::xccdf_value_get_interface_hint (const struct xccdf_value *value)
 Return an interface hint for the value.
xccdf_operator_t xccdf_value::xccdf_value_get_oper (const struct xccdf_value *value)
 Return an operator to be applied on the value.
const char * xccdf_value::xccdf_value_get_selector (const struct xccdf_value *value)
 Return currently active selector of the value.
bool xccdf_value::xccdf_value_get_set_selector (struct xccdf_item *value, const char *selector)
 Apply a selector on the value.
const char * xccdf_value::xccdf_value_get_value_string (const struct xccdf_value *value)
 Return the item's value as a string.
xccdf_numeric xccdf_value::xccdf_value_get_value_number (const struct xccdf_value *value)
 Return the item's value as a number.
bool xccdf_value::xccdf_value_get_value_boolean (const struct xccdf_value *value)
 Return the item's value as a boolean value.
const char * xccdf_value::xccdf_value_get_defval_string (const struct xccdf_value *value)
 Return the item's default value as a string.
xccdf_numeric xccdf_value::xccdf_value_get_defval_number (const struct xccdf_value *value)
 Return the item's default value as a number.
bool xccdf_value::xccdf_value_get_defval_boolean (const struct xccdf_value *value)
 Return the item's default value as a boolean value.
xccdf_numeric xccdf_value::xccdf_value_get_lower_bound (const struct xccdf_value *value)
 Return upper limit for the numeric value.
xccdf_numeric xccdf_value::xccdf_value_get_upper_bound (const struct xccdf_value *value)
 Return lower limit for the numeric value.
const char * xccdf_value::xccdf_value_get_match (const struct xccdf_value *value)
 Regex the values should match.
bool xccdf_value::xccdf_value_get_must_match (const struct xccdf_value *value)
 Return mustMatch property.
time_t xccdf_status::xccdf_status_get_date (const struct xccdf_status *status)
 Get an iterator to the XCCDF value's source URIs.
xccdf_status_type_t xccdf_status::xccdf_status_get_status (const struct xccdf_status *status)
 Get status type.
const char * xccdf_notice::xccdf_notice_get_id (const struct xccdf_notice *notice)
 Get copyright notice ID.
const char * xccdf_notice::xccdf_notice_get_text (const struct xccdf_notice *notice)
 Get copyright notice text.
const char * xccdf_model::xccdf_model_get_system (const struct xccdf_model *model)
 Get scoring model system URI.
const char * xccdf_ident::xccdf_ident_get_id (const struct xccdf_ident *ident)
 Get scoring model parameter.
const char * xccdf_ident::xccdf_ident_get_system (const struct xccdf_ident *ident)
 Get ident system URI.
const char * xccdf_check::xccdf_check_get_id (const struct xccdf_check *check)
 Get check ID.
bool xccdf_check::xccdf_check_get_complex (const struct xccdf_check *check)
 True if the check is a complex check.
xccdf_bool_operator_t xccdf_check::xccdf_check_get_oper (const struct xccdf_check *check)
 Get an operator to be applied no children of the complex check.
const char * xccdf_check::xccdf_check_get_system (const struct xccdf_check *check)
 Get check system URI.
const char * xccdf_check::xccdf_check_get_selector (const struct xccdf_check *check)
 Get check selector.
const char * xccdf_check::xccdf_check_get_content (const struct xccdf_check *check)
 Get check content.
struct xccdf_rulexccdf_check::xccdf_check_get_parent (const struct xccdf_check *check)
 Get rule containing this check.
struct xccdf_check_iteratorxccdf_check::xccdf_check_get_children (const struct xccdf_check *check)
 Get an iterator to the check content references.
const char * xccdf_check_content_ref::xccdf_check_content_ref_get_href (const struct xccdf_check_content_ref *ref)
 Get URI of the check content reference.
const char * xccdf_check_content_ref::xccdf_check_content_ref_get_name (const struct xccdf_check_content_ref *ref)
 Get name of a part of the check content document this reference is pointing to.
const char * xccdf_profile_note::xccdf_profile_note_get_reftag (const struct xccdf_profile_note *note)
 Get profile note tag.
const char * xccdf_profile_note::xccdf_profile_note_get_text (const struct xccdf_profile_note *note)
 Get profile note text as a piece of XML.
const char * xccdf_check_import::xccdf_check_import_get_name (const struct xccdf_check_import *item)
 Get check import target system variable name.
const char * xccdf_check_import::xccdf_check_import_get_content (const struct xccdf_check_import *item)
 Get content of the imported variable.
const char * xccdf_check_export::xccdf_check_export_get_name (const struct xccdf_check_export *item)
 Get check export target system variable name.
struct xccdf_valuexccdf_check_export::xccdf_check_export_get_value (const struct xccdf_check_export *item)
 Get an XCCDF value bound to the check export item.
const char * xccdf_fix::xccdf_fix_get_content (const struct xccdf_fix *fix)
 Get fix content (e.g.
bool xccdf_fix::xccdf_fix_get_reboot (const struct xccdf_fix *fix)
 True if the fix needs rebooting a system.
xccdf_strategy_t xccdf_fix::xccdf_fix_get_strategy (const struct xccdf_fix *fix)
 Get fix strategy.
xccdf_level_t xccdf_fix::xccdf_fix_get_complexity (const struct xccdf_fix *fix)
 Get fix complexity.
xccdf_level_t xccdf_fix::xccdf_fix_get_disruption (const struct xccdf_fix *fix)
 Get fix disruption.
const char * xccdf_fix::xccdf_fix_get_id (const struct xccdf_fix *fix)
 Get fix ID,.
const char * xccdf_fix::xccdf_fix_get_system (const struct xccdf_fix *fix)
 Get fix fixing system URI,.
const char * xccdf_fix::xccdf_fix_get_platform (const struct xccdf_fix *fix)
 Get URI of a platform the fix applies to.
bool xccdf_fixtext::xccdf_fixtext_get_reboot (const struct xccdf_fixtext *fixtext)
 True if the fixtext needs rebooting a system.
xccdf_strategy_t xccdf_fixtext::xccdf_fixtext_get_strategy (const struct xccdf_fixtext *fixtext)
 Get fixtext strategy.
xccdf_level_t xccdf_fixtext::xccdf_fixtext_get_complexity (const struct xccdf_fixtext *fixtext)
 Get fixtext complexity.
xccdf_level_t xccdf_fixtext::xccdf_fixtext_get_disruption (const struct xccdf_fixtext *fixtext)
 Get fixtext disruption.
struct xccdf_fixxccdf_fixtext::xccdf_fixtext_get_fixref (const struct xccdf_fixtext *fixtext)
 Get a fix this text references to.

Enumeration Type Documentation

Boolean operators for logical expressions.

Enumerator:
XCCDF_OPERATOR_AND 

Logical and.

XCCDF_OPERATOR_OR 

Logical or.

XCCDF_OPERATOR_NOT 

Logical negation.

XCCDF_OPERATOR_NAND 

Logical nand.

XCCDF_OPERATOR_NOR 

Logical nor.

XCCDF_OPERATOR_MASK 

Mask to strip the negation away (using bitwise and).

Interface hint.

Enumerator:
XCCDF_IFACE_HINT_NONE 

No interface hint.

XCCDF_IFACE_HINT_CHOICE 

Choice from multiple values.

XCCDF_IFACE_HINT_TEXTLINE 

Text line input widget.

XCCDF_IFACE_HINT_TEXT 

Textarea.

XCCDF_IFACE_HINT_DATE 

Date selection widget.

XCCDF_IFACE_HINT_DATETIME 

Date and time selection widget.

XCCDF error, complexity, disruption, or severity level.

Enumerator:
XCCDF_UNKNOWN 

Unknown.

XCCDF_INFO 

Info.

XCCDF_LOW 

Low.

XCCDF_MEDIUM 

Medium.

XCCDF_HIGH 

High.

Severity of an xccdf_message.

Enumerator:
XCCDF_MSG_INFO 

Info.

XCCDF_MSG_WARNING 

Warning.

XCCDF_MSG_ERROR 

Error.

Operator to be applied on an xccdf_value.

Enumerator:
XCCDF_OPERATOR_EQUALS 

Equality.

XCCDF_OPERATOR_NOT_EQUAL 

Inequality.

XCCDF_OPERATOR_GREATER 

Greater than.

XCCDF_OPERATOR_GREATER_EQUAL 

Greater than or equal.

XCCDF_OPERATOR_LESS 

Less than.

XCCDF_OPERATOR_LESS_EQUAL 

Less than or equal.

XCCDF_OPERATOR_PATTERN_MATCH 

Match a regular expression.

XCCDF role.

Enumerator:
XCCDF_ROLE_FULL 

Check the rule and let the result contriburte to the score and appear in reports.

XCCDF_ROLE_UNSCORED 

Check the rule and include the result in reports, but do not include it into score computations.

XCCDF_ROLE_UNCHECKED 

Don't check the rule, result will be XCCDF_RESULT_UNKNOWN.

Status of an XCCDF item.

Enumerator:
XCCDF_STATUS_NOT_SPECIFIED 

Status was not specified by benchmark.

XCCDF_STATUS_ACCEPTED 

Accepted.

XCCDF_STATUS_DEPRECATED 

Deprecated.

XCCDF_STATUS_DRAFT 

Draft item.

XCCDF_STATUS_INCOMPLETE 

The item is not complete.

XCCDF_STATUS_INTERIM 

Interim.

Fix strategy type.

Enumerator:
XCCDF_STRATEGY_UNKNOWN 

Strategy not defined.

XCCDF_STRATEGY_CONFIGURE 

Adjust target config or settings.

XCCDF_STRATEGY_DISABLE 

Turn off or deinstall something.

XCCDF_STRATEGY_ENABLE 

Turn on or install something.

XCCDF_STRATEGY_PATCH 

Apply a patch, hotfix, or update.

XCCDF_STRATEGY_POLICY 

Remediation by changing policies/procedures.

XCCDF_STRATEGY_RESTRICT 

Adjust permissions or ACLs.

XCCDF_STRATEGY_UPDATE 

Install upgrade or update the system.

XCCDF_STRATEGY_COMBINATION 

Combo of two or more of the above.

Test result.

Enumerator:
XCCDF_RESULT_PASS 

The test passed.

XCCDF_RESULT_FAIL 

The test failed.

XCCDF_RESULT_ERROR 

An error occurred and test could not complete.

XCCDF_RESULT_UNKNOWN 

Could not tell what happened.

XCCDF_RESULT_NOT_APPLICABLE 

Rule did not apply to test target.

XCCDF_RESULT_NOT_CHECKED 

Rule did not cause any evaluation by the checking engine.

XCCDF_RESULT_NOT_SELECTED 

Rule was not selected in the Benchmark.

XCCDF_RESULT_INFORMATIONAL 

Rule was evaluated by the checking engine, but isn't to be scored.

XCCDF_RESULT_FIXED 

Rule failed, but was later fixed.

Type of an XCCDF object.

When checking the type, you can use either operator == for type equivalence, or operator & to take a type inheriritance hierarchy into account. For example, XCCDF_ITEM & XCCDF_RULE evaluates to true, as the rule type is a subclass of the xccdf item type.

Enumerator:
XCCDF_BENCHMARK 

Type constant for xccdf_benchmark.

XCCDF_PROFILE 

Type constant for xccdf_profile.

XCCDF_RESULT 

Type constant for xccdf_result.

XCCDF_RULE 

Type constant for xccdf_rule.

XCCDF_GROUP 

Type constant for xccdf_group.

XCCDF_VALUE 

Type constant for xccdf_value.

XCCDF_CONTENT 

Represents selectable items, i.e. rules and groups (see xccdf_item).

XCCDF_ITEM 

Represents items as described in the XCCDF documentation (see xccdf_item).

XCCDF_OBJECT 

Represents an object, profile, result or whole benchmark (see xccdf_item).

Type of an xccdf_value.

Enumerator:
XCCDF_TYPE_NUMBER 

Integer.

XCCDF_TYPE_STRING 

String.

XCCDF_TYPE_BOOLEAN 

Boolean.

Category of xccdf_warning.

Enumerator:
XCCDF_WARNING_GENERAL 

General-purpose warning.

XCCDF_WARNING_FUNCTIONALITY 

Warning about possible impacts to functionality.

XCCDF_WARNING_PERFORMANCE 

Warning about changes to target system performance.

XCCDF_WARNING_HARDWARE 

Warning about hardware restrictions or possible impacts to hardware.

XCCDF_WARNING_LEGAL 

Warning about legal implications.

XCCDF_WARNING_REGULATORY 

Warning about regulatory obligations.

XCCDF_WARNING_MANAGEMENT 

Warning about impacts to the mgmt or administration of the target system.

XCCDF_WARNING_AUDIT 

Warning about impacts to audit or logging.

XCCDF_WARNING_DEPENDENCY 

Warning about dependencies between this Rule and other parts of the target system.


Function Documentation

void xccdf_benchmark_free ( struct xccdf_benchmark benchmark  )  [related, inherited]

Delete the benchmark.

Parameters:
benchmark Benchmark to be deleted.
struct xccdf_item_iterator * xccdf_benchmark_get_content ( const struct xccdf_benchmark benchmark  )  [related, inherited]

Get an iterator to the bencmark content.

The items are either groups or rules.

See also:
xccdf_rule
xccdf_group
xccdf_item
struct xccdf_item * xccdf_benchmark_get_item ( const struct xccdf_benchmark benchmark,
const char *  id 
) [related, inherited]

Get benchmark item by ID.

Parameters:
item ID
Returns:
Item with given ID
Return values:
NULL if no such item exists
struct xccdf_model_iterator * xccdf_benchmark_get_models ( const struct xccdf_benchmark benchmark  )  [related, inherited]

Get an iterator to the benchmark scoring models.

See also:
xccdf_model
struct xccdf_notice_iterator * xccdf_benchmark_get_notices ( const struct xccdf_benchmark benchmark  )  [related, inherited]

Get an iterator to the benchmark legal notices.

See also:
xccdf_notice
const char * xccdf_benchmark_get_plain_text ( const struct xccdf_benchmark benchmark,
const char *  id 
) [related, inherited]

Get a plain text by ID.

Parameters:
id ID of the plain text to get.
Returns:
Plain text content.
Return values:
NULL if given plain text does not exist
struct xccdf_profile_iterator * xccdf_benchmark_get_profiles ( const struct xccdf_benchmark benchmark  )  [related, inherited]

Get an iterator to the benchmark XCCDF profiles.

See also:
xccdf_profile
struct xccdf_benchmark * xccdf_benchmark_parse_xml ( const char *  filename  )  [related, inherited]

Convert the item to a benchmark.

Returns:
Pointer to this item as the benchmark.
Return values:
NULL on faliure (e.g. item is not a benchmark) Convert the item to a profile.
Returns:
Pointer to this item as the profile.
Return values:
NULL on faliure (e.g. item is not a profile) Convert the item to a rule.
Returns:
Pointer to this item as the rule.
Return values:
NULL on faliure (e.g. item is not a rule) Convert the item to a group.
Returns:
Pointer to this item as the group.
Return values:
NULL on faliure (e.g. item is not a group) Convert the item to a value.
Returns:
Pointer to this item as the value.
Return values:
NULL on faliure (e.g. item is not a value) Convert the item to a test result.
Returns:
Pointer to this item as the test result.
Return values:
NULL on faliure (e.g. item is not a test result) Create a new benmchmark from a benchmark XML file.
Parameters:
filename Name of the file to load the contents from.
Returns:
Pointer to the new benchmark.
Return values:
NULL on failure
struct xccdf_check_iterator * xccdf_check_get_children ( const struct xccdf_check check  )  [related, inherited]

Get an iterator to the check content references.

See also:
xccdf_check_get_content_ref Get an iterator to the check imports.
xccdf_check_get_import Get an iterator to the check exports.
xccdf_check_get_export Get an iterator to nested checks of the complex check.
xccdf_check_get_export
bool xccdf_check_get_complex ( const struct xccdf_check check  )  [related, inherited]

True if the check is a complex check.

See also:
xccdf_check_get_children
xccdf_bool_operator_t xccdf_check_get_oper ( const struct xccdf_check check  )  [related, inherited]

Get an operator to be applied no children of the complex check.

See also:
xccdf_check_get_children
void xccdf_cleanup ( void   ) 

Release library internal caches.

Deprecated:
Use oscap_cleanup() instead.
const char * xccdf_fix_get_content ( const struct xccdf_fix fix  )  [related, inherited]

Get fix content (e.g.

a script).

struct xccdf_item_iterator * xccdf_group_get_content ( const struct xccdf_group benchmark  )  [related, inherited]

Get an iterator to the group content.

The items are either groups or rules.

See also:
xccdf_rule
xccdf_group
xccdf_item
struct xccdf_item * xccdf_group_get_parent ( const struct xccdf_group group  )  [related, inherited]

Return group's parent in the grouping hierarchy.

Returned item will be either a group or a benchmark.

const char * xccdf_ident_get_id ( const struct xccdf_ident ident  )  [related, inherited]

Get scoring model parameter.

Get ident ID.

struct xccdf_item * xccdf_item_get_parent ( const struct xccdf_item item  )  [related, inherited]

Return item's parent in the grouping hierarchy.

Returned item will be either a group or a benchmark.

struct xccdf_select_iterator * xccdf_profile_get_selects ( const struct xccdf_profile profile  )  [related, inherited]

Get profile note tag.

Get an iterator to the select options of the profile.

struct xccdf_item * xccdf_rule_get_parent ( const struct xccdf_rule rule  )  [related, inherited]

Return rule's parent in the grouping hierarchy.

Returned item will be either a group or a benchmark.

time_t xccdf_status_get_date ( const struct xccdf_status status  )  [related, inherited]

Get an iterator to the XCCDF value's source URIs.

Get status date.

bool xccdf_value_get_defval_boolean ( const struct xccdf_value value  )  [related, inherited]

Return the item's default value as a boolean value.

Implicit conversion is performed on non-boolean types: value is true for nonempty strings and nonzero numbers.

Returns:
boolean value
xccdf_numeric xccdf_value_get_defval_number ( const struct xccdf_value value  )  [related, inherited]

Return the item's default value as a number.

Returns:
numeric value
Return values:
NAN if value is not a number or is not set.
const char * xccdf_value_get_defval_string ( const struct xccdf_value value  )  [related, inherited]

Return the item's default value as a string.

Returns:
string value
Return values:
NULL if value is not a string or is not set
xccdf_numeric xccdf_value_get_lower_bound ( const struct xccdf_value value  )  [related, inherited]

Return upper limit for the numeric value.

Return values:
NAN if value is not a number or lower limit is not set.
const char * xccdf_value_get_match ( const struct xccdf_value value  )  [related, inherited]

Regex the values should match.

Return values:
NULL if regex was not set or the value is not a string.
bool xccdf_value_get_must_match ( const struct xccdf_value value  )  [related, inherited]

Return mustMatch property.

Returns whether value must match conditions given by choices, or these are just hints.

struct xccdf_item * xccdf_value_get_parent ( const struct xccdf_value value  )  [related, inherited]

Return value's parent in the grouping hierarchy.

Returned item will be either a value or a benchmark.

bool xccdf_value_get_set_selector ( struct xccdf_item value,
const char *  selector 
) [related, inherited]

Apply a selector on the value.

Parameters:
The selector character string.
Returns:
whether setting the new selector was successful
xccdf_numeric xccdf_value_get_upper_bound ( const struct xccdf_value value  )  [related, inherited]

Return lower limit for the numeric value.

Return values:
NAN if value is not a number or upper limit is not set.
bool xccdf_value_get_value_boolean ( const struct xccdf_value value  )  [related, inherited]

Return the item's value as a boolean value.

Implicit conversion is performed on non-boolean types: value is true for nonempty strings and nonzero numbers.

Returns:
boolean value
xccdf_numeric xccdf_value_get_value_number ( const struct xccdf_value value  )  [related, inherited]

Return the item's value as a number.

Returns:
numeric value
Return values:
NAN if value is not a number or is not set.
const char * xccdf_value_get_value_string ( const struct xccdf_value value  )  [related, inherited]

Return the item's value as a string.

Returns:
string value
Return values:
NULL if value is not a string or is not set

Generated on 4 Jan 2010 for Open SCAP Library by  doxygen 1.6.1