Open SCAP Library
xccdf_session.h
Go to the documentation of this file.
1 
12 /*
13  * Copyright 2013 Red Hat Inc., Durham, North Carolina.
14  * All Rights Reserved.
15  *
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  *
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24  * Lesser General Public License for more details.
25  *
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29  *
30  */
31 
32 #ifndef XCCDF_SESSION_H_
33 #define XCCDF_SESSION_H_
34 
35 #include "xccdf_policy.h"
36 #include "oscap_download_cb.h"
37 #include "oscap_export.h"
38 
43 struct xccdf_session;
44 
50 typedef enum {
51  XCCDF_SESSION_LOAD_NONE = 0,
52  XCCDF_SESSION_LOAD_XCCDF = 1 << 0,
53  XCCDF_SESSION_LOAD_CPE = 1 << 1,
54  XCCDF_SESSION_LOAD_OVAL = 1 << 2,
55  XCCDF_SESSION_LOAD_CHECK_ENGINE_PLUGINS = 1 << 3,
56  XCCDF_SESSION_LOAD_ALL = XCCDF_SESSION_LOAD_XCCDF | XCCDF_SESSION_LOAD_CPE | XCCDF_SESSION_LOAD_OVAL | XCCDF_SESSION_LOAD_CHECK_ENGINE_PLUGINS
58 
66 OSCAP_API struct xccdf_session *xccdf_session_new(const char *filename);
67 
76 
82 OSCAP_API void xccdf_session_free(struct xccdf_session *session);
83 
88 OSCAP_API const char *xccdf_session_get_filename(const struct xccdf_session *session);
89 
96 OSCAP_API bool xccdf_session_is_sds(const struct xccdf_session *session);
97 
105 OSCAP_API void xccdf_session_set_rule(struct xccdf_session *session, const char *rule);
106 
118 
127 OSCAP_API void xccdf_session_set_thin_results(struct xccdf_session *session, bool thin_result);
128 
137 OSCAP_API void xccdf_session_set_datastream_id(struct xccdf_session *session, const char *datastream_id);
138 
144 OSCAP_API const char *xccdf_session_get_datastream_id(struct xccdf_session *session);
145 
154 OSCAP_API void xccdf_session_set_component_id(struct xccdf_session *session, const char *component_id);
155 
161 OSCAP_API const char *xccdf_session_get_component_id(struct xccdf_session *session);
162 
169 OSCAP_API void xccdf_session_set_benchmark_id(struct xccdf_session *session, const char *benchmark_id);
170 
176 OSCAP_API const char *xccdf_session_get_benchmark_id(struct xccdf_session *session);
177 
182 OSCAP_API const char *xccdf_session_get_result_id(struct xccdf_session *session);
183 
191 OSCAP_API void xccdf_session_set_user_cpe(struct xccdf_session *session, const char *user_cpe);
192 
200 OSCAP_API void xccdf_session_set_user_tailoring_file(struct xccdf_session *session, const char *user_tailoring_file);
201 
209 OSCAP_API void xccdf_session_set_user_tailoring_cid(struct xccdf_session *session, const char *user_tailoring_cid);
210 
219 OSCAP_API void xccdf_session_set_remote_resources(struct xccdf_session *session, bool allowed, download_progress_calllback_t callback);
220 
228 
237 OSCAP_API void xccdf_session_set_custom_oval_files(struct xccdf_session *session, char **oval_filenames);
238 
247 
255 OSCAP_API bool xccdf_session_set_product_cpe(struct xccdf_session *session, const char *product_cpe);
256 
264 
271 OSCAP_API void xccdf_session_set_oval_results_export(struct xccdf_session *session, bool to_export_oval_results);
272 
279 OSCAP_API void xccdf_session_set_check_engine_plugins_results_export(struct xccdf_session *session, bool to_export_results);
280 
287 OSCAP_API void xccdf_session_set_oval_variables_export(struct xccdf_session *session, bool to_export_oval_variables);
288 
296 OSCAP_API bool xccdf_session_set_xccdf_export(struct xccdf_session *session, const char *xccdf_file);
297 
306 
314 OSCAP_API bool xccdf_session_set_arf_export(struct xccdf_session *session, const char *arf_file);
315 
323 OSCAP_API bool xccdf_session_set_report_export(struct xccdf_session *session, const char *report_file);
324 
332 OSCAP_API bool xccdf_session_set_profile_id(struct xccdf_session *session, const char *profile_id);
333 
342 OSCAP_API int xccdf_session_set_profile_id_by_suffix(struct xccdf_session *session, const char *profile_suffix);
343 
349 OSCAP_API const char *xccdf_session_get_profile_id(struct xccdf_session *session);
350 
358 OSCAP_API struct ds_sds_index *xccdf_session_get_sds_idx(struct xccdf_session *session);
359 
367 OSCAP_API int xccdf_session_load(struct xccdf_session *session);
368 
381 OSCAP_API int xccdf_session_load_xccdf(struct xccdf_session *session);
382 
390 OSCAP_API int xccdf_session_load_cpe(struct xccdf_session *session);
391 
398 OSCAP_API int xccdf_session_load_oval(struct xccdf_session *session);
399 
414 OSCAP_API int xccdf_session_load_check_engine_plugin2(struct xccdf_session *session, const char* plugin_name, bool quiet);
415 OSCAP_API int xccdf_session_load_check_engine_plugin(struct xccdf_session *session, const char* plugin_name);
416 
427 OSCAP_API int xccdf_session_load_check_engine_plugins(struct xccdf_session *session);
428 
435 OSCAP_API int xccdf_session_load_tailoring(struct xccdf_session *session);
436 
443 OSCAP_API int xccdf_session_evaluate(struct xccdf_session *session);
444 
451 OSCAP_API int xccdf_session_export_xccdf(struct xccdf_session *session);
452 
459 OSCAP_API int xccdf_session_export_oval(struct xccdf_session *session);
460 
469 OSCAP_API int xccdf_session_export_check_engine_plugins(struct xccdf_session *session);
470 
477 OSCAP_API int xccdf_session_export_arf(struct xccdf_session *session);
478 
486 OSCAP_API struct xccdf_policy_model *xccdf_session_get_policy_model(const struct xccdf_session *session);
487 
494 OSCAP_API struct xccdf_policy *xccdf_session_get_xccdf_policy(const struct xccdf_session *session);
495 
502 OSCAP_API float xccdf_session_get_base_score(const struct xccdf_session *session);
503 
510 OSCAP_API unsigned int xccdf_session_get_oval_agents_count(const struct xccdf_session *session);
511 
520 OSCAP_API unsigned int xccdf_session_get_cpe_oval_agents_count(const struct xccdf_session *session);
521 
528 OSCAP_API bool xccdf_session_contains_fail_result(const struct xccdf_session *session);
529 
538 OSCAP_API int xccdf_session_remediate(struct xccdf_session *session);
539 
550 OSCAP_API int xccdf_session_build_policy_from_testresult(struct xccdf_session *session, const char *testresult_id);
551 
559 OSCAP_API int xccdf_session_add_report_from_source(struct xccdf_session *session, struct oscap_source *report_source);
560 
563 #endif
xccdf_session::xccdf_session_export_xccdf
OSCAP_API int xccdf_session_export_xccdf(struct xccdf_session *session)
Export XCCDF file.
Definition: xccdf_session.c:1319
xccdf_session::xccdf_session_add_report_from_source
OSCAP_API int xccdf_session_add_report_from_source(struct xccdf_session *session, struct oscap_source *report_source)
Load xccdf:TestResult to the session from oscap_source.
Definition: xccdf_session.c:1738
xccdf_policy_engine_eval_fn
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.
Definition: xccdf_policy.h:103
xccdf_session::xccdf_session_get_result_id
const OSCAP_API char * xccdf_session_get_result_id(struct xccdf_session *session)
Retrieves the result id.
Definition: xccdf_session.c:348
xccdf_session::xccdf_session_get_profile_id
const OSCAP_API char * xccdf_session_get_profile_id(struct xccdf_session *session)
Retrieves ID of the profile that we will evaluate with, or NULL.
Definition: xccdf_session.c:528
xccdf_session::xccdf_session_set_user_tailoring_file
OSCAP_API 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.
Definition: xccdf_session.c:359
xccdf_session::xccdf_session_get_base_score
OSCAP_API float xccdf_session_get_base_score(const struct xccdf_session *session)
Get the base score of the latest XCCDF evaluation in the session.
oscap_source
Definition: oscap_source.c:66
xccdf_session::session
struct ds_sds_session * session
SDS Registry abstract structure.
Definition: xccdf_session.c:82
xccdf_session::xccdf_session_load
OSCAP_API int xccdf_session_load(struct xccdf_session *session)
Load and parse all XCCDF structures needed to evaluate this session.
Definition: xccdf_session.c:580
xccdf_session::xccdf_session_build_policy_from_testresult
OSCAP_API 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.
Definition: xccdf_session.c:1708
xccdf_session::without_sys_chars
bool without_sys_chars
Shall system characteristics be exported?
Definition: xccdf_session.c:108
xccdf_session::xccdf_session_set_xccdf_export
OSCAP_API bool xccdf_session_set_xccdf_export(struct xccdf_session *session, const char *xccdf_file)
Set where to export XCCDF file.
Definition: xccdf_session.c:411
xccdf_session::xccdf_session_load_check_engine_plugin2
OSCAP_API int xccdf_session_load_check_engine_plugin2(struct xccdf_session *session, const char *plugin_name, bool quiet)
Load extra check engine from a plugin of given name to the XCCDF session.
Definition: xccdf_session.c:1075
xccdf_session::xccdf_session_set_product_cpe
OSCAP_API bool xccdf_session_set_product_cpe(struct xccdf_session *session, const char *product_cpe)
Set custom product CPE name.
Definition: xccdf_session.c:377
xccdf_session::xccdf_session_set_custom_oval_files
OSCAP_API void xccdf_session_set_custom_oval_files(struct xccdf_session *session, char **oval_filenames)
Set custom oval files for this session.
Definition: xccdf_session.c:850
xccdf_session::profile_id
char * profile_id
Last selected profile.
Definition: xccdf_session.c:76
xccdf_session::xccdf_session_set_user_cpe
OSCAP_API void xccdf_session_set_user_cpe(struct xccdf_session *session, const char *user_cpe)
Set path to custom CPE dictionary for the session.
Definition: xccdf_session.c:353
xccdf_session::filename
const char * filename
File name of SCAP (SDS or XCCDF) file for this session.
Definition: xccdf_session.c:69
xccdf_session::xccdf_session_load_tailoring
OSCAP_API int xccdf_session_load_tailoring(struct xccdf_session *session)
Load Tailoring file (if applicable) to the XCCDF session.
Definition: xccdf_session.c:1136
xccdf_session::rule
const char * rule
Single-rule feature: if not NULL, the session will work only with this one rule.
Definition: xccdf_session.c:70
xccdf_session::xccdf_session_set_user_tailoring_cid
OSCAP_API void xccdf_session_set_user_tailoring_cid(struct xccdf_session *session, const char *user_tailoring_cid)
Set ID of Tailoring component for the session.
Definition: xccdf_session.c:366
xccdf_policy
XCCDF policy structure is abstract (class) structure of Profile element from benchmark.
Definition: xccdf_policy_priv.h:57
xccdf_session::xccdf_session_loading_flags_t
xccdf_session_loading_flags_t
Loading flags for XCCDF session.
Definition: xccdf_session.h:50
xccdf_session::xccdf_session_set_xccdf_stig_viewer_export
OSCAP_API bool xccdf_session_set_xccdf_stig_viewer_export(struct xccdf_session *session, const char *xccdf_stig_viewer_file)
Set where to export STIG Viewer XCCDF file.
Definition: xccdf_session.c:418
xccdf_session::xccdf_session_get_component_id
const OSCAP_API char * xccdf_session_get_component_id(struct xccdf_session *session)
Retrieves the component id.
Definition: xccdf_session.c:329
xccdf_session::xccdf_session_set_oval_results_export
OSCAP_API 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.
Definition: xccdf_session.c:389
xccdf_session::xccdf_session_get_sds_idx
OSCAP_API struct ds_sds_index * xccdf_session_get_sds_idx(struct xccdf_session *session)
Get Source DataStream index of the session.
Definition: xccdf_session.c:572
xccdf_session::xccdf_session_set_report_export
OSCAP_API bool xccdf_session_set_report_export(struct xccdf_session *session, const char *report_file)
Set where to export HTML Report file.
Definition: xccdf_session.c:425
xccdf_session::report_file
char * report_file
Path to HTML file to eport.
Definition: xccdf_session.c:104
xccdf_session
Definition: xccdf_session.c:68
xccdf_session::xccdf_session_get_oval_agents_count
OSCAP_API 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.
Definition: xccdf_session.c:1638
xccdf_session::xccdf_session_load_cpe
OSCAP_API int xccdf_session_load_cpe(struct xccdf_session *session)
Load and parse CPE dictionaries.
Definition: xccdf_session.c:765
ds_sds_index
Definition: sds_index.c:214
xccdf_session::xccdf_session_contains_fail_result
OSCAP_API 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.
Definition: xccdf_session.c:1665
xccdf_session::xccdf_session_get_policy_model
OSCAP_API struct xccdf_policy_model * xccdf_session_get_policy_model(const struct xccdf_session *session)
Get policy_model of the session.
xccdf_session::xccdf_session_set_without_sys_chars_export
OSCAP_API void xccdf_session_set_without_sys_chars_export(struct xccdf_session *session, bool without_sys_chars)
Set whether the System Characteristics shall be exported in result files.
Definition: xccdf_session.c:384
xccdf_session::xccdf_session_free
OSCAP_API void xccdf_session_free(struct xccdf_session *session)
Destructor of xccdf_session.
Definition: xccdf_session.c:248
xccdf_session::xccdf_session_set_arf_export
OSCAP_API bool xccdf_session_set_arf_export(struct xccdf_session *session, const char *arf_file)
Set where to export ARF file.
Definition: xccdf_session.c:404
xccdf_session::xccdf_session_get_cpe_oval_agents_count
OSCAP_API 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.
Definition: xccdf_session.c:1647
xccdf_session::xccdf_session_get_benchmark_id
const OSCAP_API char * xccdf_session_get_benchmark_id(struct xccdf_session *session)
Retrieves the benchmark_id.
Definition: xccdf_session.c:343
xccdf_policy_model
XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...
Definition: xccdf_policy_priv.h:38
xccdf_session::xccdf_session_new
OSCAP_API struct xccdf_session * xccdf_session_new(const char *filename)
Costructor of xccdf_session.
Definition: xccdf_session.c:173
xccdf_session::xccdf_session_set_check_engine_plugins_results_export
OSCAP_API 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.
Definition: xccdf_session.c:399
xccdf_session::xccdf_session_load_xccdf
OSCAP_API int xccdf_session_load_xccdf(struct xccdf_session *session)
Load and parse XCCDF file.
Definition: xccdf_session.c:719
xccdf_session::xccdf_session_get_xccdf_policy
OSCAP_API struct xccdf_policy * xccdf_session_get_xccdf_policy(const struct xccdf_session *session)
Get xccdf_policy of the session.
Definition: xccdf_session.c:1629
xccdf_session::xccdf_session_set_custom_oval_eval_fn
OSCAP_API 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.
Definition: xccdf_session.c:372
xccdf_session::xccdf_session_set_validation
OSCAP_API void xccdf_session_set_validation(struct xccdf_session *session, bool validate, bool full_validation)
Set XSD validation level to one of three possibilities:
Definition: xccdf_session.c:298
xccdf_session::user_cpe
char * user_cpe
Path to CPE dictionary required by user.
Definition: xccdf_session.c:111
xccdf_session::full_validation
bool full_validation
True value indicates that every possible step will be validated by XSD.
Definition: xccdf_session.c:117
xccdf_session::xccdf_session_load_oval
OSCAP_API int xccdf_session_load_oval(struct xccdf_session *session)
Load and parse OVAL definitions files for the XCCDF session.
Definition: xccdf_session.c:995
xccdf_session::xccdf_session_set_profile_id
OSCAP_API bool xccdf_session_set_profile_id(struct xccdf_session *session, const char *profile_id)
Select XCCDF Profile for evaluation.
Definition: xccdf_session.c:432
xccdf_session::xccdf_stig_viewer_file
char * xccdf_stig_viewer_file
Path to STIG Viewer XCCDF file to export.
Definition: xccdf_session.c:103
xccdf_session::arf_file
char * arf_file
Path to ARF file to export.
Definition: xccdf_session.c:101
xccdf_session::xccdf_session_set_oval_variables_export
OSCAP_API 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.
Definition: xccdf_session.c:394
xccdf_session::xccdf_session_set_thin_results
OSCAP_API void xccdf_session_set_thin_results(struct xccdf_session *session, bool thin_result)
Set whether the thin results override is enabled.
Definition: xccdf_session.c:304
xccdf_session::xccdf_session_is_sds
OSCAP_API bool xccdf_session_is_sds(const struct xccdf_session *session)
Query if the session is based on Source DataStream.
Definition: xccdf_session.c:288
xccdf_session::xccdf_session_load_check_engine_plugins
OSCAP_API int xccdf_session_load_check_engine_plugins(struct xccdf_session *session)
Load extra check engines (if any are available) to the XCCDF session.
Definition: xccdf_session.c:1101
xccdf_session::xccdf_session_get_datastream_id
const OSCAP_API char * xccdf_session_get_datastream_id(struct xccdf_session *session)
Retrieves the datastream id.
Definition: xccdf_session.c:315
xccdf_session::xccdf_session_evaluate
OSCAP_API int xccdf_session_evaluate(struct xccdf_session *session)
Evaluate XCCDF Policy.
Definition: xccdf_session.c:1185
xccdf_session::xccdf_session_set_remote_resources
OSCAP_API void xccdf_session_set_remote_resources(struct xccdf_session *session, bool allowed, download_progress_calllback_t callback)
Set properties of remote content.
Definition: xccdf_session.c:543
xccdf_session::xccdf_session_new_from_source
OSCAP_API struct xccdf_session * xccdf_session_new_from_source(struct oscap_source *source)
Costructor of xccdf_session.
Definition: xccdf_session.c:131
xccdf_session::xccdf_session_export_arf
OSCAP_API int xccdf_session_export_arf(struct xccdf_session *session)
Export ARF (if enabled by xccdf_session_set_arf_export).
Definition: xccdf_session.c:1603
xccdf_session::xccdf_session_export_oval
OSCAP_API int xccdf_session_export_oval(struct xccdf_session *session)
Export OVAL (result and variables) files.
Definition: xccdf_session.c:1526
xccdf_session::validate
bool validate
False value indicates to skip any XSD validation.
Definition: xccdf_session.c:116
xccdf_session::xccdf_session_set_profile_id_by_suffix
OSCAP_API int xccdf_session_set_profile_id_by_suffix(struct xccdf_session *session, const char *profile_suffix)
Select XCCDF Profile for evaluation with only profile suffix as input.
Definition: xccdf_session.c:486
xccdf_session::xccdf_session_get_filename
const OSCAP_API char * xccdf_session_get_filename(const struct xccdf_session *session)
Retrieves the filename the session was created with.
Definition: xccdf_session.c:283
xccdf_session::product_cpe
char * product_cpe
CPE of scanner product.
Definition: xccdf_session.c:94
xccdf_session::xccdf_session_set_component_id
OSCAP_API void xccdf_session_set_component_id(struct xccdf_session *session, const char *component_id)
Set requested component_id for this session.
Definition: xccdf_session.c:323
xccdf_session::source
struct oscap_source * source
Main source assigned with the main file (SDS or XCCDF)
Definition: xccdf_session.c:71
xccdf_session::xccdf_session_set_benchmark_id
OSCAP_API void xccdf_session_set_benchmark_id(struct xccdf_session *session, const char *benchmark_id)
Sets requested benchmark_id for this session.
Definition: xccdf_session.c:337
xccdf_session::xccdf_session_set_datastream_id
OSCAP_API void xccdf_session_set_datastream_id(struct xccdf_session *session, const char *datastream_id)
Set requested datastream_id for this session.
Definition: xccdf_session.c:309
xccdf_policy.h
xccdf_session::xccdf_session_set_loading_flags
OSCAP_API void xccdf_session_set_loading_flags(struct xccdf_session *session, xccdf_session_loading_flags_t flags)
Disable or allow loading of depending content (OVAL, SCE, CPE)
xccdf_session::xccdf_file
char * xccdf_file
Path to XCCDF file to export.
Definition: xccdf_session.c:102
xccdf_session::xccdf_session_export_check_engine_plugins
OSCAP_API int xccdf_session_export_check_engine_plugins(struct xccdf_session *session)
Export results (if any) from any check engine plugins that are loaded.
Definition: xccdf_session.c:1579
xccdf_session::xccdf_session_set_rule
OSCAP_API void xccdf_session_set_rule(struct xccdf_session *session, const char *rule)
Set rule for session - if rule is not NULL, session will use only this one rule.
Definition: xccdf_session.c:293
xccdf_session::xccdf_session_remediate
OSCAP_API int xccdf_session_remediate(struct xccdf_session *session)
Run XCCDF Remediation.
Definition: xccdf_session.c:1682