/home/pvrabec/openscap/openscap-0.5.8/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_refine_rule_get_item (const struct xccdf_refine_rule *rr)
 xccdf_refine_rule
const char * xccdf_refine_rule_get_selector (const struct xccdf_refine_rule *rr)
 xccdf_refine_rule
xccdf_role_t xccdf_refine_rule_get_role (const struct xccdf_refine_rule *rr)
 xccdf_refine_rule
xccdf_level_t xccdf_refine_rule_get_severity (const struct xccdf_refine_rule *rr)
 xccdf_refine_rule
struct oscap_text_iteratorxccdf_refine_rule_get_remarks (const struct xccdf_refine_rule *rr)
 xccdf_refine_rule
void xccdf_cleanup (void)
 Release library internal caches.
struct xccdf_groupxccdf_benchmark_append_new_group (const struct xccdf_benchmark *, const char *id)
 Create a group and append it to the benchmark.
struct xccdf_valuexccdf_benchmark_append_new_value (const struct xccdf_benchmark *, const char *id, xccdf_value_type_t type)
 Create a value and append it to the benchmark.
struct xccdf_rulexccdf_benchmark_append_new_rule (const struct xccdf_benchmark *, const char *id)
 Create a rule and append it to the benchmark.
struct xccdf_selectxccdf_select_new (void)
void xccdf_item_free (struct xccdf_item *item)
void xccdf_select_free (struct xccdf_select *sel)
void xccdf_refine_rule_free (struct xccdf_refine_rule *rr)
void xccdf_refine_value_free (struct xccdf_refine_value *rv)
void xccdf_setvalue_free (struct xccdf_setvalue *sv)
struct xccdf_selectxccdf_select_clone (const struct xccdf_select *select)
void xccdf_select_set_selected (struct xccdf_select *select, bool selected)
void xccdf_select_set_item (struct xccdf_select *select, const char *item)

Detailed Description

Open-scap XCCDF library interface.

Author:
Lukas Kuklinek <lkuklinek@redhat.com>

Function Documentation

struct xccdf_group* xccdf_benchmark_append_new_group ( const struct xccdf_benchmark ,
const char *  id 
) [read]

Create a group and append it to the benchmark.

Parameters:
id - the identifier of the appended value.
Returns:
the handle of the new group.
struct xccdf_rule* xccdf_benchmark_append_new_rule ( const struct xccdf_benchmark ,
const char *  id 
) [read]

Create a rule and append it to the benchmark.

Parameters:
id - the identifier of the appended rule.
Returns:
the handle of the new rule.
struct xccdf_value* xccdf_benchmark_append_new_value ( const struct xccdf_benchmark ,
const char *  id,
xccdf_value_type_t  type 
) [read]

Create a value and append it to the benchmark.

Parameters:
id - the identifier of the appended value.
Returns:
the handle of the new value.
void xccdf_cleanup ( void   ) 

Release library internal caches.

Deprecated:
Use oscap_cleanup() instead.

Generated on 24 Mar 2010 for Open SCAP Library by  doxygen 1.6.1