nvticache.h File Reference

Protos and data structures for NVT Information Cache. More...

#include "../base/nvti.h"
#include "kb.h"
#include <glib.h>

Include dependency graph for nvticache.h:

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

Go to the source code of this file.

Macros
#define	NVTICACHE_STR   "nvticache"

Functions
int	nvticache_init (const char *, const char *)
	Initializes the nvti cache.
void	nvticache_reset (void)
	Reset connection to KB. To be called after a fork().
kb_t	nvticache_get_kb (void)
	Return the nvticache kb.
void	nvticache_save (void)
	Save the nvticache to disk.
int	nvticache_initialized (void)
	Return whether the nvt cache is initialized.
int	nvticache_check (const gchar *)
	Check if the nvt for the given filename exists in cache.
int	nvticache_add (const nvti_t *, const char *)
	Add a NVT Information to the cache.
char *	nvticache_get_src (const char *)
	Get the full source filename of an OID.
char *	nvticache_get_oid (const char *)
	Get the OID from a plugin filename.
char *	nvticache_get_name (const char *)
	Get the name from a plugin OID.
char *	nvticache_get_tags (const char *)
	Get the tags from a plugin OID.
GSList *	nvticache_get_prefs (const char *)
	Get the prefs from a plugin OID.
char *	nvticache_get_cves (const char *)
	Get the cves from a plugin OID.
char *	nvticache_get_bids (const char *)
	Get the bids from a plugin OID.
char *	nvticache_get_xrefs (const char *)
	Get the xrefs from a plugin OID.
char *	nvticache_get_family (const char *)
	Get the family from a plugin OID.
char *	nvticache_get_filename (const char *)
	Get the filename from a plugin OID.
char *	nvticache_get_required_keys (const char *)
	Get the Required Keys from a plugin OID.
char *	nvticache_get_mandatory_keys (const char *)
	Get the Mandatory Keys from a plugin OID.
char *	nvticache_get_excluded_keys (const char *)
	Get the Excluded Keys from a plugin OID.
char *	nvticache_get_required_ports (const char *)
	Get the Required ports from a plugin OID.
char *	nvticache_get_required_udp_ports (const char *)
	Get the Required udp ports from a plugin OID.
int	nvticache_get_category (const char *)
	Get the Category from a plugin OID.
char *	nvticache_get_dependencies (const char *)
	Get the Dependencies from a plugin OID.
nvti_t *	nvticache_get_nvt (const char *)
	Get the nvti from a plugin OID.
GSList *	nvticache_get_oids (void)
	Get the list of nvti OIDs.
size_t	nvticache_count (void)
	Get the number of nvt's in the cache.
void	nvticache_delete (const char *)
	Delete NVT from the cache.
char *	nvticache_feed_version (void)
	Get the NVT feed version.
int	nvticache_check_feed (void)
	Check if the plugins feed was newer than cached feed.

Detailed Description

Protos and data structures for NVT Information Cache.

This file contains the protos for nvticache.c

Definition in file nvticache.h.

Macro Definition Documentation

NVTICACHE_STR

#define NVTICACHE_STR   "nvticache"

Definition at line 22 of file nvticache.h.

Referenced by nvticache_check_feed(), nvticache_feed_version(), nvticache_init(), and nvticache_save().

Function Documentation

nvticache_add()

int nvticache_add	(	const nvti_t *	nvti,
		const char *	filename )

Add a NVT Information to the cache.

Parameters

nvti	The NVT Information to add
filename	The name of the original NVT without the path to the base location of NVTs (e.g. "scriptname1.nasl" or even "subdir1/subdir2/scriptname2.nasl" )

Returns

0 in case of success, anything else indicates an error.

Definition at line 207 of file nvticache.c.

{
  char *oid, *dummy;
 
  assert (cache_kb);
  /* Check for duplicate OID. */
  oid = nvti_oid (nvti);
  dummy = nvticache_get_filename (oid);
  if (dummy && strcmp (filename, dummy))
    {
      struct stat src_stat;
      char *src_file = g_build_filename (src_path, dummy, NULL);
 
      /* If .nasl file was duplicated, not moved. */
      if (src_file && stat (src_file, &src_stat) >= 0)
        g_warning ("NVT %s with duplicate OID %s will be replaced with %s",
                   src_file, oid, filename);
      g_free (src_file);
    }
  if (dummy)
    nvticache_delete (oid);
 
  g_free (dummy);
 
  if (kb_nvt_add (cache_kb, nvti, filename))
    goto kb_fail;
  cache_saved = 0;
 
  return 0;
kb_fail:
  return -1;
}

