xccdf_session Struct Reference
[Session]

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

#include <xccdf_session.h>

Data Fields
const char *	filename
	File name of SCAP (SDS or XCCDF) file for this session.
const char *	rule
	Single-rule feature: if not NULL, the session will work only with this one rule.
struct oscap_source *	source
	Main source assigned with the main file (SDS or XCCDF).
char *	temp_dir
	Temp directory used for decomposed component files.
struct {
struct oscap_source *   source
	oscap_source representing the XCCDF file
struct xccdf_policy_model *   policy_model
	Active policy model.
char *   profile_id
	Last selected profile.
struct xccdf_result *   result
	XCCDF Result model.
float   base_score
	Basec score of the latest evaluation.
struct oscap_source *   result_source
	oscap_source for the exported XCCDF result
}	xccdf
struct {
struct ds_sds_session *   session
	SDS Registry abstract structure.
char *   user_datastream_id
	Datastream id requested by user (only applicable for sds).
char *   user_component_id
	Component id requested by user (only applicable for sds).
char *   user_benchmark_id
	Benchmark id requested by user (only applicable for sds).
}	ds
struct {
bool   fetch_remote_resources
	Allows download of remote resources (not applicable when user sets custom oval files).
download_progress_calllback_t   progress
	Callback to report progress of download.
struct oval_content_resource **   custom_resources
	OVAL files required by user.
struct oval_content_resource **   resources
	OVAL files referenced from XCCDF.
struct oval_agent_session **   agents
	OVAL Agent Session.
xccdf_policy_engine_eval_fn   user_eval_fn
	Custom OVAL engine callback.
char *   product_cpe
	CPE of scanner product.
struct oscap_source *   arf_report
	ARF report.
struct oscap_htable *   result_sources
	mapping 'filepath' to oscap_source for OVAL results
struct oscap_htable *   results_mapping
	mapping OVAL filename to filepath for OVAL results
struct oscap_htable *   arf_report_mapping
	mapping OVAL filename to ARF report ID for OVAL results
}	oval
struct {
char *   arf_file
	Path to ARF file to export.
char *   xccdf_file
	Path to XCCDF file to export.
char *   xccdf_stig_viewer_file
	Path to STIG Viewer XCCDF file to export.
char *   report_file
	Path to HTML file to eport.
bool   oval_results
	Shall be the OVAL results files exported?
bool   oval_variables
	Shall be the OVAL variable files exported?
bool   check_engine_plugins_results
	Shall the check engine plugins results be exported?
bool   without_sys_chars
	Shall system characteristics be exported?
bool   thin_results
	Shall OVAL/ARF results be exported as THIN? Default is FULL.
}	export
	Settings of Session export.
char *	user_cpe
	Path to CPE dictionary required by user.
struct {
struct oscap_source *   user_file
	Tailoring file requested by the user.
char *   user_component_id
	Component ID of the Tailoring requested by the user.
}	tailoring
bool	validate
	False value indicates to skip any XSD validation.
bool	full_validation
	True value indicates that every possible step will be validated by XSD.
struct oscap_list *	check_engine_plugins
	Extra non-OVAL check engines that may or may not have been loaded.
xccdf_session_loading_flags_t	loading_flags
	Load referenced files while loading XCCDF.

---

Detailed Description

A structure encapsulating the context of XCCDF operations.

---

Field Documentation

struct oscap_source* xccdf_session::source [read]

Main source assigned with the main file (SDS or XCCDF).

oscap_source representing the XCCDF file

char* xccdf_session::user_component_id

Component id requested by user (only applicable for sds).

Component ID of the Tailoring requested by the user.

---

The documentation for this struct was generated from the following file:

• xccdf_session.c