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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
|
<!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.3.1"/>
<title>Open SCAP Library: cce.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="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.3.1 -->
<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 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_9cb2eb5d6968aebfd11e1ba0f4d53982.html">CCE</a></li><li class="navelem"><a class="el" href="dir_f2a93cdd3aad33ca5b82af4e93bb682f.html">public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">cce.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cce_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="l00008"></a><span class="lineno"> 8</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright 2008-2009 Red Hat Inc., Durham, North Carolina.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * All Rights Reserved.</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"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * Authors:</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Lukas Kuklinek <lkuklinek@redhat.com></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Riley C. Porter <Riley.Porter@g2-inc.com></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">#include <stdbool.h></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="oscap_8h.html" title="General OpenScap functions and types.">oscap.h</a>"</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">#ifndef _CCE_H</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define _CCE_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">struct </span><a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">struct </span><a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">struct </span><a class="code" href="structcce__reference.html" title="Structure holding a CCE reference.">cce_reference</a>;</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="comment">/************************************************************/</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">struct </span><a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a> *<a class="code" href="group__CCE.html#ga66a95018e115b837e91361e2e51746fc" title="Get an iterator to the contents of the CCE.">cce_get_entries</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">struct </span><a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="group__CCE.html#ga4ee2017074b9d3cecacb4f7c665302a9" title="Get an CCE entry by ID.">cce_get_entry</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__CCE.html#ga283ab5c803313d976c8c7c9676de0f02" title="Get CCE entry ID.">cce_entry_get_id</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__CCE.html#gabf6f975c9137420a95f8eb1f47169587" title="Get CCE entry desription.">cce_entry_get_description</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *<a class="code" href="group__CCE.html#ga39fac44a0f669ac2dad57719e93a3988" title="Get an iterator to CCE entry's parameters.">cce_entry_get_params</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">struct </span><a class="code" href="structoscap__string__iterator.html" title="String iterator.">oscap_string_iterator</a> *<a class="code" href="group__CCE.html#gafd403dfc778e139e38b334b1f5396b1e" title="Get an iterator to CCE entry's technical mechanisms.">cce_entry_get_tech_mechs</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">struct </span><a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a> *<a class="code" href="group__CCE.html#ga9191a1c0f3dbd61e5186757881420152" title="Get an iterator to CCE entry's references.">cce_entry_get_references</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__CCE.html#ga833b5414e28e8d0c90ae44217ddbd4ee" title="Get source of CCE reference.">cce_reference_get_source</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__reference.html" title="Structure holding a CCE reference.">cce_reference</a> *ref);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__CCE.html#gaa86502b7deca12a4a5683bc962e563da" title="Get contents of CCE reference.">cce_reference_get_value</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structcce__reference.html" title="Structure holding a CCE reference.">cce_reference</a> *ref);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">struct </span><a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a>;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">struct </span><a class="code" href="structcce__reference.html" title="Structure holding a CCE reference.">cce_reference</a> *<a class="code" href="group__CCE.html#ga62bff9cae373da442e5eef19e0c54fc9">cce_reference_iterator_next</a>(<span class="keyword">struct</span> <a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a> *it);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">bool</span> <a class="code" href="group__CCE.html#gaab76256cfe8b8bdbb998a177487ecb62">cce_reference_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a> *it);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="keywordtype">void</span> <a class="code" href="group__CCE.html#ga2625080872bec0ea12f2ace6a32cee89">cce_reference_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a> *it);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keywordtype">void</span> <a class="code" href="group__CCE.html#ga41d0b84deb87502b8b4b7122b06b661a">cce_reference_iterator_reset</a>(<span class="keyword">struct</span> <a class="code" href="structcce__reference__iterator.html" title="Iterator over CCE references.">cce_reference_iterator</a> *it);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">struct </span><a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a>;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">struct </span><a class="code" href="structcce__entry.html" title="Structure holding single CCE entry data.">cce_entry</a> *<a class="code" href="group__CCE.html#gadef987b5c37644c4c0abddf1afb21b82">cce_entry_iterator_next</a>(<span class="keyword">struct</span> <a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a> *it);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">bool</span> <a class="code" href="group__CCE.html#gad1801fa9c1492a5090fe9d086c1ea963">cce_entry_iterator_has_more</a>(<span class="keyword">struct</span> <a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a> *it);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">void</span> <a class="code" href="group__CCE.html#ga60f687d0a6df957a66ca645e9e06f19e">cce_entry_iterator_free</a>(<span class="keyword">struct</span> <a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a> *it);</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">void</span> <a class="code" href="group__CCE.html#ga4585009428f9daa28c79166e5a89e890">cce_entry_iterator_reset</a>(<span class="keyword">struct</span> <a class="code" href="structcce__entry__iterator.html" title="Iterator over CCE entries.">cce_entry_iterator</a> *it);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">struct </span><a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a> *<a class="code" href="group__CCE.html#gaaffe83cc955e2b2e09beb26f178d92c0" title="Create a new CCE structure from XML file.">cce_new</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keywordtype">void</span> <a class="code" href="group__CCE.html#gaf276ebae2890323a8820c6d28f55f5b3" title="CCE structure destructor.">cce_free</a>(<span class="keyword">struct</span> <a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a> *<a class="code" href="structcce.html" title="Structure holding CCE entries.">cce</a>);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="keywordtype">bool</span> <a class="code" href="group__CCE.html#ga0ef192211b0ba7e19328920fc5a7cae1" title="Vlaidate CCE XML file.">cce_validate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="group__CCE.html#gaea9ebc3534f768c0b4bd43177c0610ff" title="Get supported version of CCE XML.">cce_supported</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/************************************************************/</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor">#endif</span></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.3.1
</small></address>
</body>
</html>
|