References cache_kb, cache_saved, kb_nvt_add(), nvti_oid(), nvticache_delete(), nvticache_get_filename(), and src_path.

Here is the call graph for this function:

nvticache_check()

int nvticache_check

(

const gchar *

filename

)

Check if the nvt for the given filename exists in cache.

Parameters

filename

The name of the original NVT without the path to the base location of NVTs (e.g. "scriptname1.nasl" or even "subdir1/subdir2/scriptname2.nasl" )

Returns

1 if nvt is in cache and up to date, 0 otherwise.

Definition at line 101 of file nvticache.c.

{
  assert (cache_kb);
  char *src_file, *time_s;
  struct stat src_stat;
  int ret = 0;
 
  src_file = g_build_filename (src_path, filename, NULL);
  time_s = kb_nvt_get (cache_kb, filename, NVT_TIMESTAMP_POS);
  if (time_s && src_file && stat (src_file, &src_stat) >= 0
      && atoi (time_s) > src_stat.st_mtime)
    ret = 1;
  g_free (time_s);
  g_free (src_file);
  return ret;
}

References cache_kb, kb_nvt_get(), NVT_TIMESTAMP_POS, and src_path.

Here is the call graph for this function:

nvticache_check_feed()

int nvticache_check_feed

(

void

)

Check if the plugins feed was newer than cached feed.

Returns

1 if new feed, 0 if matching feeds or error.

Definition at line 599 of file nvticache.c.

{
  char *cached, *current;
  int ret;
 
  if (!(current = nvt_feed_version ()))
    return 0;
  cached = kb_item_get_str (cache_kb, NVTICACHE_STR);
  ret = strcmp (cached, current);
  g_free (cached);
  g_free (current);
  return ret;
}

References cache_kb, kb_item_get_str(), nvt_feed_version(), and NVTICACHE_STR.

Here is the call graph for this function:

nvticache_count()

size_t nvticache_count

(

void

)

Get the number of nvt's in the cache.

Returns

Number of nvt's.

Definition at line 547 of file nvticache.c.

{
  assert (cache_kb);
 
  return kb_item_count (cache_kb, "nvt:*");
}

References cache_kb, and kb_item_count().

Here is the call graph for this function:

nvticache_delete()

void nvticache_delete

(

const char *

oid

)

Delete NVT from the cache.

Parameters

[in]

oid

OID to match.

Definition at line 560 of file nvticache.c.

{
  char pattern[4096];
  char *filename;
 
  assert (cache_kb);
  assert (oid);
 
  filename = nvticache_get_filename (oid);
  g_snprintf (pattern, sizeof (pattern), "oid:%s:prefs", oid);
  kb_del_items (cache_kb, pattern);
  g_snprintf (pattern, sizeof (pattern), "nvt:%s", oid);
  kb_del_items (cache_kb, pattern);
 
  if (filename)
    {
      g_snprintf (pattern, sizeof (pattern), "filename:%s", filename);
      kb_del_items (cache_kb, pattern);
    }
  g_free (filename);
}

References cache_kb, kb_del_items(), and nvticache_get_filename().

Referenced by nvticache_add().

Here is the call graph for this function:

Here is the caller graph for this function:

nvticache_feed_version()

char * nvticache_feed_version

(

void

)

Get the NVT feed version.

Returns

Feed version.

Definition at line 588 of file nvticache.c.

{
  return kb_item_get_str (cache_kb, NVTICACHE_STR);
}

References cache_kb, kb_item_get_str(), and NVTICACHE_STR.

Referenced by nvticache_save().

Here is the call graph for this function:

Here is the caller graph for this function:

nvticache_get_bids()

char * nvticache_get_bids

(

const char *

oid

)

Get the bids from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

BIDs matching OID, NULL otherwise.

Definition at line 431 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_BIDS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_BIDS_POS.

Here is the call graph for this function:

nvticache_get_category()

int nvticache_get_category

(

const char *

oid

)

Get the Category from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Category matching OID, -1 otherwise.

Definition at line 383 of file nvticache.c.

{
  int category;
  char *category_s;
 
  assert (cache_kb);
  category_s = kb_nvt_get (cache_kb, oid, NVT_CATEGORY_POS);
  category = atoi (category_s);
  g_free (category_s);
  return category;
}

References cache_kb, kb_nvt_get(), and NVT_CATEGORY_POS.

Here is the call graph for this function:

nvticache_get_cves()

char * nvticache_get_cves

(

const char *

oid

)

Get the cves from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

CVEs matching OID, NULL otherwise.

Definition at line 417 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_CVES_POS);
}

References cache_kb, kb_nvt_get(), and NVT_CVES_POS.

Here is the call graph for this function:

nvticache_get_dependencies()

char * nvticache_get_dependencies

(

const char *

oid

)

Get the Dependencies from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Dependencies matching OID, NULL otherwise.

Definition at line 369 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_DEPENDENCIES_POS);
}

References cache_kb, kb_nvt_get(), and NVT_DEPENDENCIES_POS.

Here is the call graph for this function:

nvticache_get_excluded_keys()

char * nvticache_get_excluded_keys

(

const char *

oid

)

Get the Excluded Keys from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Excluded Keys matching OID, NULL otherwise.

Definition at line 327 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_EXCLUDED_KEYS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_EXCLUDED_KEYS_POS.

Here is the call graph for this function:

nvticache_get_family()

char * nvticache_get_family

(

const char *

oid

)

Get the family from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Family matching OID, NULL otherwise.

Definition at line 459 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_FAMILY_POS);
}

References cache_kb, kb_nvt_get(), and NVT_FAMILY_POS.

Here is the call graph for this function:

nvticache_get_filename()

char * nvticache_get_filename

(

const char *

oid

)

Get the filename from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Filanem matching OID, NULL otherwise.

Definition at line 285 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_FILENAME_POS);
}

References cache_kb, kb_nvt_get(), and NVT_FILENAME_POS.

Referenced by nvticache_add(), and nvticache_delete().

Here is the call graph for this function:

Here is the caller graph for this function:

nvticache_get_kb()

kb_t nvticache_get_kb

(

void

)

Return the nvticache kb.

Returns

Cache kb.

Definition at line 84 of file nvticache.c.

{
  assert (cache_kb);
  return cache_kb;
}

References cache_kb.

nvticache_get_mandatory_keys()

char * nvticache_get_mandatory_keys

(

const char *

oid

)

Get the Mandatory Keys from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Mandatory Keys matching OID, NULL otherwise.

Definition at line 313 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_MANDATORY_KEYS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_MANDATORY_KEYS_POS.

Here is the call graph for this function:

nvticache_get_name()

char * nvticache_get_name

(

const char *

oid

)

Get the name from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Name matching OID, NULL otherwise.

Definition at line 403 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_NAME_POS);
}

References cache_kb, kb_nvt_get(), and NVT_NAME_POS.

Here is the call graph for this function:

nvticache_get_nvt()

nvti_t * nvticache_get_nvt

(

const char *

oid

)

Get the nvti from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Full nvti matching OID, NULL otherwise.

Definition at line 487 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get_all (cache_kb, oid);
}

References cache_kb, and kb_nvt_get_all().

Here is the call graph for this function:

nvticache_get_oid()

char * nvticache_get_oid

(

const char *

filename

)

Get the OID from a plugin filename.

Parameters

filename

Filename to lookup.

Returns

OID matching filename if found, NULL otherwise.

Definition at line 270 of file nvticache.c.

{
  assert (cache_kb);
 
  return kb_nvt_get (cache_kb, filename, NVT_OID_POS);
}

References cache_kb, kb_nvt_get(), and NVT_OID_POS.

Here is the call graph for this function:

nvticache_get_oids()

GSList * nvticache_get_oids

(

void

)

Get the list of nvti OIDs.

Returns

OIDs list.

Definition at line 534 of file nvticache.c.

{
  assert (cache_kb);
 
  return kb_nvt_get_oids (cache_kb);
}

References cache_kb, and kb_nvt_get_oids().

Here is the call graph for this function:

nvticache_get_prefs()

GSList * nvticache_get_prefs

(

const char *

oid

)

Get the prefs from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Prefs matching OID, NULL otherwise.

Definition at line 501 of file nvticache.c.

{
  char pattern[4096];
  struct kb_item *prefs, *element;
  GSList *list = NULL;
 
  assert (cache_kb);
 
  g_snprintf (pattern, sizeof (pattern), "oid:%s:prefs", oid);
  prefs = element = kb_item_get_all (cache_kb, pattern);
  while (element)
    {
      nvtpref_t *np;
      char **array = g_strsplit (element->v_str, "|||", -1);
 
      assert (array[3]);
      assert (!array[4]);
      np = nvtpref_new (atoi (array[0]), array[1], array[2], array[3]);
      g_strfreev (array);
      list = g_slist_append (list, np);
      element = element->next;
    }
  kb_item_free (prefs);
 
  return list;
}

References cache_kb, kb_item_free(), kb_item_get_all(), kb_item::next, nvtpref_new(), and kb_item::v_str.

Here is the call graph for this function:

nvticache_get_required_keys()

