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 #ifndef SCE_ENGINE_API_H_
24 #define SCE_ENGINE_API_H
25 
26 #include <xccdf_benchmark.h>
27 #include <xccdf_policy.h>
28 
32 struct sce_check_result* sce_check_result_new(void);
33 
37 void sce_check_result_free(struct sce_check_result* v);
38 
44 void sce_check_result_set_href(struct sce_check_result* v, const char* href);
45 
49 const char* sce_check_result_get_href(struct sce_check_result* v);
50 
56 void sce_check_result_set_basename(struct sce_check_result* v, const char* basename);
57 
61 const char* sce_check_result_get_basename(struct sce_check_result* v);
62 
69 void sce_check_result_set_stdout(struct sce_check_result* v, const char* details);
70 
74 const char* sce_check_result_get_stdout(struct sce_check_result* v);
75 
80 void sce_check_result_set_exit_code(struct sce_check_result* v, int exit_code);
81 
85 int sce_check_result_get_exit_code(struct sce_check_result* v);
86 
93 
104 void sce_check_result_add_environment_variable(struct sce_check_result* v, const char* var);
105 
112 
116 xccdf_test_result_type_t sce_check_result_get_xccdf_result(struct sce_check_result* v);
117 
123 void sce_check_result_export(struct sce_check_result* v, const char* target_file);
124 
128 struct sce_session* sce_session_new(void);
129 
133 void sce_session_free(struct sce_session* s);
134 
140 void sce_session_reset(struct sce_session* s);
141 
149 void sce_session_add_check_result(struct sce_session* s, struct sce_check_result* result);
150 
157 struct sce_check_result *sce_check_result_iterator_next(struct sce_check_result_iterator *it);
164 
165 struct sce_check_result_iterator *sce_session_get_check_results(struct sce_session* s);
166 
172 void sce_session_export_to_directory(struct sce_session* s, const char* directory);
173 
177 struct sce_parameters* sce_parameters_new(void);
178 
182 void sce_parameters_free(struct sce_parameters* v);
183 
190 void sce_parameters_set_xccdf_directory(struct sce_parameters* v, const char* value);
191 
195 const char* sce_parameters_get_xccdf_directory(struct sce_parameters* v);
196 
204 void sce_parameters_set_session(struct sce_parameters* v, struct sce_session* value);
205 
209 struct sce_session* sce_parameters_get_session(struct sce_parameters* v);
210 
218 
224 xccdf_test_result_type_t sce_engine_eval_rule(struct xccdf_policy *policy, const char *rule_id, const char *id, const char *href,
225  struct xccdf_value_binding_iterator *value_binding_it,
226  struct xccdf_check_import_iterator *check_import_it,
227  void *usr);
228 
236 
237 #endif