nasl-lint.c File Reference

Source of the NASL linter of OpenVAS. More...

#include "lint.h"
#include "nasl.h"
#include <gio/gio.h>
#include <glib.h>
#include <stdio.h>
#include <stdlib.h>

Include dependency graph for nasl-lint.c:

Go to the source code of this file.

Functions
static GDataInputStream *	get_DIS_from_filename (const gchar *filename)
	Returns a GDataInputStream* for a given filepath.
static int	process_file (const gchar *filepath, int mode, struct script_infos *script_args)
	Process a file through the linter.
static int	process_file_list (const gchar *list_file, int mode, struct script_infos *script_args)
	Process each files in the list_file through the linter.
static int	process_files (const gchar **files, int mode, struct script_infos *script_args)
	Process each given files through the linter.
static void	custom_log_handler (const gchar *log_domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data)
	custom log handler
int	main (int argc, char **argv)
	Main of the nasl QA linter.

Detailed Description

Source of the NASL linter of OpenVAS.

Definition in file nasl-lint.c.

Function Documentation

custom_log_handler()

void custom_log_handler ( const gchar * log_domain, GLogLevelFlags log_level, const gchar * message, gpointer user_data )

static

custom log handler

This handler absorb each log_level not present in the log_mask, and forward the other ones to the default handler.

Definition at line 137 of file nasl-lint.c.

{
  gint log_mask = GPOINTER_TO_INT (user_data);
  if ((log_level & log_mask) != 0)
    g_log_default_handler (log_domain, log_level, message, user_data);
}

Referenced by main().

Here is the caller graph for this function:

get_DIS_from_filename()

GDataInputStream * get_DIS_from_filename ( const gchar * filename )

static

Returns a GDataInputStream* for a given filepath.

Parameters

filename

the path to the file to open

Returns

a GDataInputStream corresponding to the filepath

Definition at line 25 of file nasl-lint.c.

{
  GFile *file = NULL;
  GFileInputStream *fis = NULL;
  GDataInputStream *dis = NULL;
  GError *error = NULL;
 
  file = g_file_new_for_path (filename);
  fis = g_file_read (file, NULL, &error);
  if (error != NULL)
    {
      if (fis != NULL)
        g_object_unref (fis);
 
      g_error ("%s\n\n", error->message);
    }
  dis = g_data_input_stream_new (G_INPUT_STREAM (fis));
  g_object_unref (fis);
  return dis;
}

Referenced by process_file_list().

Here is the caller graph for this function:

main()

int main	(	int	argc,
		char **	argv )

Main of the nasl QA linter.

Returns

0 on success

Definition at line 150 of file nasl-lint.c.

{
  int mode = 0;
  int err = 0;
  int fflag = 0;
  static gboolean debug = FALSE;
  static gchar *include_dir = NULL;
  static gchar *nvt_file_list = NULL;
  static unsigned char strict_includes = 0;
  static const gchar **nvt_files = NULL;
  struct script_infos *script_infos = g_malloc0 (sizeof (struct script_infos));
  GError *error = NULL;
  GOptionContext *option_context;
 
  static GOptionEntry entries[] = {
    {"debug", 'd', 0, G_OPTION_ARG_NONE, &debug, "Output debug log messages.",
     NULL},
    {"nvt-list", 'l', 0, G_OPTION_ARG_STRING, &nvt_file_list,
     "Process files from <file>", "<file>"},
    {"include-dir", 'i', 0, G_OPTION_ARG_STRING, &include_dir,
     "Search for includes in <dir>", "<dir>"},
    {G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &nvt_files,
     "Absolute path to one or more nasl scripts", "NASL_FILE..."},
    {"strict-includes", 0, 0, G_OPTION_ARG_NONE, &strict_includes,
     "Enables check for strict include order.", NULL},
    {NULL, 0, 0, 0, NULL, NULL, NULL}};
 
  option_context =
    g_option_context_new ("- standalone NASL linter for OpenVAS");
  g_option_context_add_main_entries (option_context, entries, NULL);
  if (!g_option_context_parse (option_context, &argc, &argv, &error))
    {
      g_error ("%s\n\n", error->message);
    }
  g_option_context_free (option_context);
  fflag |= strict_includes;
  nasl_lint_feature_flags (fflag);
 
  mode |= NASL_COMMAND_LINE;
  /* signing mode */
  mode |= NASL_ALWAYS_SIGNED;
  /* linter on */
  mode |= NASL_LINT;
 
  /* For relative include */
  add_nasl_inc_dir ("");
  /* For absolute include (if given on command line) */
  if (include_dir != NULL)
    add_nasl_inc_dir (include_dir);
 
  if (debug)
    g_log_set_handler (
      NULL, G_LOG_LEVEL_MASK, custom_log_handler,
      GINT_TO_POINTER (G_LOG_LEVEL_DEBUG | G_LOG_LEVEL_INFO
                       | G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_WARNING
                       | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR));
  else
    g_log_set_handler (NULL, G_LOG_LEVEL_MASK, custom_log_handler,
                       GINT_TO_POINTER (G_LOG_LEVEL_WARNING
                                        | G_LOG_LEVEL_CRITICAL
                                        | G_LOG_LEVEL_ERROR));
 
  /* Process the files from the list */
  if (nvt_file_list != NULL)
    err += process_file_list (nvt_file_list, mode, script_infos);
 
  /* process the files from the command line */
  if (nvt_files != NULL)
    err += process_files (nvt_files, mode, script_infos);
 
  g_print ("%d scripts with one or more errors found\n", err);
 
  g_free (script_infos);
 
  return err;
}

References add_nasl_inc_dir(), custom_log_handler(), NASL_ALWAYS_SIGNED, NASL_COMMAND_LINE, NASL_LINT, process_file_list(), and process_files().

Here is the call graph for this function:

process_file()

int process_file ( const gchar * filepath, int mode, struct script_infos * script_args )

static

Process a file through the linter.

Parameters

filepath	the path of the file to be processed
mode,script_args	The parameters to be given to the linter

Returns

0 if no error was found, 1 if errors were found.

Definition at line 53 of file nasl-lint.c.

{
  int ret;
 
  g_debug ("Processing %s", filepath);
  script_args->name = (char *) filepath;
  ret = exec_nasl_script (script_args, mode);
  if (ret != 0)
    {
      // Although there is a technical difference between negative and
      // positive ret value we do not make a distinction in this error message
      // because details are already provided in exec_nasl_script()
      g_print ("%d errors while processing %s.\n", ret == -1 ? 1 : ret,
               filepath);
      return 1;
    }
  return 0;
}

References exec_nasl_script(), and script_infos::name.

Referenced by process_file_list(), and process_files().

Here is the call graph for this function:

Here is the caller graph for this function:

process_file_list()

int process_file_list ( const gchar * list_file, int mode, struct script_infos * script_args )

static

Process each files in the list_file through the linter.

Parameters

list_file	the path to a text file containing path to the files to process, one per line
mode,script_args	Parameters for the linter

Returns

The amount of scripts with errors

Definition at line 80 of file nasl-lint.c.

{
  int err = 0;
  GError *error = NULL;
  GDataInputStream *nvt_list = get_DIS_from_filename (list_file);
 
  while (TRUE)
    {
      gchar *line =
        g_data_input_stream_read_line (nvt_list, NULL, NULL, &error);
      if (error != NULL)
        {
          if (line != NULL)
            g_free (line);
 
          g_error ("%s\n\n", error->message);
          break;
        }
      if (line == NULL)
        break;
 
      err += process_file (line, mode, script_args);
 
      g_free (line);
    }
  g_object_unref (nvt_list);
 
  return err;
}

References get_DIS_from_filename(), and process_file().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

process_files()

int process_files ( const gchar ** files, int mode, struct script_infos * script_args )

static

Process each given files through the linter.

Parameters

files	The path to the files to be processed
mode,script_args	Parameters to be given to the linter

Returns

The amount scripts with errors

Definition at line 118 of file nasl-lint.c.

{
  int n = 0;
  int err = 0;
  while (files[n])
    {
      err += process_file (files[n], mode, script_args);
      n++;
    }
  return err;
}

References process_file().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function: