Open SCAP Library
xccdf_policy_priv.h
1 /*
2  * Copyright 2013 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  *
19  * Authors:
20  * Simon Lukasik <slukasik@redhat.com>
21  *
22  */
23 
24 #pragma once
25 #ifndef _OSCAP_XCCDF_POLICY_PRIV_H
26 #define _OSCAP_XCCDF_POLICY_PRIV_H
27 
28 #include "common/util.h"
29 #include "public/xccdf_policy.h"
30 
31 
32 
39 
42  struct oscap_list * policies;
43  struct oscap_list * callbacks;
44  struct oscap_list * engines;
45 
46  struct cpe_session *cpe;
47 };
48 
57 struct xccdf_policy {
58 
63  struct oscap_htable *rules_found;
64  struct oscap_htable *skip_rules;
65  struct oscap_list * selects;
66  struct oscap_list * values;
67  struct oscap_list * results;
73  /* The hash-table contains the latest refine-rule for specified item-id. */
74  struct oscap_htable *refine_rules_internal;
75 };
76 
77 
78 
89 int xccdf_policy_resolve_fix_substitution(struct xccdf_policy *policy, struct xccdf_fix *fix, struct xccdf_rule_result *rule_result, struct xccdf_result *test_result);
90 
102 int xccdf_policy_rule_result_remediate(struct xccdf_policy *policy, struct xccdf_rule_result *rr, struct xccdf_fix *fix, struct xccdf_result *test_result);
103 
111 int xccdf_policy_check_evaluate(struct xccdf_policy * policy, struct xccdf_check * check);
112 
119 int xccdf_policy_remediate(struct xccdf_policy *policy, struct xccdf_result *result);
120 
129 int xccdf_policy_report_cb(struct xccdf_policy *policy, const char *sysname, void *rule);
130 
137 struct xccdf_benchmark *xccdf_policy_get_benchmark(const struct xccdf_policy *policy);
138 
139 
140 #endif
Definition: cpe_session_priv.h:34
Definition: list.h:179
Definition: list.h:53
Top level XCCDF structure containing profiles, rules, values and results.
XCCDF simple or complex check.
Definition: item.h:285
XCCDF automatic fix.
Definition: item.h:324
XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...
Definition: xccdf_policy_priv.h:38
struct oscap_list * policies
List of xccdf_policy structures.
Definition: xccdf_policy_priv.h:42
struct xccdf_benchmark * benchmark
Benchmark element (root element of XML file)
Definition: xccdf_policy_priv.h:40
struct oscap_list * engines
Callbacks for checking engines (see xccdf_policy_engine)
Definition: xccdf_policy_priv.h:44
struct xccdf_tailoring * tailoring
Tailoring element.
Definition: xccdf_policy_priv.h:41
struct oscap_list * callbacks
Callbacks for output callbacks (see callback_out_t)
Definition: xccdf_policy_priv.h:43
XCCDF policy structure is abstract (class) structure of Profile element from benchmark.
Definition: xccdf_policy_priv.h:57
struct xccdf_policy_model * model
XCCDF Policy model.
Definition: xccdf_policy_priv.h:59
int xccdf_policy_report_cb(struct xccdf_policy *policy, const char *sysname, void *rule)
Report given "rule" to all callbacks with given sysname registered with the policy.
Definition: xccdf_policy.c:405
struct oscap_list * results
List of XCCDF results.
Definition: xccdf_policy_priv.h:67
struct oscap_htable * selected_final
A hash which for given item defines final selection.
Definition: xccdf_policy_priv.h:72
struct oscap_htable * selected_internal
A hash which for given item points to the latest selector applicable.
Definition: xccdf_policy_priv.h:70
struct oscap_htable * rules
A list of all selects.
Definition: xccdf_policy_priv.h:62
struct oscap_list * values
Bound values of profile.
Definition: xccdf_policy_priv.h:66
int xccdf_policy_resolve_fix_substitution(struct xccdf_policy *policy, struct xccdf_fix *fix, struct xccdf_rule_result *rule_result, struct xccdf_result *test_result)
Resolve text substitution in given fix element.
Definition: xccdf_policy_substitute.c:195
int xccdf_policy_remediate(struct xccdf_policy *policy, struct xccdf_result *result)
Remediate all rule-results in the given result, with settings of given policy.
Definition: xccdf_policy_remediate.c:593
struct xccdf_profile * profile
Profile structure (from benchmark)
Definition: xccdf_policy_priv.h:60
struct xccdf_benchmark * xccdf_policy_get_benchmark(const struct xccdf_policy *policy)
Get XCCDF Benchmark for given policy.
Definition: xccdf_policy.c:2235
XCCDF profile is a set of tests and their settings in a compact package.
Definition: xccdf_benchmark.h:204
Actual results of running a XCCDF test or profile.
Definition: xccdf_benchmark.h:234
XCCDF rule result.
Definition: item.h:344
Stores content from xccdf:Tailoring element which can be loaded from a separate file.
Definition: item.h:171
Open-scap XCCDF Policy library interface.