| Current File : //usr/share/docs/openscap/html/check__engine__plugin_8h_source.html |
<!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.9.1"/>
<title>Open SCAP Library: check_engine_plugin.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_e59844bb90898a84583aad04688e689a.html">XCCDF_POLICY</a></li><li class="navelem"><a class="el" href="dir_3ce90c11f2b5fbab65d4560be098a936.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">check_engine_plugin.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="check__engine__plugin_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Copyright 2013 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * All Rights Reserved.</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"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef OPENSCAP_CHECK_ENGINE_PLUGIN_H_</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define OPENSCAP_CHECK_ENGINE_PLUGIN_H_</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="xccdf__policy_8h.html">xccdf_policy.h</a>"</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structcheck__engine__plugin__def.html"> 36</a></span> <span class="keyword">struct </span><a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">int</span> _reserved; <span class="comment">// FIXME: version checking?</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> *module_handle;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> *user_data;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// NB: path hint is the input file path, can be used for relative path resolution</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// first arg: policy model to register with, second arg: path hint, third arg: user data</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  int (*register_fn)(<span class="keyword">struct </span><a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">void</span>**);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// first arg: policy model, second arg: user data</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  int (*cleanup_fn)(<span class="keyword">struct </span><a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *, <span class="keywordtype">void</span>**);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// first arg: policy model, second arg: validate, third arg: path hint, fourth arg: user data</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  int (*export_results_fn)(<span class="keyword">struct </span><a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *, bool, <span class="keyword">const</span> <span class="keywordtype">char</span>*, <span class="keywordtype">void</span>**);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// first arg: user data</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *(*get_capabilities_fn)(<span class="keywordtype">void</span>**);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> };</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">struct </span><a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *check_engine_plugin_load(<span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> check_engine_plugin_unload(<span class="keyword">struct</span> <a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *plugin);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">int</span> check_engine_plugin_register(<span class="keyword">struct</span> <a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *plugin, <span class="keyword">struct</span> <a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *model, <span class="keyword">const</span> <span class="keywordtype">char</span> *path_hint);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">int</span> check_engine_plugin_cleanup(<span class="keyword">struct</span> <a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *plugin, <span class="keyword">struct</span> <a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *model);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">int</span> check_engine_plugin_export_results(<span class="keyword">struct</span> <a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *plugin, <span class="keyword">struct</span> <a class="code" href="structxccdf__policy__model.html">xccdf_policy_model</a> *model, <span class="keywordtype">bool</span> validate, <span class="keyword">const</span> <span class="keywordtype">char</span> *path_hint);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *check_engine_plugin_get_capabilities(<span class="keyword">struct</span> <a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a> *plugin);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="group__Check.html#ga6626ae28d29c073978aa7b02b0128ab7"> 66</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__Check.html#ga6626ae28d29c073978aa7b02b0128ab7">check_engine_plugin_entry_fn</a>) (<span class="keyword">struct </span><a class="code" href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a>*);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define OPENSCAP_CHECK_ENGINE_PLUGIN_ENTRY OPENSCAP_CHECK_ENGINE_PLUGIN_ENTRY</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * <span class="keyword">const</span> *<a class="code" href="group__Check.html#ga61a901d583baabb26fc304afd51074d0">check_engine_plugin_get_known_plugins</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="group__Check_html_ga61a901d583baabb26fc304afd51074d0"><div class="ttname"><a href="group__Check.html#ga61a901d583baabb26fc304afd51074d0">check_engine_plugin_get_known_plugins</a></div><div class="ttdeci">const char *const * check_engine_plugin_get_known_plugins(void)</div><div class="ttdoc">Retrieves list of plugin names that are known to OpenSCAP. </div><div class="ttdef"><b>Definition:</b> check_engine_plugin.c:193</div></div>
<div class="ttc" id="xccdf__policy_8h_html"><div class="ttname"><a href="xccdf__policy_8h.html">xccdf_policy.h</a></div><div class="ttdoc">Open-scap XCCDF Policy library interface. </div></div>
<div class="ttc" id="structxccdf__policy__model_html"><div class="ttname"><a href="structxccdf__policy__model.html">xccdf_policy_model</a></div><div class="ttdoc">XCCDF policy model structure contains xccdf_benchmark as reference to Benchmark element in XML file a...</div><div class="ttdef"><b>Definition:</b> xccdf_policy_priv.h:39</div></div>
<div class="ttc" id="group__Check_html_ga6626ae28d29c073978aa7b02b0128ab7"><div class="ttname"><a href="group__Check.html#ga6626ae28d29c073978aa7b02b0128ab7">check_engine_plugin_entry_fn</a></div><div class="ttdeci">int(* check_engine_plugin_entry_fn)(struct check_engine_plugin_def *)</div><div class="ttdoc">This is the entry point of shared objects implementing extra check engines. </div><div class="ttdef"><b>Definition:</b> check_engine_plugin.h:66</div></div>
<div class="ttc" id="structcheck__engine__plugin__def_html"><div class="ttname"><a href="structcheck__engine__plugin__def.html">check_engine_plugin_def</a></div><div class="ttdef"><b>Definition:</b> check_engine_plugin.h:36</div></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.9.1
</small></address>
</body>
</html>