pluginload.h File Reference

pluginload.c header. More...

#include "../misc/network.h"
#include "../misc/scanneraux.h"
#include <gvm/util/kb.h>

Include dependency graph for pluginload.h:

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

Go to the source code of this file.

Functions
int	plugins_init (void)
	main function for loading all the plugins
int	plugins_cache_init (void)
	Main function for nvticache initialization without loading the plugins.
void	init_loading_shm (void)
void	destroy_loading_shm (void)
int	current_loading_plugins (void)
int	total_loading_plugins (void)
int	nasl_plugin_add (const char *, char *)
	Add one .nasl plugin to the plugin list.
int	nasl_file_check (const char *, const char *)
	Check a single .nasl/.inc file.
int	nasl_plugin_launch (struct scan_globals *, struct in6_addr *, GSList *, kb_t, const char *)
	Launch a NASL plugin.

Detailed Description

pluginload.c header.

Definition in file pluginload.h.

Function Documentation

current_loading_plugins()

int current_loading_plugins

(

void

)

Definition at line 171 of file pluginload.c.

{
  return loading_shm ? loading_shm[0] : 0;
}

References loading_shm.

destroy_loading_shm()

void destroy_loading_shm

(

void

)

Definition at line 153 of file pluginload.c.

{
  if (loading_shm)
    {
      shmdt (loading_shm);
      if (shmctl (loading_shmid, IPC_RMID, NULL))
        perror ("shmctl");
      loading_shm = NULL;
      loading_shmid = 0;
    }
}

References loading_shm, and loading_shmid.

init_loading_shm()

void init_loading_shm

(

void

)

Definition at line 120 of file pluginload.c.

{
  int shm_key;
 
  if (loading_shm)
    return;
 
  shm_key = rand () + 1;
  /*
   * Create shared memory segment if it doesn't exist.
   * This will be used to communicate current plugins loading progress to other
   * processes.
   * loading_shm[0]: Number of loaded plugins.
   * loading_shm[1]: Total number of plugins.
   */
  loading_shmid = shmget (shm_key, sizeof (int) * 2, IPC_CREAT | 0600);
  if (loading_shmid < 0)
    perror ("shmget");
  loading_shm = shmat (loading_shmid, NULL, 0);
  if (loading_shm == (void *) -1)
    {
      perror ("shmat");
      loading_shm = NULL;
    }
  else
    bzero (loading_shm, sizeof (int) * 2);
}

References loading_shm, and loading_shmid.

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 script_infos::globals, script_infos::ip, script_infos::ipc_context, script_infos::key, script_infos::name, oid, script_infos::oid, and script_infos::vhosts.

Referenced by plugin_launch().

Here is the caller graph for this function:

plugins_cache_init()

int plugins_cache_init

(

void

)

Main function for nvticache initialization without loading the plugins.

Returns

0 on success, -1 on failure.

Definition at line 348 of file pluginload.c.

{
  int ret;
  const char *plugins_folder = prefs_get ("plugins_folder");
 
  if (nvticache_init (plugins_folder, prefs_get ("db_address")))
    {
      g_debug ("Failed to initialize nvti cache.");
      return -1;
    }
  include_dirs ();
  ret = nasl_file_check (plugins_folder, "plugin_feed_info.inc");
  if (ret)
    return -1;
 
  return 0;
}

References include_dirs(), and nasl_file_check().

Referenced by attack_network_init(), openvas(), and plugins_init().

Here is the call graph for this function:

Here is the caller graph for this function:

plugins_init()

int plugins_init

(

void

)

main function for loading all the plugins

Returns

0 on success, !=0 on failure.

Definition at line 372 of file pluginload.c.

{
  int ret = 0;
  const char *plugins_folder = prefs_get ("plugins_folder");
 
  ret = plugins_cache_init ();
  if (ret)
    return ret;
 
  ret = plugins_reload_from_dir (plugins_folder);
  nvticache_save ();
  return ret;
}

References plugins_cache_init(), and plugins_reload_from_dir().

Referenced by openvas().

Here is the call graph for this function:

Here is the caller graph for this function:

total_loading_plugins()

int total_loading_plugins

(

void

)

Definition at line 182 of file pluginload.c.

{
  return loading_shm ? loading_shm[1] : 0;
}

References loading_shm.