gmp.h

Go to the documentation of this file.

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

 
#ifndef _GVM_GMP_GMP_H
#define _GVM_GMP_GMP_H
 
#include "../base/array.h"       /* for array_t */
#include "../util/serverutils.h" /* for gvm_connection_t */
#include "../util/xmlutils.h"    /* for entity_t */
 
#include <glib.h>          /* for gchar */
#include <glib/gtypes.h>   /* for gsize */
#include <gnutls/gnutls.h> /* for gnutls_session_t */
#include <stddef.h>        /* for NULL */

typedef struct
{
  int timeout;          
  const char *username; 
  const char *password; 
  char **role;          
  char **timezone;      
  char **pw_warning;    
  int jwt_requested;    
  char **jwt;           
} gmp_authenticate_info_opts_t;

static const gmp_authenticate_info_opts_t gmp_authenticate_info_opts_defaults =
  {0, NULL, NULL, NULL, NULL, NULL, 0, NULL};

typedef struct
{
  const char *sort_field;
  const char *sort_order;
  const char *format_id; 
  const char *levels;    
  const char *report_id; 
  int first_result;      
  int max_results;       
  int timeout;           
  int host_first_result; 
  int host_max_results;  
  int autofp; 
  char *type; 
  char *filter;          
  char *filt_id;         
  char *host;            
  char *pos;             
  char *timezone;        
  char *alert_id;        
  char *delta_report_id; 
  char *delta_states;    
  char *host_levels;     
  char *search_phrase;   
  char *host_search_phrase; 
  char *min_cvss_base;      
  char *min_qod;            
  /* Boolean flags: */
  int notes;             
  int notes_details;     
  int overrides;         
  int override_details;  
  int apply_overrides;   
  int result_hosts_only; 
  int ignore_pagination; 
} gmp_get_report_opts_t;

static const gmp_get_report_opts_t gmp_get_report_opts_defaults = {
  "ROWID",
  "ascending",
  "a994b278-1f62-11e1-96ac-406186ea4fc5",
  "hmlgd",
  NULL,
  1,
  -1,
  0,
  0,
  0,
  0,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  0,
  0,
  0,
  0,
  0,
  0,
  0};

typedef struct
{
  const char *filter;  
  int timeout;         
  const char *actions; 
  /* Boolean flags: */
  int details; 
  int rcfile;  
} gmp_get_tasks_opts_t;

static const gmp_get_tasks_opts_t gmp_get_tasks_opts_defaults = {"", 0, NULL, 0,
                                                                 0};

typedef struct
{
  const char *actions; 
  const char *task_id; 
  /* Boolean flags: */
  int details; 
  int rcfile;  
} gmp_get_task_opts_t;

static const gmp_get_task_opts_t gmp_get_task_opts_defaults = {NULL, NULL, 0,
                                                               0};

typedef struct
{
  array_t *alert_ids;         
  const char *config_id;      
  const char *scanner_id;     
  const char *schedule_id;    
  const char *slave_id;       
  const char *target_id;      
  const char *name;           
  const char *comment;        
  const char *hosts_ordering; 
  const char *observers;      
  array_t *observer_groups;   
  int schedule_periods;       
  /* Preferences */
  const char *in_assets;    
  const char *max_hosts;    
  const char *max_checks;   
  const char *source_iface; 
  /* Boolean flags: */
  int alterable; 
} gmp_create_task_opts_t;

static const gmp_create_task_opts_t gmp_create_task_opts_defaults = {
  NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
  NULL, NULL, 0,    NULL, NULL, NULL, NULL, 0};

typedef struct
{
  int ssh_credential_port;        
  const char *ssh_credential_id;  
  const char *smb_credential_id;  
  const char *esxi_credential_id; 
  const char *snmp_credential_id; 
  const char *port_range;         
  const char *name;               
  const char *comment;            
  const char *hosts;              
  const char *exclude_hosts;      
  const char *alive_tests;        
  /* Boolean flags: */
  int reverse_lookup_only;  
  int reverse_lookup_unify; 
} gmp_create_target_opts_t;

static const gmp_create_target_opts_t gmp_create_target_opts_defaults = {
  0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, 0};

typedef struct
{
  const char *name;       
  const char *duration;   
  const char *start_time; 
  const char *end_time;   
  const char *slave_id;   
  int brief;              
} gmp_get_system_reports_opts_t;

static const gmp_get_system_reports_opts_t
  gmp_get_system_reports_opts_defaults = {NULL, NULL, NULL, NULL, NULL, 0};

typedef struct
{
  const char *name;              
  const char *community;         
  const char *login;             
  const char *passphrase;        
  const char *private_key;       
  const char *auth_algorithm;    
  const char *privacy_password;  
  const char *privacy_algorithm; 
  const char *comment;           
} gmp_create_lsc_credential_opts_t;

static const gmp_create_lsc_credential_opts_t
  gmp_create_lsc_credential_opts_defaults = {NULL, NULL, NULL, NULL, NULL,
                                             NULL, NULL, NULL, NULL};

typedef struct
{
  int ultimate; 
} gmp_delete_opts_t;

static const gmp_delete_opts_t gmp_delete_opts_defaults = {0};

static const gmp_delete_opts_t gmp_delete_opts_ultimate_defaults = {1};
 
int
gmp_read_create_response (gnutls_session_t *, gchar **);
 
const char *
gmp_task_status (entity_t status_response);
 
int
gmp_ping (gnutls_session_t *, int);
 
int
gmp_ping_c (gvm_connection_t *, int, gchar **);
 
int
gmp_authenticate (gnutls_session_t *session, const char *username,
                  const char *password);
 
int
gmp_authenticate_info_ext (gnutls_session_t *, gmp_authenticate_info_opts_t);
 
int
gmp_authenticate_info_ext_c (gvm_connection_t *, gmp_authenticate_info_opts_t);
 
int
gmp_create_task (gnutls_session_t *, const char *, const char *, const char *,
                 const char *, gchar **);
 
int
gmp_create_task_ext (gnutls_session_t *, gmp_create_task_opts_t, gchar **);
 
int
gmp_start_task_report (gnutls_session_t *, const char *, char **);
 
int
gmp_start_task_report_c (gvm_connection_t *, const char *, char **);

typedef struct
{
  const char *task_id; 
} gmp_start_task_opts_t;
 
static const gmp_start_task_opts_t gmp_start_task_opts_defaults = {NULL};
 
int
gmp_start_task_ext_c (gvm_connection_t *, gmp_start_task_opts_t);
 
int
gmp_stop_task (gnutls_session_t *, const char *);
 
int
gmp_stop_task_c (gvm_connection_t *, const char *);
 
int
gmp_resume_task_report (gnutls_session_t *, const char *, char **);
 
int
gmp_resume_task_report_c (gvm_connection_t *, const char *, char **);
 
int
gmp_get_tasks (gnutls_session_t *, const char *, int, int, entity_t *);
 
int
gmp_get_tasks_ext (gnutls_session_t *, gmp_get_tasks_opts_t, entity_t *);
 
int
gmp_get_task_ext (gnutls_session_t *, gmp_get_task_opts_t, entity_t *);
 
int
gmp_get_targets (gnutls_session_t *, const char *, int, int, entity_t *);
 
int
gmp_get_report_ext (gnutls_session_t *, gmp_get_report_opts_t, entity_t *);
 
int
gmp_delete_port_list_ext (gnutls_session_t *, const char *, gmp_delete_opts_t);
 
int
gmp_delete_task (gnutls_session_t *, const char *);
 
int
gmp_delete_task_ext (gnutls_session_t *, const char *, gmp_delete_opts_t);
 
int
gmp_modify_task_file (gnutls_session_t *, const char *, const char *,
                      const void *, gsize);
 
int
gmp_delete_report (gnutls_session_t *, const char *);
 
int
gmp_create_target_ext (gnutls_session_t *, gmp_create_target_opts_t, gchar **);
 
int
gmp_delete_target_ext (gnutls_session_t *, const char *, gmp_delete_opts_t);
 
int
gmp_delete_config_ext (gnutls_session_t *, const char *, gmp_delete_opts_t);
 
int
gmp_create_lsc_credential_ext (gnutls_session_t *,
                               gmp_create_lsc_credential_opts_t, gchar **);
 
int
gmp_create_lsc_credential (gnutls_session_t *, const char *, const char *,
                           const char *, const char *, gchar **);
 
int
gmp_create_lsc_credential_key (gnutls_session_t *, const char *, const char *,
                               const char *, const char *, const char *,
                               gchar **);
 
int
gmp_delete_lsc_credential_ext (gnutls_session_t *, const char *,
                               gmp_delete_opts_t);
 
int
gmp_get_system_reports (gnutls_session_t *, const char *, int, entity_t *);
 
int
gmp_get_system_reports_ext (gnutls_session_t *, gmp_get_system_reports_opts_t,
                            entity_t *);
 
#endif /* not _GVM_GMP_GMP_H */