utils.h File Reference

utils.c headerfile. More...

#include "../misc/scanneraux.h"
#include <sys/types.h>

Include dependency graph for utils.h:

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

Go to the source code of this file.

Functions
int	get_max_hosts_number (void)
int	get_max_checks_number (void)
int	process_alive (pid_t)
int	data_left (int)
void	wait_for_children1 (void)
int	is_scanner_only_pref (const char *)
int	store_file (struct scan_globals *globals, const char *file, const char *file_hash)
	Stores a file type preference in a hash table.
int	check_host_still_alive (kb_t, const char *)
	Check if the hosts is still alive and set it as dead if not.
void	write_script_stats (const char *, const char *, int)
	Writes scripts stats into a file.
void	write_host_stats (kb_t, const char *, const char *)
	Reads the script stats from the kb and generate a string in json format to be stored in the disk.

Detailed Description

utils.c headerfile.

Definition in file utils.h.

Function Documentation

check_host_still_alive()

int check_host_still_alive	(	kb_t	kb,
		const char *	hostname )

Check if the hosts is still alive and set it as dead if not.

Parameters

kb	Host kb where the host is set as dead.

Returns

1 if considered alive, 0 if it is dead. -1 on error or option disabled.

Definition at line 33 of file heartbeat.c.

{
  int is_alive = 0;
  boreas_error_t alive_err;
 
  /* Heartbeat will work only with boreas enabled. We check if we
     have all what we need before running a heartbeat check. */
  if (prefs_get_bool ("test_alive_hosts_only"))
    {
      const gchar *alive_test_str = prefs_get ("ALIVE_TEST");
 
      /* Don't perform a hearbeat check if the host is always considered
         alive or the alive test is not valid. */
      if (!(alive_test_str
            && atoi (alive_test_str) >= ALIVE_TEST_TCP_ACK_SERVICE
            && atoi (alive_test_str) < 32 // max value for alive test combi.
            && !((atoi (alive_test_str)) & ALIVE_TEST_CONSIDER_ALIVE)))
        return -1;
    }
  else
    {
      g_warning ("%s: Trying to perform an alive test, but Boreas is not "
                 "enabled. Heartbeat check for %s will not be performed",
                 __func__, hostname);
      return -1;
    }
 
  alive_err = is_host_alive (hostname, &is_alive);
  if (alive_err)
    {
      g_warning ("%s: Heartbeat check failed for %s with error %d.", __func__,
                 hostname, alive_err);
      return -1;
    }
 
  if (is_alive == 0)
    {
      g_message ("%s: Heartbeat check was not successful. The host %s has"
                 " been set as dead.",
                 __func__, hostname);
      kb_item_set_int_with_main_kb_check (kb, "Host/dead", 1);
      return 0;
    }
 
  return 1;
}

References hostname, and kb_item_set_int_with_main_kb_check().

Referenced by nasl_end_denial(), and update_running_processes().

Here is the call graph for this function:

Here is the caller graph for this function:

data_left()

int data_left

(

int

soc

)

Definition at line 211 of file utils.c.

{
  int data = 0;
  ioctl (soc, FIONREAD, &data);
  return data;
}

get_max_checks_number()

int get_max_checks_number

(

void

)

Get the max number of plugins to launch against the remote host at the same time

Definition at line 168 of file utils.c.

{
  int max_checks;
  if (prefs_get ("max_checks"))
    {
      max_checks = atoi (prefs_get ("max_checks"));
      if (max_checks <= 0)
        {
          g_debug ("Error ! max_hosts = %d -- check %s", max_checks,
                   (char *) prefs_get ("config_file"));
          max_checks = global_max_checks;
        }
      else if (max_checks > global_max_checks)
        {
          g_debug ("Client tried to raise the maximum checks number - %d."
                   " Using %d. Change 'max_checks' in openvas.conf if you"
                   " believe this is incorrect",
                   max_checks, global_max_checks);
          max_checks = global_max_checks;
        }
    }
  else
    max_checks = global_max_checks;
  return (max_checks);
}

References global_max_checks.

Referenced by attack_network(), and pluginlaunch_init().

Here is the caller graph for this function:

get_max_hosts_number()

int get_max_hosts_number

(

void

)

Get the max number of hosts to test at the same time.

Definition at line 137 of file utils.c.

{
  int max_hosts;
  if (prefs_get ("max_hosts"))
    {
      max_hosts = atoi (prefs_get ("max_hosts"));
      if (max_hosts <= 0)
        {
          g_debug ("Error ! max_hosts = %d -- check %s", max_hosts,
                   (char *) prefs_get ("config_file"));
          max_hosts = global_max_hosts;
        }
      else if (max_hosts > global_max_hosts)
        {
          g_debug ("Client tried to raise the maximum hosts number - %d."
                   " Using %d. Change 'max_hosts' in openvas.conf if you"
                   " believe this is incorrect",
                   max_hosts, global_max_hosts);
          max_hosts = global_max_hosts;
        }
    }
  else
    max_hosts = global_max_hosts;
  return (max_hosts);
}

References global_max_hosts.

Referenced by attack_network().

Here is the caller graph for this function:

is_scanner_only_pref()

int is_scanner_only_pref

(

const char *

pref

)

Definition at line 238 of file utils.c.

{
  if (pref == NULL)
    return 0;
  if (!strcmp (pref, "config_file") || !strcmp (pref, "plugins_folder")
      || !strcmp (
        pref,
        "kb_location") // old name of db_address, ignore from old conf's
      || !strcmp (pref, "db_address") || !strcmp (pref, "negot_timeout")
      || !strcmp (pref, "force_pubkey_auth")
      || !strcmp (pref, "log_whole_attack")
      || !strcmp (pref, "log_plugins_name_at_load")
      || !strcmp (pref, "nasl_no_signature_check")
      || !strcmp (pref, "vendor_version") || !strcmp (pref, "drop_privileges")
      || !strcmp (pref, "nasl_drop_privileges_user")
      || !strcmp (pref, "debug_tls") || !strcmp (pref, "min_free_mem")
      || !strcmp (pref, "max_sysload")
      /* Preferences starting with sys_ are scanner-side only. */
      || !strncmp (pref, "sys_", 4))
    return 1;
  return 0;
}

Referenced by overwrite_openvas_prefs_with_prefs_from_client().

Here is the caller graph for this function:

process_alive()

int process_alive

(

pid_t

pid

)

Determines if a process is alive - as reliably as we can

Definition at line 198 of file utils.c.

{
  int i, ret;
  if (pid == 0)
    return 0;
 
  for (i = 0, ret = 1; (i < 10) && (ret > 0); i++)
    ret = waitpid (pid, NULL, WNOHANG);
 
  return kill (pid, 0) == 0;
}

References pid.

Referenced by attack_host(), next_free_process(), and update_running_processes().

Here is the caller graph for this function:

store_file()

int store_file	(	struct scan_globals *	globals,
		const char *	file,
		const char *	file_hash )

Stores a file type preference in a hash table.

Parameters

globals	Global struct.
file	File content.
file_hash	hash to reference the file.

Returns

0 if successful, -1 in case of errors.

Definition at line 104 of file utils.c.

{
  char *origname;
  gchar *contents = NULL;
 
  size_t bytes = 0;
 
  if (!file_hash || *file_hash == '\0')
    return -1;
 
  origname = g_strdup (file_hash);
 
  contents = (gchar *) g_base64_decode (file, &bytes);
 
  if (contents == NULL)
    {
      g_debug ("store_file: Failed to allocate memory for uploaded file.");
      g_free (origname);
      return -1;
    }
 
  files_add_translation (globals, origname, contents);
  files_add_size_translation (globals, origname, bytes);
 
  g_free (origname);
  return 0;
}

References files_add_size_translation(), and files_add_translation().

Referenced by overwrite_openvas_prefs_with_prefs_from_client().

Here is the call graph for this function:

Here is the caller graph for this function:

wait_for_children1()

void wait_for_children1

(

void

)

Definition at line 219 of file utils.c.

{
  int e, n = 0;
  do
    {
      errno = 0;
      e = waitpid (-1, NULL, WNOHANG);
      n++;
    }
  while ((e > 0 || errno == EINTR) && n < 20);
}

write_host_stats()

void write_host_stats	(	kb_t	kb,
		const char *	scan_id,
		const char *	ip )

Reads the script stats from the kb and generate a string in json format to be stored in the disk.

Parameters

kb	the host knowledge base to get the information from.
scan_id	Scan ID for the file name.
ip	target IP address.

Definition at line 308 of file utils.c.

{
  GString *data = g_string_new ("");
  struct kb_item *stats = NULL, *stats_tmp = NULL;
  int firstvt = 1;
  char *path = NULL;
 
  if (!prefs_get ("report_scripts"))
    return;
 
  stats = kb_item_get_pattern (kb, "general/script_stats*");
  stats_tmp = stats;
 
  g_string_append_printf (data, "\"%s\": [", ip);
  while (stats_tmp)
    {
      char **spl = g_strsplit (stats_tmp->v_str, "/", 0);
      char *buf = NULL;
 
      if (!firstvt)
        g_string_append_c (data, ',');
 
      buf = g_strdup_printf ("{\"%s\": {\"start\": %s, \"stop\": %s}}", spl[0],
                             spl[1], spl[2]);
 
      g_string_append (data, buf);
      g_strfreev (spl);
      g_free (buf);
 
      stats_tmp = stats_tmp->next;
      if (firstvt)
        firstvt = 0;
    }
  g_string_append (data, "],");
 
  path =
    g_strdup_printf ("%s/%s-stats.json", prefs_get ("report_scripts"), scan_id);
 
  kb_item_free (stats);
  write_script_stats (data->str, path, 0);
  g_free (path);
  g_string_free (data, TRUE);
}

References scan_id, and write_script_stats().

Referenced by attack_host().

Here is the call graph for this function:

Here is the caller graph for this function:

write_script_stats()

void write_script_stats	(	const char *	buf,
		const char *	path,
		int	mode )

Writes scripts stats into a file.

Parameters

buf	String to write.
path	Path to the file to write into.
mode	2 to create the file, 0 to append text to the file, 1 to finish the json list removing the trailing comma before appending the last text in the buffer.

Definition at line 271 of file utils.c.

{
  FILE *pd = NULL;
 
  if (mode < 0 || mode > 2)
    {
      g_warning ("%s: invalid mode %d", __func__, mode);
      return;
    }
  pd = fopen (path, mode == 0 ? "a" : mode == 1 ? "r+" : "w");
  if (pd == NULL)
    {
      g_warning ("%s: Error opening FILE '%s' for script stats: %d - %s",
                 __func__, path, errno, strerror (errno));
      return;
    }
 
  if (mode == 1)
    {
      int ch;
      while ((ch = fgetc (pd)) != EOF)
        ;
      fseek (pd, -1, SEEK_CUR);
    }
  fprintf (pd, "%s", buf);
  fflush (pd);
  fclose (pd);
}

Referenced by attack_network(), and write_host_stats().

Here is the caller graph for this function: