osp.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2014-2023 Greenbone AG
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

 
#ifndef _GVM_OSP_H
#define _GVM_OSP_H
 
#include "../util/xmlutils.h"
 
#include <glib.h> /* for GHashTable, GSList */
 
/* Type definitions */
 
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 enum
{
  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;

typedef enum
{
  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;
 
typedef struct
{
  const char *scan_id; 
} osp_get_scan_status_opts_t;
 
typedef struct
{
  int start;    
  int end;      
  char *titles; 
} osp_get_performance_opts_t;
 
typedef struct osp_param osp_param_t;
 
/* OSP Connection handling */
 
osp_connection_t *
osp_connection_new (const char *, int, const char *, const char *,
                    const char *);
 
void
osp_connection_close (osp_connection_t *);
 
/* OSP commands */
int
osp_check_feed (osp_connection_t *, int *, int *, char **, char **);
 
int
osp_get_version (osp_connection_t *, char **, char **, char **, char **,
                 char **, char **);
 
int
osp_get_vts_version (osp_connection_t *, char **, char **error);
 
int
osp_get_vts_feed_info (osp_connection_t *, char **, char **, char **, char **,
                       char **);
 
int
osp_get_vts (osp_connection_t *, entity_t *);
 
typedef struct
{
  char *filter;     
  int version_only; 
} osp_get_vts_opts_t;

static const osp_get_vts_opts_t osp_get_vts_opts_default = {NULL, 0};
 
int
osp_get_vts_ext (osp_connection_t *, osp_get_vts_opts_t, entity_t *);
 
int
osp_get_vts_ext_str (osp_connection_t *, osp_get_vts_opts_t, gchar **);
 
int
osp_start_scan (osp_connection_t *, const char *, const char *, GHashTable *,
                const char *, char **);
 
typedef struct
{
  GSList *targets;            
  GSList *vt_groups;          
  GSList *vts;                
  GHashTable *scanner_params; 
  const char *scan_id;        
} osp_start_scan_opts_t;
 
int
osp_start_scan_ext (osp_connection_t *, osp_start_scan_opts_t, char **);
 
int
osp_get_scan (osp_connection_t *, const char *, char **, int, char **);
 
int
osp_get_scan_pop (osp_connection_t *, const char *, char **, int, int, char **);
 
osp_scan_status_t
osp_get_scan_status_ext (osp_connection_t *, osp_get_scan_status_opts_t,
                         char **);
 
int
osp_delete_scan (osp_connection_t *, const char *);
 
int
osp_stop_scan (osp_connection_t *, const char *, char **);
 
int
osp_get_scanner_details (osp_connection_t *, char **, GSList **);
 
int
osp_get_performance_ext (osp_connection_t *, osp_get_performance_opts_t,
                         char **, char **);
 
/* OSP scanner parameters handling */
 
osp_param_t *
osp_param_new (void);
 
const char *
osp_param_id (const osp_param_t *);
 
const char *
osp_param_name (const osp_param_t *);
 
const char *
osp_param_desc (const osp_param_t *);
 
const char *
osp_param_default (const osp_param_t *);
 
const char *
osp_param_type_str (const osp_param_t *);
 
int
osp_param_mandatory (const osp_param_t *);
 
void
osp_param_free (osp_param_t *);
 
/* OSP credential handling */
 
osp_credential_t *
osp_credential_new (const char *, const char *, const char *);
 
void
osp_credential_free (osp_credential_t *);
 
const gchar *
osp_credential_get_auth_data (osp_credential_t *, const char *);
 
void
osp_credential_set_auth_data (osp_credential_t *, const char *, const char *);
 
/* OSP targets handling */
 
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 handling */
 
osp_vt_group_t *
osp_vt_group_new (const char *);
 
void
osp_vt_group_free (osp_vt_group_t *);
 
/* OSP single VT handling */
 
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 *);
 
#endif