osp.h File Reference

API for Open Scanner Protocol communication. More...

#include "../util/xmlutils.h"
#include <glib.h>

Include dependency graph for osp.h:

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

Go to the source code of this file.

Data Structures
struct	osp_get_scan_status_opts_t
struct	osp_get_performance_opts_t
struct	osp_get_vts_opts_t
struct	osp_start_scan_opts_t

Typedefs
typedef struct osp_connection	osp_connection_t
typedef struct osp_credential	osp_credential_t
typedef struct osp_target	osp_target_t
typedef struct osp_vt_group	osp_vt_group_t
typedef struct osp_vt_single	osp_vt_single_t
typedef struct osp_param	osp_param_t

Enumerations
enum	osp_param_type_t {   OSP_PARAM_TYPE_INT = 0, OSP_PARAM_TYPE_STR, OSP_PARAM_TYPE_PASSWORD, OSP_PARAM_TYPE_FILE,   OSP_PARAM_TYPE_BOOLEAN, OSP_PARAM_TYPE_OVALDEF_FILE, OSP_PARAM_TYPE_SELECTION, OSP_PARAM_TYPE_CRD_UP }
	OSP parameter types. More...
enum	osp_scan_status_t {   OSP_SCAN_STATUS_ERROR = -1, OSP_SCAN_STATUS_INIT, OSP_SCAN_STATUS_RUNNING, OSP_SCAN_STATUS_STOPPED,   OSP_SCAN_STATUS_FINISHED, OSP_SCAN_STATUS_QUEUED, OSP_SCAN_STATUS_INTERRUPTED }
	OSP scan status. More...

Functions
osp_connection_t *	osp_connection_new (const char *, int, const char *, const char *, const char *)
void	osp_connection_close (osp_connection_t *)
	Close a connection to an OSP server. More...
int	osp_check_feed (osp_connection_t *, int *, int *, char **, char **)
	Gets additional status info about the feed. More...
int	osp_get_version (osp_connection_t *, char **, char **, char **, char **, char **, char **)
	Get the scanner version from an OSP server. More...
int	osp_get_vts_version (osp_connection_t *, char **, char **error)
	Get the VTs version from an OSP server. More...
int	osp_get_vts_feed_info (osp_connection_t *, char **, char **, char **, char **, char **)
	Get the VTs version as well as other feed info from an OSP server. More...
int	osp_get_vts (osp_connection_t *, entity_t *)
	Get all VTs from an OSP server. More...
int	osp_get_vts_ext (osp_connection_t *, osp_get_vts_opts_t, entity_t *)
	Get filtered set of VTs from an OSP server. More...
int	osp_get_vts_ext_str (osp_connection_t *, osp_get_vts_opts_t, gchar **)
	Get filtered set of VTs from an OSP server. More...
int	osp_start_scan (osp_connection_t *, const char *, const char *, GHashTable *, const char *, char **)
	Start an OSP scan against a target. More...
int	osp_start_scan_ext (osp_connection_t *, osp_start_scan_opts_t, char **)
	Start an OSP scan against a target. More...
int	osp_get_scan (osp_connection_t *, const char *, char **, int, char **)
	Get a scan from an OSP server. More...
int	osp_get_scan_pop (osp_connection_t *, const char *, char **, int, int, char **)
	Get a scan from an OSP server, optionally removing the results. More...
osp_scan_status_t	osp_get_scan_status_ext (osp_connection_t *, osp_get_scan_status_opts_t, char **)
	Get a scan status from an OSP server. More...
int	osp_delete_scan (osp_connection_t *, const char *)
	Delete a scan from an OSP server. More...
int	osp_stop_scan (osp_connection_t *, const char *, char **)
	Stop a scan on an OSP server. More...
int	osp_get_scanner_details (osp_connection_t *, char **, GSList **)
	Get an OSP scanner's details. More...
int	osp_get_performance_ext (osp_connection_t *, osp_get_performance_opts_t, char **, char **)
	Get performance graphics from an OSP server. More...
osp_param_t *	osp_param_new (void)
	Create a new OSP parameter. More...
const char *	osp_param_id (const osp_param_t *)
	Get an OSP parameter's id. More...
const char *	osp_param_name (const osp_param_t *)
	Get an OSP parameter's name. More...
const char *	osp_param_desc (const osp_param_t *)
	Get an OSP parameter's description. More...
const char *	osp_param_default (const osp_param_t *)
	Get an OSP parameter's default value. More...
const char *	osp_param_type_str (const osp_param_t *)
	Get an OSP parameter in string format form its type. More...
int	osp_param_mandatory (const osp_param_t *)
	Get an OSP parameter's mandatory value. More...
void	osp_param_free (osp_param_t *)
	Free an OSP parameter. More...
osp_credential_t *	osp_credential_new (const char *, const char *, const char *)
	Allocate and initialize a new OSP credential. More...
void	osp_credential_free (osp_credential_t *)
	Free an OSP credential. More...
const gchar *	osp_credential_get_auth_data (osp_credential_t *, const char *)
	Get authentication data from an OSP credential. More...
void	osp_credential_set_auth_data (osp_credential_t *, const char *, const char *)
	Get authentication data from an OSP credential. More...
