/home/pvrabec/openscap/openscap-0.5.6/src/XCCDF/public/xccdf.h File Reference

Open-scap XCCDF library interface. More...

#include <stdbool.h>
#include <time.h>
#include "oscap.h"

Go to the source code of this file.

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.

Detailed Description

Open-scap XCCDF library interface.

Author:
Lukas Kuklinek <lkuklinek@redhat.com>

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