OpenVAS Libraries  9.0.1
Macros | Functions
plugutils.h File Reference
#include "arglists.h"
#include "../base/nvti.h"
#include "../base/openvas_networking.h"
#include "../base/kb.h"

Go to the source code of this file.

Macros

#define LEGACY_OID   "1.3.6.1.4.1.25623.1.0."
 
#define post_alarm_tcp   post_alarm
 
#define post_error_tcp   post_error
 
#define post_log_tcp   post_log
 

Functions

void scanner_add_port (struct arglist *, int, char *)
 
void plug_set_dep (struct arglist *, const char *)
 
void plug_set_xref (struct arglist *, char *, char *)
 
void plug_set_tag (struct arglist *, char *, char *)
 
void plug_set_ssl_cert (struct arglist *, char *)
 
void plug_set_ssl_key (struct arglist *, char *)
 
void plug_set_ssl_pem_password (struct arglist *, char *)
 
void plug_set_ssl_CA_file (struct arglist *, char *)
 
const char * plug_get_hostname (struct arglist *)
 
char * plug_get_host_fqdn (struct arglist *)
 
unsigned int plug_get_host_open_port (struct arglist *desc)
 
void plug_set_port_transport (struct arglist *, int, int)
 
int plug_get_port_transport (struct arglist *, int)
 
struct arglistplug_create_from_nvti_and_prefs (const nvti_t *)
 
void proto_post_alarm (const char *, struct arglist *, int, const char *, const char *)
 
void post_alarm (const char *, struct arglist *, int, const char *)
 
void post_alarm_udp (struct arglist *, int, const char *)
 
void proto_post_error (const char *, struct arglist *, int, const char *, const char *)
 
void post_error (const char *, struct arglist *, int, const char *)
 
void proto_post_log (const char *, struct arglist *, int, const char *, const char *)
 Post a log message. More...
 
void post_log (const char *, struct arglist *, int, const char *)
 Post a log message about a tcp port. More...
 
int host_get_port_state (struct arglist *, int)
 
int host_get_port_state_udp (struct arglist *, int)
 
void plug_set_key (struct arglist *, char *, int, const void *)
 
void plug_replace_key (struct arglist *, char *, int, void *)
 
kb_t plug_get_kb (struct arglist *)
 
void * plug_get_key (struct arglist *, char *, int *)
 
struct in6_addr * plug_get_host_ip (struct arglist *)
 
char * plug_get_host_ip_str (struct arglist *)
 
void add_plugin_preference (struct arglist *, const char *, const char *, const char *)
 
char * get_plugin_preference (const char *, const char *)
 
const char * get_plugin_preference_fname (struct arglist *, const char *)
 Get the file name of a plugins preference that is of type "file". More...
 
char * get_plugin_preference_file_content (struct arglist *, const char *)
 Get the file contents of a plugins preference that is of type "file". More...
 
long get_plugin_preference_file_size (struct arglist *, const char *)
 Get the file size of a plugins preference that is of type "file". More...
 
char * find_in_path (char *, int)
 

Macro Definition Documentation

◆ LEGACY_OID

#define LEGACY_OID   "1.3.6.1.4.1.25623.1.0."

◆ post_alarm_tcp

#define post_alarm_tcp   post_alarm

◆ post_error_tcp

#define post_error_tcp   post_error

◆ post_log_tcp

#define post_log_tcp   post_log

Function Documentation

◆ add_plugin_preference()

void add_plugin_preference ( struct arglist ,
const char *  ,
const char *  ,
const char *   
)

◆ find_in_path()

char* find_in_path ( char *  ,
int   
)

◆ get_plugin_preference()

char* get_plugin_preference ( const char *  ,
const char *   
)

◆ get_plugin_preference_file_content()

char* get_plugin_preference_file_content ( struct arglist desc,
const char *  identifier 
)

Get the file contents of a plugins preference that is of type "file".

As files sent to the scanner (e.g. as plugin preference) are stored in a hash table with an identifier supplied by the client as the key, the contents have to be looked up here.

Parameters
identifierIdentifier that was supplied by the client when the file was uploaded.
Returns
Contents of the file identified by identifier, NULL if not found or setup broken.

◆ get_plugin_preference_file_size()

long get_plugin_preference_file_size ( struct arglist desc,
const char *  identifier 
)

Get the file size of a plugins preference that is of type "file".