osp_target_t *	osp_target_new (const char *, const char *, const char *, int, int, int)
void	osp_target_set_finished_hosts (osp_target_t *, const char *)
void	osp_target_free (osp_target_t *)
void	osp_target_add_alive_test_methods (osp_target_t *, gboolean, gboolean, gboolean, gboolean, gboolean)
void	osp_target_add_credential (osp_target_t *, osp_credential_t *)
osp_vt_group_t *	osp_vt_group_new (const char *)
void	osp_vt_group_free (osp_vt_group_t *)
osp_vt_single_t *	osp_vt_single_new (const char *)
void	osp_vt_single_free (osp_vt_single_t *)
void	osp_vt_single_add_value (osp_vt_single_t *, const char *, const char *)

Variables
static const osp_get_vts_opts_t	osp_get_vts_opts_default = {NULL, 0}
	Sensible default values for osp_get_vts_opts_t. More...

Detailed Description

API for Open Scanner Protocol communication.

Definition in file osp.h.

Typedef Documentation

osp_connection_t

typedef struct osp_connection osp_connection_t

Definition at line 1 of file osp.h.

osp_credential_t

typedef struct osp_credential osp_credential_t

Definition at line 1 of file osp.h.

osp_param_t

typedef struct osp_param osp_param_t

Definition at line 1 of file osp.h.

osp_target_t

typedef struct osp_target osp_target_t

Definition at line 1 of file osp.h.

osp_vt_group_t

typedef struct osp_vt_group osp_vt_group_t

Definition at line 1 of file osp.h.

osp_vt_single_t

typedef struct osp_vt_single osp_vt_single_t

Definition at line 1 of file osp.h.

Enumeration Type Documentation

osp_param_type_t

enum osp_param_type_t

OSP parameter types.

Enumerator
OSP_PARAM_TYPE_INT	Integer type.
OSP_PARAM_TYPE_STR	String type.
OSP_PARAM_TYPE_PASSWORD	Password type.
OSP_PARAM_TYPE_FILE	File type.
OSP_PARAM_TYPE_BOOLEAN	Boolean type.
OSP_PARAM_TYPE_OVALDEF_FILE	Oval definition type.
OSP_PARAM_TYPE_SELECTION	Selection type.
OSP_PARAM_TYPE_CRD_UP	Credential user/pass type.

Definition at line 33 of file osp.h.

{
  OSP_PARAM_TYPE_INT = 0,      
  OSP_PARAM_TYPE_STR,          
  OSP_PARAM_TYPE_PASSWORD,     
  OSP_PARAM_TYPE_FILE,         
  OSP_PARAM_TYPE_BOOLEAN,      
  OSP_PARAM_TYPE_OVALDEF_FILE, 
  OSP_PARAM_TYPE_SELECTION,    
  OSP_PARAM_TYPE_CRD_UP,       
} osp_param_type_t;

osp_scan_status_t

enum osp_scan_status_t

OSP scan status.

Enumerator
OSP_SCAN_STATUS_ERROR	Error status.
OSP_SCAN_STATUS_INIT	Init status.
OSP_SCAN_STATUS_RUNNING	Running status.
OSP_SCAN_STATUS_STOPPED	Stopped status.
OSP_SCAN_STATUS_FINISHED	Finished status.
OSP_SCAN_STATUS_QUEUED	Queued status
OSP_SCAN_STATUS_INTERRUPTED	Interrupted status

Definition at line 48 of file osp.h.

{
  OSP_SCAN_STATUS_ERROR = -1,  
  OSP_SCAN_STATUS_INIT,        
  OSP_SCAN_STATUS_RUNNING,     
  OSP_SCAN_STATUS_STOPPED,     
  OSP_SCAN_STATUS_FINISHED,    
  OSP_SCAN_STATUS_QUEUED,      
  OSP_SCAN_STATUS_INTERRUPTED, 
} osp_scan_status_t;

Function Documentation

osp_check_feed()

int osp_check_feed	(	osp_connection_t *	connection,
		int *	lockfile_in_use,
		int *	self_test_exit_error,
		char **	self_test_error_msg,
		char **	cmd_error
	)

Gets additional status info about the feed.

The lockfile_in_use and self_test_exit_error fields will be set to -1 if the corresponding elements are missing.

Parameters

[in]	connection	Connection to an OSP server.
[out]	lockfile_in_use	Whether the lockfile is in use.
[out]	self_test_exit_error	Whether the sync script self check failed.
[out]	self_test_error_msg	Self check error message if one occurred.
[out]	cmd_error	Error message of the OSP command.

Returns

0 if success, 1 if error.

Definition at line 321 of file osp.c.

{
  entity_t entity, feed, lockfile_entity, exit_error_entity, error_msg_entity;
  const char *status, *status_text;
 
  if (!connection)
    return 1;
 
  if (osp_send_command (connection, &entity, "<check_feed/>"))
    return 1;
 
  status = entity_attribute (entity, "status");
 
  if (status != NULL && !strcmp (status, "400"))
    {
      status_text = entity_attribute (entity, "status_text");
      g_debug ("%s: %s - %s.", __func__, status, status_text);
      if (cmd_error)
        *cmd_error = g_strdup (status_text);
      free_entity (entity);
      return 1;
    }
 
  feed = entity_child (entity, "feed");
  if (!feed)
    {
      g_warning ("%s: element FEED missing.", __func__);
      free_entity (entity);
      return 1;
    }
 
  lockfile_entity = entity_child (feed, "lockfile_in_use");
  exit_error_entity = entity_child (feed, "self_test_exit_error");
  error_msg_entity = entity_child (feed, "self_test_error_msg");
 
  if (lockfile_in_use)
    {
      if (lockfile_entity)
        *lockfile_in_use = atoi (entity_text (lockfile_entity));
      else
        {
          g_warning ("%s: element LOCKFILE_IN_USE missing.", __func__);
          *lockfile_in_use = -1;
        }
    }
 
  if (self_test_exit_error)
    {
      if (exit_error_entity)
        *self_test_exit_error = atoi (entity_text (exit_error_entity));
      else
        {
          g_warning ("%s: element SELF_TEST_EXIT_ERROR missing.", __func__);
          *self_test_exit_error = -1;
        }
    }
 
  if (self_test_error_msg)
    {
      if (self_test_error_msg)
        {
          if (entity_text (error_msg_entity))
            *self_test_error_msg = g_strdup (entity_text (error_msg_entity));
          else
            *self_test_error_msg = NULL;
        }
      else
        {
          g_warning ("%s: element SELF_TEST_ERROR_MSG missing.", __func__);
          *self_test_error_msg = NULL;
        }
    }
 
  free_entity (entity);
  return 0;
}

References entity_attribute(), entity_child(), entity_text(), free_entity(), and osp_send_command().

Here is the call graph for this function:

osp_connection_close()

void osp_connection_close

(

osp_connection_t *

connection

)

Close a connection to an OSP server.

Parameters

[in]

connection

Connection to OSP server to close.

Definition at line 293 of file osp.c.

{
  if (!connection)
    return;
 
  if (*connection->host == '/')
    close (connection->socket);
  else
    gvm_server_close (connection->socket, connection->session);
  g_free (connection->host);
  g_free (connection);
}

References gvm_server_close(), osp_connection::host, osp_connection::session, and osp_connection::socket.

Here is the call graph for this function:

osp_connection_new()

osp_connection_t* osp_connection_new	(	const char *	,
		int	,
		const char *	,
		const char *	,
		const char *
	)

Referenced by Ensure().

Here is the caller graph for this function:

osp_credential_free()

void osp_credential_free

(

osp_credential_t *

credential

)

Free an OSP credential.

Parameters

[in]

credential

The credential to free.

Definition at line 1625 of file osp.c.

{
  if (!credential)
    return;
 
  g_free (credential->type);
  g_free (credential->service);
  g_free (credential->port);
  g_hash_table_destroy (credential->auth_data);
  g_free (credential);
}

References osp_credential::auth_data, osp_credential::port, osp_credential::service, and osp_credential::type.

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]	credential	The credential to get the data from.
[in]	name	The name of the data item to get.

Returns

The requested authentication data or NULL if not available.

Definition at line 1646 of file osp.c.

{
  if (credential == NULL || name == NULL)
    return NULL;
  return g_hash_table_lookup (credential->auth_data, name);
}

References osp_credential::auth_data.

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]	type	The credential type.
[in]	service	The service the credential is for.
[in]	port	The port.

Returns

New osp credential.

Definition at line 1604 of file osp.c.

{
  osp_credential_t *new_credential;
 
  new_credential = g_malloc0 (sizeof (osp_credential_t));
 
  new_credential->type = type ? g_strdup (type) : NULL;
  new_credential->service = service ? g_strdup (service) : NULL;
  new_credential->port = port ? g_strdup (port) : NULL;
  new_credential->auth_data =
    g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
 
  return new_credential;
}

References osp_credential::auth_data, osp_credential::port, osp_credential::service, and osp_credential::type.

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]	credential	The credential to get the data from.
[in]	name	The name of the data item to get.
[in]	value	The authentication data or NULL to unset.

Definition at line 1661 of file osp.c.

References osp_credential::auth_data.

osp_delete_scan()

int osp_delete_scan	(	osp_connection_t *	connection,
		const char *	scan_id
	)

Delete a scan from an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to delete.

Returns

0 if success, 1 if error.

Definition at line 722 of file osp.c.

{
  entity_t entity;
  int ret = 0;
  const char *status;
 
  if (!connection)
    return 1;
 
  ret = osp_send_command (connection, &entity, "<delete_scan scan_id='%s'/>",
                          scan_id);
  if (ret)
    return 1;
 
  /* Check response status. */
  status = entity_attribute (entity, "status");
  assert (status);
  if (strcmp (status, "200"))
    ret = 1;
 
  free_entity (entity);
  return ret;
}

References entity_attribute(), free_entity(), and osp_send_command().

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[in]	opts	Struct containing the options to apply.
[out]	graph	Graphic base64 encoded.
[out]	error	Pointer to error, if any.

Returns

0 if success, -1 if error.

Definition at line 757 of file osp.c.

{
  entity_t entity;
  int rc;
  time_t now;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_performance command "
                           "to scanner. Not valid connection");
      return -1;
    }
 
  time (&now);
 
  if (!opts.titles || !strcmp (opts.titles, "") || opts.start < 0
      || opts.start > now || opts.end < 0 || opts.end > now)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_performance command "
                           "to scanner. Bad or missing parameters.");
      return -1;
    }
 
  rc = osp_send_command (connection, &entity,
                         "<get_performance start='%d' "
                         "end='%d' titles='%s'/>",
                         opts.start, opts.end, opts.titles);
 
  if (rc)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_performance command to scanner");
      return -1;
    }
 
  if (graph && entity_text (entity) && strcmp (entity_text (entity), "\0"))
    *graph = g_strdup (entity_text (entity));
  else
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return -1;
    }
 
  free_entity (entity);
  return 0;
}

References osp_get_performance_opts_t::end, entity_attribute(), entity_text(), free_entity(), osp_send_command(), osp_get_performance_opts_t::start, and osp_get_performance_opts_t::titles.

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to get.
[out]	report_xml	Scans report.
[in]	details	0 for no scan details, 1 otherwise.
[out]	error	Pointer to error, if any.

Returns

Scan progress if success, -1 if error.

Definition at line 957 of file osp.c.

{
  return osp_get_scan_pop (connection, scan_id, report_xml, details, 0, error);
}

References osp_get_scan_pop().

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to get.
[out]	report_xml	Scans report.
[in]	details	0 for no scan details, 1 otherwise.
[in]	pop_results	0 to leave results, 1 to pop results from scanner.
[out]	error	Pointer to error, if any.

Returns

Scan progress if success, -1 if error.

Definition at line 894 of file osp.c.

{
  entity_t entity, child;
  int progress;
  int rc;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_scan command "
                           "to scanner. Not valid connection");
      return -1;
    }
  assert (scan_id);
  rc = osp_send_command (connection, &entity,
                         "<get_scans scan_id='%s'"
                         " details='%d'"
                         " pop_results='%d'/>",
                         scan_id, pop_results ? 1 : 0, details ? 1 : 0);
  if (rc)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_scans command to scanner");
      return -1;
    }
 
  child = entity_child (entity, "scan");
  if (!child)
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return -1;
    }
  progress = atoi (entity_attribute (child, "progress"));
  if (report_xml)
    {
      GString *string;
 
      string = g_string_new ("");
      print_entity_to_string (child, string);
      *report_xml = g_string_free (string, FALSE);
    }
  free_entity (entity);
  return progress;
}

References entity_attribute(), entity_child(), free_entity(), osp_send_command(), and print_entity_to_string().

Referenced by osp_get_scan().

Here is the call graph for this function:

Here is the caller graph for this function:

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]	connection	Connection to an OSP server.
[in]	opts	Struct containing the options to apply.
[out]	error	Pointer to error, if any.

Returns

Osp scan status

Definition at line 823 of file osp.c.

{
  entity_t entity, child;
  int rc;
  osp_scan_status_t status = OSP_SCAN_STATUS_ERROR;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_scans command "
                           "to scanner. Not valid connection");
      return status;
    }
 
  assert (opts.scan_id);
  rc = osp_send_command (connection, &entity,
                         "<get_scans scan_id='%s'"
                         " details='0'"
                         " pop_results='0'/>",
                         opts.scan_id);
 
  if (rc)
    {
      if (error)
        *error = g_strdup ("Couldn't send get_scans command to scanner");
      return status;
    }
 
  child = entity_child (entity, "scan");
  if (!child)
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return status;
    }
 
  if (!strcmp (entity_attribute (child, "status"), "queued"))
    status = OSP_SCAN_STATUS_QUEUED;
  else if (!strcmp (entity_attribute (child, "status"), "init"))
    status = OSP_SCAN_STATUS_INIT;
  else if (!strcmp (entity_attribute (child, "status"), "running"))
    status = OSP_SCAN_STATUS_RUNNING;
  else if (!strcmp (entity_attribute (child, "status"), "stopped"))
    status = OSP_SCAN_STATUS_STOPPED;
  else if (!strcmp (entity_attribute (child, "status"), "finished"))
    status = OSP_SCAN_STATUS_FINISHED;
  else if (!strcmp (entity_attribute (child, "status"), "interrupted"))
    status = OSP_SCAN_STATUS_INTERRUPTED;
 
  free_entity (entity);
  return status;
}

References entity_attribute(), entity_child(), free_entity(), OSP_SCAN_STATUS_ERROR, OSP_SCAN_STATUS_FINISHED, OSP_SCAN_STATUS_INIT, OSP_SCAN_STATUS_INTERRUPTED, OSP_SCAN_STATUS_QUEUED, OSP_SCAN_STATUS_RUNNING, OSP_SCAN_STATUS_STOPPED, osp_send_command(), and osp_get_scan_status_opts_t::scan_id.

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[out]	desc	Scanner's description.
[out]	params	Scanner's parameters.

Returns

0 if success, 1 if failure.

Definition at line 1441 of file osp.c.

{
  entity_t entity, child;
  entities_t entities;
 
  assert (connection);
 
  if (osp_send_command (connection, &entity, "<get_scanner_details/>"))
    return 1;
  if (params)
    {
      child = entity_child (entity, "scanner_params");
      if (!child)
        {
          free_entity (entity);
          return 1;
        }
      entities = child->entities;
      while (entities)
        {
          osp_param_t *param;
 
          child = entities->data;
          param = osp_param_new ();
          param->id = g_strdup (entity_attribute (child, "id"));
          param->type =
            osp_param_str_to_type (entity_attribute (child, "type"));
          param->name = g_strdup (entity_text (entity_child (child, "name")));
          param->desc =
            g_strdup (entity_text (entity_child (child, "description")));
          param->def = g_strdup (entity_text (entity_child (child, "default")));
          if (entity_child (child, "mandatory"))
            param->mandatory =
              atoi (entity_text (entity_child (child, "mandatory")));
          *params = g_slist_append (*params, param);
          entities = next_entities (entities);
        }
    }
  if (desc)
    {
      child = entity_child (entity, "description");
      assert (child);
      *desc = g_strdup (entity_text (child));
    }
 
  free_entity (entity);
  return 0;
}

References osp_param::def, osp_param::desc, entity_s::entities, entity_attribute(), entity_child(), entity_text(), free_entity(), osp_param::id, osp_param::mandatory, osp_param::name, next_entities(), osp_param_new(), osp_param_str_to_type(), osp_send_command(), and osp_param::type.

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[out]	s_name	Parsed scanner name.
[out]	s_version	Parsed scanner version.
[out]	d_name	Parsed scanner name.
[out]	d_version	Parsed scanner version.
[out]	p_name	Parsed scanner name.
[out]	p_version	Parsed scanner version.

Returns

0 if success, 1 if error.

Definition at line 414 of file osp.c.

{
  entity_t entity, child, gchild;
 
  if (!connection)
    return 1;
 
  if (osp_send_command (connection, &entity, "<get_version/>"))
    return 1;
 
  child = entity_child (entity, "scanner");
  if (!child)
    goto err_get_version;
  gchild = entity_child (child, "name");
  if (!gchild)
    goto err_get_version;
  if (s_name)
    *s_name = g_strdup (entity_text (gchild));
  gchild = entity_child (child, "version");
  if (!gchild)
    goto err_get_version;
  if (s_version)
    *s_version = g_strdup (entity_text (gchild));
 
  child = entity_child (entity, "daemon");
  if (!child)
    goto err_get_version;
  gchild = entity_child (child, "name");
  if (!gchild)
    goto err_get_version;
  if (d_name)
    *d_name = g_strdup (entity_text (gchild));
  gchild = entity_child (child, "version");
  if (!gchild)
    goto err_get_version;
  if (d_version)
    *d_version = g_strdup (entity_text (gchild));
 
  child = entity_child (entity, "protocol");
  if (!child)
    goto err_get_version;
  gchild = entity_child (child, "name");
  if (!gchild)
    goto err_get_version;
  if (p_name)
    *p_name = g_strdup (entity_text (gchild));
  gchild = entity_child (child, "version");
  if (!gchild)
    goto err_get_version;
  if (p_version)
    *p_version = g_strdup (entity_text (gchild));
 
  free_entity (entity);
  return 0;
 
err_get_version:
  g_warning ("Erroneous OSP <get_version/> response.");
  if (s_name)
    g_free (*s_name);
  if (s_version)
    g_free (*s_version);
  if (d_name)
    g_free (*d_name);
  if (d_version)
    g_free (*d_version);
  if (p_name)
    g_free (*p_name);
  if (p_version)
    g_free (*p_version);
  free_entity (entity);
  return 1;
}

References entity_child(), entity_text(), free_entity(), and osp_send_command().

Here is the call graph for this function:

osp_get_vts()

int osp_get_vts	(	osp_connection_t *	connection,
		entity_t *	vts
	)

Get all VTs from an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[out]	vts	VTs.

Returns

0 if success, 1 if error.

Definition at line 621 of file osp.c.

{
  if (!connection)
    return 1;
 
  if (vts == NULL)
    return 1;
 
  if (osp_send_command (connection, vts, "<get_vts/>"))
    return 1;
 
  return 0;
}

References osp_send_command().

Referenced by Ensure().

Here is the call graph for this function:

Here is the caller graph for this function:

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]	connection	Connection to an OSP server.
[in]	opts	Struct containing the options to apply.
[out]	vts	VTs.

Returns

0 if success, 1 if error.

Definition at line 645 of file osp.c.

{
  if (!connection)
    return 1;
 
  if (vts == NULL)
    return 1;
 
  if (opts.version_only == 1)
    {
      if (osp_send_command (connection, vts, "<get_vts version_only='1'/>"))
        return 1;
      return 0;
    }
 
  if (opts.filter)
    {
      if (osp_send_command (connection, vts, "<get_vts filter='%s'/>",
                            opts.filter))
        return 1;
      return 0;
    }
 
  if (osp_send_command (connection, vts, "<get_vts/>"))
    return 1;
  return 0;
}

References osp_get_vts_opts_t::filter, osp_send_command(), and osp_get_vts_opts_t::version_only.

Referenced by osp_get_vts_feed_info(), and osp_get_vts_version().

Here is the call graph for this function:

Here is the caller graph for this function:

osp_get_vts_ext_str()

int osp_get_vts_ext_str	(	osp_connection_t *	connection,
		osp_get_vts_opts_t	opts,
		gchar **	str
	)

Get filtered set of VTs from an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[in]	opts	Struct containing the options to apply.
[out]	str	Response.

Returns

0 if success, 1 if error.

Definition at line 684 of file osp.c.

{
  if (!connection)
    return 1;
 
  if (str == NULL)
    return 1;
 
  if (opts.version_only == 1)
    {
      if (osp_send_command_str (connection, str, "<get_vts version_only='1'/>"))
        return 1;
      return 0;
    }
 
  if (opts.filter)
    {
      if (osp_send_command_str (connection, str, "<get_vts filter='%s'/>",
                                opts.filter))
        return 1;
      return 0;
    }
 
  if (osp_send_command_str (connection, str, "<get_vts/>"))
    return 1;
  return 0;
}

References osp_get_vts_opts_t::filter, osp_send_command_str(), and osp_get_vts_opts_t::version_only.

Here is the call graph for this function:

osp_get_vts_feed_info()

int osp_get_vts_feed_info	(	osp_connection_t *	connection,
		char **	vts_version,
		char **	feed_name,
		char **	feed_vendor,
		char **	feed_home,
		char **	error
	)

Get the VTs version as well as other feed info from an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[out]	vts_version	Parsed VTs feed version.
[out]	feed_name	Parsed VTs feed name.
[out]	feed_vendor	Parsed VTs feed vendor.
[out]	feed_home	Parsed VTs feed home URL.
[out]	error	Pointer to error, if any.

Returns

0 if success, 1 if error.

Definition at line 557 of file osp.c.

{
  entity_t entity, vts;
  const char *version, *name, *vendor, *home;
  const char *status, *status_text;
  osp_get_vts_opts_t get_vts_opts;
 
  if (!connection)
    return 1;
 
  get_vts_opts = osp_get_vts_opts_default;
  get_vts_opts.version_only = 1;
  if (osp_get_vts_ext (connection, get_vts_opts, &entity))
    return 1;
 
  status = entity_attribute (entity, "status");
 
  if (status != NULL && !strcmp (status, "400"))
    {
      status_text = entity_attribute (entity, "status_text");
      g_debug ("%s: %s - %s.", __func__, status, status_text);
      if (error)
        *error = g_strdup (status_text);
      free_entity (entity);
      return 1;
    }
 
  vts = entity_child (entity, "vts");
  if (!vts)
    {
      g_warning ("%s: element VTS missing.", __func__);
      free_entity (entity);
      return 1;
    }
 
  version = entity_attribute (vts, "vts_version");
  name = entity_attribute (vts, "feed_name");
  vendor = entity_attribute (vts, "feed_vendor");
  home = entity_attribute (vts, "feed_home");
 
  if (vts_version)
    *vts_version = version ? g_strdup (version) : NULL;
  if (feed_name)
    *feed_name = name ? g_strdup (name) : NULL;
  if (feed_vendor)
    *feed_vendor = vendor ? g_strdup (vendor) : NULL;
  if (feed_home)
    *feed_home = home ? g_strdup (home) : NULL;
 
  free_entity (entity);
  return 0;
}

References entity_attribute(), entity_child(), free_entity(), osp_get_vts_ext(), osp_get_vts_opts_default, and osp_get_vts_opts_t::version_only.

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[out]	vts_version	Parsed scanner version.
[out]	error	Pointer to error, if any.

Returns

0 if success, 1 if error.

Definition at line 499 of file osp.c.

{
  entity_t entity, vts;
  const char *version;
  const char *status, *status_text;
  osp_get_vts_opts_t get_vts_opts;
 
  if (!connection)
    return 1;
 
  get_vts_opts = osp_get_vts_opts_default;
  get_vts_opts.version_only = 1;
  if (osp_get_vts_ext (connection, get_vts_opts, &entity))
    return 1;
 
  status = entity_attribute (entity, "status");
 
  if (status != NULL && !strcmp (status, "400"))
    {
      status_text = entity_attribute (entity, "status_text");
      g_debug ("%s: %s - %s.", __func__, status, status_text);
      if (error)
        *error = g_strdup (status_text);
      free_entity (entity);
      return 1;
    }
 
  vts = entity_child (entity, "vts");
  if (!vts)
    {
      g_warning ("%s: element VTS missing.", __func__);
      free_entity (entity);
      return 1;
    }
 
  version = entity_attribute (vts, "vts_version");
 
  if (vts_version)
    *vts_version = g_strdup (version);
 
  free_entity (entity);
  return 0;
}

References entity_attribute(), entity_child(), free_entity(), osp_get_vts_ext(), osp_get_vts_opts_default, and osp_get_vts_opts_t::version_only.

Here is the call graph for this function:

osp_param_default()

const char* osp_param_default

(

const osp_param_t *

param

)

Get an OSP parameter's default value.

Parameters

[in]

param

OSP parameter.

Returns

Default value of OSP parameter.

Definition at line 1555 of file osp.c.

{
  assert (param);
 
  return param->def;
}

References osp_param::def.

osp_param_desc()

const char* osp_param_desc

(

const osp_param_t *

param

)

Get an OSP parameter's description.

Parameters

[in]

param

OSP parameter.

Returns

Description of OSP parameter.

Definition at line 1540 of file osp.c.

{
  assert (param);
 
  return param->desc;
}

References osp_param::desc.

osp_param_free()

void osp_param_free

(

osp_param_t *

param

)

Free an OSP parameter.

Parameters

[in]

param

OSP parameter to destroy.

Definition at line 1583 of file osp.c.

{
  if (!param)
    return;
  g_free (param->id);
  g_free (param->name);
  g_free (param->desc);
  g_free (param->def);
  g_free (param);
}

References osp_param::def, osp_param::desc, osp_param::id, and osp_param::name.

osp_param_id()

const char* osp_param_id

(

const osp_param_t *

param

)

Get an OSP parameter's id.

Parameters

[in]

param

OSP parameter.

Returns

ID of OSP parameter.

Definition at line 1510 of file osp.c.

{
  assert (param);
 
  return param->id;
}

References osp_param::id.

osp_param_mandatory()

int osp_param_mandatory

(

const osp_param_t *

param

)

Get an OSP parameter's mandatory value.

Parameters

[in]

param

OSP parameter.

Returns

Mandatory value of OSP parameter.

Definition at line 1570 of file osp.c.

{
  assert (param);
 
  return param->mandatory;
}

References osp_param::mandatory.

osp_param_name()

const char* osp_param_name

(

const osp_param_t *

param

)

Get an OSP parameter's name.

Parameters

[in]

param

OSP parameter.

Returns

Name of OSP parameter.

Definition at line 1525 of file osp.c.

{
  assert (param);
 
  return param->name;
}

References osp_param::name.

osp_param_new()

osp_param_t* osp_param_new

(

void

)

Create a new OSP parameter.

Returns

New OSP parameter.

Definition at line 1497 of file osp.c.

{
  return g_malloc0 (sizeof (osp_param_t));
}

Referenced by osp_get_scanner_details().

Here is the caller graph for this function:

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]

param

OSP parameter.

Returns

OSP parameter in string format.

Definition at line 1405 of file osp.c.

{
  osp_param_type_t type;
 
  assert (param);
  type = param->type;
  if (type == OSP_PARAM_TYPE_INT)
    return "integer";
  else if (type == OSP_PARAM_TYPE_STR)
    return "string";
  else if (type == OSP_PARAM_TYPE_PASSWORD)
    return "password";
  else if (type == OSP_PARAM_TYPE_FILE)
    return "file";
  else if (type == OSP_PARAM_TYPE_BOOLEAN)
    return "boolean";
  else if (type == OSP_PARAM_TYPE_OVALDEF_FILE)
    return "ovaldef_file";
  else if (type == OSP_PARAM_TYPE_SELECTION)
    return "selection";
  else if (type == OSP_PARAM_TYPE_CRD_UP)
    return "credential_up";
  assert (0);
  return NULL;
}

References OSP_PARAM_TYPE_BOOLEAN, OSP_PARAM_TYPE_CRD_UP, OSP_PARAM_TYPE_FILE, OSP_PARAM_TYPE_INT, OSP_PARAM_TYPE_OVALDEF_FILE, OSP_PARAM_TYPE_PASSWORD, OSP_PARAM_TYPE_SELECTION, OSP_PARAM_TYPE_STR, and osp_param::type.

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]	connection	Connection to an OSP server.
[in]	target	Target host to scan.
[in]	ports	List of ports to scan.
[in]	options	Table of scan options.
[in]	scan_id	uuid to set for scan, null otherwise.
[out]	error	Pointer to error, if any.

Returns

0 on success, -1 otherwise.

Definition at line 1052 of file osp.c.

{
  entity_t entity;
  char *options_str = NULL;
  int status;
  int rc;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send start_scan command "
                           "to scanner. Not valid connection");
      return -1;
    }
 
  assert (target);
  /* Construct options string. */
  if (options)
    g_hash_table_foreach (options, option_concat_as_xml, &options_str);
 
  rc = osp_send_command (connection, &entity,
                         "<start_scan target='%s' ports='%s' scan_id='%s'>"
                         "<scanner_params>%s</scanner_params></start_scan>",
                         target, ports ? ports : "", scan_id ? scan_id : "",
                         options_str ? options_str : "");
  g_free (options_str);
  if (rc)
    {
      if (error)
        *error = g_strdup ("Couldn't send start_scan command to scanner");
      return -1;
    }
 
  status = atoi (entity_attribute (entity, "status"));
  if (status == 200)
    {
      free_entity (entity);
      return 0;
    }
  else
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return -1;
    }
}

References entity_attribute(), free_entity(), option_concat_as_xml(), and osp_send_command().

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[in]	opts	Struct containing the options to apply.
[out]	error	Pointer to error, if any.

Returns

0 on success, -1 otherwise.

Definition at line 1250 of file osp.c.

{
  gchar *scanner_params_xml = NULL;
  GString *xml;
  GSList *list_item;
  int list_count;
  int rc, status;
  entity_t entity;
  gchar *cmd;
  char filename[] = "/tmp/osp-cmd-XXXXXX";
  int fd;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send start_scan command "
                           "to scanner. Not valid connection");
      return -1;
    }
 
  fd = mkstemp (filename);
  FILE *file = fdopen (fd, "w");
 
  xml = g_string_sized_new (10240);
  g_string_append (xml, "<start_scan");
  xml_string_append (xml, " scan_id=\"%s\">", opts.scan_id ? opts.scan_id : "");
 
  g_string_append (xml, "<targets>");
  g_slist_foreach (opts.targets, (GFunc) target_append_as_xml, xml);
  g_string_append (xml, "</targets>");
 
  g_string_append (xml, "<scanner_params>");
  if (opts.scanner_params)
    {
      scanner_params_xml = NULL;
      g_hash_table_foreach (opts.scanner_params, (GHFunc) option_concat_as_xml,
                            &scanner_params_xml);
      if (scanner_params_xml)
        g_string_append (xml, scanner_params_xml);
      g_free (scanner_params_xml);
    }
  g_string_append (xml, "</scanner_params>");
 
  g_string_append (xml, "<vt_selection>");
  g_slist_foreach (opts.vt_groups, (GFunc) vt_group_append_as_xml, xml);
 
  fprintf (file, "%s", xml->str);
 
  g_string_free (xml, TRUE);
 
  xml = g_string_new ("");
  list_item = opts.vts;
  list_count = 0;
  while (list_item)
    {
      list_count++;
      vt_single_append_as_xml (list_item->data, xml);
 
      list_item = list_item->next;
 
      if (list_count == 1000)
        {
          fprintf (file, "%s", xml->str);
 
          g_string_free (xml, TRUE);
          xml = g_string_new ("");
          list_count = 0;
        }
    }
 
  g_string_append (xml, "</vt_selection>");
  g_string_append (xml, "</start_scan>");
 
  fprintf (file, "%s", xml->str);
  fflush (file);
  fclose (file);
  g_string_free (xml, TRUE);
 
  g_file_get_contents (filename, &cmd, NULL, NULL);
 
  rc = osp_send_command (connection, &entity, "%s", cmd);
 
  g_free (cmd);
  unlink (filename);
 
  if (rc)
    {
      if (error)
        *error = g_strdup ("Could not send start_scan command to scanner");
      return -1;
    }
 
  status = atoi (entity_attribute (entity, "status"));
  if (status == 200)
    {
      free_entity (entity);
      return 0;
    }
  else
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return -1;
    }
 
  if (error)
    *error = NULL;
  free_entity (entity);
  return 0;
}

References entity_attribute(), free_entity(), option_concat_as_xml(), osp_send_command(), osp_start_scan_opts_t::scan_id, osp_start_scan_opts_t::scanner_params, target_append_as_xml(), osp_start_scan_opts_t::targets, vt_group_append_as_xml(), osp_start_scan_opts_t::vt_groups, vt_single_append_as_xml(), osp_start_scan_opts_t::vts, and xml_string_append().

Here is the call graph for this function:

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]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to delete.
[out]	error	Pointer to error, if any.

Returns

Scan progress if success, -1 if error.

Definition at line 973 of file osp.c.

{
  entity_t entity;
  int rc;
 
  if (!connection)
    {
      if (error)
        *error = g_strdup ("Couldn't send stop_scan command "
                           "to scanner. Not valid connection");
      return -1;
    }
  assert (scan_id);
  rc = osp_send_command (connection, &entity, "<stop_scan scan_id='%s'/>",
                         scan_id);
  if (rc)
    {
      if (error)
        *error = g_strdup ("Couldn't send stop_scan command to scanner");
      return -1;
    }
 
  rc = atoi (entity_attribute (entity, "status"));
  if (rc == 200)
    {
      free_entity (entity);
      return 0;
    }
  else
    {
      const char *text = entity_attribute (entity, "status_text");
 
      assert (text);
      if (error)
        *error = g_strdup (text);
      free_entity (entity);
      return -1;
    }
}

References entity_attribute(), free_entity(), and osp_send_command().

Here is the call graph for this function:

osp_target_add_alive_test_methods()

void osp_target_add_alive_test_methods	(	osp_target_t *	,
		gboolean	,
		gboolean	,
		gboolean	,
		gboolean	,
		gboolean
	)

Referenced by Ensure(), and main().

Here is the caller graph for this function:

osp_target_add_credential()

void osp_target_add_credential	(	osp_target_t *	,
		osp_credential_t *
	)

osp_target_free()

void osp_target_free

(

osp_target_t *

)

Referenced by Ensure().

Here is the caller graph for this function:

osp_target_new()

osp_target_t* osp_target_new	(	const char *	,
		const char *	,
		const char *	,
		int	,
		int	,
		int
	)

Referenced by Ensure().

Here is the caller graph for this function:

osp_target_set_finished_hosts()

void osp_target_set_finished_hosts	(	osp_target_t *	,
		const char *
	)

osp_vt_group_free()

void osp_vt_group_free

(

osp_vt_group_t *

)

osp_vt_group_new()

osp_vt_group_t* osp_vt_group_new

(

const char *

)

osp_vt_single_add_value()

void osp_vt_single_add_value	(	osp_vt_single_t *	,
		const char *	,
		const char *
	)

osp_vt_single_free()

void osp_vt_single_free

(

osp_vt_single_t *

)

osp_vt_single_new()

osp_vt_single_t* osp_vt_single_new

(

const char *

)

Variable Documentation

osp_get_vts_opts_default

const osp_get_vts_opts_t osp_get_vts_opts_default = {NULL, 0}

static

Sensible default values for osp_get_vts_opts_t.

Definition at line 109 of file osp.h.

Referenced by osp_get_vts_feed_info(), and osp_get_vts_version().