plugutils.c File Reference

Plugin-specific stuff. More...

#include "plugutils.h"
#include "kb_cache.h"
#include "network.h"
#include "scan_id.h"
#include "support.h"
#include <errno.h>
#include <gvm/base/hosts.h>
#include <gvm/base/networking.h>
#include <gvm/base/prefs.h>
#include <gvm/util/mqtt.h>
#include <gvm/util/nvticache.h>
#include <magic.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/wait.h>
#include <unistd.h>

Include dependency graph for plugutils.c:

Go to the source code of this file.

Macros
#define	G_LOG_DOMAIN   "lib misc"
	GLib logging domain.
#define	MAX_CANDIDATES   16

Functions
void	init_kb_usage (void)
static int	add_kb_usage (struct script_infos *args, size_t size)
const char *	plug_current_vhost (void)
static int	plug_fork_child (kb_t kb)
	Spawns a new child process. Setups everything that is needed for a new process. Child must be handled by caller.
void	plug_set_dep (struct script_infos *args, const char *depname)
static void	host_add_port_proto (struct script_infos *args, int portnum, char *proto)
static int	unscanned_ports_as_closed (port_protocol_t ptype)
	Report state of preferences "unscanned_closed".
int	kb_get_port_state_proto (kb_t kb, int portnum, char *proto)
static int	host_get_port_state_proto (struct script_infos *args, int portnum, char *proto)
int	host_get_port_state (struct script_infos *plugdata, int portnum)
int	host_get_port_state_udp (struct script_infos *plugdata, int portnum)
static int	check_duplicated_vhost (struct script_infos *args, const char *hostname)
	Check for duplicated vhosts before inserting a new one.
int	plug_add_host_fqdn (struct script_infos *args, const char *hostname, const char *source)
char *	plug_get_host_fqdn (struct script_infos *args)
GSList *	plug_get_host_fqdn_list (struct script_infos *args)
char *	plug_get_host_source (struct script_infos *args, const char *hostname)
struct in6_addr *	plug_get_host_ip (struct script_infos *args)
char *	plug_get_host_ip_str (struct script_infos *desc)
static const char *	msg_type_to_str (msg_t type)
	Return string representation of the given msg_t.
int	check_kb_inconsistency (kb_t main_kb)
	Check if the current main kb corresponds to the original scan main kb. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
static int	check_kb_inconsistency_log (void)
	calls check_kb_inconsistency and logs as debug when local scan_id is missing.
int	kb_item_push_str_with_main_kb_check (kb_t kb, const char *name, const char *value)
	Check if the current kb corresponds to the original scanid, if it matches it kb_item_push_str. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
int	kb_item_set_str_with_main_kb_check (kb_t kb, const char *name, const char *value, size_t len)
	Check if the current kb corresponds to the original scanid, if it matches it call kb_item_set_str. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
int	kb_item_add_str_unique_with_main_kb_check (kb_t kb, const char *name, const char *value, size_t len, int pos)
	Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_str_unique. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
int	kb_item_set_int_with_main_kb_check (kb_t kb, const char *name, int value)
	Check if the current kb corresponds to the original scanid, if it matches it call kb_item_set_int. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
int	kb_item_add_int_with_main_kb_check (kb_t kb, const char *name, int value)
	Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_int. @description Compares the scan id in get_scan_id, add at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
int	kb_item_add_int_unique_with_main_kb_check (kb_t kb, const char *name, int value)
	Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_int_unique. @description Compares the scan id in get_scan_id, add at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.
static int	is_utf8_encoded (const char *filename)
static void	proto_post_wrapped (const char *oid, struct script_infos *desc, int port, const char *proto, const char *action, msg_t msg_type, const char *uri)
	Post a security message (e.g. LOG, NOTE, WARNING ...).
void	proto_post_alarm (const char *oid, struct script_infos *desc, int port, const char *proto, const char *action, const char *uri)
void	post_alarm (const char *oid, struct script_infos *desc, int port, const char *action, const char *uri)
void	proto_post_log (const char *oid, struct script_infos *desc, int port, const char *proto, const char *action, const char *uri)
	Post a log message.
void	post_log (const char *oid, struct script_infos *desc, int port, const char *action)
	Post a log message about a tcp port.
void	post_log_with_uri (const char *oid, struct script_infos *desc, int port, const char *action, const char *uri)
	Post a log message about a tcp port with a uri.
void	proto_post_error (const char *oid, struct script_infos *desc, int port, const char *proto, const char *action, const char *uri)
void	post_error (const char *oid, struct script_infos *desc, int port, const char *action, const char *uri)
char *	get_plugin_preference (const char *oid, const char *name, int pref_id)
	Get the a plugins preference.
const char *	get_plugin_preference_fname (struct script_infos *desc, const char *filename)
	Get the file name of a plugins preference that is of type "file".
char *	get_plugin_preference_file_content (struct script_infos *desc, const char *identifier)
	Get the file contents of a plugins preference that is of type "file".
long	get_plugin_preference_file_size (struct script_infos *desc, const char *identifier)
	Get the file size of a plugins preference that is of type "file".
void	plug_set_key_len (struct script_infos *args, char *name, int type, const void *value, size_t len)
void	plug_set_key (struct script_infos *args, char *name, int type, const void *value)
void	plug_set_key_len_volatile (struct script_infos *args, char *name, int type, const void *value, int expire, size_t len)
	Set volatile key with expire.
void	plug_set_key_volatile (struct script_infos *args, char *name, int type, const void *value, int expire)
	Set volatile key with expire.
void	plug_replace_key_len (struct script_infos *args, char *name, int type, void *value, size_t len)
void	plug_replace_key (struct script_infos *args, char *name, int type, void *value)
void	scanner_add_port (struct script_infos *args, int port, char *proto)
kb_t	plug_get_kb (struct script_infos *args)
static void	plug_get_key_sigchld (int s)
static void	sig_n (int signo, void(*fnc)(int))
void *	plug_get_key (struct script_infos *args, char *name, int *type, size_t *len, int single)
	Get values from a kb under the given key name.
unsigned int	plug_get_host_open_port (struct script_infos *desc)
void	plug_set_port_transport (struct script_infos *args, int port, int tr)
int	plug_get_port_transport (struct script_infos *args, int port)
static void	plug_set_ssl_item (struct script_infos *args, char *item, char *itemfname)
void	plug_set_ssl_cert (struct script_infos *args, char *cert)
void	plug_set_ssl_key (struct script_infos *args, char *key)
void	plug_set_ssl_pem_password (struct script_infos *args, char *key)
void	plug_set_ssl_CA_file (struct script_infos *args, char *key)

Variables
int	global_nasl_debug = 0
static size_t	kb_usage = 0
static size_t	max_kb_usage
gvm_vhost_t *	current_vhost = NULL

Detailed Description

Plugin-specific stuff.

Definition in file plugutils.c.

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "lib misc"

GLib logging domain.

Definition at line 36 of file plugutils.c.

MAX_CANDIDATES

#define MAX_CANDIDATES   16

Referenced by plug_get_host_open_port().

Function Documentation

add_kb_usage()

int add_kb_usage ( struct script_infos * args, size_t size )

static

Definition at line 69 of file plugutils.c.

{
  if (max_kb_usage == 0)
    return 0;
  if (kb_usage > max_kb_usage)
    return -1;
  kb_usage += size;
  if (kb_usage > max_kb_usage)
    {
      g_warning ("KB usage exceeded %lu MB. Unable to store any further KB "
                 "Items for script %s",
                 max_kb_usage / 1024 / 1024, args->name);
      return -1;
    }
  return 0;
}

References kb_usage, max_kb_usage, and script_infos::name.

Referenced by plug_replace_key_len(), and plug_set_key_len().

Here is the caller graph for this function:

check_duplicated_vhost()

int check_duplicated_vhost ( struct script_infos * args, const char * hostname )

static

Check for duplicated vhosts before inserting a new one.

Parameters

args	script info structure
hostname	hostname to check

Returns

0 if the vhosts was still not added. -1 if the vhosts already exists.

Definition at line 213 of file plugutils.c.

{
  GSList *vhosts = NULL;
  kb_t host_kb = NULL;
  struct kb_item *current_vhosts = NULL;
 
  /* Check for duplicate vhost value in args. */
  vhosts = args->vhosts;
  while (vhosts)
    {
      gvm_vhost_t *tmp = vhosts->data;
 
      if (!strcmp (tmp->value, hostname))
        {
          g_warning ("%s: Value '%s' exists already", __func__, hostname);
          return -1;
        }
      vhosts = vhosts->next;
    }
 
  /* Check for duplicate vhost value already added by other forked child of the
   * same plugin. */
  host_kb = args->key;
  current_vhosts = kb_item_get_all (host_kb, "internal/vhosts");
  if (!current_vhosts)
    return 0;
 
  while (current_vhosts)
    {
      if (!strcmp (current_vhosts->v_str, hostname))
        {
          g_warning ("%s: Value '%s' exists already", __func__, hostname);
          kb_item_free (current_vhosts);
 
          return -1;
        }
      current_vhosts = current_vhosts->next;
    }
 
  kb_item_free (current_vhosts);
  return 0;
}

References host_kb, hostname, script_infos::key, and script_infos::vhosts.

Referenced by plug_add_host_fqdn().

Here is the caller graph for this function:

check_kb_inconsistency()

int check_kb_inconsistency

(

kb_t

main_kb

)

Check if the current main kb corresponds to the original scan main kb. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

main_kb

Current main kb.

Returns

0 on success, -1 on missing global scan_id, -2 on missing current_scan_id, -3 when inconsistent.

Definition at line 442 of file plugutils.c.

{
  const char *original_scan_id;
  char *current_scan_id;
 
  original_scan_id = get_scan_id ();
  if (original_scan_id == NULL)
    return -1;
  current_scan_id = kb_item_get_str (main_kb, ("internal/scanid"));
  if (current_scan_id == NULL)
    return -2;
 
  if (!g_strcmp0 (original_scan_id, current_scan_id))
    {
      g_free (current_scan_id);
      return 0;
    }
 
  g_warning ("KB inconsitency. %s writing into %s KB", original_scan_id,
             current_scan_id);
  g_free (current_scan_id);
  return -3;
}

References get_scan_id(), and main_kb.

Referenced by attack_host(), check_kb_inconsistency_log(), and set_scan_status().

Here is the call graph for this function:

Here is the caller graph for this function:

check_kb_inconsistency_log()

int check_kb_inconsistency_log ( void )

static

calls check_kb_inconsistency and logs as debug when local scan_id is missing.

@description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 481 of file plugutils.c.

{
  char *current_scan_id;
  kb_t kb = get_main_kb ();
  int result = check_kb_inconsistency (kb);
  switch (result)
    {
    case -3:
      current_scan_id = kb_item_get_str (kb, ("internal/scanid"));
      g_warning (
        "%s: scan_id (%s) does not match global scan_id (%s); abort to "
        "prevent data corruption",
        __func__, current_scan_id, get_scan_id ());
      g_free (current_scan_id);
      _exit (1);
      break;
    case -1:
      // a call without global scan id can happen in e.g. nasl-lint or
      // openvas-nasl calls
      break;
    case -2:
      g_warning (
        "%s: No internal/scanid found; abort to prevent data corruption.",
        __func__);
      _exit (1);
      break;
    default:
      {
        // nothing
      }
    }
  return 0;
}

References check_kb_inconsistency(), get_main_kb(), and get_scan_id().

Referenced by kb_item_add_int_unique_with_main_kb_check(), kb_item_add_int_with_main_kb_check(), kb_item_add_str_unique_with_main_kb_check(), kb_item_push_str_with_main_kb_check(), kb_item_set_int_with_main_kb_check(), and kb_item_set_str_with_main_kb_check().

Here is the call graph for this function:

Here is the caller graph for this function:

get_plugin_preference()

char * get_plugin_preference	(	const char *	oid,
		const char *	name,
		int	pref_id )

Get the a plugins preference.

Search in the preferences set by the client. If it is not present, search in redis cache for the default.

Parameters

[in]	oid	Script OID to get the preference from
[in]	name	Name of the preference to get
[in]	pref_id	Id of the preferences to get

Returns

script preference on success, Null otherwise.

Definition at line 837 of file plugutils.c.

{
  GHashTable *prefs;
  GHashTableIter iter;
  char *cname = NULL, *retval = NULL;
  void *itername, *itervalue;
  char prefix[1024], suffix[1024];
 
  prefs = preferences_get ();
  if (!prefs || !nvticache_initialized () || !oid || (!name && pref_id < 0))
    return NULL;
 
  g_hash_table_iter_init (&iter, prefs);
 
  if (pref_id >= 0)
    {
      snprintf (prefix, sizeof (prefix), "%s:%d:", oid, pref_id);
      while (g_hash_table_iter_next (&iter, &itername, &itervalue))
        {
          if (g_str_has_prefix (itername, prefix))
            {
              retval = g_strdup (itervalue);
              break;
            }
        }
    }
  else
    {
      cname = g_strdup (name);
      g_strchomp (cname);
      snprintf (prefix, sizeof (prefix), "%s:", oid);
      snprintf (suffix, sizeof (suffix), ":%s", cname);
      /* NVT preferences received in OID:PrefID:PrefType:PrefName form */
      while (g_hash_table_iter_next (&iter, &itername, &itervalue))
        {
          if (g_str_has_prefix (itername, prefix)
              && g_str_has_suffix (itername, suffix))
            {
              retval = g_strdup (itervalue);
              break;
            }
        }
    }
 
  /* If no value set by the user, get the default one. */
  if (!retval)
    {
      GSList *nprefs, *tmp;
 
      tmp = nprefs = nvticache_get_prefs (oid);
      while (tmp)
        {
          if ((cname && !strcmp (cname, nvtpref_name (tmp->data)))
              || (pref_id >= 0 && pref_id == nvtpref_id (tmp->data)))
            {
              if (!strcmp (nvtpref_type (tmp->data), "radio"))
                {
                  char **opts =
                    g_strsplit (nvtpref_default (tmp->data), ";", -1);
 
                  retval = g_strdup (opts[0]);
                  g_strfreev (opts);
                }
              else
                retval = g_strdup (nvtpref_default (tmp->data));
 
              break;
            }
          tmp = tmp->next;
        }
      g_slist_free_full (nprefs, (void (*) (void *)) nvtpref_free);
    }
  if (cname)
    g_free (cname);
  return retval;
}

References name, oid, and prefix().

Referenced by plugin_do_run(), plugin_run_find_service(), plugin_timeout(), script_get_preference(), script_get_preference_file_content(), script_get_preference_file_location(), and user_agent_create().

Here is the call graph for this function:

Here is the caller graph for this function:

get_plugin_preference_file_content()

char * get_plugin_preference_file_content	(	struct script_infos *	desc,
		const char *	identifier )

Get the file contents of a plugins preference that is of type "file".

As files sent to the scanner (e.g. as plugin preference) are stored in a hash table with an identifier supplied by the client as the key, the contents have to be looked up here.

Parameters

identifier

Identifier that was supplied by the client when the file was uploaded.

Returns

Contents of the file identified by identifier, NULL if not found or setup broken.

Definition at line 980 of file plugutils.c.

{
  struct scan_globals *globals = desc->globals;
  GHashTable *trans;
 
  if (!globals)
    return NULL;
 
  trans = globals->files_translation;
  if (!trans)
    return NULL;
 
  return g_hash_table_lookup (trans, identifier);
}

References scan_globals::files_translation, and script_infos::globals.

Referenced by get_plugin_preference_fname(), and script_get_preference_file_content().

Here is the caller graph for this function:

get_plugin_preference_file_size()

long get_plugin_preference_file_size	(	struct script_infos *	desc,
		const char *	identifier )

Get the file size of a plugins preference that is of type "file".

Files sent to the scanner (e.g. as plugin preference) are stored in a hash table with an identifier supplied by the client as the key. The size of the file is stored in a separate hash table with the same identifier as key, which can be looked up here.

Parameters

identifier

Identifier that was supplied by the client when the file was uploaded.

Returns

Size of the file identified by identifier, -1 if not found or setup broken.

Definition at line 1011 of file plugutils.c.

{
  struct scan_globals *globals = desc->globals;
  GHashTable *trans;
  gchar *filesize_str;
 
  if (!globals)
    return -1;
 
  trans = globals->files_size_translation;
  if (!trans)
    return -1;
 
  filesize_str = g_hash_table_lookup (trans, identifier);
  if (filesize_str == NULL)
    return -1;
 
  return atol (filesize_str);
}

References scan_globals::files_size_translation, and script_infos::globals.

Referenced by get_plugin_preference_fname(), and script_get_preference_file_content().

Here is the caller graph for this function:

get_plugin_preference_fname()

const char * get_plugin_preference_fname	(	struct script_infos *	desc,
		const char *	filename )

Get the file name of a plugins preference that is of type "file".

As files sent to the server (e.g. as plugin preference) are stored at pseudo-random locations with different names, the "real" file name has to be looked up in a hashtable.

Returns

Filename on disc for filename, NULL if not found or setup broken.

Definition at line 925 of file plugutils.c.

{
  const char *content;
  long contentsize = 0;
  gint tmpfile;
  gchar *tmpfilename;
  GError *error = NULL;
 
  content = get_plugin_preference_file_content (desc, filename);
  if (content == NULL)
    {
      return NULL;
    }
  contentsize = get_plugin_preference_file_size (desc, filename);
  if (contentsize <= 0)
    return NULL;
 
  tmpfile =
    g_file_open_tmp ("openvas-file-upload.XXXXXX", &tmpfilename, &error);
  if (tmpfile == -1)
    {
      g_message ("get_plugin_preference_fname: Could not open temporary"
                 " file for %s: %s",
                 filename, error->message);
      g_error_free (error);
      return NULL;
    }
  close (tmpfile);
 
  if (!g_file_set_contents (tmpfilename, content, contentsize, &error))
    {
      g_message ("get_plugin_preference_fname: could set contents of"
                 " temporary file for %s: %s",
                 filename, error->message);
      g_error_free (error);
      return NULL;
    }
 
  return tmpfilename;
}

References get_plugin_preference_file_content(), and get_plugin_preference_file_size().

Referenced by plugin_run_find_service(), and script_get_preference_file_location().

Here is the call graph for this function:

Here is the caller graph for this function:

host_add_port_proto()

void host_add_port_proto ( struct script_infos * args, int portnum, char * proto )

static

Definition at line 124 of file plugutils.c.

{
  char port_s[255];
  snprintf (port_s, sizeof (port_s), "Ports/%s/%d", proto, portnum);
  plug_set_key (args, port_s, ARG_INT, (void *) 1);
}

References ARG_INT, and plug_set_key().

Referenced by scanner_add_port().

Here is the call graph for this function:

Here is the caller graph for this function:

host_get_port_state()

int host_get_port_state	(	struct script_infos *	plugdata,
		int	portnum )

Definition at line 193 of file plugutils.c.

{
  return (host_get_port_state_proto (plugdata, portnum, "tcp"));
}

References host_get_port_state_proto().

Referenced by get_port_state(), and open_sock_tcp().

Here is the call graph for this function:

Here is the caller graph for this function:

host_get_port_state_proto()

int host_get_port_state_proto ( struct script_infos * args, int portnum, char * proto )

static

Definition at line 187 of file plugutils.c.

{
  return kb_get_port_state_proto (args->key, portnum, proto);
}

References kb_get_port_state_proto(), and script_infos::key.

Referenced by host_get_port_state(), and host_get_port_state_udp().

Here is the call graph for this function:

Here is the caller graph for this function:

host_get_port_state_udp()

int host_get_port_state_udp	(	struct script_infos *	plugdata,
		int	portnum )

Definition at line 199 of file plugutils.c.

{
  return (host_get_port_state_proto (plugdata, portnum, "udp"));
}

References host_get_port_state_proto().

Referenced by get_udp_port_state().

Here is the call graph for this function:

Here is the caller graph for this function:

init_kb_usage()

void init_kb_usage

(

void

)

Definition at line 47 of file plugutils.c.

{
  const char *usage_char;
  int usage_int;
  usage_char = prefs_get ("max_mem_kb");
  if (usage_char)
    {
      usage_int = atoi (usage_char);
      if (usage_int < 0)
        {
          max_kb_usage = 0;
        }
      else
        {
          max_kb_usage = (size_t) usage_int * 1024 * 1024;
        }
    }
  else
    max_kb_usage = 0;
}

References max_kb_usage.

Referenced by pluginlaunch_init().

Here is the caller graph for this function:

is_utf8_encoded()

int is_utf8_encoded ( const char * filename )

static

Definition at line 664 of file plugutils.c.

{
  magic_t magic_cookie = magic_open (MAGIC_MIME_ENCODING);
  int ret = 0;
  if (!magic_cookie)
    {
      g_warning ("%s: It is not possible initialize magic db", __func__);
      return -1;
    }
  if (magic_load (magic_cookie, NULL) != 0)
    {
      g_warning ("%s: It was not possible to load the default magic db",
                 __func__);
      ret = -1;
      goto magic_ret;
    }
  const char *file_encoding = magic_file (magic_cookie, filename);
  if (!file_encoding)
    {
      g_warning ("%s: It was not possible to identify the file encoding for %s",
                 __func__, filename);
      ret = -1;
      goto magic_ret;
    }
 
  if (g_strstr_len (file_encoding, strlen (file_encoding), "utf-8"))
    ret = 1;
 
 magic_ret:
  magic_close (magic_cookie);
  return ret;
}

Referenced by proto_post_wrapped().

Here is the caller graph for this function:

kb_get_port_state_proto()

int kb_get_port_state_proto	(	kb_t	kb,
		int	portnum,
		char *	proto )

Parameters

proto

Protocol (udp/tcp). If NULL, "tcp" will be used.

Definition at line 149 of file plugutils.c.

{
  char port_s[255], *kbstr;
  const char *prange = prefs_get ("port_range");
  port_protocol_t port_type;
  array_t *port_ranges;
 
  if (!proto)
    proto = "tcp";
  if (!strcmp (proto, "udp"))
    {
      port_type = PORT_PROTOCOL_UDP;
      kbstr = "Host/udp_scanned";
    }
  else
    {
      port_type = PORT_PROTOCOL_TCP;
      kbstr = "Host/scanned";
    }
 
  /* Check that we actually scanned the port */
  if (kb_item_get_int (kb, kbstr) <= 0)
    return unscanned_ports_as_closed (port_type);
 
  port_ranges = port_range_ranges (prange);
  if (!port_in_port_ranges (portnum, port_type, port_ranges))
    {
      array_free (port_ranges);
      return unscanned_ports_as_closed (port_type);
    }
  array_free (port_ranges);
 
  /* Ok, we scanned it. What is its state ? */
  snprintf (port_s, sizeof (port_s), "Ports/%s/%d", proto, portnum);
  return kb_item_get_int (kb, port_s) > 0;
}

References unscanned_ports_as_closed().

Referenced by get_closed_ports(), and host_get_port_state_proto().

Here is the call graph for this function:

Here is the caller graph for this function:

kb_item_add_int_unique_with_main_kb_check()

int kb_item_add_int_unique_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		int	value )

Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_int_unique. @description Compares the scan id in get_scan_id, add at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 657 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_add_int_unique (kb, name, value) : -1;
}

References check_kb_inconsistency_log(), and name.

Referenced by set_kb_readable().

Here is the call graph for this function:

Here is the caller graph for this function:

kb_item_add_int_with_main_kb_check()

int kb_item_add_int_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		int	value )

Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_int. @description Compares the scan id in get_scan_id, add at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 633 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_add_int (kb, name, value) : -1;
}

References check_kb_inconsistency_log(), and name.

Here is the call graph for this function:

kb_item_add_str_unique_with_main_kb_check()

int kb_item_add_str_unique_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		const char *	value,
		size_t	len,
		int	pos )

Check if the current kb corresponds to the original scanid, if it matches it call kb_item_add_str_unique. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 583 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_add_str_unique (kb, name, value, len, pos) : -1;
}

References check_kb_inconsistency_log(), len, and name.

Here is the call graph for this function:

kb_item_push_str_with_main_kb_check()

int kb_item_push_str_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		const char *	value )

Check if the current kb corresponds to the original scanid, if it matches it kb_item_push_str. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 533 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_push_str (kb, name, value) : -1;
}

References check_kb_inconsistency_log(), and name.

Referenced by attack_host(), call_lsc(), call_rs_notus(), comm_send_status(), comm_send_status_host_dead(), host_set_time(), message_to_client(), open_sock_tcp(), proto_post_wrapped(), security_notus(), and update_running_processes().

Here is the call graph for this function:

Here is the caller graph for this function:

kb_item_set_int_with_main_kb_check()

int kb_item_set_int_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		int	value )

Check if the current kb corresponds to the original scanid, if it matches it call kb_item_set_int. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 609 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_set_int (kb, name, value) : -1;
}

References check_kb_inconsistency_log(), and name.

Referenced by check_host_still_alive(), open_sock_tcp(), and overwrite_openvas_prefs_with_prefs_from_client().

Here is the call graph for this function:

Here is the caller graph for this function:

kb_item_set_str_with_main_kb_check()

int kb_item_set_str_with_main_kb_check	(	kb_t	kb,
		const char *	name,
		const char *	value,
		size_t	len )

Check if the current kb corresponds to the original scanid, if it matches it call kb_item_set_str. @description Compares the scan id in get_scan_id, set at the beginning of the scan, with the one found in the main kb. Therefore it is mandatory that the global main_kb variable to be set. It helps to detect that the kb was not taken by another task/scan, and that the current plugins does not stores results in a wrong kb.

Parameters

kb	Kb where to store the item into.
name	key for the given value.
value	to store under key within kb.

Returns

0 on success, -1 on inconsistency.

Definition at line 558 of file plugutils.c.

{
  int result = check_kb_inconsistency_log ();
  return result == 0 ? kb_item_set_str (kb, name, value, len) : -1;
}

References check_kb_inconsistency_log(), len, and name.

Referenced by attack_start(), overwrite_openvas_prefs_with_prefs_from_client(), and set_scan_status().

Here is the call graph for this function:

Here is the caller graph for this function:

msg_type_to_str()

const char * msg_type_to_str ( msg_t type )

static

Return string representation of the given msg_t.

Parameters

msg	msg_t to transform

Returns

string representation of the given msg_t if successful, else NULL.

Definition at line 390 of file plugutils.c.

{
  gchar *type_str;
 
  switch (type)
    {
    case ERRMSG:
      type_str = "ERRMSG";
      break;
    case HOST_START:
      type_str = "HOST_START";
      break;
    case HOST_END:
      type_str = "HOST_END";
      break;
    case LOG:
      type_str = "LOG";
      break;
    case HOST_DETAIL:
      type_str = "HOST_DETAIL";
      break;
    case ALARM:
      type_str = "ALARM";
      break;
    case DEADHOST:
      type_str = "DEADHOST";
      break;
    default:
      return NULL;
      break;
    }
 
  return type_str;
}

References ALARM, DEADHOST, ERRMSG, HOST_DETAIL, HOST_END, HOST_START, and LOG.

Referenced by proto_post_wrapped().

Here is the caller graph for this function:

plug_add_host_fqdn()

int plug_add_host_fqdn	(	struct script_infos *	args,
		const char *	hostname,
		const char *	source )

Definition at line 257 of file plugutils.c.

{
  gvm_vhost_t *vhost;
  char **excluded;
 
  if (!prefs_get_bool ("expand_vhosts") || !hostname || !source)
    return -1;
 
  if (check_duplicated_vhost (args, hostname))
    return -1;
 
  /* Check for excluded vhost value. */
  if (prefs_get ("exclude_hosts"))
    {
      char **tmp = excluded = g_strsplit (prefs_get ("exclude_hosts"), ",", 0);
 
      while (*tmp)
        {
          if (!strcmp (g_strstrip (*tmp), hostname))
            {
              g_strfreev (excluded);
              return -1;
            }
          tmp++;
        }
      g_strfreev (excluded);
    }
  vhost = gvm_vhost_new (g_strdup (hostname), g_strdup (source));
  args->vhosts = g_slist_prepend (args->vhosts, vhost);
  return 0;
}

References check_duplicated_vhost(), hostname, and script_infos::vhosts.

Referenced by add_hostname().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_current_vhost()

const char * plug_current_vhost

(

void

)

Definition at line 93 of file plugutils.c.

{
  if (current_vhost != NULL)
    return current_vhost->value;
 
  return NULL;
}

References current_vhost.

Referenced by nasl_end_denial(), and open_sock_tcp().

Here is the caller graph for this function:

plug_fork_child()

int plug_fork_child ( kb_t kb )

static

Spawns a new child process. Setups everything that is needed for a new process. Child must be handled by caller.

Parameters

kb	for redis connection

Returns

int 0 for the child process, 1 for the parent process and -1 on failure

Definition at line 1191 of file plugutils.c.

{
  pid_t pid;
 
  // TODO change forking to official channels
  if ((pid = fork ()) == 0)
    {
      sig_n (SIGTERM, _exit);
      mqtt_reset ();
      kb_lnk_reset (kb);
      kb_lnk_reset (get_main_kb ());
      nvticache_reset ();
      srand48 (getpid () + getppid () + time (NULL));
      return 0;
    }
  else if (pid < 0)
    {
      g_warning ("%s(): fork() failed (%s)", __func__, strerror (errno));
      return -1;
    }
  else
    // the parent waits for the spawned process to finish to prevent DDOS on a
    // host when multiple vhosts got spawned
    waitpid (pid, NULL, 0);
  return 1;
}

References get_main_kb(), pid, and sig_n().

Referenced by plug_get_host_fqdn(), and plug_get_key().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_host_fqdn()

char * plug_get_host_fqdn

(

struct script_infos *

args

)

Definition at line 291 of file plugutils.c.

{
  GSList *vhosts = args->vhosts;
 
  if (!args->vhosts)
    return addr6_as_str (args->ip);
 
  /* Workaround for rapid growth of forked processes ie. http_get() calls
   * within foreach() loops. */
  if (current_vhost)
    return g_strdup (current_vhost->value);
  while (vhosts)
    {
      int ret = plug_fork_child (args->key);
 
      if (ret == 0)
        {
          current_vhost = vhosts->data;
          return g_strdup (current_vhost->value);
        }
      else if (ret == -1)
        return NULL;
      vhosts = vhosts->next;
    }
 
  // Allow to return to the main process if parent process is openvas-nasl.
  // So, the main process can do e.g. a kb clean up
  if (args->standalone)
    return NULL;
 
  _exit (0);
}

References current_vhost, script_infos::ip, script_infos::key, plug_fork_child(), script_infos::standalone, and script_infos::vhosts.

Referenced by _http2_req(), _http_req(), get_hostname(), open_stream_connection_ext(), plug_get_host_source(), plugin_do_run(), retry_stream_connection(), and socket_negotiate_ssl().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_host_fqdn_list()

GSList * plug_get_host_fqdn_list

(

struct script_infos *

args

)

Definition at line 325 of file plugutils.c.

{
  GSList *results = NULL, *vhosts = args->vhosts;
 
  if (!args->vhosts)
    results = g_slist_prepend (results, addr6_as_str (args->ip));
 
  while (vhosts)
    {
      gvm_vhost_t *vhost = vhosts->data;
 
      results = g_slist_prepend (results, g_strdup (vhost->value));
      vhosts = vhosts->next;
    }
  return results;
}

References script_infos::ip, and script_infos::vhosts.

Referenced by get_hostnames().

Here is the caller graph for this function:

plug_get_host_ip()

struct in6_addr * plug_get_host_ip

(

struct script_infos *

args

)

Definition at line 371 of file plugutils.c.

{
  return args->ip;
}

References script_infos::ip.

Referenced by forge_ip_packet(), forge_ip_v6_packet(), get_host_ip(), nasl_get_mtu(), nasl_islocalhost(), nasl_islocalnet(), nasl_open_privileged_socket(), nasl_open_sock_udp(), nasl_pcap_next(), nasl_send(), nasl_send_arp_request(), nasl_send_capture(), nasl_send_frame(), nasl_send_packet(), nasl_send_v6packet(), nasl_smb_connect(), nasl_ssh_connect(), nasl_target_is_ipv6(), nasl_tcp_ping(), nasl_tcp_v6_ping(), nasl_this_host(), nasl_win_cmd_exec(), nasl_wmi_connect(), nasl_wmi_connect_reg(), nasl_wmi_connect_rsop(), open_sock_option(), plug_get_host_ip_str(), plugin_run_synscan(), and proto_post_wrapped().

Here is the caller graph for this function:

plug_get_host_ip_str()

char * plug_get_host_ip_str

(

struct script_infos *

desc

)

Definition at line 377 of file plugutils.c.

{
  return addr6_as_str (plug_get_host_ip (desc));
}

References plug_get_host_ip().

Referenced by host_reverse_lookup(), nasl_snmpv1v2c_get(), nasl_snmpv3_get_action(), open_sock_tcp(), and socket_negotiate_ssl().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_host_open_port()

unsigned int plug_get_host_open_port

(

struct script_infos *

desc

)

Don't always return the first open port, otherwise we might get bitten by OSes doing active SYN flood countermeasures. Also, avoid returning 80 and 21 as open ports, as many transparent proxies are acting for these...

Definition at line 1328 of file plugutils.c.

{
  kb_t kb = plug_get_kb (desc);
  struct kb_item *res, *k;
  int open21 = 0, open80 = 0;
#define MAX_CANDIDATES 16
  u_short candidates[MAX_CANDIDATES];
  int num_candidates = 0;
 
  k = res = kb_item_get_pattern (kb, "Ports/tcp/*");
  if (res == NULL)
    return 0;
  else
    {
      int ret;
      char *s;
 
      for (;;)
        {
          s = res->name + sizeof ("Ports/tcp/") - 1;
          ret = atoi (s);
          if (ret == 21)
            open21 = 1;
          else if (ret == 80)
            open80 = 1;
          else
            {
              candidates[num_candidates++] = ret;
              if (num_candidates >= MAX_CANDIDATES)
                break;
            }
          res = res->next;
          if (res == NULL)
            break;
        }
 
      kb_item_free (k);
      if (num_candidates != 0)
        return candidates[lrand48 () % num_candidates];
      else if (open21)
        return 21;
      else if (open80)
        return 80;
    }
 
  /* Not reachable */
  return 0;
}

References MAX_CANDIDATES, and plug_get_kb().

Referenced by get_host_open_port(), nasl_start_denial(), nasl_tcp_ping(), and nasl_tcp_v6_ping().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_host_source()

char * plug_get_host_source	(	struct script_infos *	args,
		const char *	hostname )

Definition at line 343 of file plugutils.c.

{
  if (!args->vhosts)
    return g_strdup ("IP-address");
 
  if (hostname)
    {
      GSList *vhosts = args->vhosts;
 
      /* Search for source of specified hostname/vhost. */
      while (vhosts)
        {
          gvm_vhost_t *vhost = vhosts->data;
 
          if (!strcmp (vhost->value, hostname))
            return g_strdup (vhost->source);
          vhosts = vhosts->next;
        }
      return NULL;
    }
  /* Call plug_get_host_fqdn() to set current_vhost (and fork, in case of
   * multiple vhosts.) */
  if (!current_vhost)
    g_free (plug_get_host_fqdn (args));
  return g_strdup (current_vhost->source);
}

References current_vhost, hostname, plug_get_host_fqdn(), and script_infos::vhosts.

Referenced by get_hostname_source().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_kb()

kb_t plug_get_kb

(

struct script_infos *

args

)

Definition at line 1157 of file plugutils.c.

{
  return args->key;
}

References script_infos::key.

Referenced by _http_req(), exec_nasl_script(), get_kb_list(), nasl_end_denial(), nasl_ssh_set_login(), nasl_ssh_userauth(), open_sock_tcp(), open_stream_connection_ext(), plug_get_host_open_port(), plug_get_port_transport(), plug_replace_key_len(), plug_set_key_len(), plug_set_key_len_volatile(), plugin_run_find_service(), and socket_negotiate_ssl().

Here is the caller graph for this function:

plug_get_key()

void * plug_get_key	(	struct script_infos *	args,
		char *	name,
		int *	type,
		size_t *	len,
		int	single )

Get values from a kb under the given key name.

Parameters

[in]	args	The script infos where to get the kb from.
[in]	name	Key name to search in the kb.
	[in/out]	type If 1 is given, the answer is forced to be KB_TYPE_INT type. Otherwise it returns the fetched type.
[in]	len	Desired string length to be returned.
[in]	single	In case of a list, fetch only the last element

Returns

Null if no result, or a void pointer to the result in success.

Definition at line 1231 of file plugutils.c.

{
  kb_t kb = args->key;
  struct kb_item *res = NULL, *res_list;
 
  if (type != NULL && *type != KB_TYPE_INT)
    *type = -1;
 
  if (kb == NULL)
    return NULL;
 
  if (single && type != NULL && *type != KB_TYPE_INT)
    res = kb_item_get_single (kb, name, KB_TYPE_UNSPEC);
  else if (type != NULL && *type == KB_TYPE_INT)
    res = kb_item_get_single (kb, name, KB_TYPE_INT);
  else
    res = kb_item_get_all (kb, name);
 
  if (res == NULL)
    return NULL;
 
  if (!res->next) /* No fork - good */
    {
      void *ret;
      if (res->type == KB_TYPE_INT)
        {
          if (type != NULL)
            *type = KB_TYPE_INT;
          ret = g_memdup2 (&res->v_int, sizeof (res->v_int));
        }
      else
        {
          if (type != NULL)
            *type = KB_TYPE_STR;
          if (len)
            *len = res->len;
 
          ret = g_malloc0 (res->len + 1);
          memcpy (ret, res->v_str, res->len + 1);
        }
      kb_item_free (res);
      return ret;
    }
 
  /* More than  one value - we will fork() then */
  sig_n (SIGCHLD, plug_get_key_sigchld);
  res_list = res;
  while (res)
    {
      int pret = plug_fork_child (kb);
 
      if (pret == 0)
        {
          /* Forked child. */
          void *ret;
 
          if (res->type == KB_TYPE_INT)
            {
              if (type != NULL)
                *type = KB_TYPE_INT;
              ret = g_memdup2 (&res->v_int, sizeof (res->v_int));
            }
          else
            {
              if (type != NULL)
                *type = KB_TYPE_STR;
              if (len)
                *len = res->len;
 
              ret = g_malloc0 (res->len + 1);
              memcpy (ret, res->v_str, res->len + 1);
            }
          kb_item_free (res_list);
          return ret;
        }
      else if (pret == -1)
        return NULL;
      res = res->next;
    }
  kb_item_free (res_list);
 
  // Allow to return to the main process if parent process is openvas-nasl.
  // So, the main process can do e.g. a kb clean up
  if (args->standalone)
    return NULL;
 
  _exit (0);
}

References script_infos::key, len, name, plug_fork_child(), plug_get_key_sigchld(), sig_n(), and script_infos::standalone.

Referenced by banner_grab(), get_kb_item(), get_ssh_port(), nasl_open_sock_kdc(), and plugin_do_run().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_get_key_sigchld()

void plug_get_key_sigchld ( int s )

static

Definition at line 1163 of file plugutils.c.

{
  int status;
  (void) s;
 
  wait (&status);
}

Referenced by plug_get_key().

Here is the caller graph for this function:

plug_get_port_transport()

int plug_get_port_transport	(	struct script_infos *	args,
		int	port )

Definition at line 1396 of file plugutils.c.

{
  char s[256];
  int trp;
 
  snprintf (s, sizeof (s), "Transports/TCP/%d", port);
  trp = kb_item_get_int (plug_get_kb (args), s);
  if (trp >= 0)
    return trp;
  else
    return OPENVAS_ENCAPS_IP; /* Change this to 0 for ultra smart SSL
                                 negotiation, at the expense of possibly
                                 breaking stuff */
}

References OPENVAS_ENCAPS_IP, and plug_get_kb().

Referenced by get_port_transport(), and open_stream_auto_encaps_ext().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_replace_key()

void plug_replace_key	(	struct script_infos *	args,
		char *	name,
		int	type,
		void *	value )

Definition at line 1145 of file plugutils.c.

{
  plug_replace_key_len (args, name, type, value, 0);
}

References name, and plug_replace_key_len().

Referenced by mark_acap_server(), mark_adsgone(), mark_exchg_routing_server(), mark_ftp_server(), mark_fw1(), mark_http_server(), mark_imap_server(), mark_linuxconf(), mark_locked_adsubtract_server(), mark_mon_server(), mark_ncacn_http_server(), mark_nntp_server(), mark_pop3pw_server(), mark_pop_server(), mark_psybnc(), mark_rmserver(), mark_shoutcast_server(), mark_smtp_server(), mark_snpp_server(), mark_unknown_svc(), mark_uucp_server(), mark_vnc_server(), mark_vtun_server(), mark_whois_plus2_server(), mark_zebra_server(), plugin_do_run(), register_service(), and replace_kb_item().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_replace_key_len()

void plug_replace_key_len	(	struct script_infos *	args,
		char *	name,
		int	type,
		void *	value,
		size_t	len )

Definition at line 1118 of file plugutils.c.

{
  kb_t kb = plug_get_kb (args);
 
  if (name == NULL || value == NULL)
    return;
 
  if (type == ARG_STRING)
    {
      if (add_kb_usage (args, len) == -1)
        return;
      kb_item_set_str (kb, name, value, len);
    }
  else if (type == ARG_INT)
    kb_item_set_int (kb, name, GPOINTER_TO_SIZE (value));
  if (global_nasl_debug == 1)
    {
      if (type == ARG_STRING)
        g_message ("replace key %s -> %s", name, (char *) value);
      else if (type == ARG_INT)
        g_message ("replace key %s -> %d", name,
                   (int) GPOINTER_TO_SIZE (value));
    }
}

References add_kb_usage(), ARG_INT, ARG_STRING, global_nasl_debug, len, name, and plug_get_kb().

Referenced by plug_replace_key(), and replace_kb_item().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_dep()

void plug_set_dep	(	struct script_infos *	args,
		const char *	depname )

Definition at line 104 of file plugutils.c.

{
  nvti_t *n = args->nvti;
  gchar *old = nvti_dependencies (n);
  gchar *new;
 
  if (!depname)
    return;
 
  if (old)
    {
      new = g_strdup_printf ("%s, %s", old, depname);
      nvti_set_dependencies (n, new);
      g_free (new);
    }
  else
    nvti_set_dependencies (n, depname);
}

References script_infos::nvti.

Referenced by script_dependencies().

Here is the caller graph for this function:

plug_set_key()

void plug_set_key	(	struct script_infos *	args,
		char *	name,
		int	type,
		const void *	value )

Definition at line 1060 of file plugutils.c.

{
  plug_set_key_len (args, name, type, value, 0);
}

References name, and plug_set_key_len().

Referenced by banner_grab(), host_add_port_proto(), mark_unknown_svc(), mark_wrapped_svc(), nasl_update_table_driven_lsc_data(), plug_set_port_transport(), plug_set_ssl_item(), plugin_do_run(), plugin_run_openvas_tcp_scanner(), plugin_run_synscan(), register_service(), scan(), set_kb_item(), and simple_register_host_detail().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_key_len()

void plug_set_key_len	(	struct script_infos *	args,
		char *	name,
		int	type,
		const void *	value,
		size_t	len )

Definition at line 1033 of file plugutils.c.

{
  kb_t kb = plug_get_kb (args);
  int pos = 0; // Append the item on the right position of the list
 
  if (name == NULL || value == NULL)
    return;
 
  if (type == ARG_STRING)
    {
      if (add_kb_usage (args, len) == -1)
        return;
      kb_item_add_str_unique (kb, name, value, len, pos);
    }
  else if (type == ARG_INT)
    kb_item_add_int_unique (kb, name, GPOINTER_TO_SIZE (value));
  if (global_nasl_debug == 1)
    {
      if (type == ARG_STRING)
        g_message ("set key %s -> %s", name, (char *) value);
      else if (type == ARG_INT)
        g_message ("set key %s -> %d", name, (int) GPOINTER_TO_SIZE (value));
    }
}

References add_kb_usage(), ARG_INT, ARG_STRING, global_nasl_debug, len, name, and plug_get_kb().

Referenced by plug_set_key(), and set_kb_item().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_key_len_volatile()

void plug_set_key_len_volatile	(	struct script_infos *	args,
		char *	name,
		int	type,
		const void *	value,
		int	expire,
		size_t	len )

Set volatile key with expire.

Parameters

args	Script infos.
name	Key name.
type	Key type.
value	Key value.
expire	Key expire in seconds.
len	Len of value.

Definition at line 1077 of file plugutils.c.

{
  kb_t kb = plug_get_kb (args);
  int pos = 0; // Append the item on the right position of the list
 
  if (name == NULL || value == NULL || expire == -1)
    return;
 
  if (type == ARG_STRING)
    kb_add_str_unique_volatile (kb, name, value, expire, len, pos);
  else if (type == ARG_INT)
    kb_add_int_unique_volatile (kb, name, GPOINTER_TO_SIZE (value),
                                GPOINTER_TO_SIZE (expire));
  if (global_nasl_debug == 1)
    {
      if (type == ARG_STRING)
        g_message ("set volatile key %s -> %s", name, (char *) value);
      else if (type == ARG_INT)
        g_message ("set volatile key %s -> %d", name,
                   (int) GPOINTER_TO_SIZE (value));
    }
}

References ARG_INT, ARG_STRING, global_nasl_debug, len, name, and plug_get_kb().

Referenced by plug_set_key_volatile(), and set_kb_item_volatile().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_key_volatile()

void plug_set_key_volatile	(	struct script_infos *	args,
		char *	name,
		int	type,
		const void *	value,
		int	expire )

Set volatile key with expire.

Parameters

args	Script infos.
name	Key name.
type	Key type.
value	Key value.
expire	Key expire in seconds.

Definition at line 1111 of file plugutils.c.

{
  plug_set_key_len_volatile (args, name, type, value, expire, 0);
}

References name, and plug_set_key_len_volatile().

Referenced by set_kb_item_volatile().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_port_transport()

void plug_set_port_transport	(	struct script_infos *	args,
		int	port,
		int	tr )

Todo

Those brain damaged functions should probably be in another file They are use to remember who speaks SSL or not

Definition at line 1383 of file plugutils.c.

{
  char s[256];
 
  snprintf (s, sizeof (s), "Transports/TCP/%d", port);
  plug_set_key (args, s, ARG_INT, GSIZE_TO_POINTER (tr));
}

References ARG_INT, and plug_set_key().

Referenced by open_stream_auto_encaps_ext(), and plugin_do_run().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_ssl_CA_file()

void plug_set_ssl_CA_file	(	struct script_infos *	args,
		char *	key )

Todo

Also, all plug_set_ssl*-functions set values that are only accessed in network.c:open_stream_connection under specific conditions. Check whether these conditions can actually occur. Document the functions on the way.

Definition at line 1442 of file plugutils.c.

{
  plug_set_ssl_item (args, "CA", key);
}

References plug_set_ssl_item().

Referenced by plugin_run_find_service().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_ssl_cert()

void plug_set_ssl_cert	(	struct script_infos *	args,
		char *	cert )

Definition at line 1420 of file plugutils.c.

{
  plug_set_ssl_item (args, "cert", cert);
}

References plug_set_ssl_item().

Referenced by plugin_run_find_service().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_ssl_item()

void plug_set_ssl_item ( struct script_infos * args, char * item, char * itemfname )

static

Definition at line 1412 of file plugutils.c.

{
  char s[256];
  snprintf (s, sizeof (s), "SSL/%s", item);
  plug_set_key (args, s, ARG_STRING, itemfname);
}

References ARG_STRING, and plug_set_key().

Referenced by plug_set_ssl_CA_file(), plug_set_ssl_cert(), plug_set_ssl_key(), and plug_set_ssl_pem_password().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_ssl_key()

void plug_set_ssl_key	(	struct script_infos *	args,
		char *	key )

Definition at line 1426 of file plugutils.c.

{
  plug_set_ssl_item (args, "key", key);
}

References plug_set_ssl_item().

Referenced by plugin_run_find_service().

Here is the call graph for this function:

Here is the caller graph for this function:

plug_set_ssl_pem_password()

void plug_set_ssl_pem_password	(	struct script_infos *	args,
		char *	key )

Definition at line 1432 of file plugutils.c.

{
  plug_set_ssl_item (args, "password", key);
}

References plug_set_ssl_item().

Referenced by plugin_run_find_service().

Here is the call graph for this function:

Here is the caller graph for this function:

post_alarm()

void post_alarm	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	action,
		const char *	uri )

Definition at line 774 of file plugutils.c.

{
  proto_post_alarm (oid, desc, port, "tcp", action, uri);
}

References oid, and proto_post_alarm().

Referenced by mark_fssniffer(), mark_netbus_server(), mark_sub7_server(), mark_wild_shell(), and security_message().

Here is the call graph for this function:

Here is the caller graph for this function:

post_error()

void post_error	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	action,
		const char *	uri )

Definition at line 818 of file plugutils.c.

{
  proto_post_error (oid, desc, port, "tcp", action, uri);
}

References oid, and proto_post_error().

Referenced by error_message2().

Here is the call graph for this function:

Here is the caller graph for this function:

post_log()

void post_log	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	action )

Post a log message about a tcp port.

Definition at line 794 of file plugutils.c.

{
  proto_post_log (oid, desc, port, "tcp", action, NULL);
}

References oid, and proto_post_log().

Referenced by mark_acap_server(), mark_adsgone(), mark_auth_server(), mark_avotus_mm_server(), mark_BitTorrent_server(), mark_chargen_server(), mark_citrix_server(), mark_cvslockserver(), mark_cvspserver(), mark_cvsupserver(), mark_dameware_server(), mark_dictd_server(), mark_direct_connect_hub(), mark_echo_server(), mark_eggdrop_server(), mark_ens_server(), mark_exchg_routing_server(), mark_finger_server(), mark_ftp_server(), mark_fw1(), mark_giop_server(), mark_gnocatan_server(), mark_gnome14_server(), mark_gnuserv(), mark_gopher_server(), mark_http_proxy(), mark_http_server(), mark_imap_server(), mark_interscan_viruswall(), mark_ircxpro_admin_server(), mark_iss_realsecure(), mark_jabber_server(), mark_linuxconf(), mark_LISa_server(), mark_listserv_server(), mark_locked_adsubtract_server(), mark_lpd_server(), mark_lyskom_server(), mark_mldonkey(), mark_mon_server(), mark_mongodb(), mark_msdtc_server(), mark_mysql(), mark_nagiosd_server(), mark_nntp_server(), mark_ofa_express_server(), mark_pblocald_server(), mark_pbmaster_server(), mark_ph_server(), mark_pnsclient(), mark_pop3pw_server(), mark_pop_server(), mark_postgresql(), mark_ppp_daemon(), mark_psybnc(), mark_quicktime_streaming_server(), mark_remote_nc_server(), mark_rmserver(), mark_rsync(), mark_shoutcast_server(), mark_smppd_server(), mark_smtp_server(), mark_smux_server(), mark_snpp_server(), mark_socks_proxy(), mark_spamd_server(), mark_sphinxql(), mark_ssh_server(), mark_stonegate_auth_server(), mark_tcpmux_server(), mark_teamspeak2_server(), mark_telnet_server(), mark_time_server(), mark_unknown_svc(), mark_upsmon_server(), mark_uucp_server(), mark_veritas_backup(), mark_vmware_auth(), mark_vtun_server(), mark_websm_server(), mark_whois_plus2_server(), mark_wrapped_svc(), mark_zebra_server(), and plugin_do_run().

