Open SCAP Library
sce_engine_api.h
1 /*
2  * Copyright 2012 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors:
20  * "Martin Preisler" <mpreisle@redhat.com>
21  */
22 
23 #pragma once
24 
25 #ifndef SCE_ENGINE_API_H_
26 #define SCE_ENGINE_API_H_
27 
28 #include <xccdf_benchmark.h>
29 #include <xccdf_policy.h>
30 #include "oscap_export.h"
31 
35 OSCAP_API struct sce_check_result* sce_check_result_new(void);
36 
40 OSCAP_API void sce_check_result_free(struct sce_check_result* v);
41 
47 OSCAP_API void sce_check_result_set_href(struct sce_check_result* v, const char* href);
48 
52 OSCAP_API const char* sce_check_result_get_href(struct sce_check_result* v);
53 
59 OSCAP_API void sce_check_result_set_basename(struct sce_check_result* v, const char* basename);
60 
64 OSCAP_API const char* sce_check_result_get_basename(struct sce_check_result* v);
65 
72 OSCAP_API void sce_check_result_set_stdout(struct sce_check_result* v, const char* details);
73 
77 OSCAP_API const char* sce_check_result_get_stdout(struct sce_check_result* v);
78 
85 OSCAP_API void sce_check_result_set_stderr(struct sce_check_result* v, const char* details);
86 
90 OSCAP_API const char* sce_check_result_get_stderr(struct sce_check_result* v);
91 
96 OSCAP_API void sce_check_result_set_exit_code(struct sce_check_result* v, int exit_code);
97 
101 OSCAP_API int sce_check_result_get_exit_code(struct sce_check_result* v);
102 
109 
120 OSCAP_API void sce_check_result_add_environment_variable(struct sce_check_result* v, const char* var);
121 
128 
132 OSCAP_API xccdf_test_result_type_t sce_check_result_get_xccdf_result(struct sce_check_result* v);
133 
139 OSCAP_API void sce_check_result_export(struct sce_check_result* v, const char* target_file);
140 
144 OSCAP_API struct sce_session* sce_session_new(void);
145 
149 OSCAP_API void sce_session_free(struct sce_session* s);
150 
156 OSCAP_API void sce_session_reset(struct sce_session* s);
157 
165 OSCAP_API void sce_session_add_check_result(struct sce_session* s, struct sce_check_result* result);
166 
173 OSCAP_API struct sce_check_result *sce_check_result_iterator_next(struct sce_check_result_iterator *it);
180 
181 OSCAP_API struct sce_check_result_iterator *sce_session_get_check_results(struct sce_session* s);
182 
188 OSCAP_API void sce_session_export_to_directory(struct sce_session* s, const char* directory);
189 
193 OSCAP_API struct sce_parameters* sce_parameters_new(void);
194 
198 OSCAP_API void sce_parameters_free(struct sce_parameters* v);
199 
206 OSCAP_API void sce_parameters_set_xccdf_directory(struct sce_parameters* v, const char* value);
207 
211 OSCAP_API const char* sce_parameters_get_xccdf_directory(struct sce_parameters* v);
212 
220 OSCAP_API void sce_parameters_set_session(struct sce_parameters* v, struct sce_session* value);
221 
225 OSCAP_API struct sce_session* sce_parameters_get_session(struct sce_parameters* v);
226 
233 OSCAP_API void sce_parameters_allocate_session(struct sce_parameters* v);
234 
240 xccdf_test_result_type_t sce_engine_eval_rule(struct xccdf_policy *policy, const char *rule_id, const char *id, const char *href,
241  struct xccdf_value_binding_iterator *value_binding_it,
242  struct xccdf_check_import_iterator *check_import_it,
243  void *usr);
244 
252 
253 #endif
OSCAP_API void sce_check_result_set_exit_code(struct sce_check_result *v, int exit_code)
Sets exit code with which the script ended execution after evaluation.
Definition: sce_engine.c:140
OSCAP_API void sce_check_result_set_stderr(struct sce_check_result *v, const char *details)
Sets stderr that was captured while script was evaluating.
Definition: sce_engine.c:129
Open-scap XCCDF Policy library interface.
OSCAP_API void sce_check_result_export(struct sce_check_result *v, const char *target_file)
Exports details (in XML form) of given check result to given file.
Definition: sce_engine.c:171
OSCAP_API void sce_parameters_allocate_session(struct sce_parameters *v)
Just a convenience shortcut of setting a session to a newly allocated session.
Definition: sce_engine.c:312
OSCAP_API void sce_check_result_set_href(struct sce_check_result *v, const char *href)
Sets the href used to execute the check that yielded given check result.
Definition: sce_engine.c:96
OSCAP_API void sce_session_add_check_result(struct sce_session *s, struct sce_check_result *result)
Adds a check result to the session.
Definition: sce_engine.c:235
OSCAP_API void sce_check_result_reset_environment_variables(struct sce_check_result *v)
Clears the list of passed environment variables.
Definition: sce_engine.c:150
OSCAP_API void sce_check_result_iterator_free(struct sce_check_result_iterator *it)
Check import iterator.
Definition: xccdf_benchmark.h:540
Iterator over collections of sce_check_results.
Definition: sce_engine.c:57
XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...
Definition: xccdf_policy_priv.h:38
OSCAP_API void sce_session_export_to_directory(struct sce_session *s, const char *directory)
Exports all check results to given directory.
Definition: sce_engine.c:247
OSCAP_API bool sce_check_result_iterator_has_more(struct sce_check_result_iterator *it)
Open-scap XCCDF library interface.
xccdf_test_result_type_t
Test result.
Definition: xccdf_benchmark.h:169
OSCAP_API void sce_check_result_set_stdout(struct sce_check_result *v, const char *details)
Sets stdout that was captured while script was evaluating.
Definition: sce_engine.c:118
xccdf_test_result_type_t sce_engine_eval_rule(struct xccdf_policy *policy, const char *rule_id, const char *id, const char *href, struct xccdf_value_binding_iterator *value_binding_it, struct xccdf_check_import_iterator *check_import_it, void *usr)
Internal rule evaluation callback, don&#39;t use directly.
Definition: sce_engine.c:358
Definition: sce_engine.c:207
void sce_parameters_set_xccdf_directory(struct sce_parameters *v, const char *value)
Sets the directory that contains XCCDF that will reference SCE checks.
Definition: sce_engine.c:288
OSCAP_API void sce_session_reset(struct sce_session *s)
Removes all check results from the session.
Definition: sce_engine.c:229
OSCAP_API void sce_parameters_set_session(struct sce_parameters *v, struct sce_session *value)
Sets SCE session to use for check results storage.
Definition: sce_engine.c:301
Definition: sce_engine.c:262
XCCDF policy structure is abstract (class) structure of Profile element from benchmark.
Definition: xccdf_policy_priv.h:57
OSCAP_API void sce_check_result_set_basename(struct sce_check_result *v, const char *basename)
Sets basename of the script that was used for check evaluation.
Definition: sce_engine.c:107
bool xccdf_policy_model_register_engine_sce(struct xccdf_policy_model *model, struct sce_parameters *parameters)
Registers SCE to given policy model.
Definition: sce_engine.c:691
OSCAP_API void sce_check_result_add_environment_variable(struct sce_check_result *v, const char *var)
Adds an environment variable entry to list of environment variables that were passed to the script...
Definition: sce_engine.c:156
OSCAP_API void sce_check_result_set_xccdf_result(struct sce_check_result *v, xccdf_test_result_type_t result)
Sets the final xccdf result (after exit code to xccdf mapping takes place)
Definition: sce_engine.c:161
OSCAP_API void sce_check_result_iterator_reset(struct sce_check_result_iterator *it)