plugs_req.h File Reference

#include <openvas/base/kb.h>
#include <openvas/misc/arglists.h>

Include dependency graph for plugs_req.h:

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

Go to the source code of this file.

Functions
char *	requirements_plugin (kb_t, struct scheduler_plugin *)
	Determine if the plugin requirements are met. More...
int	mandatory_requirements_met (kb_t, struct scheduler_plugin *)
	Check whether mandatory requirements for plugin are met. More...
struct arglist *	requirements_common_ports (struct scheduler_plugin *, struct scheduler_plugin *)
	Returns <port> if the lists of the required ports between. More...

Function Documentation

mandatory_requirements_met()

int mandatory_requirements_met	(	kb_t	kb,
		struct scheduler_plugin *	plugin
	)

Check whether mandatory requirements for plugin are met.

Parameters

kb	The arglist knowledge base with all keys.
plugin	The arglist plugin.

Returns

1 if all mandatory requirements for the plugin are met. 0 if it is not the case.

Definition at line 299 of file plugs_req.c.

References scheduler_plugin::oid.

{
  char *mandatory_keys;
  int ret;

  mandatory_keys = nvticache_get_mandatory_keys (plugin->oid);
  ret = check_mandatory_keys (kb, mandatory_keys);

  g_free (mandatory_keys);
  if (ret)
    return 0;
  return 1;
}

requirements_common_ports()

struct arglist* requirements_common_ports	(	struct scheduler_plugin *	plugin1,
		struct scheduler_plugin *	plugin2
	)

Returns <port> if the lists of the required ports between.

plugin 1 and plugin 2 have at least one port in common.

Definition at line 95 of file plugs_req.c.

References scheduler_plugin::oid.

{
  struct arglist *ret = NULL;
  int i, j;
  char *ports1, *ports2, **array1, **array2;

  if (!plugin1 || !plugin2)
    return 0;

  ports1 = nvticache_get_required_ports (plugin1->oid);
  ports2 = nvticache_get_required_ports (plugin2->oid);
  if (!ports1 || !ports2)
    {
      g_free (ports1);
      g_free (ports2);
      return 0;
    }
  array1 = g_strsplit (ports1, ", ", 0);
  array2 = g_strsplit (ports2, ", ", 0);
  g_free (ports1);
  g_free (ports2);
  if (!array1 || !array2)
    {
      g_strfreev (array1);
      g_strfreev (array2);
      return 0;
    }

  for (i = 0; array1[i] != NULL; i ++)
    {
      for (j = 0; array2[j] != NULL; j ++)
        {
           if (!strcmp (array2[j], array1[i]))
             {
               if (!ret)
                 ret = g_malloc0 (sizeof (struct arglist));
               arg_add_value (ret, array2[j], ARG_INT, (void *) 1);
             }
        }
    }
  g_strfreev (array1);
  g_strfreev (array2);
  return ret;
}

requirements_plugin()

char* requirements_plugin	(	kb_t	kb,
		struct scheduler_plugin *	plugin
	)

Determine if the plugin requirements are met.

Returns

Returns NULL is everything is ok, else an error message.

Definition at line 320 of file plugs_req.c.

References scheduler_plugin::oid.

{
  static char error[64];
  char *errkey = NULL, *keys, *tcp, *udp;
  const char *opti = prefs_get ("optimization_level");

  /*
   * Check wether the good ports are open
   */
  error[sizeof (error) - 1] = '\0';
  tcp = nvticache_get_required_ports (plugin->oid);
  if (tcp && *tcp && (get_closed_ports (kb, tcp, "tcp")) == 0)
    {
      strncpy (error, "none of the required tcp ports are open",
               sizeof (error) - 1);
      g_free (tcp);
      return error;
    }
  g_free (tcp);

  udp = nvticache_get_required_udp_ports (plugin->oid);
  if (udp && *udp && (get_closed_ports (kb, udp, "udp")) == 0)
    {
      strncpy (error, "none of the required udp ports are open",
               sizeof (error) - 1);
      g_free (udp);
      return error;
    }
  g_free (udp);

  if (opti != NULL && (strcmp (opti, "open_ports") == 0 || atoi (opti) == 1))
    return NULL;

  /*
   * Check wether a key we wanted is missing
   */
  keys = nvticache_get_required_keys (plugin->oid);
  if (kb_missing_keyname_of_namelist (kb, keys, &errkey))
    {
      snprintf (error, sizeof (error), "because the key %s is missing", errkey);
      g_free (errkey);
      g_free (keys);
      return error;
    }
  g_free (keys);

  if (opti != NULL && (strcmp (opti, "required_keys") == 0 || atoi (opti) == 2))
    return NULL;

  /*
   * Check wether a key we do not want is present
   */
  keys = nvticache_get_excluded_keys (plugin->oid);
  if (kb_present_keyname_of_namelist (kb, keys, &errkey))
    {
      snprintf (error, sizeof (error), "because the key %s is present", errkey);
      g_free (errkey);
      g_free (keys);
      return error;
    }
  g_free (keys);
  return NULL;
}