Open SCAP Library
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
src
XCCDF
public
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
Generated by
1.8.3.1