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
|
<!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"/>
<title>Open SCAP Library: /home/pvrabec/project/openscap/openscap-0.5.12/src/OVAL/public/oval_agent_api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>/home/pvrabec/project/openscap/openscap-0.5.12/src/OVAL/public/oval_agent_api.h</h1><a href="oval__agent__api_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00016"></a>00016 <span class="comment">/*</span>
<a name="l00017"></a>00017 <span class="comment"> * Copyright 2009,2010 Red Hat Inc., Durham, North Carolina.</span>
<a name="l00018"></a>00018 <span class="comment"> * All Rights Reserved.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00021"></a>00021 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00022"></a>00022 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00023"></a>00023 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00026"></a>00026 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00027"></a>00027 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00028"></a>00028 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00029"></a>00029 <span class="comment"> *</span>
<a name="l00030"></a>00030 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00031"></a>00031 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00032"></a>00032 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef OVAL_AGENT_API_H_</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define OVAL_AGENT_API_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="oval__definitions_8h.html">oval_definitions.h</a>"</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include "<a class="code" href="oval__system__characteristics_8h.html">oval_system_characteristics.h</a>"</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="oval__results_8h.html">oval_results.h</a>"</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include "<a class="code" href="oval__variables_8h.html">oval_variables.h</a>"</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include "oval_probe.h"</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#ifdef ENABLE_XCCDF</span>
<a name="l00047"></a>00047 <span class="preprocessor"></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>
<a name="l00048"></a>00048
<a name="l00053"></a>00053 <span class="keyword">struct </span><a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a>;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="preprocessor">#endif</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span>
<a name="l00057"></a>00057 <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a>;
<a name="l00058"></a>00058
<a name="l00064"></a><a class="code" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">00064</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a> <a class="code" href="structoval__agent__session.html">oval_agent_session_t</a>;
<a name="l00065"></a>00065
<a name="l00072"></a><a class="code" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">00072</a> <span class="keyword">typedef</span> int (<a class="code" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86" title="This callback is called after evaluation of each definition.">oval_agent_result_cb_t</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> *id, <span class="keywordtype">int</span> result, <span class="keywordtype">void</span> *arg);
<a name="l00073"></a>00073
<a name="l00077"></a>00077 <a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * <a class="code" href="group__OVALAGENT.html#ga063cbd39becb1e6848966ad88f48de51" title="Create new session for OVAL agent from OVAL definition model.">oval_agent_new_session</a>(<span class="keyword">struct</span> <a class="code" href="structoval__definition__model.html" title="Oval definition model.">oval_definition_model</a> * model);
<a name="l00078"></a>00078
<a name="l00082"></a>00082 <a class="code" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf" title="Result values for the evaluation of an OVAL Definition or an OVAL Test.">oval_result_t</a> <a class="code" href="group__OVALAGENT.html#ga65c6c0a750c30ccbf40aea8e2e3f4374" title="Probe the system and evaluate specified definition.">oval_agent_eval_definition</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>);
<a name="l00083"></a>00083
<a name="l00087"></a>00087 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga1b0b775e52aff1452ff4423f897c5825" title="Clean resuls that were generated in this agent session.">oval_agent_reset_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);
<a name="l00088"></a>00088
<a name="l00092"></a>00092 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#gaec71f72c60b8c668f270c8c85cbf640a" title="Probe and evaluate all definitions from the content, call the callback functions...">oval_agent_eval_system</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess, <a class="code" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86" title="This callback is called after evaluation of each definition.">oval_agent_result_cb_t</a> * cb, <span class="keywordtype">void</span> *arg);
<a name="l00093"></a>00093
<a name="l00097"></a>00097 <span class="keyword">struct </span><a class="code" href="structoval__results__model.html" title="OVAL Results Model holds OVAL results structure instances.">oval_results_model</a> * <a class="code" href="group__OVALAGENT.html#ga46b7afeb2b281141e4722f219a7a438a" title="Get a result model from agent session.">oval_agent_get_results_model</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);
<a name="l00098"></a>00098
<a name="l00102"></a>00102 <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#ga301f466948c1844837208f917b3e2025" title="Finish OVAL agent session.">oval_agent_destroy_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);
<a name="l00103"></a>00103
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="preprocessor">#ifdef ENABLE_XCCDF</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span>
<a name="l00107"></a>00107 <span class="comment">/************************************************************/</span>
<a name="l00121"></a>00121 <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a> * <a class="code" href="group__OVALAGENT.html#ga8798934771d02532822073e5e6d09e66" title="Get session of OVAL Agent callback data.">oval_agent_cb_data_get_session</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data);
<a name="l00122"></a>00122
<a name="l00129"></a>00129 <a class="code" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86" title="This callback is called after evaluation of each definition.">oval_agent_result_cb_t</a> * <a class="code" href="group__OVALAGENT.html#ga1589810dcfaa46fd942c38deac774491" title="Get callback of OVAL Agent callback data.">oval_agent_cb_data_get_callback</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data);
<a name="l00130"></a>00130
<a name="l00137"></a>00137 <span class="keywordtype">void</span> * <a class="code" href="group__OVALAGENT.html#ga6e328a4a69868d36c89a3f031583f060" title="Get usr data of OVAL Agent callback data.">oval_agent_cb_data_get_usr</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/************************************************************/</span>
<a name="l00142"></a>00142 <span class="comment">/************************************************************/</span>
<a name="l00157"></a>00157 <span class="keywordtype">bool</span> <a class="code" href="group__OVALAGENT.html#ga9b77bd4bf6988b3e2061677f3b0a12b8" title="Set the OVAL Agent session to OVAL Agent callback data.">oval_agent_cb_data_set_session</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data, <span class="keyword">struct</span> <a class="code" href="structoval__agent__session.html">oval_agent_session</a> * session);
<a name="l00158"></a>00158
<a name="l00166"></a>00166 <span class="keywordtype">bool</span> <a class="code" href="group__OVALAGENT.html#ga7bd156f921b42c01e68323683729dbb4" title="Set the OVAL Agent Result callback to OVAL Agent callback data.">oval_agent_cb_data_set_callback</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data, <a class="code" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86" title="This callback is called after evaluation of each definition.">oval_agent_result_cb_t</a> * <a class="code" href="structcallback__t.html" title="Typedef of callback structure with system identificator, callback function and usr...">callback</a>, <span class="keywordtype">void</span> * usr);
<a name="l00167"></a>00167
<a name="l00175"></a>00175 <span class="keywordtype">bool</span> <a class="code" href="group__OVALAGENT.html#gab4cf4016cf92228faea70c65a3a7b873" title="Set the User data to OVAL Agent callback data.">oval_agent_cb_data_set_usr</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data, <span class="keywordtype">void</span> * usr);
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <span class="comment">/************************************************************/</span>
<a name="l00180"></a>00180 <span class="comment">/************************************************************/</span>
<a name="l00195"></a><a class="code" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">00195</a> <span class="keyword">typedef</span> <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> (<a class="code" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">xccdf_policy_eval_rule_cb_t</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,
<a name="l00196"></a>00196 <span class="keyword">const</span> <span class="keywordtype">char</span> * id, <span class="keyword">struct </span>xccdf_value_binding_iterator * it, <span class="keywordtype">void</span> * usr);
<a name="l00197"></a>00197
<a name="l00212"></a>00212 <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> <a class="code" href="group__OVALAGENT.html#ga7b472f8a251a294478a01bbf96417bf7" title="Internal OVAL Agent Callback that can be used to evaluate XCCDF content.">oval_agent_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,
<a name="l00213"></a>00213 <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keywordtype">id</span>, <span class="keyword">struct</span> xccdf_value_binding_iterator * it, <span class="keywordtype">void</span> * usr);
<a name="l00214"></a>00214
<a name="l00222"></a>00222 <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#ga9020215fc2db19ea98b6e11984947176" title="Resolve variables from XCCDF Value Bindings and set their values to OVAL Variables...">oval_agent_resolve_variables</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__session.html">oval_agent_session</a> * session, <span class="keyword">struct</span> xccdf_value_binding_iterator *it);
<a name="l00223"></a>00223
<a name="l00229"></a>00229 <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#gacd87da61a584f365001a6a9a1f4a5c13" title="Transform OVAL Sysinfo into XCCDF Test Result.">oval_agent_export_sysinfo_to_xccdf_result</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__session.html">oval_agent_session</a> * session, <span class="keyword">struct</span> <a class="code" href="structxccdf__result.html" title="Actual results of running a XCCDF test or profile.">xccdf_result</a> * ritem);
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="comment">/************************************************************/</span>
<a name="l00249"></a>00249 <span class="keyword">struct </span><a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * <a class="code" href="group__OVALAGENT.html#gaaeeaddad8cd993de2022553ed94b9ae0" title="Create new OVAL Agent callback data.">oval_agent_cb_data_new</a>(<span class="keywordtype">void</span>);
<a name="l00250"></a>00250
<a name="l00256"></a>00256 <span class="keywordtype">void</span> <a class="code" href="group__OVALAGENT.html#ga038c2e9ec791d86a6db76301de4628ac" title="Free function of OVAL Agent callback data.">oval_agent_cb_data_free</a>(<span class="keyword">struct</span> <a class="code" href="structoval__agent__cb__data.html" title="Handle all callback data that are needed by xccdf_policy_eval_rule_cb_t.">oval_agent_cb_data</a> * data);
<a name="l00257"></a>00257 <span class="preprocessor">#endif</span>
<a name="l00258"></a>00258 <span class="preprocessor"></span>
<a name="l00263"></a>00263 <span class="preprocessor">#endif </span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
