xccdf_session Struct Reference
[Session]

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

#include <xccdf_session.h>

Public Member Functions

struct xccdf_sessionxccdf_session_new (const char *filename)
 Costructor of xccdf_session.
void xccdf_session_free (struct xccdf_session *session)
 Destructor of xccdf_session.
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.
void xccdf_session_set_validation (struct xccdf_session *session, bool validate, bool full_validation)
 Set XSD validation level.
void xccdf_session_set_datastream_id (struct xccdf_session *session, const char *datastream_id)
 Set requested datastream_id for this session.
const char * xccdf_session_get_datastream_id (struct xccdf_session *session)
 Retrieves the datastream id.
void xccdf_session_set_component_id (struct xccdf_session *session, const char *component_id)
 Set requested component_id for this session.
const char * xccdf_session_get_component_id (struct xccdf_session *session)
 Retrieves the component id.
void xccdf_session_set_benchmark_id (struct xccdf_session *session, const char *benchmark_id)
 Sets requested benchmark_id for this session.
const char * xccdf_session_get_benchmark_id (struct xccdf_session *session)
 Retrieves the benchmark_id.
void xccdf_session_set_user_cpe (struct xccdf_session *session, const char *user_cpe)
 Set path to custom CPE dictionary for the session.
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.
void xccdf_session_set_user_tailoring_cid (struct xccdf_session *session, const char *user_tailoring_cid)
 Set ID of Tailoring component for the session.
void xccdf_session_set_remote_resources (struct xccdf_session *session, bool allowed, download_progress_calllback_t callback)
 Set properties of remote content.
void xccdf_session_set_custom_oval_files (struct xccdf_session *session, char **oval_filenames)
 Set custom oval files for this session.
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.
bool xccdf_session_set_product_cpe (struct xccdf_session *session, const char *product_cpe)
 Set custom product CPE name.
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.
void xccdf_session_set_sce_results_export (struct xccdf_session *session, bool to_export_sce_results)
 Set that SCE reult files shall be exported.
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.
bool xccdf_session_set_xccdf_export (struct xccdf_session *session, const char *xccdf_file)
 Set where to export XCCDF file.
bool xccdf_session_set_arf_export (struct xccdf_session *session, const char *arf_file)
 Set where to export ARF file.
bool xccdf_session_set_report_export (struct xccdf_session *session, const char *report_file)
 Set where to export HTML Report file.
bool xccdf_session_set_profile_id (struct xccdf_session *session, const char *profile_id)
 Select XCCDF Profile for evaluation.
const char * xccdf_session_get_profile_id (struct xccdf_session *session)
 Retrieves ID of the profile that we will evaluate with, or NULL.
struct ds_sds_indexxccdf_session_get_sds_idx (struct xccdf_session *session)
 Get Source DataStream index of the session.
int xccdf_session_load (struct xccdf_session *session)
 Load and parse all XCCDF structures needed to evaluate this session.
int xccdf_session_load_xccdf (struct xccdf_session *session)
 Load and parse XCCDF file.
int xccdf_session_load_cpe (struct xccdf_session *session)
 Load and parse CPE dictionaries.
int xccdf_session_load_oval (struct xccdf_session *session)
 Load and parse OVAL definitions files for the XCCDF session.
int xccdf_session_load_sce (struct xccdf_session *session)
 Load Script Check Engine (if available) to the XCCDF session.
int xccdf_session_load_tailoring (struct xccdf_session *session)
 Load Tailoring file (if applicable) to the XCCDF session.
int xccdf_session_evaluate (struct xccdf_session *session)
 Evaluate XCCDF Policy.
int xccdf_session_export_xccdf (struct xccdf_session *session)
 Export XCCDF file.
int xccdf_session_export_oval (struct xccdf_session *session)
 Export OVAL (result and variables) files.
int xccdf_session_export_sce (struct xccdf_session *session)
 Export SCE files (if enabled by xccdf_session_set_sce_results_export).
int xccdf_session_export_arf (struct xccdf_session *session)
 Export ARF (if enabled by xccdf_session_set_arf_export).
struct xccdf_policy_modelxccdf_session_get_policy_model (const struct xccdf_session *session)
 Get policy_model of the session.
struct xccdf_policyxccdf_session_get_xccdf_policy (const struct xccdf_session *session)
 Get xccdf_policy of the session.
float xccdf_session_get_base_score (const struct xccdf_session *session)
 Get the base score of the latest XCCDF evaluation in the session.
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.
unsigned int xccdf_session_get_cpe_oval_agents_count (const struct xccdf_session *session)
 Get count of OVAL agent sessions for CPE in the xccdf_session.
bool xccdf_session_contains_fail_result (const struct xccdf_session *session)
 Query if the result of evaluation contains FAIL, ERROR, or UNKNOWN rule-result elements.
int xccdf_session_remediate (struct xccdf_session *session)
 Run XCCDF Remediation.
int xccdf_session_build_policy_from_testresult (struct xccdf_session *session, const char *testresult_id)
 Load xccdf:TestResult to the session from file and prepare session for remediation.

Data Fields

const char * filename
 File name of SCAP (SDS or XCCDF) file for this session.
char * temp_dir
 Temp directory used for decomposed component files.
struct {
   char *   file
 Path to XCCDF File (shall differ from the filename for sds).
   struct xccdf_policy_model *   policy_model
 Active policy model.
   char *   doc_version
 Version of parsed XCCDF file.
   char *   profile_id
 Last selected profile.
   struct xccdf_result *   result
 XCCDF Result model.
   float   base_score
 Basec score of the latest evaluation.
xccdf
struct {
   struct ds_sds_index *   sds_idx
 Index of Source DataStream (only applicable for sds).
   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).
   char *   datastream_id
 Datastream id used (only applicable for sds).
   char *   component_id
 Component id used (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.
   char **   result_files
 Path to exported OVAL Result files.
oval
struct {
   char *   arf_file
 Path to ARF file to export.
   char *   xccdf_file
 Path to 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   sce_results
 Shall be the SCE results exported?
export
 Settings of Session export.
char * user_cpe
 Path to CPE dictionary required by user.
char * user_tailoring_file
 Path to Tailoring file requested by the user.
char * user_tailoring_cid
 Component ID of the Tailoring file requested by the user.
oscap_document_type_t doc_type
 Document type of the session file (see filename member) used.
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.

Detailed Description

A structure encapsulating the context of XCCDF operations.


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

Generated on 17 Jul 2013 for Open SCAP Library by  doxygen 1.6.1