char * nvticache_get_required_keys

(

const char *

oid

)

Get the Required Keys from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Required Keys matching OID, NULL otherwise.

Definition at line 299 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_REQUIRED_KEYS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_REQUIRED_KEYS_POS.

Here is the call graph for this function:

nvticache_get_required_ports()

char * nvticache_get_required_ports

(

const char *

oid

)

Get the Required ports from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Required ports matching OID, NULL otherwise.

Definition at line 355 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_REQUIRED_PORTS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_REQUIRED_PORTS_POS.

Here is the call graph for this function:

nvticache_get_required_udp_ports()

char * nvticache_get_required_udp_ports

(

const char *

oid

)

Get the Required udp ports from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Required udp ports matching OID, NULL otherwise.

Definition at line 341 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_REQUIRED_UDP_PORTS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_REQUIRED_UDP_PORTS_POS.

Here is the call graph for this function:

nvticache_get_src()

char * nvticache_get_src

(

const char *

oid

)

Get the full source filename of an OID.

Parameters

oid	The OID to look up.

Returns

Filename with full path matching OID if found, NULL otherwise.

Definition at line 248 of file nvticache.c.

{
  char *filename, *src;
 
  assert (cache_kb);
 
  filename = kb_nvt_get (cache_kb, oid, NVT_FILENAME_POS);
  if (!filename)
    return NULL;
  src = g_build_filename (src_path, filename, NULL);
  g_free (filename);
  return src;
}

References cache_kb, kb_nvt_get(), NVT_FILENAME_POS, and src_path.

Here is the call graph for this function:

nvticache_get_tags()

char * nvticache_get_tags

(

const char *

oid

)

Get the tags from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

Tags matching OID, NULL otherwise.

Definition at line 473 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_TAGS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_TAGS_POS.

Here is the call graph for this function:

nvticache_get_xrefs()

char * nvticache_get_xrefs

(

const char *

oid

)

Get the xrefs from a plugin OID.

Parameters

[in]

oid

OID to match.

Returns

XREFs matching OID, NULL otherwise.

Definition at line 445 of file nvticache.c.

{
  assert (cache_kb);
  return kb_nvt_get (cache_kb, oid, NVT_XREFS_POS);
}

References cache_kb, kb_nvt_get(), and NVT_XREFS_POS.

Here is the call graph for this function:

nvticache_init()

int nvticache_init	(	const char *	src,
		const char *	kb_path )

Initializes the nvti cache.

Parameters

src	The directory that contains the nvt files.
kb_path	Path to kb socket.

Returns

0 in case of success, anything else indicates an error.

Definition at line 59 of file nvticache.c.

{
  assert (src);
 
  if (src_path)
    g_free (src_path);
  src_path = g_strdup (src);
  if (cache_kb)
    kb_lnk_reset (cache_kb);
  cache_kb = kb_find (kb_path, NVTICACHE_STR);
  if (cache_kb)
    return 0;
 
  if (kb_new (&cache_kb, kb_path)
      || kb_item_set_str (cache_kb, NVTICACHE_STR, "0", 0))
    return -1;
  return 0;
}

References cache_kb, kb_find(), kb_item_set_str(), kb_lnk_reset(), kb_new(), NVTICACHE_STR, and src_path.

Here is the call graph for this function:

nvticache_initialized()

int nvticache_initialized

(

void

)

Return whether the nvt cache is initialized.

Returns

1 if cache is initialized, 0 otherwise.

Definition at line 45 of file nvticache.c.

{
  return !!cache_kb;
}

References cache_kb.

nvticache_reset()

void nvticache_reset

(

void

)

Reset connection to KB. To be called after a fork().

Definition at line 122 of file nvticache.c.

{
  if (cache_kb)
    kb_lnk_reset (cache_kb);
}

References cache_kb, and kb_lnk_reset().

Here is the call graph for this function:

nvticache_save()

void nvticache_save

(

void

)

Save the nvticache to disk.

Definition at line 178 of file nvticache.c.

{
  char *feed_version, *old_version;
 
  old_version = nvticache_feed_version ();
  feed_version = nvt_feed_version ();
  if (feed_version && g_strcmp0 (old_version, feed_version))
    {
      kb_item_set_str (cache_kb, NVTICACHE_STR, feed_version, 0);
      g_message ("Updated NVT cache from version %s to %s", old_version,
                 feed_version);
    }
  g_free (old_version);
  g_free (feed_version);
}

References cache_kb, kb_item_set_str(), nvt_feed_version(), nvticache_feed_version(), and NVTICACHE_STR.

Here is the call graph for this function: