xccdf_session Struct Reference

A structure encapsulating the context of XCCDF operations. More...

#include <xccdf_session.h>

Public Member Functions
struct xccdf_session *	xccdf_session_new (const char *filename)
	Costructor of xccdf_session. More...
void	xccdf_session_free (struct xccdf_session *session)
	Destructor of xccdf_session. More...
const char *	xccdf_session_get_filename (const struct xccdf_session *session)
	Retrieves the filename the session was created with.
bool	xccdf_session_is_sds (const struct xccdf_session *session)
	Query if the session is based on Source DataStream. More...
void	xccdf_session_set_validation (struct xccdf_session *session, bool validate, bool full_validation)
	Set XSD validation level. More...
void	xccdf_session_set_datastream_id (struct xccdf_session *session, const char *datastream_id)
	Set requested datastream_id for this session. More...
const char *	xccdf_session_get_datastream_id (struct xccdf_session *session)
	Retrieves the datastream id. More...
void	xccdf_session_set_component_id (struct xccdf_session *session, const char *component_id)
	Set requested component_id for this session. More...
const char *	xccdf_session_get_component_id (struct xccdf_session *session)
	Retrieves the component id. More...
void	xccdf_session_set_benchmark_id (struct xccdf_session *session, const char *benchmark_id)
	Sets requested benchmark_id for this session. More...
const char *	xccdf_session_get_benchmark_id (struct xccdf_session *session)
	Retrieves the benchmark_id. More...
void	xccdf_session_set_user_cpe (struct xccdf_session *session, const char *user_cpe)
	Set path to custom CPE dictionary for the session. More...
void	xccdf_session_set_user_tailoring_file (struct xccdf_session *session, const char *user_tailoring_file)
	Set path to custom Tailoring file for the session. More...
void	xccdf_session_set_user_tailoring_cid (struct xccdf_session *session, const char *user_tailoring_cid)
	Set ID of Tailoring component for the session. More...
void	xccdf_session_set_remote_resources (struct xccdf_session *session, bool allowed, download_progress_calllback_t callback)
	Set properties of remote content. More...
void	xccdf_session_set_custom_oval_files (struct xccdf_session *session, char **oval_filenames)
	Set custom oval files for this session. More...
void	xccdf_session_set_custom_oval_eval_fn (struct xccdf_session *session, xccdf_policy_engine_eval_fn eval_fn)
	Set custom OVAL eval function to register with each OVAL session. More...
bool	xccdf_session_set_product_cpe (struct xccdf_session *session, const char *product_cpe)
	Set custom product CPE name. More...
void	xccdf_session_set_oval_results_export (struct xccdf_session *session, bool to_export_oval_results)
	Set whether the OVAL result files shall be exported. More...
void	xccdf_session_set_check_engine_plugins_results_export (struct xccdf_session *session, bool to_export_results)
	Set that check engine plugin's result files shall be exported. More...
void	xccdf_session_set_sce_results_export (struct xccdf_session *session, bool to_export_sce_results)
	Set that SCE reult files shall be exported. More...
void	xccdf_session_set_oval_variables_export (struct xccdf_session *session, bool to_export_oval_variables)
	Set whether the OVAL variables files shall be exported. More...
bool	xccdf_session_set_xccdf_export (struct xccdf_session *session, const char *xccdf_file)
	Set where to export XCCDF file. More...
bool	xccdf_session_set_arf_export (struct xccdf_session *session, const char *arf_file)
	Set where to export ARF file. More...
bool	xccdf_session_set_report_export (struct xccdf_session *session, const char *report_file)
	Set where to export HTML Report file. More...
bool	xccdf_session_set_profile_id (struct xccdf_session *session, const char *profile_id)
	Select XCCDF Profile for evaluation. More...
const char *	xccdf_session_get_profile_id (struct xccdf_session *session)
	Retrieves ID of the profile that we will evaluate with, or NULL. More...
struct ds_sds_index *	xccdf_session_get_sds_idx (struct xccdf_session *session)
	Get Source DataStream index of the session. More...
int	xccdf_session_load (struct xccdf_session *session)
	Load and parse all XCCDF structures needed to evaluate this session. More...
int	xccdf_session_load_xccdf (struct xccdf_session *session)
	Load and parse XCCDF file. More...
int	xccdf_session_load_cpe (struct xccdf_session *session)
	Load and parse CPE dictionaries. More...
int	xccdf_session_load_oval (struct xccdf_session *session)
	Load and parse OVAL definitions files for the XCCDF session. More...
int	xccdf_session_load_check_engine_plugin (struct xccdf_session *session, const char *plugin_name)
	Load extra check engine from a plugin of given name to the XCCDF session. More...
int	xccdf_session_load_check_engine_plugins (struct xccdf_session *session)
	Load extra check engines (if any are available) to the XCCDF session. More...
int	xccdf_session_load_tailoring (struct xccdf_session *session)
	Load Tailoring file (if applicable) to the XCCDF session. More...
int	xccdf_session_evaluate (struct xccdf_session *session)
	Evaluate XCCDF Policy. More...
int	xccdf_session_export_xccdf (struct xccdf_session *session)
	Export XCCDF file. More...
int	xccdf_session_export_oval (struct xccdf_session *session)
	Export OVAL (result and variables) files. More...
int	xccdf_session_export_check_engine_plugins (struct xccdf_session *session)
	Export results (if any) from any check engine plugins that are loaded. More...
int	xccdf_session_export_sce (struct xccdf_session *session)
	Export SCE files (if enabled by xccdf_session_set_sce_results_export). More...
int	xccdf_session_export_arf (struct xccdf_session *session)
	Export ARF (if enabled by xccdf_session_set_arf_export). More...
struct xccdf_policy_model *	xccdf_session_get_policy_model (const struct xccdf_session *session)
	Get policy_model of the session. More...
struct xccdf_policy *	xccdf_session_get_xccdf_policy (const struct xccdf_session *session)
	Get xccdf_policy of the session. More...
float	xccdf_session_get_base_score (const struct xccdf_session *session)
	Get the base score of the latest XCCDF evaluation in the session. More...
unsigned int	xccdf_session_get_oval_agents_count (const struct xccdf_session *session)
	Get count of OVAL agent sessions not used for CPE in the xccdf_session. More...
unsigned int	xccdf_session_get_cpe_oval_agents_count (const struct xccdf_sessi