File: structcve__model.tex

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 (107 lines) | stat: -rw-r--r-- 6,264 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
\hypertarget{structcve__model}{
\section{cve\_\-model Struct Reference}
\label{structcve__model}\index{cve\_\-model@{cve\_\-model}}
}


cve\_\-list cve\_\-list is the top level element of the CVE List provided by MITRE.  


{\ttfamily \#include $<$cve\_\-priv.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structcve__model}{cve\_\-model} $\ast$ \hyperlink{group__CVE_ga743af6ca1c274180e587feb63599bcd6}{cve\_\-model\_\-new} (void)
\begin{DoxyCompactList}\small\item\em New CVE model. \item\end{DoxyCompactList}\item 
void \hyperlink{group__CVE_ga43fce49d7e548907db40e89c9555b87d}{cve\_\-model\_\-free} (struct \hyperlink{structcve__model}{cve\_\-model} $\ast$\hyperlink{structcve__model}{cve\_\-model})
\begin{DoxyCompactList}\small\item\em Free CVE model. \item\end{DoxyCompactList}\item 
void \hyperlink{structcve__model_adea9158aefbd20d08ffd39918871196d}{cve\_\-model\_\-export} (struct \hyperlink{structcve__model}{cve\_\-model} $\ast$cve, const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Export CVE model to XML file. \item\end{DoxyCompactList}\item 
struct \hyperlink{structcve__model}{cve\_\-model} $\ast$ \hyperlink{structcve__model_a0b4422c3e6ea2339721a2ac973365b09}{cve\_\-model\_\-import} (const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Parses the specified XML file and creates a list of CVE data structures. \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 
struct \hyperlink{structxml__metadata__iterator}{xml\_\-metadata\_\-iterator} $\ast$ \hyperlink{group__CVE_gac03cbd24e33a5f7c7b207fc56fbd1686}{cve\_\-model\_\-get\_\-xmlns} (const struct \hyperlink{structcve__model}{cve\_\-model} $\ast$\hyperlink{structcve__model}{cve\_\-model})
\begin{DoxyCompactList}\small\item\em Get en iterator to XML metadatas from CVE model. \item\end{DoxyCompactList}\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__CVE_gaec8f745d0f680c83f6fe74f61b1d1d8f}{cve\_\-model\_\-add\_\-entry} (struct \hyperlink{structcve__model}{cve\_\-model} $\ast$model, struct \hyperlink{structcve__entry}{cve\_\-entry} $\ast$new\_\-entry)
\begin{DoxyCompactList}\small\item\em Add entry to CVE model. \item\end{DoxyCompactList}\item 
\hypertarget{group__CVE_ga1d1df0af8af9655a11623baf7c2b9c34}{
bool \hyperlink{group__CVE_ga1d1df0af8af9655a11623baf7c2b9c34}{cve\_\-model\_\-add\_\-xml} (struct \hyperlink{structcve__model}{cve\_\-model} $\ast$model, struct \hyperlink{structxml__metadata}{xml\_\-metadata} $\ast$xml)}
\label{group__CVE_ga1d1df0af8af9655a11623baf7c2b9c34}

\begin{DoxyCompactList}\small\item\em Add XML namespace to CVE model. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
const char $\ast$ \hyperlink{group__CVE_ga0521ad9696a5a48d5b7f13a1b7d782d4}{cve\_\-model\_\-supported} (void)
\begin{DoxyCompactList}\small\item\em Get supported version of CVE XML. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structcve__model_aed4e7417f4da06e1a5a3054a0ef8ebfb}{
struct \hyperlink{structxml__metadata}{xml\_\-metadata} {\bfseries xml}}
\label{structcve__model_aed4e7417f4da06e1a5a3054a0ef8ebfb}

\item 
\hypertarget{structcve__model_a04d607e72138335cb5d6f6a5dd98144c}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries xmlns}}
\label{structcve__model_a04d607e72138335cb5d6f6a5dd98144c}

\item 
\hypertarget{structcve__model_a0b98546f5f16b7239e494ba57cc084fe}{
struct \hyperlink{structoscap__list}{oscap\_\-list} $\ast$ {\bfseries entries}}
\label{structcve__model_a0b98546f5f16b7239e494ba57cc084fe}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
cve\_\-list cve\_\-list is the top level element of the CVE List provided by MITRE. Structure holding CVE model.

It represents holds all CVE Items. 

\subsection{Member Function Documentation}
\hypertarget{structcve__model_adea9158aefbd20d08ffd39918871196d}{
\index{cve\_\-model@{cve\_\-model}!cve\_\-model\_\-export@{cve\_\-model\_\-export}}
\index{cve\_\-model\_\-export@{cve\_\-model\_\-export}!cve_model@{cve\_\-model}}
\subsubsection[{cve\_\-model\_\-export}]{\setlength{\rightskip}{0pt plus 5cm}void cve\_\-model\_\-export (struct {\bf cve\_\-model} $\ast$ {\em cve}, \/  const char $\ast$ {\em file})}}
\label{structcve__model_adea9158aefbd20d08ffd39918871196d}


Export CVE model to XML file. 
\begin{DoxyParams}{Parameters}
\item[{\em cve}]CVE model \item[{\em target}]OSCAP export target \end{DoxyParams}
\hypertarget{structcve__model_a0b4422c3e6ea2339721a2ac973365b09}{
\index{cve\_\-model@{cve\_\-model}!cve\_\-model\_\-import@{cve\_\-model\_\-import}}
\index{cve\_\-model\_\-import@{cve\_\-model\_\-import}!cve_model@{cve\_\-model}}
\subsubsection[{cve\_\-model\_\-import}]{\setlength{\rightskip}{0pt plus 5cm}struct {\bf cve\_\-model} $\ast$ cve\_\-model\_\-import (const char $\ast$ {\em file})\hspace{0.3cm}{\ttfamily  \mbox{[}read\mbox{]}}}}
\label{structcve__model_a0b4422c3e6ea2339721a2ac973365b09}


Parses the specified XML file and creates a list of CVE data structures. The returned list can be freed with cveDelAll().


\begin{DoxyParams}{Parameters}
\item[{\em file}]filename \end{DoxyParams}
\begin{DoxyReturn}{Returns}
non-\/negative value indicates the number of CVEs in the list, negative value indicates an error 
\end{DoxyReturn}


The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/CVE/\hyperlink{cve__priv_8c}{cve\_\-priv.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/CVE/public/\hyperlink{cve_8h}{cve.h}\end{DoxyCompactItemize}