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
|
\hypertarget{structoval__object}{
\section{oval\_\-object Struct Reference}
\label{structoval__object}\index{oval\_\-object@{oval\_\-object}}
}
An Oval\_\-object instance describes a set of items to look for on an instrumented host platform.
{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ \hyperlink{group__OVALDEF_ga0745d23ca1646b7e5de5015a6dbce333}{oval\_\-object\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$, const char $\ast$id)
\begin{DoxyCompactList}\small\item\em Construct new intance of \hyperlink{structoval__object}{oval\_\-object}. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__object}{oval\_\-object} $\ast$ \hyperlink{group__OVALDEF_ga4ecf8898e68b0ce27be0e379e782051d}{oval\_\-object\_\-clone} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$new\_\-model, struct \hyperlink{structoval__object}{oval\_\-object} $\ast$old\_\-object)
\begin{DoxyCompactList}\small\item\em Clone instance of \hyperlink{structoval__object}{oval\_\-object} and add it to the specified \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model}. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga7f398a02efaaaa8962d68ad486c01a4e}{
void \hyperlink{group__OVALDEF_ga7f398a02efaaaa8962d68ad486c01a4e}{oval\_\-object\_\-free} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALDEF_ga7f398a02efaaaa8962d68ad486c01a4e}
\begin{DoxyCompactList}\small\item\em Free instance of \hyperlink{structoval__object}{oval\_\-object}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
}\begin{DoxyCompactItemize}
\item
void \hyperlink{group__OVALDEF_gab8022028389fbea3d58ff68f259490ca}{oval\_\-object\_\-set\_\-subtype} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, \hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} subtype)
\begin{DoxyCompactList}\small\item\em Sets attributes \hyperlink{structoval__object}{oval\_\-object}-\/$>$subtype and \hyperlink{structoval__object}{oval\_\-object}-\/$>$family. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga6acf65fe782b64885a38a7f9ef88f854}{oval\_\-object\_\-add\_\-note} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, char $\ast$note)
\begin{DoxyCompactList}\small\item\em Appends a copy of the note parameter to attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$notes. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gaa8c0c1dd2ba2400ebcbc896169d5666b}{oval\_\-object\_\-set\_\-comment} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, char $\ast$comment)
\begin{DoxyCompactList}\small\item\em Sets a copy of the comment parameter to attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$comment. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gaaa4cd7b065405e47cab4794eaf149962}{
void \hyperlink{group__OVALDEF_gaaa4cd7b065405e47cab4794eaf149962}{oval\_\-object\_\-set\_\-deprecated} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, bool deprecated)}
\label{group__OVALDEF_gaaa4cd7b065405e47cab4794eaf149962}
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$deprecated. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gaba746d196149d499e10bde052158a474}{oval\_\-object\_\-set\_\-version} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, int version)
\begin{DoxyCompactList}\small\item\em Sets attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$version. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gab62165673d2479dd5d27cb437e7120b8}{oval\_\-object\_\-add\_\-object\_\-content} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, struct \hyperlink{structoval__object__content}{oval\_\-object\_\-content} $\ast$content)
\begin{DoxyCompactList}\small\item\em Append instance of \hyperlink{structoval__object__content}{oval\_\-object\_\-content} to attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$object\_\-contents. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga01301c7353996e914cfddb52fb98a229}{oval\_\-object\_\-add\_\-behavior} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$, struct \hyperlink{structoval__behavior}{oval\_\-behavior} $\ast$behavior)
\begin{DoxyCompactList}\small\item\em Append instance of \hyperlink{structoval__behavior}{oval\_\-behavior} to attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$behaviors. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
}\begin{DoxyCompactItemize}
\item
\hypertarget{group__OVALDEF_ga37ae5b026dae3ba19307bee4eabae755}{
\hyperlink{group__OVAL_ga83b7e728a31f7ad0a0306ec1408f0a1a}{oval\_\-family\_\-t} \hyperlink{group__OVALDEF_ga37ae5b026dae3ba19307bee4eabae755}{oval\_\-object\_\-get\_\-family} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALDEF_ga37ae5b026dae3ba19307bee4eabae755}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$family. \item\end{DoxyCompactList}\item
const char $\ast$ \hyperlink{group__OVALDEF_ga84349daf1af6150c3cacdf5e1de6cd1e}{oval\_\-object\_\-get\_\-name} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns the name of an \hyperlink{structoval__object}{oval\_\-object}. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga0d345c0d277c3ddb7d3919eafbbbb1bd}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} \hyperlink{group__OVALDEF_ga0d345c0d277c3ddb7d3919eafbbbb1bd}{oval\_\-object\_\-get\_\-subtype} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALDEF_ga0d345c0d277c3ddb7d3919eafbbbb1bd}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$subtype. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga3c9bdd066ff355ac056618c3087e0fb1}{oval\_\-object\_\-get\_\-notes} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$notes. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__OVALDEF_ga1f96b1099febf9cad3f8b8830be86b82}{oval\_\-object\_\-get\_\-comment} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$comment. \item\end{DoxyCompactList}\item
char $\ast$ \hyperlink{group__OVALDEF_ga7caf7a93229db23933ddb155db9314fa}{oval\_\-object\_\-get\_\-id} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$id. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga0e2c853a129e06691591d76f57ca7076}{
bool \hyperlink{group__OVALDEF_ga0e2c853a129e06691591d76f57ca7076}{oval\_\-object\_\-get\_\-deprecated} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALDEF_ga0e2c853a129e06691591d76f57ca7076}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$deprecated. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gaf4bc6662c4a38bf0667d44a2ef3d837b}{
int \hyperlink{group__OVALDEF_gaf4bc6662c4a38bf0667d44a2ef3d837b}{oval\_\-object\_\-get\_\-version} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)}
\label{group__OVALDEF_gaf4bc6662c4a38bf0667d44a2ef3d837b}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$version. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__object__content__iterator}{oval\_\-object\_\-content\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_gaea7af3fbe1776527e8eef6233aebe3b5}{oval\_\-object\_\-get\_\-object\_\-contents} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$contents. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__behavior__iterator}{oval\_\-behavior\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_gab8bd2340de0758874def8c260fdd4054}{oval\_\-object\_\-get\_\-behaviors} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__object}{oval\_\-object}-\/$>$behaviors. \item\end{DoxyCompactList}\item
bool \hyperlink{group__OVALDEF_ga81cb3eac4127c92051d5b33ad9e55928}{oval\_\-object\_\-is\_\-locked} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$object)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the object instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
}\begin{DoxyCompactItemize}
\item
bool \hyperlink{group__OVALDEF_ga2c81c85dcbe63fea465e3ad5381bbd93}{oval\_\-object\_\-is\_\-valid} (struct \hyperlink{structoval__object}{oval\_\-object} $\ast$object)
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the object instance is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structoval__object_a68ed77ea493d8ef3e2cdb53af5d33764}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__object_a68ed77ea493d8ef3e2cdb53af5d33764}
\item
\hypertarget{structoval__object_ac268753325b86bee65e19abadf1254c5}{
\hyperlink{group__OVAL_ga99498f525c1a0282ef45557fc882f97f}{oval\_\-subtype\_\-t} {\bfseries subtype}}
\label{structoval__object_ac268753325b86bee65e19abadf1254c5}
\item
\hypertarget{structoval__object_a221176fb024becd2c75b176f93a4b7f2}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries notes}}
\label{structoval__object_a221176fb024becd2c75b176f93a4b7f2}
\item
\hypertarget{structoval__object_a5d9317866b0dfb692feb858938342b2d}{
char $\ast$ {\bfseries comment}}
\label{structoval__object_a5d9317866b0dfb692feb858938342b2d}
\item
\hypertarget{structoval__object_a0b64a9bf5faefe569d89bde4ede4515e}{
char $\ast$ {\bfseries id}}
\label{structoval__object_a0b64a9bf5faefe569d89bde4ede4515e}
\item
\hypertarget{structoval__object_a405d77f7a9b28c5bf3d992e6d5da0a81}{
int {\bfseries deprecated}}
\label{structoval__object_a405d77f7a9b28c5bf3d992e6d5da0a81}
\item
\hypertarget{structoval__object_af1b3f655bb3dd0e2271ede9a1c031a79}{
int {\bfseries version}}
\label{structoval__object_af1b3f655bb3dd0e2271ede9a1c031a79}
\item
\hypertarget{structoval__object_a9906ce242d2a053e6f3da52af6804b98}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries object\_\-content}}
\label{structoval__object_a9906ce242d2a053e6f3da52af6804b98}
\item
\hypertarget{structoval__object_a55ade63deb9999f79221801283ad5332}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries behaviors}}
\label{structoval__object_a55ade63deb9999f79221801283ad5332}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
An Oval\_\-object instance describes a set of items to look for on an instrumented host platform. A simple object will usually result in a single file, process, etc being identified. But through the use pattern matches, sets, and variables, multiple matching objects can be identified. Therefore an OVAL Object can identify a set of many individual items on a system. This set of items defined by the OVAL Object can then be used by an OVAL Test and compared against an OVAL State.
The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/\hyperlink{oval__object_8c}{oval\_\-object.c}\item
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/public/\hyperlink{oval__definitions_8h}{oval\_\-definitions.h}\end{DoxyCompactItemize}
|
