<!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.7.4/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.7.4 -->
<div id="top">
<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>
<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 class="header">
<div class="headertitle">
<div class="title">/home/pvrabec/project/openscap/openscap-0.7.4/src/OVAL/public/oval_agent_api.h</div> </div>
</div>
<div class="contents">
<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 <span class="preprocessor">#include "<a class="code" href="reporter_8h.html" title="Reporters interface.">reporter.h</a>"</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#ifdef ENABLE_XCCDF</span>
<a name="l00048"></a>00048 <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="l00049"></a>00049 <span class="preprocessor">#endif</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span>
<a name="l00051"></a>00051 <span class="keyword">struct </span><a class="code" href="structoval__agent__session.html">oval_agent_session</a>;
<a name="l00052"></a>00052
<a name="l00058"></a><a class="code" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">00058</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="l00059"></a>00059
<a name="l00065"></a>00065 <a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * <a class="code" href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934" 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, <span class="keyword">const</span> <span class="keywordtype">char</span> * name);
<a name="l00066"></a>00066
<a name="l00071"></a>00071 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab" 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> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00072"></a>00072
<a name="l00077"></a>00077 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d" title="Get the OVAL result of a definition from an agent session.">oval_agent_get_definition_result</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *, <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 name="l00078"></a>00078
<a name="l00082"></a>00082 <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="l00083"></a>00083
<a name="l00087"></a>00087 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga7b465c077aa0ade17135dc1826b4465c" title="Abort a running probe session.">oval_agent_abort_session</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess);
<a name="l00088"></a>00088
<a name="l00093"></a>00093 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#gaf997d19641259ab5ac9add9831e1e62b" title="Probe and evaluate all definitions from the content, call the callback functions upon single evaluati...">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__Reporters.html#gada96dbbbb54a7659c3acf1c00a7d7ad3" title="Reporter prototype.">oscap_reporter</a> cb, <span class="keywordtype">void</span> *arg);
<a name="l00094"></a>00094
<a name="l00098"></a>00098 <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="l00102"></a>00102 <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="group__OVALAGENT.html#ga891f69cec678e572518603f482e54877" title="Get a filename under which was created.">oval_agent_get_filename</a>(<a class="code" href="structoval__agent__session.html">oval_agent_session_t</a> * ag_sess);
<a name="l00103"></a>00103
<a name="l00107"></a>00107 <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="l00108"></a>00108
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#ifdef ENABLE_XCCDF</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>
<a name="l00112"></a>00112 <span class="comment">/************************************************************/</span>
<a name="l00127"></a><a class="code" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">00127</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="l00128"></a>00128 <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="l00129"></a>00129
<a name="l00145"></a>00145 <a class="code" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d" title="Test result.">xccdf_test_result_type_t</a> <a class="code" href="group__OVALAGENT.html#ga58d82d4d759d169780b7ed90720a5af4" 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="l00146"></a>00146 <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, <span class="keyword">struct</span> xccdf_value_binding_iterator * it, <span class="keywordtype">void</span> * usr);
<a name="l00147"></a>00147
<a name="l00156"></a>00156 <span class="keywordtype">int</span> <a class="code" href="group__OVALAGENT.html#ga86f153582f6e48986aaac82efcb064ae" 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="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00166"></a>00166 <span class="keywordtype">bool</span> <a class="code" href="group__OVALAGENT.html#gaeee658b7aee3ba20b274248ec024eefc" title="Function to register predefined oval callback for XCCDF evaluation proccess.">xccdf_policy_model_register_engine_oval</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="structoval__agent__session.html">oval_agent_session</a> * sess);
<a name="l00167"></a>00167
<a name="l00173"></a>00173 <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="l00174"></a>00174
<a name="l00175"></a>00175 <span class="comment">/************************************************************/</span>
<a name="l00178"></a>00178 <span class="preprocessor">#endif</span>
<a name="l00179"></a>00179 <span class="preprocessor"></span>
<a name="l00184"></a>00184 <span class="preprocessor">#endif </span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
