Open SCAP Library: xccdf_session.h Source File

Open SCAP Library

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

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
42 typedef void (*download_progress_calllback_t) (bool warning, const char * format, ...);
43
48 struct xccdf_session;
49
57 struct xccdf_session *xccdf_session_new(const char *filename);
58
64 void xccdf_session_free(struct xccdf_session *session);
65
70 const char *xccdf_session_get_filename(const struct xccdf_session *session);
71
78 bool xccdf_session_is_sds(const struct xccdf_session *session);
79
87 void xccdf_session_set_validation(struct xccdf_session *session, bool validate, bool full_validation);
88
97 void xccdf_session_set_datastream_id(struct xccdf_session *session, const char *datastream_id);
98
104 const char *xccdf_session_get_datastream_id(struct xccdf_session *session);
105
114 void xccdf_session_set_component_id(struct xccdf_session *session, const char *component_id);
115
121 const char *xccdf_session_get_component_id(struct xccdf_session *session);
122
129 void xccdf_session_set_benchmark_id(struct xccdf_session *session, const char *benchmark_id);
130
136 const char *xccdf_session_get_benchmark_id(struct xccdf_session *session);
137
145 void xccdf_session_set_user_cpe(struct xccdf_session *session, const char *user_cpe);
146
154 void xccdf_session_set_user_tailoring_file(struct xccdf_session *session, const char *user_tailoring_file);
155
163 void xccdf_session_set_user_tailoring_cid(struct xccdf_session *session, const char *user_tailoring_cid);
164
173 void xccdf_session_set_remote_resources(struct xccdf_session *session, bool allowed, download_progress_calllback_t callback);
174
183 void xccdf_session_set_custom_oval_files(struct xccdf_session *session, char **oval_filenames);
184
192 void xccdf_session_set_custom_oval_eval_fn(struct xccdf_session *session, xccdf_policy_engine_eval_fn eval_fn);
193
201 bool xccdf_session_set_product_cpe(struct xccdf_session *session, const char *product_cpe);
202
209 void xccdf_session_set_oval_results_export(struct xccdf_session *session, bool to_export_oval_results);
210
217 void xccdf_session_set_check_engine_plugins_results_export(struct xccdf_session *session, bool to_export_results);
218
225 OSCAP_DEPRECATED(void xccdf_session_set_sce_results_export(struct xccdf_session *session, bool to_export_sce_results));
226
233 void xccdf_session_set_oval_variables_export(struct xccdf_session *session, bool to_export_oval_variables);
234
242 bool xccdf_session_set_xccdf_export(struct xccdf_session *session, const char *xccdf_file);
243
251 bool xccdf_session_set_arf_export(struct xccdf_session *session, const char *arf_file);
252
260 bool xccdf_session_set_report_export(struct xccdf_session *session, const char *report_file);
261
269 bool xccdf_session_set_profile_id(struct xccdf_session *session, const char *profile_id);
270
276 const char *xccdf_session_get_profile_id(struct xccdf_session *session);
277
285 struct ds_sds_index *xccdf_session_get_sds_idx(struct xccdf_session *session);
286
294 int xccdf_session_load(struct xccdf_session *session);
295
308 int xccdf_session_load_xccdf(struct xccdf_session *session);
309
317 int xccdf_session_load_cpe(struct xccdf_session *session);
318
325 int xccdf_session_load_oval(struct xccdf_session *session);
326
339 int xccdf_session_load_check_engine_plugin(struct xccdf_session *session, const char* plugin_name);
340
351 int xccdf_session_load_check_engine_plugins(struct xccdf_session *session);
352
358 OSCAP_DEPRECATED(int xccdf_session_load_sce(struct xccdf_session *session));
359
366 int xccdf_session_load_tailoring(struct xccdf_session *session);
367
374 int xccdf_session_evaluate(struct xccdf_session *session);
375
382 int xccdf_session_export_xccdf(struct xccdf_session *session);
383
390 int xccdf_session_export_oval(struct xccdf_session *session);
391
400 int xccdf_session_export_check_engine_plugins(struct xccdf_session *session);
401
410 OSCAP_DEPRECATED(int xccdf_session_export_sce(struct xccdf_session *session));
411
418 int xccdf_session_export_arf(struct xccdf_session *session);
419
427 struct xccdf_policy_model *xccdf_session_get_policy_model(const struct xccdf_session *session);
428
435 struct xccdf_policy *xccdf_session_get_xccdf_policy(const struct xccdf_session *session);
436
443 float xccdf_session_get_base_score(const struct xccdf_session *session);
444
451 unsigned int xccdf_session_get_oval_agents_count(const struct xccdf_session *session);
452
461 unsigned int xccdf_session_get_cpe_oval_agents_count(const struct xccdf_session *session);
462
469 bool xccdf_session_contains_fail_result(const struct xccdf_session *session);
470
479 int xccdf_session_remediate(struct xccdf_session *session);
480
491 int xccdf_session_build_policy_from_testresult(struct xccdf_session *session, const char *testresult_id);
492
495 #endif
xccdf_session::xccdf_session_set_custom_oval_eval_fn
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:345
xccdf_session_load_sce
int xccdf_session_load_sce(struct xccdf_session *session)
Definition: xccdf_session.c:862
xccdf_session::xccdf_session_free
void xccdf_session_free(struct xccdf_session *session)
Destructor of xccdf_session.
Definition: xccdf_session.c:233
xccdf_session::xccdf_session_load_tailoring
int xccdf_session_load_tailoring(struct xccdf_session *session)
Load Tailoring file (if applicable) to the XCCDF session.
Definition: xccdf_session.c:867
xccdf_session::xccdf_session_is_sds
bool xccdf_session_is_sds(const struct xccdf_session *session)
Query if the session is based on Source DataStream.
Definition: xccdf_session.c:270
xccdf_session
A structure encapsulating the context of XCCDF operations.
Definition: xccdf_session.c:64
xccdf_session::xccdf_session_set_datastream_id
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:281
xccdf_session::xccdf_session_get_component_id
const char * xccdf_session_get_component_id(struct xccdf_session *session)
Retrieves the component id.
Definition: xccdf_session.c:301
xccdf_policy.h
Open-scap XCCDF Policy library interface.
xccdf_session::xccdf_session_get_base_score
float xccdf_session_get_base_score(const struct xccdf_session *session)
Get the base score of the latest XCCDF evaluation in the session.
OSCAP_DEPRECATED
#define OSCAP_DEPRECATED(func)
This macro will warn, when a deprecated function is used.
Definition: oscap.h:50
xccdf_session::xccdf_session_load
int xccdf_session_load(struct xccdf_session *session)
Load and parse all XCCDF structures needed to evaluate this session.
Definition: xccdf_session.c:436
xccdf_session::profile_id
char * profile_id
Last selected profile.
Definition: xccdf_session.c:71
xccdf_session::xccdf_session_export_check_engine_plugins
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:1288
xccdf_session::xccdf_file
char * xccdf_file
Path to XCCDF file to export.
Definition: xccdf_session.c:95
download_progress_calllback_t
void(* download_progress_calllback_t)(bool warning, const char *format,...)
Type of the function used to report progress of download.
Definition: xccdf_session.h:42
xccdf_session::xccdf_session_set_sce_results_export
void xccdf_session_set_sce_results_export(struct xccdf_session *session, bool to_export_sce_results)
Set that SCE reult files shall be exported.
Definition: xccdf_session.c:372
xccdf_policy_model
XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...
Definition: xccdf_policy_priv.h:39
xccdf_session::xccdf_session_export_xccdf
int xccdf_session_export_xccdf(struct xccdf_session *session)
Export XCCDF file.
Definition: xccdf_session.c:1036
xccdf_session::report_file
char * report_file
Path to HTML file to eport.
Definition: xccdf_session.c:96
xccdf_session::xccdf_session_load_check_engine_plugin
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.
Definition: xccdf_session.c:815
xccdf_session::xccdf_session_set_user_cpe
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:320
xccdf_session::xccdf_session_set_check_engine_plugins_results_export
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:367
xccdf_session::xccdf_session_get_datastream_id
const char * xccdf_session_get_datastream_id(struct xccdf_session *session)
Retrieves the datastream id.
Definition: xccdf_session.c:287
xccdf_session::xccdf_session_set_profile_id
bool xccdf_session_set_profile_id(struct xccdf_session *session, const char *profile_id)
Select XCCDF Profile for evaluation.
Definition: xccdf_session.c:398
ds_sds_index
Represents element - the root element of each source datastream.
Definition: sds_index.c:214
xccdf_session::xccdf_session_export_oval
int xccdf_session_export_oval(struct xccdf_session *session)
Export OVAL (result and variables) files.
Definition: xccdf_session.c:1235
xccdf_session::xccdf_session_set_product_cpe
bool xccdf_session_set_product_cpe(struct xccdf_session *session, const char *product_cpe)
Set custom product CPE name.
Definition: xccdf_session.c:350
xccdf_session::user_cpe
char * user_cpe
Path to CPE dictionary required by user.
Definition: xccdf_session.c:101
xccdf_session::xccdf_session_build_policy_from_testresult
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:1416
xccdf_session::xccdf_session_get_benchmark_id
const char * xccdf_session_get_benchmark_id(struct xccdf_session *session)
Retrieves the benchmark_id.
Definition: xccdf_session.c:315
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:98
xccdf_session::xccdf_session_get_xccdf_policy
struct xccdf_policy * xccdf_session_get_xccdf_policy(const struct xccdf_session *session)
Get xccdf_policy of the session.
Definition: xccdf_session.c:1342
xccdf_session::xccdf_session_set_report_export
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:391
xccdf_session::xccdf_session_evaluate
int xccdf_session_evaluate(struct xccdf_session *session)
Evaluate XCCDF Policy.
Definition: xccdf_session.c:916
xccdf_session::xccdf_session_get_policy_model
struct xccdf_policy_model * xccdf_session_get_policy_model(const struct xccdf_session *session)
Get policy_model of the session.
xccdf_session::xccdf_session_export_arf
int xccdf_session_export_arf(struct xccdf_session *session)
Export ARF (if enabled by xccdf_session_set_arf_export).
Definition: xccdf_session.c:1317
xccdf_session::xccdf_session_set_arf_export
bool xccdf_session_set_arf_export(struct xccdf_session *session, const char *arf_file)
Set where to export ARF file.
Definition: xccdf_session.c:377
xccdf_session::xccdf_session_load_oval
int xccdf_session_load_oval(struct xccdf_session *session)
Load and parse OVAL definitions files for the XCCDF session.
Definition: xccdf_session.c:748
xccdf_session::xccdf_session_set_user_tailoring_cid
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:333
xccdf_session::xccdf_session_load_check_engine_plugins
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:827
xccdf_session::xccdf_session_remediate
int xccdf_session_remediate(struct xccdf_session *session)
Run XCCDF Remediation.
Definition: xccdf_session.c:1395
xccdf_session::xccdf_session_set_custom_oval_files
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:608
xccdf_session::filename
const char * filename
File name of SCAP (SDS or XCCDF) file for this session.
Definition: xccdf_session.c:65
xccdf_session::xccdf_session_set_component_id
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:295
xccdf_session::xccdf_session_set_validation
void xccdf_session_set_validation(struct xccdf_session *session, bool validate, bool full_validation)
Set XSD validation level.
Definition: xccdf_session.c:275
xccdf_session::xccdf_session_load_cpe
int xccdf_session_load_cpe(struct xccdf_session *session)
Load and parse CPE dictionaries.
Definition: xccdf_session.c:529
xccdf_session::arf_file
char * arf_file
Path to ARF file to export.
Definition: xccdf_session.c:94
xccdf_policy
XCCDF policy structure is abstract (class) structure of Profile element from benchmark.
Definition: xccdf_policy_priv.h:58
xccdf_session::xccdf_session_load_xccdf
int xccdf_session_load_xccdf(struct xccdf_session *session)
Load and parse XCCDF file.
Definition: xccdf_session.c:490
xccdf_session::xccdf_session_new
struct xccdf_session * xccdf_session_new(const char *filename)
Costructor of xccdf_session.
Definition: xccdf_session.c:120
xccdf_session::xccdf_session_set_benchmark_id
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:309
xccdf_session::xccdf_session_export_sce
int xccdf_session_export_sce(struct xccdf_session *session)
Export SCE files (if enabled by xccdf_session_set_sce_results_export).
Definition: xccdf_session.c:1312
xccdf_session::xccdf_session_get_sds_idx
struct ds_sds_index * xccdf_session_get_sds_idx(struct xccdf_session *session)
Get Source DataStream index of the session.
Definition: xccdf_session.c:428
xccdf_session::full_validation
bool full_validation
True value indicates that every possible step will be validated by XSD.
Definition: xccdf_session.c:107
xccdf_session::product_cpe
char * product_cpe
CPE of scanner product.
Definition: xccdf_session.c:89
xccdf_session::xccdf_session_set_oval_results_export
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:357
xccdf_session::validate
bool validate
False value indicates to skip any XSD validation.
Definition: xccdf_session.c:106
xccdf_session::xccdf_session_contains_fail_result
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:1378
xccdf_session::xccdf_session_set_xccdf_export
bool xccdf_session_set_xccdf_export(struct xccdf_session *session, const char *xccdf_file)
Set where to export XCCDF file.
Definition: xccdf_session.c:384
xccdf_session::xccdf_session_set_remote_resources
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:339
xccdf_session::xccdf_session_set_user_tailoring_file
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:326
xccdf_session::xccdf_session_set_oval_variables_export
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:362
xccdf_session::xccdf_session_get_oval_agents_count
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:1351
xccdf_session::xccdf_session_get_profile_id
const 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:407
xccdf_session::xccdf_session_get_cpe_oval_agents_count
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:1360
xccdf_session::session
struct ds_sds_session * session
SDS Registry abstract structure.
Definition: xccdf_session.c:77
xccdf_session::xccdf_session_get_filename
const char * xccdf_session_get_filename(const struct xccdf_session *session)
Retrieves the filename the session was created with.
Definition: xccdf_session.c:265