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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
\hypertarget{structxccdf__benchmark}{
\section{xccdf\_\-benchmark Struct Reference}
\label{structxccdf__benchmark}\index{xccdf\_\-benchmark@{xccdf\_\-benchmark}}
}
Top level XCCDF structure containing profiles, rules, values and results.
{\ttfamily \#include $<$xccdf.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_gad71cc690fef5bceb9aa98bed119288f0}{xccdf\_\-benchmark\_\-import} (const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Import the content from a specified XML stream into a benchmark. \item\end{DoxyCompactList}\item
int \hyperlink{group__XCCDF_gaba556840f22fd02429b4c1917ab9ca51}{xccdf\_\-benchmark\_\-export} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Export a benchmark to an XML stream. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_gab4f6456bb76e29e6888ac09966097434}{xccdf\_\-benchmark\_\-new} (void)
\item
void \hyperlink{group__XCCDF_ga35e666e154a6a2f915dfe433c14fd74f}{xccdf\_\-benchmark\_\-free} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\item
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_ga9bb0dd7fe7db2a344e2f8366d9ce09c0}{xccdf\_\-benchmark\_\-to\_\-item} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item)
\item
struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$ \hyperlink{group__XCCDF_ga1a53f6a00ab20389c6d3e3f3ed0a03bd}{xccdf\_\-benchmark\_\-clone} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\item
const char $\ast$ \hyperlink{group__XCCDF_ga68b6b580c44dbe362fb7458449480a9c}{xccdf\_\-benchmark\_\-supported} (void)
\begin{DoxyCompactList}\small\item\em Get supported version of XCCDF XML. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
Return value is pointer to structure's member.
Do not free unless you null the pointer in the structure. Use remove function otherwise. }\begin{DoxyCompactItemize}
\item
\hypertarget{group__XCCDF_ga7a03386992919d1fa330c4c24b3b62d6}{
const char $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-id} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga7a03386992919d1fa330c4c24b3b62d6}
\item
\hypertarget{group__XCCDF_ga27e79892c0a92c03c17197c317069f42}{
bool {\bfseries xccdf\_\-benchmark\_\-get\_\-resolved} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga27e79892c0a92c03c17197c317069f42}
\item
\hypertarget{group__XCCDF_ga3de1224f1e671d0c009b6eb4c163a590}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-title} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga3de1224f1e671d0c009b6eb4c163a590}
\item
\hypertarget{group__XCCDF_ga0e63135ca08462e79b9f02cf2bcb0eed}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-description} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga0e63135ca08462e79b9f02cf2bcb0eed}
\item
\hypertarget{group__XCCDF_ga96e28a7749986ab0fd91ba64e3dcf5d6}{
const char $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-version} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga96e28a7749986ab0fd91ba64e3dcf5d6}
\item
\hypertarget{group__XCCDF_ga0c87656ac0f39d9aad1ccefd7142f044}{
const char $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-style} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga0c87656ac0f39d9aad1ccefd7142f044}
\item
\hypertarget{group__XCCDF_ga58f62d987ce5b150468bb9d05f2fba50}{
const char $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-style\_\-href} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga58f62d987ce5b150468bb9d05f2fba50}
\item
\hypertarget{group__XCCDF_gab947757c36ac3075002a8a47d9981859}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-front\_\-matter} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_gab947757c36ac3075002a8a47d9981859}
\item
\hypertarget{group__XCCDF_ga19947299e32d34dba00b18f2f6216a4b}{
struct \hyperlink{structoscap__text__iterator}{oscap\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-rear\_\-matter} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga19947299e32d34dba00b18f2f6216a4b}
\item
\hypertarget{group__XCCDF_gae708e1e880427ebdee8066948b97abdf}{
const char $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-metadata} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_gae708e1e880427ebdee8066948b97abdf}
\item
\hypertarget{group__XCCDF_ga31768dc945fbd317ed67ed851cfdab9c}{
struct \hyperlink{structxccdf__status__iterator}{xccdf\_\-status\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-statuses} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga31768dc945fbd317ed67ed851cfdab9c}
\item
\hypertarget{group__XCCDF_gace516f914bdf7f06103cc72d8fc7f0b8}{
struct \hyperlink{structxccdf__reference__iterator}{xccdf\_\-reference\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-references} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_gace516f914bdf7f06103cc72d8fc7f0b8}
\item
\hypertarget{group__XCCDF_ga64be8bb3913e2691341e039af4558f76}{
struct \hyperlink{structoscap__string__iterator}{oscap\_\-string\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-platforms} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga64be8bb3913e2691341e039af4558f76}
\item
\hypertarget{group__XCCDF_ga6263364d412ecd8c8cbb5b5029f51e0e}{
\hyperlink{group__XCCDF_gac0d5c1c85828e13ebb13935551f8da38}{xccdf\_\-status\_\-type\_\-t} {\bfseries xccdf\_\-benchmark\_\-get\_\-status\_\-current} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)}
\label{group__XCCDF_ga6263364d412ecd8c8cbb5b5029f51e0e}
\item
\hypertarget{group__XCCDF_ga3f73f577dcc419d081b9a360a6bba82c}{
struct \hyperlink{structxccdf__plain__text__iterator}{xccdf\_\-plain\_\-text\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-plain\_\-texts} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item)}
\label{group__XCCDF_ga3f73f577dcc419d081b9a360a6bba82c}
\item
\hypertarget{group__XCCDF_ga528236d63673ca8817d01fb1f8e4beb3}{
struct \hyperlink{structxccdf__result__iterator}{xccdf\_\-result\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-results} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$bench)}
\label{group__XCCDF_ga528236d63673ca8817d01fb1f8e4beb3}
\item
\hypertarget{group__XCCDF_gae2016c443083c20bda2d6942c8f840fa}{
struct \hyperlink{structxccdf__value__iterator}{xccdf\_\-value\_\-iterator} $\ast$ {\bfseries xccdf\_\-benchmark\_\-get\_\-values} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item)}
\label{group__XCCDF_gae2016c443083c20bda2d6942c8f840fa}
\item
const char $\ast$ \hyperlink{group__XCCDF_ga21836d072111dddf9992ae8af5596113}{xccdf\_\-benchmark\_\-get\_\-plain\_\-text} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, const char $\ast$id)
\begin{DoxyCompactList}\small\item\em Get a plain text by ID. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$ \hyperlink{group__XCCDF_ga92afdc66eed4d0c691327da277e9766b}{xccdf\_\-benchmark\_\-get\_\-item} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, const char $\ast$id)
\begin{DoxyCompactList}\small\item\em Get benchmark item by ID. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__notice__iterator}{xccdf\_\-notice\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga344d2b339d28f8a86cc95c0b437709ea}{xccdf\_\-benchmark\_\-get\_\-notices} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\begin{DoxyCompactList}\small\item\em Get an iterator to the benchmark legal notices. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__model__iterator}{xccdf\_\-model\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gad1691a19de813ff391c455b651cd6162}{xccdf\_\-benchmark\_\-get\_\-models} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\begin{DoxyCompactList}\small\item\em Get an iterator to the benchmark scoring models. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__profile__iterator}{xccdf\_\-profile\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga9e2fce5908a4955f7ab291d7a9b4e3db}{xccdf\_\-benchmark\_\-get\_\-profiles} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\begin{DoxyCompactList}\small\item\em Get an iterator to the benchmark XCCDF profiles. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__item__iterator}{xccdf\_\-item\_\-iterator} $\ast$ \hyperlink{group__XCCDF_ga986e534558ef85b903abbbea65bcd0dd}{xccdf\_\-benchmark\_\-get\_\-content} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\begin{DoxyCompactList}\small\item\em Get an iterator to the bencmark content. \item\end{DoxyCompactList}\item
struct \hyperlink{structxccdf__warning__iterator}{xccdf\_\-warning\_\-iterator} $\ast$ \hyperlink{group__XCCDF_gab54263d75d2620a8a0fbe275dcd511ca}{xccdf\_\-benchmark\_\-get\_\-warnings} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\item
const char $\ast$ \hyperlink{group__XCCDF_gae8ee0fd48ed6bab61123270271b67058}{xccdf\_\-benchmark\_\-get\_\-version\_\-update} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\item
time\_\-t \hyperlink{group__XCCDF_ga2e8886ed0a593a6b26dc39a10ada4daf}{xccdf\_\-benchmark\_\-get\_\-version\_\-time} (const struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark)
\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
For lists use add functions.
Parameters of set functions are duplicated in memory and need to be freed by caller. }\begin{DoxyCompactItemize}
\item
bool \hyperlink{group__XCCDF_ga294a47c163a122a618d49a449c33c71e}{xccdf\_\-benchmark\_\-set\_\-resolved} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, bool newval)
\item
bool \hyperlink{group__XCCDF_ga33be99e326ab39ddaff56a017b9a1255}{xccdf\_\-benchmark\_\-set\_\-metadata} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga79685f9db64304378c156582dede161c}{xccdf\_\-benchmark\_\-set\_\-style\_\-href} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gaeb877f43e25ee1d5ef561dbf48f74d1a}{xccdf\_\-benchmark\_\-set\_\-style} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga0065b7ae8e50617d9ac8e8c45f10ac65}{xccdf\_\-benchmark\_\-set\_\-id} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga1a64271b9a1952d2ce2130b1f97b7e43}{xccdf\_\-benchmark\_\-set\_\-version} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gad26a92995ab034296a1b7bf6d8b39c92}{xccdf\_\-benchmark\_\-set\_\-version\_\-time} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, time\_\-t newval)
\item
bool \hyperlink{group__XCCDF_gaa7a238d79a0f77e8603eac301c5ea80b}{xccdf\_\-benchmark\_\-set\_\-version\_\-update} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gaf8b81208eb9acf30bc93957582e5a621}{xccdf\_\-benchmark\_\-add\_\-result} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$bench, struct \hyperlink{structxccdf__result}{xccdf\_\-result} $\ast$result)
\item
bool \hyperlink{group__XCCDF_ga7fc2f6f739ed7ce3dd7c656b369be3f3}{xccdf\_\-benchmark\_\-add\_\-description} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga8d349985d7d5d121a726573cf64d43a2}{xccdf\_\-benchmark\_\-add\_\-platform} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, const char $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga06a72ba7f846eb468d1d672c45effa8d}{xccdf\_\-benchmark\_\-add\_\-reference} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__reference}{xccdf\_\-reference} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga2f2f15e1a2f05eb522c6092b18e14084}{xccdf\_\-benchmark\_\-add\_\-status} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__status}{xccdf\_\-status} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga3953bb5e150c98bbe4910250412a89a2}{xccdf\_\-benchmark\_\-add\_\-title} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga499bf29b73036e1ec4dd6bf64c8d9835}{xccdf\_\-benchmark\_\-add\_\-front\_\-matter} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga2abb5745c07a0b7a3414c3e9f73f41c5}{xccdf\_\-benchmark\_\-add\_\-model} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__model}{xccdf\_\-model} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_gad7a436e66c5ed23ee79fee602825d40e}{xccdf\_\-benchmark\_\-add\_\-notice} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__notice}{xccdf\_\-notice} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga0e0867d3bb3f660000a88ee8cbbc1f0e}{xccdf\_\-benchmark\_\-add\_\-plain\_\-text} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__plain__text}{xccdf\_\-plain\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga5a7a178c88c9e46805b90ff1476501d3}{xccdf\_\-benchmark\_\-add\_\-profile} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structxccdf__profile}{xccdf\_\-profile} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga8ff9185ad00c5b915e00b1b5919f8c4a}{xccdf\_\-benchmark\_\-add\_\-rear\_\-matter} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$item, struct \hyperlink{structoscap__text}{oscap\_\-text} $\ast$newval)
\item
bool \hyperlink{group__XCCDF_ga3af47823b4b8c830b746f127b47e884f}{xccdf\_\-benchmark\_\-add\_\-rule} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, struct \hyperlink{structxccdf__rule}{xccdf\_\-rule} $\ast$rule)
\item
bool \hyperlink{group__XCCDF_ga58cf6982e63fec35326ed13c1118d26d}{xccdf\_\-benchmark\_\-add\_\-group} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, struct \hyperlink{structxccdf__group}{xccdf\_\-group} $\ast$group)
\item
bool \hyperlink{group__XCCDF_ga8328912b18562f44f95a90efc4a47218}{xccdf\_\-benchmark\_\-add\_\-value} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$benchmark, struct \hyperlink{structxccdf__value}{xccdf\_\-value} $\ast$value)
\item
bool \hyperlink{group__XCCDF_ga3223a26e1f305d28faeb85a3957360ff}{xccdf\_\-benchmark\_\-add\_\-content} (struct \hyperlink{structxccdf__benchmark}{xccdf\_\-benchmark} $\ast$bench, struct \hyperlink{structxccdf__item}{xccdf\_\-item} $\ast$item)
\end{DoxyCompactItemize}
\end{Indent}
\subsection{Detailed Description}
Top level XCCDF structure containing profiles, rules, values and results.
The documentation for this struct was generated from the following file:\begin{DoxyCompactItemize}
\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/XCCDF/public/\hyperlink{xccdf_8h}{xccdf.h}\end{DoxyCompactItemize}
|
