File: oval__agent__api_8h.html

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (83 lines) | stat: -rw-r--r-- 10,945 bytes parent folder | download 
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
 
<!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 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.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>/home/pvrabec/project/openscap/openscap-0.5.12/src/OVAL/public/oval_agent_api.h File Reference</h1><code>#include &quot;<a class="el" href="oval__definitions_8h_source.html">oval_definitions.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oval__system__characteristics_8h_source.html">oval_system_characteristics.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oval__results_8h_source.html">oval_results.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oval__variables_8h_source.html">oval_variables.h</a>&quot;</code><br/>
<code>#include &quot;oval_probe.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="xccdf__policy_8h_source.html">xccdf_policy.h</a>&quot;</code><br/>

<p><a href="oval__agent__api_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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>&nbsp;</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">&nbsp;</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 class="memItemLeft" align="right" valign="top">typedef int(&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> )(const char *id, int result, void *arg)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This callback is called after evaluation of each definition.  <a href="group__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga063cbd39becb1e6848966ad88f48de51"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_new_session" ref="ga063cbd39becb1e6848966ad88f48de51" args="(struct oval_definition_model *model)" -->
<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga063cbd39becb1e6848966ad88f48de51">oval_agent_new_session</a> (struct <a class="el" href="structoval__definition__model.html">oval_definition_model</a> *model)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create new session for OVAL agent from OVAL definition model. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga65c6c0a750c30ccbf40aea8e2e3f4374"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_eval_definition" ref="ga65c6c0a750c30ccbf40aea8e2e3f4374" args="(oval_agent_session_t *ag_sess, const char *id)" -->
<a class="el" href="group__OVALRES.html#ga585abe0825db03426e1994ba335dc4bf">oval_result_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga65c6c0a750c30ccbf40aea8e2e3f4374">oval_agent_eval_definition</a> (<a class="el" href="structoval__agent__session.html">oval_agent_session_t</a> *ag_sess, const char *id)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Probe the system and evaluate specified definition. <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&nbsp;</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">&nbsp;</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="gaec71f72c60b8c668f270c8c85cbf640a"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_eval_system" ref="gaec71f72c60b8c668f270c8c85cbf640a" args="(oval_agent_session_t *ag_sess, oval_agent_result_cb_t *cb, void *arg)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#gaec71f72c60b8c668f270c8c85cbf640a">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__OVALAGENT.html#gaf161e671e9cd718f3231044b24b15e86">oval_agent_result_cb_t</a> *cb, void *arg)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Probe and evaluate all definitions from the content, call the callback functions upon single evaluation. <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> *&nbsp;</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">&nbsp;</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="ga301f466948c1844837208f917b3e2025"></a><!-- doxytag: member="oval_agent_api.h::oval_agent_destroy_session" ref="ga301f466948c1844837208f917b3e2025" args="(oval_agent_session_t *ag_sess)" -->
void&nbsp;</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">&nbsp;</td><td class="mdescRight">Finish OVAL agent session. <br/></td></tr>
<tr><td colspan="2"><h2>Evaluators</h2></td></tr>
<tr><td colspan="2"><p><a class="anchor" id="amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2"></a> </p>
<br/><br/></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>(&nbsp;</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga7b472f8a251a294478a01bbf96417bf7">oval_agent_eval_rule</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="mdescLeft">&nbsp;</td><td class="mdescRight">Internal OVAL Agent Callback that can be used to evaluate XCCDF content.  <a href="group__OVALAGENT.html#ga7b472f8a251a294478a01bbf96417bf7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__OVALAGENT.html#ga9020215fc2db19ea98b6e11984947176">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">&nbsp;</td><td class="mdescRight">Resolve variables from XCCDF Value Bindings and set their values to OVAL Variables.  <a href="group__OVALAGENT.html#ga9020215fc2db19ea98b6e11984947176"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</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">&nbsp;</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"></a><h2>Detailed Description</h2>
<dl class="author"><dt><b>Author:</b></dt><dd>"David Niemoller" &lt;<a href="mailto:David.Niemoller@g2-inc.com">David.Niemoller@g2-inc.com</a>&gt; </dd>
<dd>
"Peter Vrabec" &lt;<a href="mailto:pvrabec@gmail.com">pvrabec@gmail.com</a>&gt; </dd></dl>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Jun 2010 for Open SCAP Library by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>