OpenVAS Libraries  8.0.3
nvti.h
Go to the documentation of this file.
1 /* openvas-libraries/base
2  * $Id$
3  * Description: API (structs and protos) for NVT Info datasets
4  *
5  * Authors:
6  * Jan-Oliver Wagner <jan-oliver.wagner@greenbone.net>
7  * Matthew Mundell <matthew.mundell@greenbone.net>
8  *
9  * Copyright:
10  * Copyright (C) 2009, 2011 Greenbone Networks GmbH
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
25  */
26 
34 #ifndef _NVTI_H
35 #define _NVTI_H
36 
37 #include <glib.h>
38 
45 typedef struct nvtpref
46 {
47  gchar *type;
48  gchar *name;
49  gchar *dflt;
50 } nvtpref_t;
51 
52 nvtpref_t *nvtpref_new (gchar *, gchar *, gchar *);
53 void nvtpref_free (nvtpref_t *);
54 gchar *nvtpref_name (const nvtpref_t *);
55 gchar *nvtpref_type (const nvtpref_t *);
56 gchar *nvtpref_default (const nvtpref_t *);
57 
64 typedef struct nvti
65 {
66  gchar *oid;
67  gchar *version;
68  gchar *name;
69  gchar *summary;
70  gchar *copyright;
72  gchar *cve;
73  gchar *bid;
75  gchar *xref;
77  gchar *tag;
78  gchar *cvss_base;
80  gchar *dependencies;
81  gchar *required_keys;
82  gchar *mandatory_keys;
83  gchar *excluded_keys;
84  gchar *required_ports;
87  GSList *prefs;
89  // The following are not settled yet.
90  gint timeout;
91  gint category;
92  gchar *family;
93 } nvti_t;
94 
95 nvti_t *nvti_new (void);
96 void nvti_free (nvti_t *);
97 
98 gchar *nvti_oid (const nvti_t *);
99 gchar *nvti_version (const nvti_t *);
100 gchar *nvti_name (const nvti_t *);
101 gchar *nvti_summary (const nvti_t *);
102 gchar *nvti_copyright (const nvti_t *);
103 gchar *nvti_cve (const nvti_t *);
104 gchar *nvti_bid (const nvti_t *);
105 gchar *nvti_xref (const nvti_t *);
106 gchar *nvti_tag (const nvti_t *);
107 gchar *nvti_cvss_base (const nvti_t *);
108 gchar *nvti_dependencies (const nvti_t *);
109 gchar *nvti_required_keys (const nvti_t *);
110 gchar *nvti_mandatory_keys (const nvti_t *);
111 gchar *nvti_excluded_keys (const nvti_t *);
112 gchar *nvti_required_ports (const nvti_t *);
113 gchar *nvti_required_udp_ports (const nvti_t *);
114 gint nvti_timeout (const nvti_t *);
115 gint nvti_category (const nvti_t *);
116 gchar *nvti_family (const nvti_t *);
117 guint nvti_pref_len (const nvti_t *);
118 const nvtpref_t *nvti_pref (const nvti_t *, guint);
119 
120 int nvti_set_oid (nvti_t *, const gchar *);
121 int nvti_set_version (nvti_t *, const gchar *);
122 int nvti_set_name (nvti_t *, const gchar *);
123 int nvti_set_summary (nvti_t *, const gchar *);
124 int nvti_set_copyright (nvti_t *, const gchar *);
125 int nvti_set_cve (nvti_t *, const gchar *);
126 int nvti_set_bid (nvti_t *, const gchar *);
127 int nvti_set_xref (nvti_t *, const gchar *);
128 int nvti_set_tag (nvti_t *, const gchar *);
129 int nvti_set_cvss_base (nvti_t *, const gchar *);
130 int nvti_set_dependencies (nvti_t *, const gchar *);
131 int nvti_set_required_keys (nvti_t *, const gchar *);
132 int nvti_set_mandatory_keys (nvti_t *, const gchar *);
133 int nvti_set_excluded_keys (nvti_t *, const gchar *);
134 int nvti_set_required_ports (nvti_t *, const gchar *);
135 int nvti_set_required_udp_ports (nvti_t *, const gchar *);
136 int nvti_set_timeout (nvti_t *, const gint);
137 int nvti_set_category (nvti_t *, const gint);
138 int nvti_set_family (nvti_t *, const gchar *);
139 
140 int nvti_add_cve (nvti_t *, const gchar *);
141 int nvti_add_bid (nvti_t *, const gchar *);
142 int nvti_add_required_keys (nvti_t *, const gchar *);
143 int nvti_add_mandatory_keys (nvti_t *, const gchar *);
144 int nvti_add_excluded_keys (nvti_t *, const gchar *);
145 int nvti_add_required_ports (nvti_t *, const gchar *);
146 int nvti_add_required_udp_ports (nvti_t *, const gchar *);
147 int nvti_add_pref (nvti_t *, nvtpref_t *);
148 
149 nvti_t *nvti_from_keyfile (const gchar *);
150 int nvti_to_keyfile (const nvti_t *, const char *, const char *);
151 
152 /* Collections of NVT Infos. */
153 
157 typedef GHashTable nvtis_t;
158 
159 nvtis_t *
160 nvtis_new (void);
161 
162 void
163 nvtis_free (nvtis_t *);
164 
165 void
166 nvtis_add (nvtis_t *, nvti_t *);
167 
168 nvti_t *
169 nvtis_lookup (nvtis_t *, const char *);
170 
171 #endif /* not _NVTI_H */
int nvti_set_version(nvti_t *, const gchar *)
Set the version of a NVT.
Definition: nvti.c:538
gchar * copyright
Copyright for the NVT.
Definition: nvti.h:70
nvtpref_t * nvtpref_new(gchar *, gchar *, gchar *)
Create a new nvtpref structure filled with the given values.
Definition: nvti.c:65
int nvti_set_cve(nvti_t *, const gchar *)
Set the CVE references of a NVT.
Definition: nvti.c:622
struct nvtpref nvtpref_t
The structure for a preference of a NVT.
void nvti_free(nvti_t *)
Free memory of a nvti structure.
Definition: nvti.c:164
const nvtpref_t * nvti_pref(const nvti_t *, guint)
Get the n'th preferences of the NVT.
Definition: nvti.c:475
int nvti_set_excluded_keys(nvti_t *, const gchar *)
Set the excluded keys of a NVT.
Definition: nvti.c:808
gchar * nvti_tag(const nvti_t *)
Get the tag.
Definition: nvti.c:335
gchar * required_keys
List of required KB keys of this NVT.
Definition: nvti.h:81
int nvti_add_pref(nvti_t *, nvtpref_t *)
Add a preference to the NVT Info.
Definition: nvti.c:1149
int nvti_set_required_keys(nvti_t *, const gchar *)
Set the required keys of a NVT.
Definition: nvti.c:760
nvti_t * nvtis_lookup(nvtis_t *, const char *)
Add an NVT Info to a collection of NVT Infos.
Definition: nvti.c:1470
gchar * cvss_base
CVSS base score for this NVT.
Definition: nvti.h:78
gchar * name
Name of the preference.
Definition: nvti.h:48
The structure of a information record that corresponds to a NVT.
Definition: nvti.h:64
gint timeout
Default timeout time for this NVT.
Definition: nvti.h:90
gchar * nvti_family(const nvti_t *)
Get the family name.
Definition: nvti.c:447
gchar * nvti_version(const nvti_t *)
Get the version.
Definition: nvti.c:237
gchar * version
Version of the NVT.
Definition: nvti.h:67
gchar * bid
List of Bugtraq IDs, this NVT corresponds to.
Definition: nvti.h:73
int nvti_set_tag(nvti_t *, const gchar *)
Set the tags of a NVT.
Definition: nvti.c:688
gint nvti_category(const nvti_t *)
Get the category for this NVT.
Definition: nvti.c:502
int nvti_set_oid(nvti_t *, const gchar *)
Set the OID of a NVT Info.
Definition: nvti.c:517
gchar * name
The name.
Definition: nvti.h:68
int nvti_set_category(nvti_t *, const gint)
Set the category type of a NVT Info.
Definition: nvti.c:920
gchar * oid
Object ID.
Definition: nvti.h:66
int nvti_set_name(nvti_t *, const gchar *)
Set the name of a NVT.
Definition: nvti.c:559
gchar * nvtpref_type(const nvtpref_t *)
Get the Type of a NVT Preference.
Definition: nvti.c:125
gint category
The category, this NVT belongs to.
Definition: nvti.h:91
int nvti_set_copyright(nvti_t *, const gchar *)
Set the copyright of a NVT.
Definition: nvti.c:601
int nvti_to_keyfile(const nvti_t *, const char *, const char *)
int nvti_add_excluded_keys(nvti_t *, const gchar *)
Add a excluded key of a NVT.
Definition: nvti.c:1059
void nvtis_free(nvtis_t *)
Free a collection of NVT Infos.
Definition: nvti.c:1442
gchar * nvti_mandatory_keys(const nvti_t *)
Get the mandatory keys list.
Definition: nvti.c:391
gchar * nvtpref_name(const nvtpref_t *)
Get the Name of a NVT Preference.
Definition: nvti.c:111
nvti_t * nvti_new(void)
Create a new (empty) nvti structure.
Definition: nvti.c:153
gchar * nvti_cvss_base(const nvti_t *)
Get the CVSS base.
Definition: nvti.c:349
int nvti_add_mandatory_keys(nvti_t *, const gchar *)
Add a mandatory key of a NVT.
Definition: nvti.c:1029
int nvti_set_family(nvti_t *, const gchar *)
Set the family of a NVT.
Definition: nvti.c:880
gchar * nvti_bid(const nvti_t *)
Get the bid references.
Definition: nvti.c:307
gchar * type
Preference type.
Definition: nvti.h:47
int nvti_add_cve(nvti_t *, const gchar *)
Add a single CVE ID of a NVT.
Definition: nvti.c:939
int nvti_add_required_keys(nvti_t *, const gchar *)
Add a required key of a NVT.
Definition: nvti.c:999
gchar * nvti_oid(const nvti_t *)
Get the OID string.
Definition: nvti.c:223
int nvti_add_bid(nvti_t *, const gchar *)
Add a single BID ID of a NVT.
Definition: nvti.c:969
int nvti_set_required_ports(nvti_t *, const gchar *)
Set the required ports of a NVT.
Definition: nvti.c:832
void nvtis_add(nvtis_t *, nvti_t *)
Add an NVT Info to a collection of NVT Infos.
Definition: nvti.c:1455
gchar * required_udp_ports
List of required UDP ports of this NVT.
Definition: nvti.h:85
int nvti_set_dependencies(nvti_t *, const gchar *)
Set the dependencies of a NVT.
Definition: nvti.c:736
gchar * nvtpref_default(const nvtpref_t *)
Get the Default of a NVT Preference.
Definition: nvti.c:139
gchar * cve
List of CVEs, this NVT corresponds to.
Definition: nvti.h:72
nvtis_t * nvtis_new(void)
Make a collection of NVT Infos.
Definition: nvti.c:1430
gchar * nvti_cve(const nvti_t *)
Get the CVE references.
Definition: nvti.c:293
gchar * summary
Summary about the NVT.
Definition: nvti.h:69
gchar * excluded_keys
List of excluded KB keys of this NVT.
Definition: nvti.h:83
gchar * nvti_excluded_keys(const nvti_t *)
Get the excluded keys list.
Definition: nvti.c:405
gchar * dependencies
List of dependencies of this NVT.
Definition: nvti.h:80
gchar * dflt
Default value of the preference.
Definition: nvti.h:49
gchar * nvti_name(const nvti_t *)
Get the name.
Definition: nvti.c:251
int nvti_add_required_ports(nvti_t *, const gchar *)
Add a required port of a NVT.
Definition: nvti.c:1089
guint nvti_pref_len(const nvti_t *)
Get the number of preferences of the NVT.
Definition: nvti.c:460
int nvti_set_xref(nvti_t *, const gchar *)
Set the xrefs of a NVT.
Definition: nvti.c:664
gchar * nvti_required_ports(const nvti_t *)
Get the required ports list.
Definition: nvti.c:419
gchar * required_ports
List of required ports of this NVT.
Definition: nvti.h:84
nvti_t * nvti_from_keyfile(const gchar *)
Read NVT Info from a keyfile.
Definition: nvti.c:1193
gint nvti_timeout(const nvti_t *)
Get the timeout for this NVT.
Definition: nvti.c:489
gchar * family
Family the NVT belongs to.
Definition: nvti.h:92
int nvti_set_cvss_base(nvti_t *, const gchar *)
Set the CVSS base of an NVT.
Definition: nvti.c:712
int nvti_set_bid(nvti_t *, const gchar *)
Set the bid references of a NVT.
Definition: nvti.c:643
The structure for a preference of a NVT.
Definition: nvti.h:45
gchar * nvti_dependencies(const nvti_t *)
Get the dependencies list.
Definition: nvti.c:363
gchar * mandatory_keys
List of mandatory KB keys of this NVT.
Definition: nvti.h:82
gchar * tag
List of tags attached to this NVT.
Definition: nvti.h:77
struct nvti nvti_t
The structure of a information record that corresponds to a NVT.
int nvti_set_summary(nvti_t *, const gchar *)
Set the summary of a NVT.
Definition: nvti.c:580
gchar * nvti_xref(const nvti_t *)
Get the xref's.
Definition: nvti.c:321
gchar * nvti_required_keys(const nvti_t *)
Get the required keys list.
Definition: nvti.c:377
int nvti_add_required_udp_ports(nvti_t *, const gchar *)
Add a required udp port of a NVT.
Definition: nvti.c:1119
GHashTable nvtis_t
A collection of information records corresponding to NVTs.
Definition: nvti.h:157
int nvti_set_mandatory_keys(nvti_t *, const gchar *)
Set the mandatory keys of a NVT.
Definition: nvti.c:784
gchar * nvti_copyright(const nvti_t *)
Get the copyright notice.
Definition: nvti.c:279
gchar * xref
List of Cross-references, this NVT corresponds to.
Definition: nvti.h:75
int nvti_set_required_udp_ports(nvti_t *, const gchar *)
Set the required udp ports of a NVT.
Definition: nvti.c:856
gchar * nvti_summary(const nvti_t *)
Get the summary.
Definition: nvti.c:265
gchar * nvti_required_udp_ports(const nvti_t *)
Get the required udp ports list.
Definition: nvti.c:433
int nvti_set_timeout(nvti_t *, const gint)
Set the timout of a NVT Info.
Definition: nvti.c:901
GSList * prefs
Collection of NVT preferences.
Definition: nvti.h:87
void nvtpref_free(nvtpref_t *)
Free memory of a nvtpref structure.
Definition: nvti.c:88