Open SCAP Library
xccdf_policy.h
Go to the documentation of this file.
1 /*
2  * Copyright 2009 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  */
20 
21 
31 #ifndef XCCDF_POLICY_H_
32 #define XCCDF_POLICY_H_
33 
34 #include <xccdf_benchmark.h>
35 #include <stdbool.h>
36 #include <time.h>
37 #include <oscap.h>
38 
43 struct xccdf_policy_model;
44 
49 struct xccdf_policy;
50 
55 struct xccdf_value_binding;
56 
57 struct xccdf_value_binding_iterator;
58 
65 
70 typedef enum {
71  POLICY_ENGINE_QUERY_NAMES_FOR_HREF = 1,
73 
88 typedef void *(*xccdf_policy_engine_query_fn) (void *, xccdf_policy_engine_query_t, void *);
89 
98 typedef 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);
99 
100 /************************************************************/
101 
109 
117 
124 
130 
135 void xccdf_policy_free(struct xccdf_policy *);
136 
142 
147 bool xccdf_policy_model_add_cpe_dict(struct xccdf_policy_model * model, const char * cpe_dict);
148 
153 bool xccdf_policy_model_add_cpe_lang_model(struct xccdf_policy_model * model, const char * cpe_lang);
154 
160 bool xccdf_policy_model_add_cpe_autodetect(struct xccdf_policy_model *model, const char* filepath);
161 
174 OSCAP_DEPRECATED(bool xccdf_policy_model_register_engine_callback(struct xccdf_policy_model * model, char * sys, void * func, void * usr));
175 
187 
188 typedef int (*policy_reporter_output)(struct xccdf_rule_result *, void *);
189 
198 bool xccdf_policy_model_register_output_callback(struct xccdf_policy_model * model, policy_reporter_output func, void * usr);
199 
200 typedef int (*policy_reporter_start)(struct xccdf_rule *, void *);
201 
210 bool xccdf_policy_model_register_start_callback(struct xccdf_policy_model * model, policy_reporter_start func, void * usr);
211 
212 /************************************************************/
226 struct xccdf_policy_model * xccdf_policy_get_model(const struct xccdf_policy * policy);
227 
235 
240 struct xccdf_value_binding_iterator * xccdf_policy_get_values(const struct xccdf_policy * item);
241 
250 
258 
264 struct xccdf_profile * xccdf_policy_get_profile(const struct xccdf_policy *);
265 
272 
279 
286 
293 
300 
307 
312 struct xccdf_result_iterator * xccdf_policy_get_results(const struct xccdf_policy * policy);
313 
319 struct xccdf_result * xccdf_policy_get_result_by_id(struct xccdf_policy * policy, const char * id);
320 
327 const char * xccdf_policy_get_id(struct xccdf_policy * policy);
328 
336 struct xccdf_policy * xccdf_policy_model_get_policy_by_id(struct xccdf_policy_model * policy_model, const char * id);
337 
338 /************************************************************/
341 /************************************************************/
355 
361 bool xccdf_policy_add_select(struct xccdf_policy *, struct xccdf_select *);
362 
371 bool xccdf_policy_set_selected(struct xccdf_policy * policy, char * idref)
372 );
373 
378 bool xccdf_policy_add_result(struct xccdf_policy * policy, struct xccdf_result * item);
379 
386 
392 bool xccdf_policy_is_item_selected(struct xccdf_policy *policy, const char *id);
398 struct xccdf_select * xccdf_policy_get_select_by_id(struct xccdf_policy * policy, const char *item_id);
399 
400 /************************************************************/
403 /************************************************************/
427 struct xccdf_result * xccdf_policy_evaluate(struct xccdf_policy * policy);
428 
437 bool xccdf_policy_resolve(struct xccdf_policy * policy);
438 
445 struct xccdf_item * xccdf_policy_tailor_item(struct xccdf_policy * policy, struct xccdf_item * item);
446 
450 struct oscap_file_entry;
451 
455 struct oscap_file_entry *oscap_file_entry_dup(struct oscap_file_entry* file_entry);
457 void oscap_file_entry_free(struct oscap_file_entry* entry);
459 const char* oscap_file_entry_get_system(struct oscap_file_entry* entry);
461 const char* oscap_file_entry_get_file(struct oscap_file_entry* entry);
462 
467 
476 
480 struct oscap_file_entry_list;
481 
488 
498 
507 
514 
520 struct oscap_stringlist * xccdf_item_get_files(struct xccdf_item * item);
521 
528 
529 /************************************************************/
532 /************************************************************/
543 
549 
555 
561 
566 bool xccdf_value_binding_iterator_has_more(struct xccdf_value_binding_iterator *it);
567 
572 struct xccdf_value_binding * xccdf_value_binding_iterator_next(struct xccdf_value_binding_iterator *it);
573 
578 void xccdf_value_binding_iterator_free(struct xccdf_value_binding_iterator *it);
579 
584 void xccdf_value_binding_iterator_reset(struct xccdf_value_binding_iterator *it);
585 
593 struct xccdf_score * xccdf_policy_get_score(struct xccdf_policy * policy, struct xccdf_result * test_result, const char * system);
594 
600 char* xccdf_policy_substitute(const char *text, struct xccdf_policy *policy);
601 
602 /************************************************************/
608 #endif
609 
610