xccdf_policy.h File Reference

Open-scap XCCDF Policy library interface. More...

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

Go to the source code of this file.

Typedefs

typedef void *(* xccdf_policy_engine_query_fn )(void *, xccdf_policy_engine_query_t, void *)
 Type of function which implements queries defined within xccdf_policy_engine_query_t.
typedef xccdf_test_result_type_t(* xccdf_policy_engine_eval_fn )(struct xccdf_policy *policy, const char *rule_id, const char *definition_id, const char *href_if, struct xccdf_value_binding_iterator *value_binding_it, struct xccdf_check_import_iterator *check_imports_it, void *user_data)
 Type of function which implements OpenSCAP checking engine.
typedef int(* policy_reporter_output )(struct xccdf_rule_result *, void *)
typedef int(* policy_reporter_start )(struct xccdf_rule *, void *)

Enumerations

enum  xccdf_policy_engine_query_t { POLICY_ENGINE_QUERY_NAMES_FOR_HREF = 1 }
 Type of a query over checking-engine data. More...

Functions

struct xccdf_policy_modelxccdf_policy_model_new (struct xccdf_benchmark *benchmark)
 Constructor of Policy Model structure.
struct xccdf_policyxccdf_policy_new (struct xccdf_policy_model *model, struct xccdf_profile *profile)
 Constructor of Policy structure.
struct xccdf_value_bindingxccdf_value_binding_new (void)
 Constructor of structure with profile bindings - refine_rules, refine_values and set_values xccdf_value_binding.
void xccdf_policy_model_free (struct xccdf_policy_model *)
 Destructor of Policy Model structure xccdf_policy_model.
void xccdf_policy_free (struct xccdf_policy *)
 Destructor of Policy structure xccdf_policy.
void xccdf_value_binding_free (struct xccdf_value_binding *)
 Destructor of Value binding structure xccdf_value_binding.
bool xccdf_policy_model_set_tailoring (struct xccdf_policy_model *model, struct xccdf_tailoring *tailoring)
 Sets the Tailoring element to use in the policy.
struct xccdf_tailoringxccdf_policy_model_get_tailoring (struct xccdf_policy_model *model)
 Retrieves the Tailoring element used in this policy.
char * xccdf_policy_get_readable_item_title (struct xccdf_policy *policy, struct xccdf_item *item, const char *preferred_lang)
 Get human readable title of given XCCDF Item.
char * xccdf_policy_get_readable_item_description (struct xccdf_policy *policy, struct xccdf_item *item, const char *preferred_lang)
 Get human readable description of given XCCDF Item.
bool xccdf_policy_model_add_cpe_dict_source (struct xccdf_policy_model *model, struct oscap_source *source)
 Registers an additional CPE dictionary for applicability testing The one embedded in the evaluated XCCDF take precedence!
bool xccdf_policy_model_add_cpe_dict (struct xccdf_policy_model *model, const char *cpe_dict)
 Registers an additional CPE dictionary for applicability testing The one embedded in the evaluated XCCDF take precedence!
bool xccdf_policy_model_add_cpe_lang_model_source (struct xccdf_policy_model *model, struct oscap_source *source)
 Registers an additional CPE lang model for applicability testing The one embedded in the evaluated XCCDF take precedence!
bool xccdf_policy_model_add_cpe_lang_model (struct xccdf_policy_model *model, const char *cpe_lang)
 Registers an additional CPE lang model for applicability testing The one embedded in the evaluated XCCDF take precedence!
bool xccdf_policy_model_add_cpe_autodetect_source (struct xccdf_policy_model *model, struct oscap_source *source)
 Registers an additional CPE resource (either dictionary or language) Autodetects given file and acts accordingly.
bool xccdf_policy_model_add_cpe_autodetect (struct xccdf_policy_model *model, const char *filepath)
 Registers an additional CPE resource (either dictionary or language) Autodetects given file and acts accordingly.
struct oscap_htable_iterator * xccdf_policy_model_get_cpe_oval_sessions (struct xccdf_policy_model *model)
 Retrieves an iterator of all OVAL sessions created for CPE applicability evaluation key is the OVAL href, value is the OVAL session itself (type oval_agent_session*).
bool xccdf_policy_model_register_engine_callback (struct xccdf_policy_model *model, char *sys, void *func, void *usr)
 Function to register callback for checking system.
bool xccdf_policy_model_register_engine_and_query_callback (struct xccdf_policy_model *model, char *sys, xccdf_policy_engine_eval_fn eval_fn, void *usr, xccdf_policy_engine_query_fn query_fn)
 Function to register callback for checking system.
bool xccdf_policy_model_register_output_callback (struct xccdf_policy_model *model, policy_reporter_output func, void *usr)
 Function to register output callback for checking system that will be called AFTER each rule evaluation.
bool xccdf_policy_model_register_start_callback (struct xccdf_policy_model *model, policy_reporter_start func, void *usr)
 Function to register start callback for checking system that will be called BEFORE each rule evaluation.
Getters
Return value is pointer to structure's member.

Do not free unless you null the pointer in the structure. Use remove function otherwise.

struct xccdf_policy_modelxccdf_policy_get_model (const struct xccdf_policy *policy)
 Get model from Policy (parent structure of Policy to access the benchmark).
struct xccdf_benchmarkxccdf_policy_model_get_benchmark (const struct xccdf_policy_model *item)
 Get Benchmark from Policy Model.
struct
xccdf_value_binding_iterator * 
xccdf_policy_get_values (const struct xccdf_policy *item)
 Get Value Bindings from XCCDF Policy xccdf_policy.
struct xccdf_policy_iteratorxccdf_policy_model_get_policies (const struct xccdf_policy_model *model)
 Get policies from Policy Model.
int xccdf_policy_model_build_all_useful_policies (struct xccdf_policy_model *policy_model)
 Build all policies that can be useful for user.
struct xccdf_select_iteratorxccdf_policy_get_selected_rules (struct xccdf_policy *)
 Get selected rules from policy xccdf_policy.
struct xccdf_profilexccdf_policy_get_profile (const struct xccdf_policy *)
 Get XCCDF Profile from Policy xccdf_policy.
struct xccdf_select_iteratorxccdf_policy_get_selects (const struct xccdf_policy *)
 Get rules from Policy xccdf_policy.
char * xccdf_value_binding_get_name (const struct xccdf_value_binding *)
 Get variable name from value bindings xccdf_value_binding.
char * xccdf_value_binding_get_value (const struct xccdf_value_binding *)
 Get value from value bindings xccdf_value_binding.
xccdf_value_type_t xccdf_value_binding_get_type (const struct xccdf_value_binding *)
 get variable type from value bindings xccdf_value_binding
xccdf_operator_t xccdf_value_binding_get_operator (const struct xccdf_value_binding *)
 get Value operator from value bindings xccdf_value_binding
char * xccdf_value_binding_get_setvalue (const struct xccdf_value_binding *)
 get Set Value from value bindings xccdf_value_binding
struct xccdf_result_iteratorxccdf_policy_get_results (const struct xccdf_policy *policy)
 Get results of all XCCDF Policy results xccdf_policy_model.
struct xccdf_resultxccdf_policy_get_result_by_id (struct xccdf_policy *policy, const char *id)
 Get XCCDF Result structure by it's idetificator if there is one xccdf_policy_model.
const char * xccdf_policy_get_id (struct xccdf_policy *policy)
 Get ID of XCCDF Profile that is implemented by XCCDF Policy.
struct xccdf_policyxccdf_policy_model_get_policy_by_id (struct xccdf_policy_model *policy_model, const char *id)
 Get XCCDF Policy from Policy model by speciefied ID of Profile.
Setters
For lists use add functions.

Parameters of set functions are duplicated in memory and need to be freed by caller.

bool xccdf_policy_model_add_policy (struct xccdf_policy_model *, struct xccdf_policy *)
 Add Policy to Policy Model xccdf_policy_model.
bool xccdf_policy_add_select (struct xccdf_policy *, struct xccdf_select *)
 Add rule to Policy xccdf_policy.
bool xccdf_policy_set_selected (struct xccdf_policy *policy, char *idref)
 Set a new selector to the Policy structure xccdf_policy.
bool xccdf_policy_add_result (struct xccdf_policy *policy, struct xccdf_result *item)
 Add result to XCCDF Policy Model xccdf_policy_model.
bool xccdf_policy_add_value (struct xccdf_policy *, struct xccdf_value_binding *)
 Add value binding to the Policy structure xccdf_policy.
bool xccdf_policy_is_item_selected (struct xccdf_policy *policy, const char *id)
 Get the selection settings of the item.
int xccdf_policy_get_selected_rules_count (struct xccdf_policy *policy)
 Retrieves number of selected items in the policy.
struct xccdf_selectxccdf_policy_get_select_by_id (struct xccdf_policy *policy, const char *item_id)
 Get select from policy by specified ID of XCCDF Item xccdf_policy.
Evaluators
struct xccdf_resultxccdf_policy_evaluate (struct xccdf_policy *policy)
 Call the checking engine for each selected rule in given policy structure.
bool xccdf_policy_resolve (struct xccdf_policy *policy)
 Resolve benchmark by applying all refine_rules and refine_values to rules / values of benchmark.
int xccdf_policy_generate_fix (struct xccdf_policy *policy, struct xccdf_result *result, const char *sys, int output_fd)
 Generate remediation prescription (presumably a remediation script).
struct xccdf_itemxccdf_policy_tailor_item (struct xccdf_policy *policy, struct xccdf_item *item)
 Clone the item and tailor it against given policy (profile).
struct oscap_file_entry * oscap_file_entry_new (void)
 oscap_file_entry
struct oscap_file_entry * oscap_file_entry_dup (struct oscap_file_entry *file_entry)
 oscap_file_entry
void oscap_file_entry_free (struct oscap_file_entry *entry)
 oscap_file_entry
const char * oscap_file_entry_get_system (struct oscap_file_entry *entry)
 oscap_file_entry
const char * oscap_file_entry_get_file (struct oscap_file_entry *entry)
 oscap_file_entry
struct oscap_file_entry * oscap_file_entry_iterator_next (struct oscap_file_entry_iterator *it)
 oscap_file_entry_iterator
bool oscap_file_entry_iterator_has_more (struct oscap_file_entry_iterator *it)
 oscap_file_entry_iterator
void oscap_file_entry_iterator_free (struct oscap_file_entry_iterator *it)
 oscap_file_entry_iterator
void oscap_file_entry_iterator_reset (struct oscap_file_entry_iterator *it)
 oscap_file_entry_iterator
struct oscap_file_entry_listoscap_file_entry_list_new (void)
 oscap_file_entry_list
void oscap_file_entry_list_free (struct oscap_file_entry_list *list)
 oscap_file_entry_list
struct oscap_file_entry_iteratoroscap_file_entry_list_get_files (struct oscap_file_entry_list *list)
 oscap_file_entry_list
struct oscap_file_entry_listxccdf_policy_model_get_systems_and_files (struct xccdf_policy_model *policy_model)
 Return names of files that are used in checks of particular rules.
struct oscap_file_entry_listxccdf_item_get_systems_and_files (struct xccdf_item *item)
 Return names of files that are used in checks of particular rules.
struct oscap_stringlistxccdf_policy_model_get_files (struct xccdf_policy_model *policy_model)
 Return names of files that are used in checks of particular rules.
struct oscap_stringlistxccdf_item_get_files (struct xccdf_item *item)
 Return names of files that are used in checks of particular rules.
xccdf_test_result_type_t xccdf_test_result_resolve_and_operation (xccdf_test_result_type_t A, xccdf_test_result_type_t B)
 Return result of the AND operation for two given attributes.
Iterators
bool xccdf_policy_iterator_has_more (struct xccdf_policy_iterator *it)
 Return true if the list is not empty, false otherwise xccdf_policy_iterator.
struct xccdf_policyxccdf_policy_iterator_next (struct xccdf_policy_iterator *it)
 Return the next xccdf_policy structure from the list and increment the iterator xccdf_policy_iterator.
void xccdf_policy_iterator_free (struct xccdf_policy_iterator *it)
 Free the iterator structure (it makes no changes to the list structure) xccdf_policy_iterator.
void xccdf_policy_iterator_reset (struct xccdf_policy_iterator *it)
 Reset the iterator structure (it will point to the first item in the list) xccdf_policy_iterator.
bool xccdf_value_binding_iterator_has_more (struct xccdf_value_binding_iterator *it)
 Return true if the list is not empty, false otherwise xccdf_value_binding_iterator.
struct xccdf_value_bindingxccdf_value_binding_iterator_next (struct xccdf_value_binding_iterator *it)
 Return the next xccdf_value_binding structure from the list and increment the iterator xccdf_value_binding_iterator.
void xccdf_value_binding_iterator_free (struct xccdf_value_binding_iterator *it)
 Free the iterator structure (it makes no changes to the list structure) xccdf_value_binding_iterator.
void xccdf_value_binding_iterator_reset (struct xccdf_value_binding_iterator *it)
 Reset the iterator structure (it will point to the first item in the list) xccdf_value_binding_iterator.
struct xccdf_scorexccdf_policy_get_score (struct xccdf_policy *policy, struct xccdf_result *test_result, const char *system)
 Get score of the XCCDF Benchmark.
int xccdf_policy_recalculate_score (struct xccdf_policy *policy, struct xccdf_result *test_result)
 Recalculate score of the XCCDF Benchmark.
const char * xccdf_policy_get_value_of_item (struct xccdf_policy *policy, struct xccdf_item *item)
 Get value of given value item in context of given policy xccdf_policy.
char * xccdf_policy_substitute (const char *text, struct xccdf_policy *policy)
 Perform textual substitution of cdf:sub elements with respect to given XCCDF policy.


Detailed Description

Open-scap XCCDF Policy library interface.

Author:
Maros Barabas <mbarabas@redhat.com>

Dave Niemoller <david.niemoller@g2-inc.com>


Generated on Tue Nov 14 12:18:57 2017 for Open SCAP Library by  doxygen 1.5.6