Greenbone Vulnerability Management Libraries  10.0.0
osp.h
Go to the documentation of this file.
1 /* Copyright (C) 2014-2019 Greenbone Networks GmbH
2  *
3  * SPDX-License-Identifier: GPL-2.0-or-later
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
25 #ifndef _GVM_OSP_H
26 #define _GVM_OSP_H
27 
28 #include <glib.h> /* for GHashTable, GSList */
29 
31 
35 typedef enum
36 {
46 
47 typedef struct osp_param osp_param_t;
48 
50 osp_connection_new (const char *, int, const char *, const char *,
51  const char *);
52 
53 int
54 osp_get_version (osp_connection_t *, char **, char **, char **, char **,
55  char **, char **);
56 
57 int
58 osp_start_scan (osp_connection_t *, const char *, const char *, GHashTable *,
59  const char *, char **);
60 
61 int
62 osp_get_scan (osp_connection_t *, const char *, char **, int, char **);
63 
64 int
65 osp_delete_scan (osp_connection_t *, const char *);
66 
67 int
68 osp_stop_scan (osp_connection_t *, const char *, char **);
69 
70 int
71 osp_get_scanner_details (osp_connection_t *, char **, GSList **);
72 
74 osp_param_new (void);
75 
76 const char *
77 osp_param_id (const osp_param_t *);
78 
79 const char *
80 osp_param_name (const osp_param_t *);
81 
82 const char *
83 osp_param_desc (const osp_param_t *);
84 
85 const char *
87 
88 const char *
90 
91 int
93 
94 void
96 
97 void
99 
100 #endif
int osp_start_scan(osp_connection_t *, const char *, const char *, GHashTable *, const char *, char **)
Start an OSP scan against a target.
Definition: osp.c:457
Struct holding options for OSP parameters.
Definition: osp.c:60
Struct holding options for OSP connection.
Definition: osp.c:49
int osp_get_scanner_details(osp_connection_t *, char **, GSList **)
Get an OSP scanner's details.
Definition: osp.c:578
osp_param_type_t
OSP parameter types.
Definition: osp.h:35
Definition: osp.h:39
Definition: osp.h:42
int osp_get_version(osp_connection_t *, char **, char **, char **, char **, char **, char **)
Get the scanner version from an OSP server.
Definition: osp.c:211
const char * osp_param_type_str(const osp_param_t *)
Get an OSP parameter in string format form its type.
Definition: osp.c:542
void osp_connection_close(osp_connection_t *)
Close a connection to an OSP server.
Definition: osp.c:184
int osp_param_mandatory(const osp_param_t *)
Get an OSP parameter's mandatory value.
Definition: osp.c:707
Definition: osp.h:41
const char * osp_param_desc(const osp_param_t *)
Get an OSP parameter's description.
Definition: osp.c:677
int osp_stop_scan(osp_connection_t *, const char *, char **)
Stop a scan on an OSP server.
Definition: osp.c:384
Definition: osp.h:40
void osp_param_free(osp_param_t *)
Free an OSP parameter.
Definition: osp.c:720
int osp_delete_scan(osp_connection_t *, const char *)
Delete a scan from an OSP server.
Definition: osp.c:295
osp_param_t * osp_param_new(void)
Create a new OSP parameter.
Definition: osp.c:634
const char * osp_param_name(const osp_param_t *)
Get an OSP parameter's name.
Definition: osp.c:662
const char * osp_param_default(const osp_param_t *)
Get an OSP parameter's default value.
Definition: osp.c:692
const char * osp_param_id(const osp_param_t *)
Get an OSP parameter's id.
Definition: osp.c:647
Definition: osp.h:43
Definition: osp.h:37
Definition: osp.h:44
Definition: osp.h:38
int osp_get_scan(osp_connection_t *, const char *, char **, int, char **)
Get a scan from an OSP server.
Definition: osp.c:331
osp_connection_t * osp_connection_new(const char *, int, const char *, const char *, const char *)