nasl.h File Reference

#include "../misc/scanneraux.h"
#include <glib.h>

Include dependency graph for nasl.h:

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

Go to the source code of this file.

Macros
#define	NASL_EXEC_DESCR   (1 << 0)
#define	NASL_EXEC_PARSE_ONLY   (1 << 1)
#define	NASL_ALWAYS_SIGNED   (1 << 2)
#define	NASL_COMMAND_LINE   (1 << 3)
#define	NASL_LINT   (1 << 4)
#define	NASL_ERR_NOERR   0
#define	NASL_ERR_ETIMEDOUT   1
#define	NASL_ERR_ECONNRESET   2
#define	NASL_ERR_EUNREACH   3
#define	NASL_ERR_EUNKNOWN   99

Functions
int	nasl_verify_signature (const char *filename)
char *	nasl_extract_signature_fprs (const char *filename)
GSList *	nasl_get_all_certificates (void)
int	add_nasl_inc_dir (const char *)
	Adds the given string as directory for searching for includes.
void	nasl_clean_inc (void)
int	exec_nasl_script (struct script_infos *, int)
	Execute a NASL script.
char *	nasl_version (void)
pid_t	nasl_server_start (char *, char *)
void	nasl_server_recompile (char *, char *)

Macro Definition Documentation

NASL_ALWAYS_SIGNED

#define NASL_ALWAYS_SIGNED   (1 << 2)

Definition at line 47 of file nasl.h.

Referenced by exec_nasl_script(), main(), nasl_file_check(), nasl_plugin_add(), nasl_thread(), and parse_script_infos().

NASL_COMMAND_LINE

#define NASL_COMMAND_LINE   (1 << 3)

Definition at line 48 of file nasl.h.

Referenced by exec_nasl_script(), and main().

NASL_ERR_ECONNRESET

#define NASL_ERR_ECONNRESET   2

Definition at line 53 of file nasl.h.

Referenced by nasl_socket_get_error().

NASL_ERR_ETIMEDOUT

#define NASL_ERR_ETIMEDOUT   1

Definition at line 52 of file nasl.h.

Referenced by nasl_socket_get_error().

NASL_ERR_EUNKNOWN

#define NASL_ERR_EUNKNOWN   99

Definition at line 55 of file nasl.h.

NASL_ERR_EUNREACH

#define NASL_ERR_EUNREACH   3

Definition at line 54 of file nasl.h.

Referenced by nasl_socket_get_error().

NASL_ERR_NOERR

#define NASL_ERR_NOERR   0

Definition at line 51 of file nasl.h.

Referenced by nasl_socket_get_error().

NASL_EXEC_DESCR

#define NASL_EXEC_DESCR   (1 << 0)

Definition at line 45 of file nasl.h.

Referenced by exec_nasl_script(), main(), nasl_file_check(), nasl_plugin_add(), and parse_script_infos().

NASL_EXEC_PARSE_ONLY

#define NASL_EXEC_PARSE_ONLY   (1 << 1)

Definition at line 46 of file nasl.h.

Referenced by exec_nasl_script(), and main().

NASL_LINT

#define NASL_LINT   (1 << 4)

Definition at line 49 of file nasl.h.

Referenced by exec_nasl_script(), and main().

Function Documentation

add_nasl_inc_dir()

int add_nasl_inc_dir

(

const char *

dir

)

Adds the given string as directory for searching for includes.

Parameters

dir	A directory path. This function will add a copy of this parameter to the list of include folders. This means the parameter can be freed elsewhere without affecting the list.

Returns

0 in case of success. -1 if the stat on the given directory path was unsuccessful. -2 if the given directory path was not a directory.

Definition at line 2536 of file nasl_grammar.tab.c.

{
  if (dir == NULL)
    {
      return 0;
    }
 
  // Allow initialization with empty element
  if (*dir == '\0')
    {
      inc_dirs = g_slist_append (inc_dirs, g_strdup((gchar *)dir));
      return 0;
    }
 
  struct stat stat_buf;
 
  if (stat (dir, &stat_buf) != 0)
    return -1;
 
  if (S_ISDIR(stat_buf.st_mode) != 0)
    {
      inc_dirs = g_slist_append (inc_dirs, g_strdup((gchar *)dir));
      return 0;
    }
  else
    return -2;
}

References inc_dirs.

Referenced by include_dirs(), init_nasl_ctx(), and main().

Here is the caller graph for this function:

exec_nasl_script()

int exec_nasl_script	(	struct script_infos *	script_infos,
		int	mode )

Execute a NASL script.

"mode" is a bit field: bit #0 (1) is "description" Bit #1 (2) is "parse only"

Parameters

script_infos

The plugin script_infos. #param mode Flags for different execution modes (Description, parse-only, always-signed, command-line, lint)

Returns

0 if the script was executed successfully, negative values if an error occurred. Return number of errors if mode is NASL_LINT and no none linting errors occurred.

Definition at line 1614 of file exec.c.

{
  naslctxt ctx;
  nasl_func *pf;
  int err = 0, to;
  tree_cell *ret;
  lex_ctxt *lexic;
  gchar *old_dir;
  gchar *newdir;
  tree_cell tc;
  const char *str, *name = script_infos->name, *oid = script_infos->oid;
  gchar *short_name = g_path_get_basename (name);
  int error_counter = 0;
 
  nasl_set_plugin_filename (short_name);
  g_free (short_name);
 
  srand48 (getpid () + getppid () + (long) time (NULL));
 
  old_dir = g_get_current_dir ();
 
  newdir = g_path_get_dirname (name);
 
  if (g_chdir (newdir) != 0)
    {
      g_message ("%s: Not able to change working directory to %s (%d [%s]).",
                 __func__, newdir, errno, strerror (errno));
      g_free (old_dir);
      g_free (newdir);
      return -1;
    }
  g_free (newdir);
 
  bzero (&ctx, sizeof (ctx));
  if (mode & NASL_ALWAYS_SIGNED)
    ctx.always_signed = 1;
  if ((mode & NASL_EXEC_DESCR) != 0)
    ctx.exec_descr = 1;
  if (nvticache_initialized ())
    ctx.kb = nvticache_get_kb ();
  else
    ctx.kb = plug_get_kb (script_infos);
 
  if (init_nasl_ctx (&ctx, NULL, name) == 0)
    {
      err = naslparse (&ctx, &error_counter);
      if (err != 0 || error_counter > 0)
        {
          g_message ("%s. There were %d parse errors.", name, error_counter);
          nasl_clean_ctx (&ctx);
          g_chdir (old_dir);
          g_free (old_dir);
          return -1;
        }
    }
  else
    {
      g_chdir (old_dir);
      g_free (old_dir);
      return -1;
    }
 
  lexic = init_empty_lex_ctxt ();
  lexic->script_infos = script_infos;
  lexic->oid = oid;
  nasl_set_filename (name);
 
  str = prefs_get ("checks_read_timeout");
  if (str != NULL)
    to = atoi (str);
  else
    to = 5;
 
  if (to <= 0)
    to = 5;
 
  lexic->recv_timeout = to;
 
  if (mode & NASL_LINT)
    {
      /* ret is set to the number of errors the linter finds.
      ret will be overwritten with -1 if any errors occur in the steps
      after linting so we do not break other behaviour dependent on a
      negative return value when doing more than just linting. */
      tree_cell *lintret = nasl_lint (lexic, ctx.tree);
      if (lintret == NULL)
        err--;
      else if (lintret != FAKE_CELL && lintret->x.i_val > 0)
        {
          err = lintret->x.i_val;
          g_free (lintret);
        }
    }
  else if (!(mode & NASL_EXEC_PARSE_ONLY))
    {
      char *p;
 
      bzero (&tc, sizeof (tc));
      tc.type = CONST_INT;
      tc.x.i_val = (mode & NASL_COMMAND_LINE) != 0;
      add_named_var_to_ctxt (lexic, "COMMAND_LINE", &tc);
 
      bzero (&tc, sizeof (tc));
      tc.type = CONST_INT;
      tc.x.i_val = (mode & NASL_EXEC_DESCR) != 0;
      add_named_var_to_ctxt (lexic, "description", &tc);
 
      tc.type = CONST_DATA;
      p = strrchr (name, '/');
      if (p == NULL)
        p = (char *) name;
      else
        p++;
      tc.x.str_val = p;
      tc.size = strlen (p);
      add_named_var_to_ctxt (lexic, "SCRIPT_NAME", &tc);
 
      truc = (lex_ctxt *) ctx.tree;
      if ((ret = nasl_exec (lexic, ctx.tree)) == NULL)
        err = -1;
      else
        deref_cell (ret);
 
      if ((pf = get_func_ref_by_name (lexic, "on_exit")) != NULL)
        nasl_func_call (lexic, pf, NULL);
    }
 
  if (g_chdir (old_dir) != 0)
    {
      g_free (old_dir);
      return -1;
    }
  g_free (old_dir);
 
  nasl_clean_ctx (&ctx);
  free_lex_ctxt (lexic);
  return err;
}

References add_named_var_to_ctxt(), naslctxt::always_signed, CONST_DATA, CONST_INT, deref_cell(), naslctxt::exec_descr, FAKE_CELL, free_lex_ctxt(), get_func_ref_by_name(), TC::i_val, init_empty_lex_ctxt(), init_nasl_ctx(), naslctxt::kb, name, script_infos::name, NASL_ALWAYS_SIGNED, nasl_clean_ctx(), NASL_COMMAND_LINE, nasl_exec(), NASL_EXEC_DESCR, NASL_EXEC_PARSE_ONLY, nasl_func_call(), NASL_LINT, nasl_lint(), nasl_set_filename(), nasl_set_plugin_filename(), naslparse(), oid, script_infos::oid, struct_lex_ctxt::oid, plug_get_kb(), struct_lex_ctxt::recv_timeout, struct_lex_ctxt::script_infos, TC::size, TC::str_val, naslctxt::tree, truc, TC::type, and TC::x.

Referenced by main(), nasl_file_check(), nasl_plugin_add(), nasl_thread(), parse_script_infos(), and process_file().

Here is the call graph for this function:

Here is the caller graph for this function:

nasl_clean_inc()

void nasl_clean_inc

(

void

)

Definition at line 2858 of file nasl_grammar.tab.c.

{
 if (!includes_hash)
   return;
 g_hash_table_destroy (includes_hash);
 includes_hash = NULL;
}

References includes_hash.

Referenced by plugins_reload_from_dir().

Here is the caller graph for this function:

nasl_extract_signature_fprs()

char * nasl_extract_signature_fprs

(

const char *

filename

)

nasl_get_all_certificates()

GSList * nasl_get_all_certificates

(

void

)

nasl_server_recompile()

void nasl_server_recompile	(	char *	,
		char *	)

nasl_server_start()

pid_t nasl_server_start	(	char *	,
		char *	)

nasl_verify_signature()

int nasl_verify_signature

(

const char *

filename

)

Referenced by load_checksums().

Here is the caller graph for this function:

nasl_version()

char * nasl_version

(

void

)

Definition at line 571 of file nasl_init.c.

{
  static char vers[sizeof (OPENVASLIB_VERSION) + 1];
  strncpy (vers, OPENVASLIB_VERSION, sizeof (vers) - 1);
  vers[sizeof (vers) - 1] = '\0';
  return vers;
}