Greenbone Vulnerability Management Libraries  21.4.2
Data Structures | Macros | Functions
osp.c File Reference

API for Open Scanner Protocol communication. More...

#include "osp.h"
#include "../base/hosts.h"
#include "../util/serverutils.h"
#include <assert.h>
#include <gnutls/gnutls.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <unistd.h>

Data Structures

struct  osp_connection
 Struct holding options for OSP connection. More...
 
struct  osp_param
 Struct holding options for OSP parameters. More...
 
struct  osp_credential
 Struct credential information for OSP. More...
 
struct  osp_target
 Struct holding target information. More...
 
struct  osp_vt_group
 Struct holding vt_group information. More...
 
struct  osp_vt_single
 Struct holding vt_group information. More...
 

Macros

#define G_LOG_DOMAIN   "libgvm osp"
 GLib log domain. More...
 

Functions

static int osp_send_command (osp_connection_t *connection, entity_t *response, const char *fmt,...)
 Send a command to an OSP server. More...
 
void osp_connection_close (osp_connection_t *connection)
 Close a connection to an OSP server. More...
 
int osp_get_version (osp_connection_t *connection, char **s_name, char **s_version, char **d_name, char **d_version, char **p_name, char **p_version)
 Get the scanner version from an OSP server. More...
 
int osp_get_vts_version (osp_connection_t *connection, char **vts_version, char **error)
 Get the VTs version from an OSP server. More...
 
int osp_get_vts (osp_connection_t *connection, entity_t *vts)
 Get all VTs from an OSP server. More...
 
int osp_get_vts_ext (osp_connection_t *connection, osp_get_vts_opts_t opts, entity_t *vts)
 Get filtered set of VTs from an OSP server. More...
 
int osp_delete_scan (osp_connection_t *connection, const char *scan_id)
 Delete a scan from an OSP server. More...
 
int osp_get_performance_ext (osp_connection_t *connection, osp_get_performance_opts_t opts, char **graph, char **error)
 Get performance graphics from an OSP server. More...
 
osp_scan_status_t osp_get_scan_status_ext (osp_connection_t *connection, osp_get_scan_status_opts_t opts, char **error)
 Get a scan status from an OSP server. More...
 
int osp_get_scan_pop (osp_connection_t *connection, const char *scan_id, char **report_xml, int details, int pop_results, char **error)
 Get a scan from an OSP server, optionally removing the results. More...
 
int osp_get_scan (osp_connection_t *connection, const char *scan_id, char **report_xml, int details, char **error)
 Get a scan from an OSP server. More...
 
int osp_stop_scan (osp_connection_t *connection, const char *scan_id, char **error)
 Stop a scan on an OSP server. More...
 
static void option_concat_as_xml (gpointer key, gpointer value, gpointer pstr)
 Concatenate options as xml. More...
 
int osp_start_scan (osp_connection_t *connection, const char *target, const char *ports, GHashTable *options, const char *scan_id, char **error)
 Start an OSP scan against a target. More...
 
static void credential_append_as_xml (osp_credential_t *credential, GString *xml_string)
 Concatenate a credential as XML. More...
 
static void target_append_as_xml (osp_target_t *target, GString *xml_string)
 Concatenate a target as XML. More...
 
static void vt_group_append_as_xml (osp_vt_group_t *vt_group, GString *xml_string)
 Append VT groups as XML to a string buffer. More...
 
static void vt_value_append_as_xml (gpointer id, gchar *value, GString *xml_string)
 Append VT values as XML to a string buffer. More...
 
static void vt_single_append_as_xml (osp_vt_single_t *vt_single, GString *xml_string)
 Append single VTs as XML to a string buffer. More...
 
int osp_start_scan_ext (osp_connection_t *connection, osp_start_scan_opts_t opts, char **error)
 Start an OSP scan against a target. More...
 
static osp_param_type_t osp_param_str_to_type (const char *str)
 Get an OSP parameter's type from its string format. More...
 
const char * osp_param_type_str (const osp_param_t *param)
 Get an OSP parameter in string format form its type. More...
 
int osp_get_scanner_details (osp_connection_t *connection, char **desc, GSList **params)
 Get an OSP scanner's details. More...
 
osp_param_tosp_param_new (void)
 Create a new OSP parameter. More...
 
const char * osp_param_id (const osp_param_t *param)
 Get an OSP parameter's id. More...
 
const char * osp_param_name (const osp_param_t *param)
 Get an OSP parameter's name. More...
 
const char * osp_param_desc (const osp_param_t *param)
 Get an OSP parameter's description. More...
 
const char * osp_param_default (const osp_param_t *param)
 Get an OSP parameter's default value. More...
 
int osp_param_mandatory (const osp_param_t *param)
 Get an OSP parameter's mandatory value. More...
 
void osp_param_free (osp_param_t *param)
 Free an OSP parameter. More...
 
osp_credential_tosp_credential_new (const char *type, const char *service, const char *port)
 Allocate and initialize a new OSP credential. More...
 
void osp_credential_free (osp_credential_t *credential)
 Free an OSP credential. More...
 
const gchar * osp_credential_get_auth_data (osp_credential_t *credential, const char *name)
 Get authentication data from an OSP credential. More...
 
void osp_credential_set_auth_data (osp_credential_t *credential, const char *name, const char *value)
 Get authentication data from an OSP credential. More...
 

Detailed Description

API for Open Scanner Protocol communication.

Macro Definition Documentation

◆ G_LOG_DOMAIN

#define G_LOG_DOMAIN   "libgvm osp"

GLib log domain.

Function Documentation

◆ credential_append_as_xml()

static void credential_append_as_xml ( osp_credential_t credential,
GString *  xml_string 
)
static

Concatenate a credential as XML.

Parameters
[in]credentialCredential data.
[in,out]xml_stringXML string buffer to append to.

◆ option_concat_as_xml()

static void option_concat_as_xml ( gpointer  key,
gpointer  value,
gpointer  pstr 
)
static

Concatenate options as xml.

Parameters
[in]keyTag name for xml element.
[in]valueText for xml element.
[in,out]pstrParameters as xml concatenated xml elements.

◆ osp_connection_close()

void osp_connection_close ( osp_connection_t connection)

Close a connection to an OSP server.

Parameters
[in]connectionConnection to OSP server to close.

◆ osp_credential_free()

void osp_credential_free ( osp_credential_t credential)

Free an OSP credential.

Parameters
[in]credentialThe credential to free.

◆ osp_credential_get_auth_data()

const gchar* osp_credential_get_auth_data ( osp_credential_t credential,
const char *  name 
)

Get authentication data from an OSP credential.

Parameters
[in]credentialThe credential to get the data from.
[in]nameThe name of the data item to get.
Returns
The requested authentication data or NULL if not available.

◆ osp_credential_new()

osp_credential_t* osp_credential_new ( const char *  type,
const char *  service,
const char *  port 
)

Allocate and initialize a new OSP credential.

Parameters
[in]typeThe credential type.
[in]serviceThe service the credential is for.
[in]portThe port.
Returns
New osp credential.

◆ osp_credential_set_auth_data()

void osp_credential_set_auth_data ( osp_credential_t credential,
const char *  name,
const char *  value 
)

Get authentication data from an OSP credential.

Parameters
[in]credentialThe credential to get the data from.
[in]nameThe name of the data item to get.
[in]valueThe authentication data or NULL to unset.

◆ osp_delete_scan()

int osp_delete_scan ( osp_connection_t connection,
const char *  scan_id 
)

Delete a scan from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]scan_idID of scan to delete.
Returns
0 if success, 1 if error.

◆ osp_get_performance_ext()

int osp_get_performance_ext ( osp_connection_t connection,
osp_get_performance_opts_t  opts,
char **  graph,
char **  error 
)

Get performance graphics from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]optsStruct containing the options to apply.
[out]graphGraphic base64 encoded.
[out]errorPointer to error, if any.
Returns
0 if success, -1 if error.

◆ osp_get_scan()

int osp_get_scan ( osp_connection_t connection,
const char *  scan_id,
char **  report_xml,
int  details,
char **  error 
)

Get a scan from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]scan_idID of scan to get.
[out]report_xmlScans report.
[in]details0 for no scan details, 1 otherwise.
[out]errorPointer to error, if any.
Returns
Scan progress if success, -1 if error.

◆ osp_get_scan_pop()

int osp_get_scan_pop ( osp_connection_t connection,
const char *  scan_id,
char **  report_xml,
int  details,
int  pop_results,
char **  error 
)

Get a scan from an OSP server, optionally removing the results.

Parameters
[in]connectionConnection to an OSP server.
[in]scan_idID of scan to get.
[out]report_xmlScans report.
[in]details0 for no scan details, 1 otherwise.
[in]pop_results0 to leave results, 1 to pop results from scanner.
[out]errorPointer to error, if any.
Returns
Scan progress if success, -1 if error.

◆ osp_get_scan_status_ext()

osp_scan_status_t osp_get_scan_status_ext ( osp_connection_t connection,
osp_get_scan_status_opts_t  opts,
char **  error 
)

Get a scan status from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]scan_idID of scan to get.
[out]errorPointer to error, if any.
Returns
Osp scan status

◆ osp_get_scanner_details()

int osp_get_scanner_details ( osp_connection_t connection,
char **  desc,
GSList **  params 
)

Get an OSP scanner's details.

Parameters
[in]connectionConnection to an OSP server.
[out]descScanner's description.
[out]paramsScanner's parameters.
Returns
0 if success, 1 if failure.

◆ osp_get_version()

int osp_get_version ( osp_connection_t connection,
char **  s_name,
char **  s_version,
char **  d_name,
char **  d_version,
char **  p_name,
char **  p_version 
)

Get the scanner version from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[out]s_nameParsed scanner name.
[out]s_versionParsed scanner version.
[out]d_nameParsed scanner name.
[out]d_versionParsed scanner version.
[out]p_nameParsed scanner name.
[out]p_versionParsed scanner version.
Returns
0 if success, 1 if error.

◆ osp_get_vts()

int osp_get_vts ( osp_connection_t connection,
entity_t vts 
)

Get all VTs from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[out]vtsVTs.
Returns
0 if success, 1 if error.

◆ osp_get_vts_ext()

int osp_get_vts_ext ( osp_connection_t connection,
osp_get_vts_opts_t  opts,
entity_t vts 
)

Get filtered set of VTs from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]optsStruct containing the options to apply.
[out]vtsVTs.
Returns
0 if success, 1 if error.

◆ osp_get_vts_version()

int osp_get_vts_version ( osp_connection_t connection,
char **  vts_version,
char **  error 
)

Get the VTs version from an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[out]vts_versionParsed scanner version.
[out]errorPointer to error, if any.
Returns
0 if success, 1 if error.

◆ osp_param_default()

const char* osp_param_default ( const osp_param_t param)

Get an OSP parameter's default value.

Parameters
[in]paramOSP parameter.
Returns
Default value of OSP parameter.

◆ osp_param_desc()

const char* osp_param_desc ( const osp_param_t param)

Get an OSP parameter's description.

Parameters
[in]paramOSP parameter.
Returns
Description of OSP parameter.

◆ osp_param_free()

void osp_param_free ( osp_param_t param)

Free an OSP parameter.

Parameters
[in]paramOSP parameter to destroy.

◆ osp_param_id()

const char* osp_param_id ( const osp_param_t param)

Get an OSP parameter's id.

Parameters
[in]paramOSP parameter.
Returns
ID of OSP parameter.

◆ osp_param_mandatory()

int osp_param_mandatory ( const osp_param_t param)

Get an OSP parameter's mandatory value.

Parameters
[in]paramOSP parameter.
Returns
Mandatory value of OSP parameter.

◆ osp_param_name()

const char* osp_param_name ( const osp_param_t param)

Get an OSP parameter's name.

Parameters
[in]paramOSP parameter.
Returns
Name of OSP parameter.

◆ osp_param_new()

osp_param_t* osp_param_new ( void  )

Create a new OSP parameter.

Returns
New OSP parameter.

◆ osp_param_str_to_type()

static osp_param_type_t osp_param_str_to_type ( const char *  str)
static

Get an OSP parameter's type from its string format.

Parameters
[in]strOSP parameter in string format.
Returns
OSP parameter type.

◆ osp_param_type_str()

const char* osp_param_type_str ( const osp_param_t param)

Get an OSP parameter in string format form its type.

Parameters
[in]paramOSP parameter.
Returns
OSP parameter in string format.

◆ osp_send_command()

int osp_send_command ( osp_connection_t connection,
entity_t response,
const char *  fmt,
  ... 
)
static

Send a command to an OSP server.

Parameters
[in]connectionConnection to OSP server.
[out]responseResponse from OSP server.
[in]fmtOSP Command to send.
Returns
0 and response, 1 if error.

◆ osp_start_scan()

int osp_start_scan ( osp_connection_t connection,
const char *  target,
const char *  ports,
GHashTable *  options,
const char *  scan_id,
char **  error 
)

Start an OSP scan against a target.

Parameters
[in]connectionConnection to an OSP server.
[in]targetTarget host to scan.
[in]portsList of ports to scan.
[in]optionsTable of scan options.
[in]scan_iduuid to set for scan, null otherwise.
[out]errorPointer to error, if any.
Returns
0 on success, -1 otherwise.

◆ osp_start_scan_ext()

int osp_start_scan_ext ( osp_connection_t connection,
osp_start_scan_opts_t  opts,
char **  error 
)

Start an OSP scan against a target.

Parameters
[in]connectionConnection to an OSP server.
[in]optsStruct containing the options to apply.
[out]errorPointer to error, if any.
Returns
0 on success, -1 otherwise.

◆ osp_stop_scan()

int osp_stop_scan ( osp_connection_t connection,
const char *  scan_id,
char **  error 
)

Stop a scan on an OSP server.

Parameters
[in]connectionConnection to an OSP server.
[in]scan_idID of scan to delete.
[out]errorPointer to error, if any.
Returns
Scan progress if success, -1 if error.

◆ target_append_as_xml()

static void target_append_as_xml ( osp_target_t target,
GString *  xml_string 
)
static

Concatenate a target as XML.

Parameters
[in]targetTarget data.
[in,out]xml_stringXML string buffer to append to.

◆ vt_group_append_as_xml()

static void vt_group_append_as_xml ( osp_vt_group_t vt_group,
GString *  xml_string 
)
static

Append VT groups as XML to a string buffer.

Parameters
[in]vt_groupVT group data.
[in,out]xml_stringXML string buffer to append to.

◆ vt_single_append_as_xml()

static void vt_single_append_as_xml ( osp_vt_single_t vt_single,
GString *  xml_string 
)
static

Append single VTs as XML to a string buffer.

Parameters
[in]vt_singleSingle VT data.
[in,out]xml_stringXML string buffer to append to.

◆ vt_value_append_as_xml()

static void vt_value_append_as_xml ( gpointer  id,
gchar *  value,
GString *  xml_string 
)
static

Append VT values as XML to a string buffer.

Parameters
[in]idIdentifier of the vt_value.
[in]valueThe value of the vt_value.
[in,out]xml_stringXML string buffer to append to.