<!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 File Reference</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>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">/home/pvrabec/project/openscap/openscap-0.7.4/src/OVAL/public/oval_agent_api.h File Reference<div class="ingroups"><a class="el" href="group__OVALAGENT.html">OVAL Agent</a></div></div> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="oval__definitions_8h_source.html">oval_definitions.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__results_8h_source.html">oval_results.h</a>"</code><br/>
<code>#include "<a class="el" href="oval__variables_8h_source.html">oval_variables.h</a>"</code><br/>
<code>#include "oval_probe.h"</code><br/>
<code>#include "<a class="el" href="reporter_8h_source.html">reporter.h</a>"</code><br/>
<code>#include "<a class="el" href="xccdf__policy_8h_source.html">xccdf_policy.h</a>"</code><br/>
</div>
<p><a href="oval__agent__api_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7c852f3681ee4aaf6d372facf2e8c016"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_session_t" ref="ga7c852f3681ee4aaf6d372facf2e8c016" args="" -->
typedef struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7c852f3681ee4aaf6d372facf2e8c016">oval_agent_session_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Agent session consists of connection to system checking engine, definition model, system characteristics model and results model. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934">oval_agent_new_session</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new session for OVAL agent from OVAL definition model. <a href="group__OVALAGENT.html#ga363376feb3dc45839611dbf7ae149934"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab">oval_agent_eval_definition</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *, const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Probe the system and evaluate specified definition. <a href="group__OVALAGENT.html#gaf73eb2fb4162b9293f166ea02dd889ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d">oval_agent_get_definition_result</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *, const char *, <a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the OVAL result of a definition from an agent session. <a href="group__OVALAGENT.html#ga9a88f1166593f63aa0f7cdc080685c1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b0b775e52aff1452ff4423f897c5825"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_reset_session" ref="ga1b0b775e52aff1452ff4423f897c5825" args="(oval_agent_session_t *ag_sess)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga1b0b775e52aff1452ff4423f897c5825">oval_agent_reset_session</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clean resuls that were generated in this agent session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b465c077aa0ade17135dc1826b4465c"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_abort_session" ref="ga7b465c077aa0ade17135dc1826b4465c" args="(oval_agent_session_t *ag_sess)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7b465c077aa0ade17135dc1826b4465c">oval_agent_abort_session</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abort a running probe session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaf997d19641259ab5ac9add9831e1e62b">oval_agent_eval_system</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess, <a class="el" href="group__Reporters.html#gada96dbbbb54a7659c3acf1c00a7d7ad3">oscap_reporter</a> cb, void *arg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Probe and evaluate all definitions from the content, call the callback functions upon single evaluation. <a href="group__OVALAGENT.html#gaf997d19641259ab5ac9add9831e1e62b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga46b7afeb2b281141e4722f219a7a438a"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_get_results_model" ref="ga46b7afeb2b281141e4722f219a7a438a" args="(oval_agent_session_t *ag_sess)" -->
struct <a class="el" href="structoval__results__model.html">oval_results_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga46b7afeb2b281141e4722f219a7a438a">oval_agent_get_results_model</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a result model from agent session. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga891f69cec678e572518603f482e54877"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_get_filename" ref="ga891f69cec678e572518603f482e54877" args="(oval_agent_session_t *ag_sess)" -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga891f69cec678e572518603f482e54877">oval_agent_get_filename</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a filename under which was created. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga301f466948c1844837208f917b3e2025"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_destroy_session" ref="ga301f466948c1844837208f917b3e2025" args="(oval_agent_session_t *ag_sess)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga301f466948c1844837208f917b3e2025">oval_agent_destroy_session</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish OVAL agent session. <br/></td></tr>
<tr><td colspan="2"><h2><a name="member-group"></a>
Evaluators</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a>( </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaa4616a7375ac4a91ee293d69a5c30481">xccdf_policy_eval_rule_cb_t</a> )(struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *rule_id, const char *id, struct xccdf_value_binding_iterator *it, void *usr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__XCCDF.html#gabf34f4480799efc8e1af5f4706d2666d">xccdf_test_result_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga58d82d4d759d169780b7ed90720a5af4">oval_agent_eval_rule</a> (struct <a class="el" href="structxccdf__policy.html">xccdf_policy</a> *policy, const char *rule_id, const char *id, const char *href, struct xccdf_value_binding_iterator *it, void *usr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal OVAL Agent Callback that can be used to evaluate XCCDF content. <a href="group__OVALAGENT.html#ga58d82d4d759d169780b7ed90720a5af4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga86f153582f6e48986aaac82efcb064ae">oval_agent_resolve_variables</a> (struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> *session, struct xccdf_value_binding_iterator *it)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resolve variables from XCCDF Value Bindings and set their values to OVAL Variables. <a href="group__OVALAGENT.html#ga86f153582f6e48986aaac82efcb064ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gacd87da61a584f365001a6a9a1f4a5c13">oval_agent_export_sysinfo_to_xccdf_result</a> (struct <a class="el" href="structoval__agent__session.html">oval_agent_session</a> *session, struct <a class="el" href="structxccdf__result.html">xccdf_result</a> *ritem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transform OVAL Sysinfo into XCCDF Test Result. <a href="group__OVALAGENT.html#gacd87da61a584f365001a6a9a1f4a5c13"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>"David Niemoller" <<a href="mailto:David.Niemoller@g2-inc.com">David.Niemoller@g2-inc.com</a>> </dd>
<dd>
"Peter Vrabec" <<a href="mailto:pvrabec@gmail.com">pvrabec@gmail.com</a>> </dd></dl>
</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>