Files sent to the scanner (e.g. as plugin preference) are stored in a hash table with an identifier supplied by the client as the key. The size of the file is stored in a separate hash table with the same identifier as key, which can be looked up here.

Parameters
identifierIdentifier that was supplied by the client when the file was uploaded.
Returns
Size of the file identified by identifier, -1 if not found or setup broken.

◆ get_plugin_preference_fname()

const char* get_plugin_preference_fname ( struct arglist desc,
const char *  filename 
)

Get the file name of a plugins preference that is of type "file".

As files sent to the server (e.g. as plugin preference) are stored at pseudo-random locations with different names, the "real" file name has to be looked up in a hashtable.

Returns
Filename on disc for filename, NULL if not found or setup broken.

◆ host_get_port_state()

int host_get_port_state ( struct arglist ,
int   
)

◆ host_get_port_state_udp()

int host_get_port_state_udp ( struct arglist ,
int   
)

◆ plug_create_from_nvti_and_prefs()

struct arglist* plug_create_from_nvti_and_prefs ( const nvti_t )

◆ plug_get_host_fqdn()

char* plug_get_host_fqdn ( struct arglist )

◆ plug_get_host_ip()

struct in6_addr* plug_get_host_ip ( struct arglist )

◆ plug_get_host_ip_str()

char* plug_get_host_ip_str ( struct arglist )

◆ plug_get_host_open_port()

unsigned int plug_get_host_open_port ( struct arglist desc)

Don't always return the first open port, otherwise we might get bitten by OSes doing active SYN flood countermeasures. Also, avoid returning 80 and 21 as open ports, as many transparent proxies are acting for these...

◆ plug_get_hostname()

const char* plug_get_hostname ( struct arglist )

◆ plug_get_kb()

kb_t plug_get_kb ( struct arglist )

◆ plug_get_key()

void* plug_get_key ( struct arglist ,
char *  ,
int *   
)

◆ plug_get_port_transport()

int plug_get_port_transport ( struct arglist ,
int   
)

◆ plug_replace_key()

void plug_replace_key ( struct arglist ,
char *  ,
int  ,
void *   
)

◆ plug_set_dep()

void plug_set_dep ( struct arglist ,
const char *   
)

◆ plug_set_key()

void plug_set_key ( struct arglist ,
char *  ,
int  ,
const void *   
)

◆ plug_set_port_transport()

void plug_set_port_transport ( struct arglist args,
int  port,
int  tr 
)
Todo:
Those brain damaged functions should probably be in another file They are use to remember who speaks SSL or not

◆ plug_set_ssl_CA_file()

void plug_set_ssl_CA_file ( struct arglist args,
char *  key 
)
Todo:
Also, all plug_set_ssl*-functions set values that are only accessed in network.c:open_stream_connection under specific conditions. Check whether these conditions can actually occur. Document the functions on the way.

◆ plug_set_ssl_cert()

void plug_set_ssl_cert ( struct arglist ,
char *   
)

◆ plug_set_ssl_key()

void plug_set_ssl_key ( struct arglist ,
char *   
)

◆ plug_set_ssl_pem_password()

void plug_set_ssl_pem_password ( struct arglist ,
char *   
)

◆ plug_set_tag()

void plug_set_tag ( struct arglist ,
char *  ,
char *   
)

◆ plug_set_xref()

void plug_set_xref ( struct arglist ,
char *  ,
char *   
)

◆ post_alarm()

void post_alarm ( const char *  ,
struct arglist ,
int  ,
const char *   
)

◆ post_alarm_udp()

void post_alarm_udp ( struct arglist ,
int  ,
const char *   
)

◆ post_error()

void post_error ( const char *  ,
struct arglist ,
int  ,
const char *   
)

◆ post_log()

void post_log ( const char *  ,
struct arglist ,
int  ,
const char *   
)

Post a log message about a tcp port.

◆ proto_post_alarm()

void proto_post_alarm ( const char *  ,
struct arglist ,
int  ,
const char *  ,
const char *   
)

◆ proto_post_error()

void proto_post_error ( const char *  ,
struct arglist ,
int  ,
const char *  ,
const char *   
)

◆ proto_post_log()

void proto_post_log ( const char *  ,
struct arglist ,
int  ,
const char *  ,
const char *   
)

Post a log message.

◆ scanner_add_port()

void scanner_add_port ( struct arglist ,
int  ,
char *   
)