1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>Open SCAP Library: sce_engine_api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Open SCAP Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2907eb5268f8c7a51da22eaa0a32e043.html">SCE</a></li><li class="navelem"><a class="el" href="dir_11c4a5bb2f28850a78e8c787e7178614.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">sce_engine_api.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2012 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Authors:</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * "Martin Preisler" <mpreisle@redhat.com></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef SCE_ENGINE_API_H_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define SCE_ENGINE_API_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="xccdf__benchmark_8h.html" title="Open-scap XCCDF library interface.">xccdf_benchmark.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="xccdf__policy_8h.html" title="Open-scap XCCDF Policy library interface.">xccdf_policy.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct </span><a class="code" href="structsce__check__result.html">sce_check_result</a>* sce_check_result_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> sce_check_result_free(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#ad0f2c197d7871a868996d5b336b5a31c" title="Sets the href used to execute the check that yielded given check result.">sce_check_result_set_href</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* href);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* sce_check_result_get_href(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#ad706ee9cad5195e87a9304ca3a21145d" title="Sets basename of the script that was used for check evaluation.">sce_check_result_set_basename</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* basename);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* sce_check_result_get_basename(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#ad2ced7f2fcb4771181591fe61380468a" title="Sets stdout that was captured while script was evaluating.">sce_check_result_set_stdout</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* details);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* sce_check_result_get_stdout(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#a92496bb53bf6de30b7f5daac054bea46" title="Sets exit code with which the script ended execution after evaluation.">sce_check_result_set_exit_code</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keywordtype">int</span> exit_code);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keywordtype">int</span> sce_check_result_get_exit_code(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#a527899bc859f036c7fa9788af378d585" title="Clears the list of passed environment variables.">sce_check_result_reset_environment_variables</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#a25cb6feea6c0173dc485936481c9d6a0" title="Adds an environment variable entry to list of environment variables that were passed to the script...">sce_check_result_add_environment_variable</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* var);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#a9dacd04a46932e19506a664ab0352301" title="Sets the final xccdf result (after exit code to xccdf mapping takes place)">sce_check_result_set_xccdf_result</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> result);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> sce_check_result_get_xccdf_result(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result.html#afad4a0ba0f1226aff6fb6308676b36fe" title="Exports details (in XML form) of given check result to given file.">sce_check_result_export</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* target_file);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">struct </span><a class="code" href="structsce__session.html">sce_session</a>* sce_session_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="keywordtype">void</span> sce_session_free(<span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* s);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">void</span> <a class="code" href="structsce__session.html#a553444b33672a5d3c39591cdcc1f9195" title="Removes all check results from the session.">sce_session_reset</a>(<span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* s);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="keywordtype">void</span> <a class="code" href="structsce__session.html#a327a938787f38714ff6d12f619ee1874" title="Adds a check result to the session.">sce_session_add_check_result</a>(<span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* s, <span class="keyword">struct</span> <a class="code" href="structsce__check__result.html">sce_check_result</a>* result);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="keyword">struct </span><a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a>;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="keyword">struct </span><a class="code" href="structsce__check__result.html">sce_check_result</a> *sce_check_result_iterator_next(<span class="keyword">struct</span> <a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a> *it);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keywordtype">bool</span> <a class="code" href="structsce__check__result__iterator.html#a495041bc5d5addee48191069407bdc62">sce_check_result_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a> *it);</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result__iterator.html#a31760cfae104ed2926da2126e65ac684">sce_check_result_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a> *it);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="keywordtype">void</span> <a class="code" href="structsce__check__result__iterator.html#a29be5b60feae97637aab669d4c84e12a">sce_check_result_iterator_reset</a>(<span class="keyword">struct</span> <a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a> *it);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keyword">struct </span><a class="code" href="structsce__check__result__iterator.html" title="Iterator over collections of sce_check_results.">sce_check_result_iterator</a> *sce_session_get_check_results(<span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* s);</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="keywordtype">void</span> <a class="code" href="structsce__session.html#a9966a6b220d510e39fd9a4bb21971e21" title="Exports all check results to given directory.">sce_session_export_to_directory</a>(<span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* s, <span class="keyword">const</span> <span class="keywordtype">char</span>* directory);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">struct </span><a class="code" href="structsce__parameters.html">sce_parameters</a>* sce_parameters_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keywordtype">void</span> sce_parameters_free(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v);</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keywordtype">void</span> <a class="code" href="sce__engine_8c.html#ac6c9b3ab187953ae81ae4b00556b9125" title="Sets the directory that contains XCCDF that will reference SCE checks.">sce_parameters_set_xccdf_directory</a>(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v, <span class="keyword">const</span> <span class="keywordtype">char</span>* value);</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* sce_parameters_get_xccdf_directory(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="keywordtype">void</span> <a class="code" href="structsce__parameters.html#a0bec050a547eea417413ca79e9f7be4f" title="Sets SCE session to use for check results storage.">sce_parameters_set_session</a>(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v, <span class="keyword">struct</span> <a class="code" href="structsce__session.html">sce_session</a>* value);</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="keyword">struct </span><a class="code" href="structsce__session.html">sce_session</a>* sce_parameters_get_session(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="keywordtype">void</span> <a class="code" href="structsce__parameters.html#ae128122f59b8601b5bf13cdfc721c32d" title="Just a convenience shortcut of setting a session to a newly allocated session.">sce_parameters_allocate_session</a>(<span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a>* v);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> <a class="code" href="sce__engine_8c.html#a7eaa38ae1537cb73c92e1c8536918718" title="Internal rule evaluation callback, don't use directly.">sce_engine_eval_rule</a>(<span class="keyword">struct</span> <a class="code" href="structxccdf__policy.html" title="XCCDF policy structure is abstract (class) structure of Profile element from benchmark.">xccdf_policy</a> *policy, <span class="keyword">const</span> <span class="keywordtype">char</span> *rule_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *href,</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keyword">struct</span> xccdf_value_binding_iterator *value_binding_it,</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keyword">struct</span> <a class="code" href="structxccdf__check__import__iterator.html" title="Check import iterator.">xccdf_check_import_iterator</a> *check_import_it,</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">void</span> *usr);</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="keywordtype">bool</span> <a class="code" href="sce__engine_8c.html#a0047795f7ba3cb1aaa64044c4449027e" title="Registers SCE to given policy model.">xccdf_policy_model_register_engine_sce</a>(<span class="keyword">struct</span> <a class="code" href="structxccdf__policy__model.html" title="XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...">xccdf_policy_model</a> * model, <span class="keyword">struct</span> <a class="code" href="structsce__parameters.html">sce_parameters</a> *<a class="code" href="structsce__parameters.html">sce_parameters</a>);</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
|
