vtparser.h File Reference

Simple JSON reader. More...

#include "../base/cvss.h"
#include "../base/nvti.h"
#include "../util/jsonpull.h"
#include <cjson/cJSON.h>
#include <glib.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

Include dependency graph for vtparser.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	_GNU_SOURCE   /* See feature_test_macros(7) */
#define	_FILE_OFFSET_BITS   64

Enumerations
enum	nvt_category {   ACT_INIT = 0 , ACT_SCANNER , ACT_SETTINGS , ACT_GATHER_INFO ,   ACT_ATTACK , ACT_MIXED_ATTACK , ACT_DESTRUCTIVE_ATTACK , ACT_DENIAL ,   ACT_KILL_HOST , ACT_FLOOD , ACT_END }
	VT categories. More...

Functions
int	parse_vt_json (gvm_json_pull_parser_t *, gvm_json_pull_event_t *, nvti_t **)
	Parse a VT element given in json format.

Detailed Description

Simple JSON reader.

Definition in file vtparser.h.

Macro Definition Documentation

_FILE_OFFSET_BITS

#define _FILE_OFFSET_BITS   64

Definition at line 15 of file vtparser.h.

_GNU_SOURCE

#define _GNU_SOURCE   /* See feature_test_macros(7) */

Definition at line 14 of file vtparser.h.

Enumeration Type Documentation

nvt_category

enum nvt_category

VT categories.

Enumerator
ACT_INIT
ACT_SCANNER
ACT_SETTINGS
ACT_GATHER_INFO
ACT_ATTACK
ACT_MIXED_ATTACK
ACT_DESTRUCTIVE_ATTACK
ACT_DENIAL
ACT_KILL_HOST
ACT_FLOOD
ACT_END

Definition at line 29 of file vtparser.h.

{
  ACT_INIT = 0,
  ACT_SCANNER,
  ACT_SETTINGS,
  ACT_GATHER_INFO,
  ACT_ATTACK,
  ACT_MIXED_ATTACK,
  ACT_DESTRUCTIVE_ATTACK,
  ACT_DENIAL,
  ACT_KILL_HOST,
  ACT_FLOOD,
  ACT_END,
} nvt_category;

Function Documentation

parse_vt_json()

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.

Parameters

[in]	parser	Json pull parser.
[in]	event	Json pull event.
[out]	nvt	The NVT Info structure to fill with the parsed data.

Returns

0 on success, 1 on end of feed, -1 on error. In case of success the nvti struct must be freed with nvti_free() by the caller.

Definition at line 239 of file vtparser.c.

{
  cJSON *vt_obj = NULL;
  gchar *str, *error_message = NULL;
  *nvt = NULL;
 
  gvm_json_pull_parser_next (parser, event);
 
  // Handle start/end of json array
  gchar *path = gvm_json_path_to_string (event->path);
  if (!g_strcmp0 (path, "$") && event->type == GVM_JSON_PULL_EVENT_ARRAY_START)
    {
      gvm_json_pull_parser_next (parser, event);
      g_debug ("%s: Start parsing feed", __func__);
    }
  else if (!g_strcmp0 (path, "$")
           && (event->type == GVM_JSON_PULL_EVENT_ARRAY_END
               || event->type == GVM_JSON_PULL_EVENT_EOF))
    {
      g_debug ("%s: Finish parsing feed", __func__);
      g_free (path);
      return 1;
    }
  g_free (path);
 
  // It is an NVT object
  if (event->type != GVM_JSON_PULL_EVENT_OBJECT_START)
    {
      g_warning ("%s: Error reading VT object", __func__);
      return -1;
    }
 
  vt_obj = gvm_json_pull_expand_container (parser, &error_message);
  if (!cJSON_IsObject (vt_obj))
    {
      g_free (error_message);
      cJSON_Delete (vt_obj);
      return -1;
    }
  g_free (error_message);
 
  *nvt = nvti_new ();
 
  if (gvm_json_obj_check_str (vt_obj, "oid", &str))
    {
      g_warning ("%s: VT missing OID", __func__);
      cJSON_Delete (vt_obj);
      nvti_free (*nvt);
      return -1;
    }
  nvti_set_oid (*nvt, str);
 
  if (gvm_json_obj_check_str (vt_obj, "name", &str))
    {
      g_warning ("%s: VT missing NAME", __func__);
      cJSON_Delete (vt_obj);
      nvti_free (*nvt);
      return -1;
    }
  nvti_set_name (*nvt, str);
 
  if (gvm_json_obj_check_str (vt_obj, "family", &str))
    {
      g_warning ("%s: VT missing FAMILY", __func__);
      cJSON_Delete (vt_obj);
      nvti_free (*nvt);
      return -1;
    }
  nvti_set_family (*nvt, str);
 
  if (gvm_json_obj_check_str (vt_obj, "category", &str))
    {
      g_warning ("%s: VT missing CATEGORY", __func__);
      cJSON_Delete (vt_obj);
      nvti_free (*nvt);
      return -1;
    }
  nvti_set_category (*nvt, get_category_from_name (str));
 
  cJSON *tag_obj = cJSON_GetObjectItem (vt_obj, "tag");
 
  if (tag_obj)
    {
      if (add_tags_to_nvt (*nvt, tag_obj))
        {
          g_warning ("%s: Error adding tags", __func__);
          cJSON_Delete (vt_obj);
          nvti_free (*nvt);
          return -1;
        }
    }
 
  parse_references (*nvt, vt_obj);
  add_preferences_to_nvt (*nvt, vt_obj);
  cJSON_Delete (vt_obj);
 
  return 0;
}

References add_preferences_to_nvt(), add_tags_to_nvt(), get_category_from_name(), gvm_json_obj_check_str(), gvm_json_path_to_string(), GVM_JSON_PULL_EVENT_ARRAY_END, GVM_JSON_PULL_EVENT_ARRAY_START, GVM_JSON_PULL_EVENT_EOF, GVM_JSON_PULL_EVENT_OBJECT_START, gvm_json_pull_expand_container(), gvm_json_pull_parser_next(), nvti_free(), nvti_new(), nvti_set_category(), nvti_set_family(), nvti_set_name(), nvti_set_oid(), parse_references(), gvm_json_pull_event_t::path, and gvm_json_pull_event_t::type.

Referenced by Ensure().

Here is the call graph for this function:

Here is the caller graph for this function: