comm.h File Reference

#include <openvas/misc/arglists.h>

Include dependency graph for comm.h:

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

Go to the source code of this file.

Functions
int	comm_init (int)
	Initializes the communication between the scanner (us) and the client. More...
int	comm_loading (int)
	Informs the client that the scanner is still loading. More...
void	comm_terminate (int)
	This function must be called at the end of a session. More...
void	comm_send_preferences (int)
	Sends the preferences of the scanner. More...
int	comm_wait_order (struct arglist *)
	This function waits for the attack order of the client. Meanwhile, it processes all the messages the client could send. More...
void	comm_send_nvt_info (int)
	Send the OTP NVT_INFO message and then handle any COMPLETE_LIST. More...
void	send_plug_info (int, const char *)
	Sends a plugin info. More...

Function Documentation

comm_init()

int comm_init

(

int

soc

)

Initializes the communication between the scanner (us) and the client.

Returns

0 if success, -1 if error.

Definition at line 57 of file comm.c.

References log_write().

{
  char buf[1024];
  int n;

  /* We must read the version of the OTP the client
     wants us to use */
  n = recv_line (soc, buf, sizeof (buf) - 1);
  if (n <= 0)
    {
      log_write ("Failed reading client-requested OTP version.");
      return -1;
    }

  buf[sizeof (buf) - 1] = '\0';
  if (strncmp (buf, "< OTP/2.0 >", 11))
    {
      log_write ("Unknown client-requested OTP version: %s.", buf);
      return -1;
    }
  nsend (soc, "< OTP/2.0 >\n", 12, 0);
  return 0;
}

Here is the call graph for this function:

comm_loading()

int comm_loading

(

int

soc

)

Informs the client that the scanner is still loading.

Parameters

[in]

soc

Socket to send and receive from.

Returns

0 if success, -1 if error.

Definition at line 89 of file comm.c.

References current_loading_plugins(), log_write(), and total_loading_plugins().

{
  int n, len;
  char buf[256];
  n = recv_line (soc, buf, sizeof (buf) - 1);
  if (n <= 0)
    {
      log_write ("Failed reading client input.");
      return -1;
    }
  /* Always respond with SCANNER_LOADING. */
  g_snprintf (buf, sizeof (buf), "SCANNER_LOADING <|> %d <|> %d\n",
              current_loading_plugins (), total_loading_plugins ());
  len = strlen (buf);
  n = nsend (soc, buf, len, 0);
  if (n != len)
    return -1;
  while (n > 0)
    n = recv_line (soc, buf, sizeof (buf) - 1);

  return 0;
}

Here is the call graph for this function:

comm_send_nvt_info()

void comm_send_nvt_info

(

int

)

Send the OTP NVT_INFO message and then handle any COMPLETE_LIST.

Definition at line 395 of file comm.c.

{
  char buf[2048];
  gchar *feed_version;
  int feed_size = 32;

  feed_version = g_malloc0 (feed_size);
  nvt_feed_version (feed_version, feed_size);

  send_printf (soc, "SERVER <|> NVT_INFO <|> %s <|> SERVER\n",
               is_valid_feed_version (feed_version)
                ? feed_version : "NOVERSION");

  g_free (feed_version);

  for (;;)
    {
      bzero (buf, sizeof (buf));
      recv_line (soc, buf, sizeof (buf) - 1);
      if (strstr (buf, "COMPLETE_LIST"))
        comm_send_pluginlist (soc);
      else
        break;
    }
}

comm_send_preferences()

void comm_send_preferences

(

int

soc

)

Sends the preferences of the scanner.

Parameters

soc	Socket to use for sending.

Definition at line 279 of file comm.c.

References is_scanner_only_pref(), send_plugins_preferences(), and send_printf().

{
  struct arglist *prefs = preferences_get ();

  /* We have to be backward compatible with the NTP/1.0 */
  send_printf (soc, "SERVER <|> PREFERENCES <|>\n");

  while (prefs && prefs->next)
    {
      if (prefs->type == ARG_STRING && !is_scanner_only_pref (prefs->name))
        send_printf (soc, "%s <|> %s\n", prefs->name,
                     (const char *) prefs->value);
      prefs = prefs->next;
    }
  send_plugins_preferences (soc);
  send_printf (soc, "<|> SERVER\n");
}

Here is the call graph for this function:

comm_terminate()

void comm_terminate

(

int

)

This function must be called at the end of a session.

Definition at line 146 of file comm.c.

References send_printf().

{
  send_printf (soc, "SERVER <|> BYE <|> BYE <|> SERVER\n");
  while (is_client_present (soc))
    {
      char buffer[4096];
      int n;

      n = recv_line (soc, buffer, sizeof (buffer) - 1);
      if (n < 0 || *buffer == '\0')
        return;
    }
}

Here is the call graph for this function:

comm_wait_order()

int comm_wait_order

(

struct arglist *

)

This function waits for the attack order of the client. Meanwhile, it processes all the messages the client could send.

Definition at line 303 of file comm.c.

References log_write().

{
  int soc = arg_get_value_int (globals, "global_socket");

  for (;;)
    {
      static char str[2048];
      int n;

      memset (str, '\0', sizeof (str));
      n = recv_line (soc, str, sizeof (str) - 1);
      if (n < 0)
        {
          log_write ("Client closed the communication");
          return -1;
        }
      if (str[0] == '\0')
        if (!is_client_present (soc))
          {
            log_write ("Client not present");
            return -1;
          }

      n = ntp_parse_input (globals, str);
      if (n == 0)
        return 0;
      else if (n == -1)
        {
          log_write ("Client input parsing error: %s", str);
          return -1;
        }
    }
}

Here is the call graph for this function:

send_plug_info()

void send_plug_info	(	int	,
		const char *
	)

Sends a plugin info.

Definition at line 164 of file comm.c.

References log_write(), and send_printf().

Referenced by comm_send_pluginlist().

{
  int category;
  char *name = NULL, *copyright = NULL, *version = NULL, *family = NULL;
  char *cve_id = NULL, *bid = NULL, *xref = NULL, *tag = NULL;

  category = nvticache_get_category (oid);
  if (category >= ACT_UNKNOWN || category < ACT_FIRST)
    category = ACT_UNKNOWN;
  version = nvticache_get_version (oid);
  name = nvticache_get_name (oid);
  if (!name || strchr (name, '\n'))
    {
      log_write ("Erroneous name for plugin %s", oid);
      goto send_cleanup;
    }
  copyright = nvticache_get_copyright (oid);
  if (!copyright || strchr (copyright, '\n'))
    {
      log_write ("Erroneous copyright for plugin %s", oid);
      goto send_cleanup;
    }
  family = nvticache_get_family (oid);
  if (!family)
    {
      log_write ("Missing family for plugin %s", oid);
      goto send_cleanup;
    }

  cve_id = nvticache_get_cves (oid);
  bid = nvticache_get_bids (oid);
  xref = nvticache_get_xrefs (oid);
  tag = nvticache_get_tags (oid);
  if (tag)
    {
      char *index = tag;
      while (*index)
        {
          if (*index == '\n')
            *index = ';';
          index++;
        }
    }

  send_printf
   (soc, "%s <|> %s <|> %d <|> %s <|> %s <|> %s <|> %s <|> %s <|> "
    "%s <|> %s\n", oid, name, category, copyright, family, version,
    (cve_id && *cve_id) ? cve_id : "NOCVE", (bid && *bid) ? bid : "NOBID",
    (xref && *xref) ? xref: "NOXREF", (tag && *tag) ? tag : "NOTAG");

send_cleanup:
  g_free (name);
  g_free (copyright);
  g_free (family);
  g_free (version);
  g_free (cve_id);
  g_free (bid);
  g_free (xref);
  g_free (tag);
}

Here is the call graph for this function:

Here is the caller graph for this function: