plugutils.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Greenbone AG
 * SPDX-FileCopyrightText: 1998-2007 Tenable Network Security, Inc.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

 
#ifndef MISC_PLUGUTILS_H
#define MISC_PLUGUTILS_H
 
#include "scanneraux.h" /* for struct script_infos */
 
#include <gvm/base/nvti.h> /* for nvti_t */
 
#define ARG_STRING 1
#define ARG_INT 2
 
void
init_kb_usage (void);
 
void
scanner_add_port (struct script_infos *, int, char *);
 
/*
 * Arglist management at plugin-level
 */
 
void
plug_set_dep (struct script_infos *, const char *);
 
void
plug_set_ssl_cert (struct script_infos *, char *);
 
void
plug_set_ssl_key (struct script_infos *, char *);
 
void
plug_set_ssl_pem_password (struct script_infos *, char *);
 
void
plug_set_ssl_CA_file (struct script_infos *, char *);
 
const char *
plug_current_vhost (void);
 
char *
plug_get_host_fqdn (struct script_infos *);
 
int
plug_add_host_fqdn (struct script_infos *, const char *, const char *);
 
GSList *
plug_get_host_fqdn_list (struct script_infos *);
 
char *
plug_get_host_source (struct script_infos *, const char *);
 
unsigned int
plug_get_host_open_port (struct script_infos *desc);
 
void
plug_set_port_transport (struct script_infos *, int, int);
 
int
plug_get_port_transport (struct script_infos *, int);
 
struct script_infos *
plug_create_from_nvti_and_prefs (const nvti_t *);
 
/*
 * Reporting functions
 */
 
typedef enum
{
  ERRMSG,
  HOST_START,
  HOST_END,
  LOG,
  HOST_DETAIL,
  ALARM,
  DEADHOST,
  HOSTS_COUNT
} msg_t;
 
void
proto_post_alarm (const char *, struct script_infos *, int, const char *,
                  const char *, const char *);
 
void
post_alarm (const char *, struct script_infos *, int, const char *,
            const char *);
 
void
post_alarm_udp (struct script_infos *, int, const char *, const char *);
 
#define post_alarm_tcp post_alarm
 
void
proto_post_error (const char *, struct script_infos *, int, const char *,
                  const char *, const char *);
void
post_error (const char *, struct script_infos *, int, const char *,
            const char *);
 
#define post_error_tcp post_error
 
void
proto_post_log (const char *, struct script_infos *, int, const char *,
                const char *, const char *);
 
void
post_log (const char *, struct script_infos *, int, const char *);
 
void
post_log_with_uri (const char *, struct script_infos *, int, const char *,
                   const char *);
 
#define post_log_tcp post_log
 
/*
 * Management of the portlists
 */
 
int
host_get_port_state (struct script_infos *, int);
 
int
host_get_port_state_udp (struct script_infos *, int);
 
/*
 * Inter Plugins Communication functions
 */
int check_kb_inconsistency (kb_t);
 
int
kb_item_push_str_with_main_kb_check (kb_t, const char *, const char *);
 
int
kb_item_set_str_with_main_kb_check (kb_t, const char *, const char *, size_t);
 
int
kb_item_add_str_unique_with_main_kb_check (kb_t, const char *, const char *,
                                           size_t, int);
 
int
kb_item_set_int_with_main_kb_check (kb_t, const char *, int);
 
int
kb_item_add_int_with_main_kb_check (kb_t, const char *, int);
 
int
kb_item_add_int_unique_with_main_kb_check (kb_t, const char *, int);
 
void
plug_set_key (struct script_infos *, char *, int, const void *);
 
void
plug_set_key_len (struct script_infos *, char *, int, const void *, size_t);
 
void
plug_set_key_volatile (struct script_infos *, char *, int, const void *, int);
 
void
plug_set_key_len_volatile (struct script_infos *, char *, int, const void *,
                           int, size_t);
 
void
plug_replace_key (struct script_infos *, char *, int, void *);
 
void
plug_replace_key_len (struct script_infos *, char *, int, void *, size_t);
 
kb_t
plug_get_kb (struct script_infos *);
 
void *
plug_get_key (struct script_infos *, char *, int *, size_t *, int);
 
struct in6_addr *
plug_get_host_ip (struct script_infos *);
 
char *
plug_get_host_ip_str (struct script_infos *);
 
char *
get_plugin_preference (const char *, const char *, int);
 
const char *
get_plugin_preference_fname (struct script_infos *, const char *);
 
char *
get_plugin_preference_file_content (struct script_infos *, const char *);
 
long
get_plugin_preference_file_size (struct script_infos *, const char *);
 
int
kb_get_port_state_proto (kb_t kb, int portnum, char *proto);
 
#endif