nasl_plugins.c File Reference

The nasl - plugin class. Loads or launches nasl- plugins. More...

#include "../misc/kb_cache.h"
#include "../misc/network.h"
#include "../misc/plugutils.h"
#include "../nasl/nasl.h"
#include "pluginlaunch.h"
#include "pluginload.h"
#include "pluginscheduler.h"
#include "processes.h"
#include <bsd/unistd.h>
#include <errno.h>
#include <glib.h>
#include <gvm/base/drop_privileges.h>
#include <gvm/base/networking.h>
#include <gvm/base/prefs.h>
#include <gvm/util/nvticache.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <utime.h>

Include dependency graph for nasl_plugins.c:

Go to the source code of this file.

Macros
#define	G_LOG_DOMAIN   "sd main"
	GLib log domain. More...

Functions
static int	check_nvti (const char *filename, nvti_t *nvt)
	Check that the nvt's data is valid. More...
int	nasl_file_check (const char *folder, const char *filename)
	Check a single .nasl/.inc file. More...
int	nasl_plugin_add (const char *folder, char *filename)
	Add one .nasl plugin to the plugin list. More...
static void	nasl_thread (struct ipc_context *, struct script_infos *)
int	nasl_plugin_launch (struct scan_globals *globals, struct in6_addr *ip, GSList *vhosts, kb_t kb, const char *oid)
	Launch a NASL plugin. More...

Detailed Description

The nasl - plugin class. Loads or launches nasl- plugins.

Definition in file nasl_plugins.c.

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "sd main"

GLib log domain.

Definition at line 40 of file nasl_plugins.c.

Function Documentation

check_nvti()

static int check_nvti ( const char *  filename, nvti_t *  nvt  )

static

Check that the nvt's data is valid.

Parameters

filename	Filename of the NVT.
nvt	NVT to check.

Returns

0 on success, -1 on error.

Definition at line 51 of file nasl_plugins.c.

{
  assert (filename);
  assert (nvt);
 
  if (!nvti_oid (nvt))
    {
      g_warning ("%s: Missing OID", filename);
      return -1;
    }
  else if (!nvti_name (nvt))
    {
      g_warning ("%s: Missing name", filename);
      return -1;
    }
  else if (!nvti_family (nvt))
    {
      g_warning ("%s: Missing family", filename);
      return -1;
    }
  return 0;
}

Referenced by nasl_plugin_add().

Here is the caller graph for this function:

nasl_file_check()

int nasl_file_check	(	const char *	folder,
		const char *	filename
	)

Check a single .nasl/.inc file.

Parameters

folder	Path to the plugin folder.
filename	File-name of the plugin

Returns

0 on success, -1 on error.

Definition at line 83 of file nasl_plugins.c.

{
  char fullname[PATH_MAX + 1];
  int nasl_mode;
  struct script_infos *args;
 
  snprintf (fullname, sizeof (fullname), "%s/%s", folder, filename);
  nasl_mode = NASL_EXEC_DESCR;
  if (prefs_get_bool ("nasl_no_signature_check"))
    nasl_mode |= NASL_ALWAYS_SIGNED;
 
  args = g_malloc0 (sizeof (struct script_infos));
  args->key = nvticache_get_kb ();
  args->nvti = NULL;
  args->name = fullname;
  if (exec_nasl_script (args, nasl_mode) < 0)
    {
      g_debug ("%s: Checksum check failed", fullname);
      g_free (args);
      return -1;
    }
  g_free (args);
 
  return 0;
}

References exec_nasl_script(), script_infos::key, script_infos::name, NASL_ALWAYS_SIGNED, NASL_EXEC_DESCR, and script_infos::nvti.

Referenced by plugins_cache_init().

Here is the call graph for this function:

Here is the caller graph for this function:

nasl_plugin_add()

int nasl_plugin_add	(	const char *	folder,
		char *	filename
	)

Add one .nasl plugin to the plugin list.

It is parsed (via exec_nasl_script) and added to the cache

Parameters

folder	Path to the plugin folder.
filename	File-name of the plugin

Returns

0 on success, -1 on error.

Definition at line 120 of file nasl_plugins.c.

{
  char fullname[PATH_MAX + 1];
  int nasl_mode;
  nvti_t *new_nvti;
  struct script_infos *args;
  time_t now;
  struct utimbuf updated_timestamp;
 
  snprintf (fullname, sizeof (fullname), "%s/%s", folder, filename);
  nasl_mode = NASL_EXEC_DESCR;
  if (prefs_get_bool ("nasl_no_signature_check"))
    nasl_mode |= NASL_ALWAYS_SIGNED;
 
  args = g_malloc0 (sizeof (struct script_infos));
  args->key = nvticache_get_kb ();
  new_nvti = nvti_new ();
  args->nvti = new_nvti;
  args->name = fullname;
  if (exec_nasl_script (args, nasl_mode) < 0)
    {
      g_debug ("%s: Could not be loaded", fullname);
      g_free (args);
      return -1;
    }
  g_free (args);
 
  now = time (NULL) - 1;
  updated_timestamp.actime = now;
  updated_timestamp.modtime = now;
  utime (fullname, &updated_timestamp);
 
  if (!check_nvti (filename, new_nvti))
    nvticache_add (new_nvti, filename);
  nvti_free (new_nvti);
 
  return 0;
}

References check_nvti(), exec_nasl_script(), script_infos::key, script_infos::name, NASL_ALWAYS_SIGNED, NASL_EXEC_DESCR, and script_infos::nvti.

Referenced by plugins_reload_from_dir().

Here is the call graph for this function:

Here is the caller graph for this function:

nasl_plugin_launch()

int nasl_plugin_launch	(	struct scan_globals *	globals,
		struct in6_addr *	ip,
		GSList *	vhosts,
		kb_t	kb,
		const char *	oid
	)

Launch a NASL plugin.

Definition at line 166 of file nasl_plugins.c.

{
  int module;
  struct script_infos infos;
 
  memset (&infos, '\0', sizeof (infos));
  // extend here, maybe create struct to simplify calls
  infos.ip = ip;
  infos.vhosts = vhosts;
  infos.globals = globals;
  infos.key = kb;
  infos.oid = (char *) oid;
  infos.name = nvticache_get_src (oid);
  infos.ipc_context = NULL;
 
  module = create_ipc_process ((ipc_process_func) nasl_thread, &infos);
  g_free (infos.name);
  return module;
}

References create_ipc_process(), script_infos::globals, script_infos::ip, script_infos::ipc_context, script_infos::key, script_infos::name, nasl_thread(), script_infos::oid, oid, and script_infos::vhosts.

Referenced by plugin_launch().

Here is the call graph for this function:

Here is the caller graph for this function:

nasl_thread()

static void nasl_thread ( struct ipc_context *  ipcc, struct script_infos *  args  )

static

Definition at line 188 of file nasl_plugins.c.

{
  char ip_str[INET6_ADDRSTRLEN];
  int nasl_mode = 0;
  kb_t kb;
  GError *error = NULL;
  args->ipc_context = ipcc;
 
  /* Make plugin process a group leader, to make it easier to cleanup forked
   * processes & their children. */
  setpgid (0, 0);
  nvticache_reset ();
  kb = args->key;
  kb_lnk_reset (kb);
  kb_lnk_reset (get_main_kb ());
  addr6_to_str (args->ip, ip_str);
  // TODO extend sript_infos here
 
  setproctitle ("openvas: testing %s (%s)", ip_str,
                g_path_get_basename (args->name));
 
  if (prefs_get_bool ("nasl_no_signature_check"))
    nasl_mode |= NASL_ALWAYS_SIGNED;
 
  if (prefs_get_bool ("drop_privileges"))
    {
      int drop_priv_res = drop_privileges (NULL, &error);
      if (drop_priv_res != GVM_DROP_PRIVILEGES_OK)
        {
          if (drop_priv_res != GVM_DROP_PRIVILEGES_FAIL_NOT_ROOT)
            g_debug ("Failed to drop privileges for %s", args->name);
          g_error_free (error);
        }
    }
 
  if (exec_nasl_script (args, nasl_mode))
    g_debug ("exec_nasl_script: %s error", args->name);
}

References exec_nasl_script(), get_main_kb(), script_infos::ip, script_infos::ipc_context, ipcc, script_infos::key, script_infos::name, and NASL_ALWAYS_SIGNED.

Referenced by nasl_plugin_launch().

Here is the call graph for this function:

Here is the caller graph for this function: