Greenbone Vulnerability Management Libraries: base/nvti.h Source File

Greenbone Vulnerability Management Libraries 23.7.0

nvti.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2009-2023 Greenbone AG
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later
4 */
5
12
13#ifndef _GVM_BASE_NVTI_H
14#define _GVM_BASE_NVTI_H
15
16#include <glib.h>
17
18#define NVTPREF_TIMEOUT_ID 0
19
20typedef struct nvtpref nvtpref_t;
21
22 nvtpref_t *
23 nvtpref_new (int, const gchar *, const gchar *, const gchar *);
24
25void
26 nvtpref_free (nvtpref_t *);
27
28gchar *
29 nvtpref_name (const nvtpref_t *);
30
31gchar *
32 nvtpref_type (const nvtpref_t *);
33
34gchar *
35 nvtpref_default (const nvtpref_t *);
36
37int
38 nvtpref_id (const nvtpref_t *);
39
43typedef struct vtref vtref_t;
44
48typedef struct vtseverity vtseverity_t;
49
53typedef struct nvti nvti_t;
54
55 vtref_t *
56 vtref_new (const gchar *, const gchar *, const gchar *);
57void
58 vtref_free (vtref_t *);
59const gchar *
60 vtref_type (const vtref_t *);
61const gchar *
62 vtref_id (const vtref_t *);
63const gchar *
64 vtref_text (const vtref_t *);
65
66 vtseverity_t *
67 vtseverity_new (const gchar *, const gchar *, int, double, const gchar *);
68void
69 vtseverity_free (vtseverity_t *);
70const gchar *
71 vtseverity_type (const vtseverity_t *);
72const gchar *
73 vtseverity_origin (const vtseverity_t *);
74const gchar *
75 vtseverity_value (const vtseverity_t *);
76int
77 vtseverity_date (const vtseverity_t *);
78double
79 vtseverity_score (const vtseverity_t *);
80
81int
82 nvti_add_vtref (nvti_t *, vtref_t *);
83guint
84 nvti_vtref_len (const nvti_t *);
85 vtref_t *
86 nvti_vtref (const nvti_t *, guint);
87
88int
89 nvti_add_vtseverity (nvti_t *, vtseverity_t *);
90guint
91 nvti_vtseverities_len (const nvti_t *);
92 vtseverity_t *
93 nvti_vtseverity (const nvti_t *, guint);
94double
95 nvti_severity_score (const nvti_t *);
96gchar *
97 nvti_severity_vector_from_tag (const nvti_t *);
98
99 nvti_t *
100 nvti_new (void);
101void
102 nvti_free (nvti_t *);
103
104gchar *
105 nvti_oid (const nvti_t *);
106gchar *
107 nvti_name (const nvti_t *);
108gchar *
109 nvti_summary (const nvti_t *);
110gchar *
111 nvti_affected (const nvti_t *);
112gchar *
113 nvti_impact (const nvti_t *);
114time_t
115 nvti_creation_time (const nvti_t *);
116time_t
117 nvti_modification_time (const nvti_t *);
118gchar *
119 nvti_insight (const nvti_t *);
120gchar *
121nvti_refs (const nvti_t *, const gchar *, const char *, guint);
122gchar *
123 nvti_solution (const nvti_t *);
124gchar *
125 nvti_solution_type (const nvti_t *);
126gchar *
127 nvti_solution_method (const nvti_t *);
128gchar *
129 nvti_tag (const nvti_t *);
130gchar *
131 nvti_get_tag (const nvti_t *, const gchar *);
132gchar *
133 nvti_cvss_base (const nvti_t *);
134gchar *
135 nvti_dependencies (const nvti_t *);
136gchar *
137 nvti_required_keys (const nvti_t *);
138gchar *
139 nvti_mandatory_keys (const nvti_t *);
140gchar *
141 nvti_excluded_keys (const nvti_t *);
142gchar *
143 nvti_required_ports (const nvti_t *);
144gchar *
145 nvti_required_udp_ports (const nvti_t *);
146gchar *
147 nvti_detection (const nvti_t *);
148gchar *
149 nvti_qod_type (const nvti_t *);
150gchar *
151 nvti_qod (const nvti_t *);
152gint
153nvti_timeout (const nvti_t *);
154gint
155 nvti_category (const nvti_t *);
156gchar *
157 nvti_family (const nvti_t *);
158guint
159 nvti_pref_len (const nvti_t *);
160const nvtpref_t *
161 nvti_pref (const nvti_t *, guint);
162
163int
164 nvti_set_oid (nvti_t *, const gchar *);
165int
166 nvti_set_name (nvti_t *, const gchar *);
167int
168 nvti_put_name (nvti_t *, gchar *);
169int
170 nvti_set_summary (nvti_t *, const gchar *);
171int
172 nvti_put_summary (nvti_t *, gchar *);
173int
174 nvti_set_insight (nvti_t *, const gchar *);
175int
176 nvti_put_insight (nvti_t *, gchar *);
177int
178 nvti_set_affected (nvti_t *, const gchar *);
179int
180 nvti_put_affected (nvti_t *, gchar *);
181int
182 nvti_set_impact (nvti_t *, const gchar *);
183int
184 nvti_put_impact (nvti_t *, gchar *);
185int
186 nvti_set_creation_time (nvti_t *, const time_t);
187int
188 nvti_set_modification_time (nvti_t *, const time_t);
189int
190 nvti_set_solution (nvti_t *, const gchar *);
191int
192 nvti_put_solution (nvti_t *, gchar *);
193int
194 nvti_set_solution_type (nvti_t *, const gchar *);
195int
196 nvti_set_solution_method (nvti_t *, const gchar *);
197int
198 nvti_add_tag (nvti_t *, const gchar *, const gchar *);
199int
200 nvti_set_tag (nvti_t *, const gchar *);
201int
202 nvti_set_cvss_base (nvti_t *, const gchar *);
203int
204 nvti_set_dependencies (nvti_t *, const gchar *);
205int
206 nvti_set_required_keys (nvti_t *, const gchar *);
207int
208 nvti_set_mandatory_keys (nvti_t *, const gchar *);
209int
210 nvti_set_excluded_keys (nvti_t *, const gchar *);
211int
212 nvti_set_required_ports (nvti_t *, const gchar *);
213int
214 nvti_set_required_udp_ports (nvti_t *, const gchar *);
215int
216 nvti_set_detection (nvti_t *, const gchar *);
217int
218 nvti_put_detection (nvti_t *, gchar *);
219int
220 nvti_set_qod_type (nvti_t *, const gchar *);
221int
222 nvti_set_qod (nvti_t *, const gchar *);
223int
224nvti_set_timeout (nvti_t *, const gint);
225int
226 nvti_set_category (nvti_t *, const gint);
227int
228 nvti_set_family (nvti_t *, const gchar *);
229int
230 nvti_put_family (nvti_t *, gchar *);
231
232int
233 nvti_add_refs (nvti_t *, const gchar *, const gchar *, const gchar *);
234int
235 nvti_add_required_keys (nvti_t *, const gchar *);
236int
237 nvti_add_mandatory_keys (nvti_t *, const gchar *);
238int
239 nvti_add_excluded_keys (nvti_t *, const gchar *);
240int
241 nvti_add_required_ports (nvti_t *, const gchar *);
242int
243 nvti_add_required_udp_ports (nvti_t *, const gchar *);
244int
245 nvti_add_pref (nvti_t *, nvtpref_t *);
246
247/* Collections of NVT Infos. */
248
252 typedef GHashTable nvtis_t;
253
254 nvtis_t *
255 nvtis_new (void);
256
257void
258 nvtis_free (nvtis_t *);
259
260void
261 nvtis_add (nvtis_t *, nvti_t *);
262
263 nvti_t *
264 nvtis_lookup (nvtis_t *, const char *);
265
266#endif /* not _GVM_BASE_NVTI_H */
vtseverity_t
struct vtseverity vtseverity_t
The structure for a severity of a VT.
nvti_t
struct nvti nvti_t
The structure of a information record that corresponds to a NVT.
nvtpref_t
struct nvtpref nvtpref_t
The structure for a preference of a NVT.
vtref_t
struct vtref vtref_t
The structure for a cross reference of a VT.
nvti_set_qod
int nvti_set_qod(nvti_t *, const gchar *)
Set the QoD of a NVT.
Definition nvti.c:1880
nvti_new
nvti_t * nvti_new(void)
Create a new (empty) nvti structure.
Definition nvti.c:559
nvtpref_free
void nvtpref_free(nvtpref_t *)
Free memory of a nvtpref structure.
Definition nvti.c:484
nvtis_add
void nvtis_add(nvtis_t *, nvti_t *)
Add an NVT Info to a collection of NVT Infos.
Definition nvti.c:2233
vtseverity_new
vtseverity_t * vtseverity_new(const gchar *, const gchar *, int, double, const gchar *)
Create a new vtseverity structure filled with the given values.
Definition nvti.c:180
nvti_set_modification_time
int nvti_set_modification_time(nvti_t *, const time_t)
Set the modification time of a NVT.
Definition nvti.c:1453
nvti_set_dependencies
int nvti_set_dependencies(nvti_t *, const gchar *)
Set the dependencies of a NVT.
Definition nvti.c:1672
nvti_insight
gchar * nvti_insight(const nvti_t *)
Get the text about insight.
Definition nvti.c:653
nvti_pref_len
guint nvti_pref_len(const nvti_t *)
Get the number of preferences of the NVT.
Definition nvti.c:1171
nvti_put_name
int nvti_put_name(nvti_t *, gchar *)
Set the name of a NVT, using the given memory.
Definition nvti.c:1254
nvti_oid
gchar * nvti_oid(const nvti_t *)
Get the OID string.
Definition nvti.c:611
nvti_put_family
int nvti_put_family(nvti_t *, gchar *)
Set the family of a NVT, using the given memory.
Definition nvti.c:1923
nvti_vtref_len
guint nvti_vtref_len(const nvti_t *)
Get the number of references of the NVT.
Definition nvti.c:722
nvtpref_name
gchar * nvtpref_name(const nvtpref_t *)
Get the Name of a NVT Preference.
Definition nvti.c:518
nvtis_free
void nvtis_free(nvtis_t *)
Free a collection of NVT Infos.
Definition nvti.c:2220
nvtpref_new
nvtpref_t * nvtpref_new(int, const gchar *, const gchar *, const gchar *)
Create a new nvtpref structure filled with the given values.
Definition nvti.c:463
nvti_set_solution_method
int nvti_set_solution_method(nvti_t *, const gchar *)
Set the solution method of a NVT.
Definition nvti.c:1534
nvtis_new
nvtis_t * nvtis_new(void)
Make a collection of NVT Infos.
Definition nvti.c:2208
nvti_timeout
gint nvti_timeout(const nvti_t *)
nvti_tag
gchar * nvti_tag(const nvti_t *)
Get the tags.
Definition nvti.c:966
nvti_refs
gchar * nvti_refs(const nvti_t *, const gchar *, const char *, guint)
nvti_severity_score
double nvti_severity_score(const nvti_t *)
Get the maximum severity score.
Definition nvti.c:868
nvti_mandatory_keys
gchar * nvti_mandatory_keys(const nvti_t *)
Get the mandatory keys list.
Definition nvti.c:1060
nvti_qod
gchar * nvti_qod(const nvti_t *)
Get the QoD.
Definition nvti.c:1144
vtref_id
const gchar * vtref_id(const vtref_t *)
Get the id of a reference.
Definition nvti.c:131
nvti_modification_time
time_t nvti_modification_time(const nvti_t *)
Get the modification time.
Definition nvti.c:709
vtseverity_score
double vtseverity_score(const vtseverity_t *)
Get the score of a severity.
Definition nvti.c:279
nvti_put_insight
int nvti_put_insight(nvti_t *, gchar *)
Set the insight text of a NVT, using the given memory.
Definition nvti.c:1334
nvti_add_pref
int nvti_add_pref(nvti_t *, nvtpref_t *)
Add a preference to the NVT Info.
Definition nvti.c:2180
nvti_solution_method
gchar * nvti_solution_method(const nvti_t *)
Get the solution method.
Definition nvti.c:952
nvti_affected
gchar * nvti_affected(const nvti_t *)
Get the text about affected systems.
Definition nvti.c:667
nvti_creation_time
time_t nvti_creation_time(const nvti_t *)
Get the creation time.
Definition nvti.c:695
nvti_family
gchar * nvti_family(const nvti_t *)
Get the family name.
Definition nvti.c:1158
nvti_set_family
int nvti_set_family(nvti_t *, const gchar *)
Set the family of a NVT.
Definition nvti.c:1903
nvti_pref
const nvtpref_t * nvti_pref(const nvti_t *, guint)
Get the n'th preferences of the NVT.
Definition nvti.c:1186
nvti_name
gchar * nvti_name(const nvti_t *)
Get the name.
Definition nvti.c:625
nvti_set_insight
int nvti_set_insight(nvti_t *, const gchar *)
Set the insight text of a NVT.
Definition nvti.c:1314
nvti_set_cvss_base
int nvti_set_cvss_base(nvti_t *, const gchar *)
Set the CVSS base of an NVT.
Definition nvti.c:1648
nvti_set_creation_time
int nvti_set_creation_time(nvti_t *, const time_t)
Set the creation time of a NVT.
Definition nvti.c:1434
nvti_set_required_udp_ports
int nvti_set_required_udp_ports(nvti_t *, const gchar *)
Set the required udp ports of a NVT.
Definition nvti.c:1792
vtref_text
const gchar * vtref_text(const vtref_t *)
Get the text of a reference.
Definition nvti.c:145
nvtis_lookup
nvti_t * nvtis_lookup(nvtis_t *, const char *)
Add an NVT Info to a collection of NVT Infos.
Definition nvti.c:2250
nvti_excluded_keys
gchar * nvti_excluded_keys(const nvti_t *)
Get the excluded keys list.
Definition nvti.c:1074
nvti_add_vtseverity
int nvti_add_vtseverity(nvti_t *, vtseverity_t *)
Add a severity to the VT Info.
Definition nvti.c:426
nvti_vtseverity
vtseverity_t * nvti_vtseverity(const nvti_t *, guint)
Get the n'th reference of the NVT.
Definition nvti.c:855
nvtpref_default
gchar * nvtpref_default(const nvtpref_t *)
Get the Default of a NVT Preference.
Definition nvti.c:546
nvti_put_affected
int nvti_put_affected(nvti_t *, gchar *)
Set the affected text of a NVT, using the given memory.
Definition nvti.c:1374
nvti_set_detection
int nvti_set_detection(nvti_t *, const gchar *)
Set the detection text of a NVT.
Definition nvti.c:1815
nvti_set_tag
int nvti_set_tag(nvti_t *, const gchar *)
Set the tags of a NVT.
Definition nvti.c:1625
nvti_detection
gchar * nvti_detection(const nvti_t *)
Get the text about detection.
Definition nvti.c:1116
nvti_add_mandatory_keys
int nvti_add_mandatory_keys(nvti_t *, const gchar *)
Add a mandatory key of a NVT.
Definition nvti.c:2052
nvti_add_excluded_keys
int nvti_add_excluded_keys(nvti_t *, const gchar *)
Add a excluded key of a NVT.
Definition nvti.c:2084
nvti_set_qod_type
int nvti_set_qod_type(nvti_t *, const gchar *)
Set the QoD type of a NVT.
Definition nvti.c:1856
nvti_qod_type
gchar * nvti_qod_type(const nvti_t *)
Get the QoD type.
Definition nvti.c:1130
nvti_add_tag
int nvti_add_tag(nvti_t *, const gchar *, const gchar *)
Add a tag to the NVT tags. The tag names "severity_date", "last_modification" and "creation_date" are...
Definition nvti.c:1561
nvti_add_required_udp_ports
int nvti_add_required_udp_ports(nvti_t *, const gchar *)
Add a required udp port of a NVT.
Definition nvti.c:2148
nvti_cvss_base
gchar * nvti_cvss_base(const nvti_t *)
Get the CVSS base.
Definition nvti.c:1018
nvti_impact
gchar * nvti_impact(const nvti_t *)
Get the text about impact.
Definition nvti.c:681
nvti_put_solution
int nvti_put_solution(nvti_t *, gchar *)
Set the solution of a NVT, using the given memory.
Definition nvti.c:1492
nvti_set_required_keys
int nvti_set_required_keys(nvti_t *, const gchar *)
Set the required keys of a NVT.
Definition nvti.c:1696
nvtis_t
GHashTable nvtis_t
A collection of information records corresponding to NVTs.
Definition nvti.h:252
nvti_put_detection
int nvti_put_detection(nvti_t *, gchar *)
Set the detection text of a NVT, using the given memory.
Definition nvti.c:1835
nvti_add_refs
int nvti_add_refs(nvti_t *, const gchar *, const gchar *, const gchar *)
Add many new vtref from a comma-separated list.
Definition nvti.c:1968
nvti_add_required_keys
int nvti_add_required_keys(nvti_t *, const gchar *)
Add a required key of a NVT.
Definition nvti.c:2020
nvti_set_impact
int nvti_set_impact(nvti_t *, const gchar *)
Set the impact text of a NVT.
Definition nvti.c:1394
nvti_set_summary
int nvti_set_summary(nvti_t *, const gchar *)
Set the summary of a NVT.
Definition nvti.c:1274
nvti_required_keys
gchar * nvti_required_keys(const nvti_t *)
Get the required keys list.
Definition nvti.c:1046
nvti_put_impact
int nvti_put_impact(nvti_t *, gchar *)
Set the impact text of a NVT, using the given memory.
Definition nvti.c:1414
nvti_set_timeout
int nvti_set_timeout(nvti_t *, const gint)
nvtpref_id
int nvtpref_id(const nvtpref_t *)
Get the ID of a NVT Preference.
Definition nvti.c:504
nvti_put_summary
int nvti_put_summary(nvti_t *, gchar *)
Set the summary of a NVT, using the given memory.
Definition nvti.c:1294
nvti_solution
gchar * nvti_solution(const nvti_t *)
Get the solution.
Definition nvti.c:924
vtseverity_type
const gchar * vtseverity_type(const vtseverity_t *)
Get the type of a severity.
Definition nvti.c:223
vtseverity_value
const gchar * vtseverity_value(const vtseverity_t *)
Get the value of a severity.
Definition nvti.c:251
vtref_new
vtref_t * vtref_new(const gchar *, const gchar *, const gchar *)
Create a new vtref structure filled with the given values.
Definition nvti.c:77
nvti_set_required_ports
int nvti_set_required_ports(nvti_t *, const gchar *)
Set the required ports of a NVT.
Definition nvti.c:1768
nvti_set_solution_type
int nvti_set_solution_type(nvti_t *, const gchar *)
Set the solution type of a NVT.
Definition nvti.c:1513
nvtpref_type
gchar * nvtpref_type(const nvtpref_t *)
Get the Type of a NVT Preference.
Definition nvti.c:532
nvti_add_required_ports
int nvti_add_required_ports(nvti_t *, const gchar *)
Add a required port of a NVT.
Definition nvti.c:2116
vtref_type
const gchar * vtref_type(const vtref_t *)
Get the type of a reference.
Definition nvti.c:117
nvti_set_category
int nvti_set_category(nvti_t *, const gint)
Set the category type of a NVT Info.
Definition nvti.c:1943
nvti_set_mandatory_keys
int nvti_set_mandatory_keys(nvti_t *, const gchar *)
Set the mandatory keys of a NVT.
Definition nvti.c:1720
nvti_set_affected
int nvti_set_affected(nvti_t *, const gchar *)
Set the affected text of a NVT.
Definition nvti.c:1354
nvti_solution_type
gchar * nvti_solution_type(const nvti_t *)
Get the solution type.
Definition nvti.c:938
vtseverity_free
void vtseverity_free(vtseverity_t *)
Free memory of a vtseverity structure.
Definition nvti.c:203
nvti_get_tag
gchar * nvti_get_tag(const nvti_t *, const gchar *)
Get a tag value by a tag name.
Definition nvti.c:982
vtseverity_date
int vtseverity_date(const vtseverity_t *)
Get the date of a severity.
Definition nvti.c:265
nvti_vtref
vtref_t * nvti_vtref(const nvti_t *, guint)
Get the n'th reference of the NVT.
Definition nvti.c:737
nvti_set_name
int nvti_set_name(nvti_t *, const gchar *)
Set the name of a NVT.
Definition nvti.c:1234
vtseverity_origin
const gchar * vtseverity_origin(const vtseverity_t *)
Get the origin of a severity.
Definition nvti.c:237
nvti_add_vtref
int nvti_add_vtref(nvti_t *, vtref_t *)
Add a reference to the VT Info.
Definition nvti.c:408
nvti_set_solution
int nvti_set_solution(nvti_t *, const gchar *)
Set the solution of a NVT.
Definition nvti.c:1472
nvti_vtseverities_len
guint nvti_vtseverities_len(const nvti_t *)
Get the number of severities of the NVT.
Definition nvti.c:840
nvti_free
void nvti_free(nvti_t *)
Free memory of a nvti structure.
Definition nvti.c:570
nvti_dependencies
gchar * nvti_dependencies(const nvti_t *)
Get the dependencies list.
Definition nvti.c:1032
vtref_free
void vtref_free(vtref_t *)
Free memory of a vtref structure.
Definition nvti.c:97
nvti_summary
gchar * nvti_summary(const nvti_t *)
Get the summary.
Definition nvti.c:639
nvti_category
gint nvti_category(const nvti_t *)
Get the category for this NVT.
Definition nvti.c:1199
nvti_required_ports
gchar * nvti_required_ports(const nvti_t *)
Get the required ports list.
Definition nvti.c:1088
nvti_required_udp_ports
gchar * nvti_required_udp_ports(const nvti_t *)
Get the required udp ports list.
Definition nvti.c:1102
nvti_set_oid
int nvti_set_oid(nvti_t *, const gchar *)
Set the OID of a NVT Info.
Definition nvti.c:1214
nvti_severity_vector_from_tag
gchar * nvti_severity_vector_from_tag(const nvti_t *)
Get the severity score.
Definition nvti.c:900
nvti_set_excluded_keys
int nvti_set_excluded_keys(nvti_t *, const gchar *)
Set the excluded keys of a NVT.
Definition nvti.c:1744
nvti
The structure of a information record that corresponds to a NVT.
Definition nvti.c:358
nvtpref
The structure for a preference of a NVT.
Definition nvti.c:441
vtref
The structure for a cross reference of a VT.
Definition nvti.c:58
vtseverity
The structure for a severity of a VT.
Definition nvti.c:158