Here is the call graph for this function:

post_log_with_uri()

void post_log_with_uri	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	action,
		const char *	uri )

Post a log message about a tcp port with a uri.

Definition at line 804 of file plugutils.c.

{
  proto_post_log (oid, desc, port, "tcp", action, uri);
}

References oid, and proto_post_log().

Referenced by log_message().

Here is the call graph for this function:

Here is the caller graph for this function:

proto_post_alarm()

void proto_post_alarm	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	proto,
		const char *	action,
		const char *	uri )

Definition at line 767 of file plugutils.c.

{
  proto_post_wrapped (oid, desc, port, proto, action, ALARM, uri);
}

References ALARM, oid, and proto_post_wrapped().

Referenced by post_alarm(), and security_message().

Here is the call graph for this function:

Here is the caller graph for this function:

proto_post_error()

void proto_post_error	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	proto,
		const char *	action,
		const char *	uri )

Definition at line 811 of file plugutils.c.

{
  proto_post_wrapped (oid, desc, port, proto, action, ERRMSG, uri);
}

References ERRMSG, oid, and proto_post_wrapped().

Referenced by error_message2(), and post_error().

Here is the call graph for this function:

Here is the caller graph for this function:

proto_post_log()

void proto_post_log	(	const char *	oid,
		struct script_infos *	desc,
		int	port,
		const char *	proto,
		const char *	action,
		const char *	uri )

Post a log message.

Definition at line 784 of file plugutils.c.

{
  proto_post_wrapped (oid, desc, port, proto, action, LOG, uri);
}

References LOG, oid, and proto_post_wrapped().

Referenced by log_message(), post_log(), and post_log_with_uri().

Here is the call graph for this function:

Here is the caller graph for this function:

proto_post_wrapped()

void proto_post_wrapped ( const char * oid, struct script_infos * desc, int port, const char * proto, const char * action, msg_t msg_type, const char * uri )

static

Post a security message (e.g. LOG, NOTE, WARNING ...).

Parameters

oid	The oid of the NVT
desc	The script infos where to get settings.
port	Port number related to the issue.
proto	Protocol related to the issue (tcp or udp).
action	The actual result text
msg_type	The message type.
uri	Location like file path or webservice URL.

Definition at line 709 of file plugutils.c.

{
  const char *hostname = "";
  char *buffer, *data, port_s[16] = "general";
  char ip_str[INET6_ADDRSTRLEN];
  GError *err = NULL;
  GString *action_str;
  gsize length;
 
  /* Should not happen, just to avoid trouble stop here if no NVTI found */
  if (!oid)
    return;
 
  if (action == NULL)
    action_str = g_string_new ("");
  else
    {
      action_str = g_string_new (action);
      g_string_append (action_str, "\n");
    }
 
  if (port > 0)
    snprintf (port_s, sizeof (port_s), "%d", port);
  if (current_vhost)
    hostname = current_vhost->value;
  else if (desc->vhosts)
    hostname = ((gvm_vhost_t *) desc->vhosts->data)->value;
  addr6_to_str (plug_get_host_ip (desc), ip_str);
  buffer = g_strdup_printf ("%s|||%s|||%s|||%s/%s|||%s|||%s|||%s",
                            msg_type_to_str (msg_type), ip_str,
                            hostname ? hostname : " ", port_s, proto, oid,
                            action_str->str, uri ? uri : "");
 
  /* Convert to UTF-8 before sending to Manager only if necessary. */
  if (is_utf8_encoded (desc->name) > 0)
    data = g_strdup (buffer);
  else
    data = g_convert (buffer, -1, "UTF-8", "ISO_8859-1", NULL, &length, &err);
 
  if (!data)
    {
      g_warning ("%s: Error converting to UTF-8: %s\nOriginal string: %s",
                 __func__, err ? err->message: "", buffer);
      g_free (buffer);
      g_string_free (action_str, TRUE);
      return;
    }
 
  kb_item_push_str_with_main_kb_check (get_main_kb (), "internal/results",
                                       data);
  g_free (data);
  g_free (buffer);
  g_string_free (action_str, TRUE);
}

References current_vhost, get_main_kb(), hostname, is_utf8_encoded(), kb_item_push_str_with_main_kb_check(), length, msg_type_to_str(), script_infos::name, oid, plug_get_host_ip(), and script_infos::vhosts.

Referenced by proto_post_alarm(), proto_post_error(), and proto_post_log().

Here is the call graph for this function:

Here is the caller graph for this function:

scanner_add_port()

void scanner_add_port	(	struct script_infos *	args,
		int	port,
		char *	proto )

Definition at line 1151 of file plugutils.c.

{
  host_add_port_proto (args, port, proto);
}

References host_add_port_proto().

Referenced by banner_grab(), nasl_scanner_add_port(), sendpacket(), and v6_sendpacket().

Here is the call graph for this function:

Here is the caller graph for this function:

sig_n()

void sig_n ( int signo, void(* fnc )(int) )

static

Definition at line 1172 of file plugutils.c.

{
  struct sigaction sa;
 
  sa.sa_handler = fnc;
  sa.sa_flags = 0;
  sigemptyset (&sa.sa_mask);
  sigaction (signo, &sa, (struct sigaction *) 0);
}

Referenced by plug_fork_child(), and plug_get_key().

Here is the caller graph for this function:

unscanned_ports_as_closed()

int unscanned_ports_as_closed ( port_protocol_t ptype )

static

Report state of preferences "unscanned_closed".

Returns

0 if pref is "yes", 1 otherwise.

Definition at line 137 of file plugutils.c.

{
  if (ptype == PORT_PROTOCOL_UDP)
    return (prefs_get_bool ("unscanned_closed_udp") ? 0 : 1);
 
  return (prefs_get_bool ("unscanned_closed") ? 0 : 1);
}

Referenced by kb_get_port_state_proto().

Here is the caller graph for this function:

Variable Documentation

current_vhost

gvm_vhost_t* current_vhost = NULL

Definition at line 89 of file plugutils.c.

Referenced by plug_current_vhost(), plug_get_host_fqdn(), plug_get_host_source(), and proto_post_wrapped().

global_nasl_debug

int global_nasl_debug = 0

Definition at line 39 of file plugutils.c.

Referenced by main(), plug_replace_key_len(), plug_set_key_len(), and plug_set_key_len_volatile().

kb_usage

size_t kb_usage = 0

static

Definition at line 42 of file plugutils.c.

Referenced by add_kb_usage().

max_kb_usage

size_t max_kb_usage

static

Definition at line 44 of file plugutils.c.

Referenced by add_kb_usage(), and init_kb_usage().