Greenbone Vulnerability Management Libraries 22.22.0
vtparser.c
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Greenbone AG
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later
4 */
5
10
11#include "vtparser.h"
12
13#undef G_LOG_DOMAIN
17#define G_LOG_DOMAIN "libgvm util"
18
26static int
27get_category_from_name (const gchar *cat)
28{
29 if (!g_strcmp0 (cat, "init"))
30 return ACT_INIT;
31 else if (!g_strcmp0 (cat, "scanner"))
32 return ACT_SCANNER;
33 else if (!g_strcmp0 (cat, "settings"))
34 return ACT_SETTINGS;
35 else if (!g_strcmp0 (cat, "gather_info"))
36 return ACT_GATHER_INFO;
37 else if (!g_strcmp0 (cat, "attack"))
38 return ACT_ATTACK;
39 else if (!g_strcmp0 (cat, "mixed_attack"))
40 return ACT_MIXED_ATTACK;
41 else if (!g_strcmp0 (cat, "destructive_attack"))
43 else if (!g_strcmp0 (cat, "denial"))
44 return ACT_DENIAL;
45 else if (!g_strcmp0 (cat, "kill_host"))
46 return ACT_KILL_HOST;
47 else if (!g_strcmp0 (cat, "flood"))
48 return ACT_FLOOD;
49 else if (!g_strcmp0 (cat, "end"))
50 return ACT_END;
51
52 return -1;
53}
54
55static void
56add_tags_to_nvt (nvti_t *nvt, cJSON *tag_obj)
57{
58 if (cJSON_IsObject (tag_obj))
59 {
60 gchar *severity_vector, *str;
61
62 if (!gvm_json_obj_check_str (tag_obj, "affected", &str))
63 nvti_set_affected (nvt, str);
64
66 gvm_json_obj_double (tag_obj, "creation_date"));
67
69 nvt, gvm_json_obj_double (tag_obj, "last_modification"));
70
71 if (!gvm_json_obj_check_str (tag_obj, "insight", &str))
72 nvti_set_insight (nvt, str);
73
74 if (!gvm_json_obj_check_str (tag_obj, "impact", &str))
75 nvti_set_impact (nvt, str);
76
77 if (!gvm_json_obj_check_str (tag_obj, "qod", &str))
78 nvti_set_qod (nvt, str);
79
80 if (!gvm_json_obj_check_str (tag_obj, "qod_type", &str))
81 nvti_set_qod_type (nvt, str);
82
83 if (!gvm_json_obj_check_str (tag_obj, "solution", &str))
84 {
85 nvti_set_solution (nvt, str);
86
87 if (gvm_json_obj_check_str (tag_obj, "solution_type", &str))
88 g_debug ("%s: SOLUTION: missing type for OID: %s", __func__,
89 nvti_oid (nvt));
90 else
91 nvti_set_solution_type (nvt, str);
92
93 if (!gvm_json_obj_check_str (tag_obj, "solution_method", &str))
94 nvti_set_solution_method (nvt, str);
95 }
96
97 if (!gvm_json_obj_check_str (tag_obj, "summary", &str))
98 nvti_set_summary (nvt, str);
99
100 if (!gvm_json_obj_check_str (tag_obj, "vuldetect", &str))
101 nvti_set_detection (nvt, str);
102
103 // Parse severity
104
105 severity_vector = gvm_json_obj_str (tag_obj, "severity_vector");
106 if (!severity_vector)
107 severity_vector = gvm_json_obj_str (tag_obj, "cvss_base_vector");
108
109 if (severity_vector)
110 {
111 gchar *severity_type, *cvss_base;
112 double cvss_base_dbl;
113
114 if (g_strrstr (severity_vector, "CVSS:3"))
115 severity_type = g_strdup ("cvss_base_v3");
116 else
117 severity_type = g_strdup ("cvss_base_v2");
118
119 cvss_base_dbl = get_cvss_score_from_base_metrics (severity_vector);
120
122 nvt, vtseverity_new (severity_type,
123 gvm_json_obj_str (tag_obj, "severity_origin"),
124 gvm_json_obj_double (tag_obj, "severity_date"),
125 cvss_base_dbl, severity_vector));
126
127 nvti_add_tag (nvt, "cvss_base_vector", severity_vector);
128
129 cvss_base = g_strdup_printf (
130 "%.1f", get_cvss_score_from_base_metrics (severity_vector));
131 nvti_set_cvss_base (nvt, cvss_base);
132
133 g_free (cvss_base);
134 g_free (severity_type);
135 // end parsing severity
136 }
137 else
138 {
139 g_warning ("%s: SEVERITY missing value element", __func__);
140 nvti_free (nvt);
141 nvt = NULL;
142 }
143 } // end tag
144}
145
146static void
147parse_references (nvti_t *nvt, cJSON *vt_obj)
148{
149 cJSON *item;
150
151 item = cJSON_GetObjectItem (vt_obj, "references");
152 if (item != NULL && cJSON_IsArray (item))
153 {
154 cJSON *ref_obj;
155 cJSON_ArrayForEach (ref_obj, item)
156 {
157 gchar *id, *class;
158
159 if (!cJSON_IsObject (ref_obj))
160 g_debug ("%s: Error reading VT/REFS reference object", __func__);
161
162 else if (gvm_json_obj_check_str (ref_obj, "class", &class))
163 g_warning ("%s: REF missing class attribute", __func__);
164
165 else if (gvm_json_obj_check_str (ref_obj, "id", &id))
166 g_warning ("%s: REF missing ID attribute", __func__);
167
168 else
169 nvti_add_vtref (nvt, vtref_new (class, id, NULL));
170 }
171 } // end references
172}
173
174static void
175add_preferences_to_nvt (nvti_t *nvt, cJSON *vt_obj)
176{
177 cJSON *item;
178
179 item = cJSON_GetObjectItem (vt_obj, "preferences");
180 if (item != NULL)
181 {
182 if (!cJSON_IsArray (item))
183 g_debug ("%s: Error reading VT/REFS array", __func__);
184 else
185 {
186 cJSON *prefs_obj = NULL;
187
188 cJSON_ArrayForEach (prefs_obj, item)
189 {
190 gchar *class, *name, *default_val;
191 int id;
192
193 if (!cJSON_IsObject (prefs_obj))
194 g_debug ("%s: Error reading VT/PREFS preference object",
195 __func__);
196
197 else if (gvm_json_obj_check_str (prefs_obj, "class", &class))
198 g_warning ("%s: PREF missing class attribute", __func__);
199
200 else if (gvm_json_obj_check_int (prefs_obj, "id", &id))
201 g_warning ("%s: PREF missing id attribute", __func__);
202
203 else if (gvm_json_obj_check_str (prefs_obj, "name", &name))
204 g_warning ("%s: PREF missing name attribute", __func__);
205
206 else if (gvm_json_obj_check_str (prefs_obj, "default",
207 &default_val))
208 g_warning ("%s: PREF missing default attribute", __func__);
209
210 else
211 nvti_add_pref (nvt, nvtpref_new (id, name, class, default_val));
212 } // end each prefs
213 } // end prefs array
214 } // end preferences
215}
216
228int
230 nvti_t **nvt)
231{
232 cJSON *vt_obj = NULL;
233 gchar *str, *error_message = NULL;
234 *nvt = NULL;
235
236 gvm_json_pull_parser_next (parser, event);
237
238 // Handle start/end of json array
239 gchar *path = gvm_json_path_to_string (event->path);
240 if (!g_strcmp0 (path, "$") && event->type == GVM_JSON_PULL_EVENT_ARRAY_START)
241 {
242 gvm_json_pull_parser_next (parser, event);
243 g_debug ("%s: Start parsing feed", __func__);
244 }
245 else if (!g_strcmp0 (path, "$")
247 || event->type == GVM_JSON_PULL_EVENT_EOF))
248 {
249 g_debug ("%s: Finish parsing feed", __func__);
250 g_free (path);
251 return 1;
252 }
253 g_free (path);
254
255 // It is an NVT object
257 {
258 g_warning ("%s: Error reading VT object", __func__);
259 return -1;
260 }
261
262 vt_obj = gvm_json_pull_expand_container (parser, &error_message);
263 if (!cJSON_IsObject (vt_obj))
264 {
265 g_free (error_message);
266 cJSON_Delete (vt_obj);
267 return -1;
268 }
269 g_free (error_message);
270
271 *nvt = nvti_new ();
272
273 if (gvm_json_obj_check_str (vt_obj, "oid", &str))
274 {
275 g_warning ("%s: VT missing OID", __func__);
276 cJSON_Delete (vt_obj);
277 nvti_free (*nvt);
278 return -1;
279 }
280 nvti_set_oid (*nvt, str);
281
282 if (gvm_json_obj_check_str (vt_obj, "name", &str))
283 {
284 g_warning ("%s: VT missing NAME", __func__);
285 cJSON_Delete (vt_obj);
286 nvti_free (*nvt);
287 return -1;
288 }
289 nvti_set_name (*nvt, str);
290
291 if (gvm_json_obj_check_str (vt_obj, "family", &str))
292 {
293 g_warning ("%s: VT missing FAMILY", __func__);
294 cJSON_Delete (vt_obj);
295 nvti_free (*nvt);
296 return -1;
297 }
298 nvti_set_family (*nvt, str);
299
300 if (gvm_json_obj_check_str (vt_obj, "category", &str))
301 {
302 g_warning ("%s: VT missing CATEGORY", __func__);
303 cJSON_Delete (vt_obj);
304 nvti_free (*nvt);
305 return -1;
306 }
308
309 cJSON *tag_obj = cJSON_GetObjectItem (vt_obj, "tag");
310 if (tag_obj)
311 add_tags_to_nvt (*nvt, tag_obj);
312
313 parse_references (*nvt, vt_obj);
314 add_preferences_to_nvt (*nvt, vt_obj);
315 cJSON_Delete (vt_obj);
316
317 return 0;
318}
double get_cvss_score_from_base_metrics(const char *cvss_str)
Calculate CVSS Score.
Definition cvss.c:585
double gvm_json_obj_double(cJSON *obj, const gchar *key)
Get a double field from a JSON object.
Definition json.c:75
int gvm_json_obj_check_int(cJSON *obj, const gchar *key, int *val)
Get an int field from a JSON object.
Definition json.c:97
gchar * gvm_json_obj_str(cJSON *obj, const gchar *key)
Get a string field from a JSON object.
Definition json.c:165
int gvm_json_obj_check_str(cJSON *obj, const gchar *key, gchar **val)
Get a string field from a JSON object.
Definition json.c:142
void gvm_json_pull_parser_next(gvm_json_pull_parser_t *parser, gvm_json_pull_event_t *event)
Get the next event from a JSON pull parser.
Definition jsonpull.c:669
gchar * gvm_json_path_to_string(GQueue *path)
Converts a path as used by a JSON pull parser to a JSONPath string.
Definition jsonpull.c:902
cJSON * gvm_json_pull_expand_container(gvm_json_pull_parser_t *parser, gchar **error_message)
Expands the current array or object of a JSON pull parser.
Definition jsonpull.c:744
@ GVM_JSON_PULL_EVENT_OBJECT_START
Definition jsonpull.h:45
@ GVM_JSON_PULL_EVENT_EOF
Definition jsonpull.h:51
@ GVM_JSON_PULL_EVENT_ARRAY_END
Definition jsonpull.h:44
@ GVM_JSON_PULL_EVENT_ARRAY_START
Definition jsonpull.h:43
nvti_t * nvti_new(void)
Create a new (empty) nvti structure.
Definition nvti.c:559
int nvti_set_qod(nvti_t *n, const gchar *qod)
Set the QoD of a NVT.
Definition nvti.c:1880
int nvti_set_solution(nvti_t *n, const gchar *solution)
Set the solution of a NVT.
Definition nvti.c:1472
int nvti_set_solution_type(nvti_t *n, const gchar *solution_type)
Set the solution type of a NVT.
Definition nvti.c:1513
struct nvti nvti_t
The structure of a information record that corresponds to a NVT.
int nvti_set_qod_type(nvti_t *n, const gchar *qod_type)
Set the QoD type of a NVT.
Definition nvti.c:1856
int nvti_set_oid(nvti_t *n, const gchar *oid)
Set the OID of a NVT Info.
Definition nvti.c:1214
int nvti_set_cvss_base(nvti_t *n, const gchar *cvss_base)
Set the CVSS base of an NVT.
Definition nvti.c:1648
int nvti_set_impact(nvti_t *n, const gchar *impact)
Set the impact text of a NVT.
Definition nvti.c:1394
int nvti_set_summary(nvti_t *n, const gchar *summary)
Set the summary of a NVT.
Definition nvti.c:1274
gchar * nvti_oid(const nvti_t *n)
Get the OID string.
Definition nvti.c:611
nvtpref_t * nvtpref_new(int id, const gchar *name, const gchar *type, const gchar *dflt)
Create a new nvtpref structure filled with the given values.
Definition nvti.c:463
int nvti_add_pref(nvti_t *n, nvtpref_t *np)
Add a preference to the NVT Info.
Definition nvti.c:2180
int nvti_set_insight(nvti_t *n, const gchar *insight)
Set the insight text of a NVT.
Definition nvti.c:1314
vtref_t * vtref_new(const gchar *type, const gchar *ref_id, const gchar *ref_text)
Create a new vtref structure filled with the given values.
Definition nvti.c:77
int nvti_add_vtseverity(nvti_t *vt, vtseverity_t *s)
Add a severity to the VT Info.
Definition nvti.c:426
int nvti_set_solution_method(nvti_t *n, const gchar *solution_method)
Set the solution method of a NVT.
Definition nvti.c:1534
int nvti_set_name(nvti_t *n, const gchar *name)
Set the name of a NVT.
Definition nvti.c:1234
vtseverity_t * vtseverity_new(const gchar *type, const gchar *origin, int date, double score, const gchar *value)
Create a new vtseverity structure filled with the given values.
Definition nvti.c:180
int nvti_set_modification_time(nvti_t *n, const time_t modification_time)
Set the modification time of a NVT.
Definition nvti.c:1453
int nvti_set_creation_time(nvti_t *n, const time_t creation_time)
Set the creation time of a NVT.
Definition nvti.c:1434
int nvti_set_family(nvti_t *n, const gchar *family)
Set the family of a NVT.
Definition nvti.c:1903
int nvti_set_affected(nvti_t *n, const gchar *affected)
Set the affected text of a NVT.
Definition nvti.c:1354
int nvti_add_tag(nvti_t *n, const gchar *name, const gchar *value)
Add a tag to the NVT tags. The tag names "severity_date", "last_modification" and "creation_date" are...
Definition nvti.c:1561
int nvti_set_detection(nvti_t *n, const gchar *detection)
Set the detection text of a NVT.
Definition nvti.c:1815
int nvti_set_category(nvti_t *n, const gint category)
Set the category type of a NVT Info.
Definition nvti.c:1943
void nvti_free(nvti_t *n)
Free memory of a nvti structure.
Definition nvti.c:570
int nvti_add_vtref(nvti_t *vt, vtref_t *ref)
Add a reference to the VT Info.
Definition nvti.c:408
Event generated by the JSON pull parser.
Definition jsonpull.h:59
GQueue * path
Path to the event value.
Definition jsonpull.h:61
gvm_json_pull_event_type_t type
Type of event.
Definition jsonpull.h:60
A json pull parser.
Definition jsonpull.h:86
int parse_vt_json(gvm_json_pull_parser_t *parser, gvm_json_pull_event_t *event, nvti_t **nvt)
Parse a VT element given in json format.
Definition vtparser.c:229
static void add_preferences_to_nvt(nvti_t *nvt, cJSON *vt_obj)
Definition vtparser.c:175
static int get_category_from_name(const gchar *cat)
Get the VT category type given the category as string.
Definition vtparser.c:27
static void parse_references(nvti_t *nvt, cJSON *vt_obj)
Definition vtparser.c:147
static void add_tags_to_nvt(nvti_t *nvt, cJSON *tag_obj)
Definition vtparser.c:56
Simple JSON reader.
@ ACT_KILL_HOST
Definition vtparser.h:39
@ ACT_DESTRUCTIVE_ATTACK
Definition vtparser.h:37
@ ACT_SCANNER
Definition vtparser.h:32
@ ACT_END
Definition vtparser.h:41
@ ACT_FLOOD
Definition vtparser.h:40
@ ACT_GATHER_INFO
Definition vtparser.h:34
@ ACT_DENIAL
Definition vtparser.h:38
@ ACT_ATTACK
Definition vtparser.h:35
@ ACT_SETTINGS
Definition vtparser.h:33
@ ACT_MIXED_ATTACK
Definition vtparser.h:36
@ ACT_INIT
Definition vtparser.h:31