Greenbone Vulnerability Management Libraries
10.0.0
|
API for Open Scanner Protocol communication. More...
#include <glib.h>
Go to the source code of this file.
Typedefs | |
typedef struct osp_connection | osp_connection_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... | |
Functions | |
osp_connection_t * | osp_connection_new (const char *, int, const char *, const char *, const char *) |
int | osp_get_version (osp_connection_t *, char **, char **, char **, char **, char **, char **) |
Get the scanner version 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_get_scan (osp_connection_t *, const char *, char **, int, char **) |
Get a scan 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... | |
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... | |
void | osp_connection_close (osp_connection_t *) |
Close a connection to an OSP server. More... | |
API for Open Scanner Protocol communication.
typedef struct osp_connection osp_connection_t |
typedef struct osp_param osp_param_t |
enum osp_param_type_t |
OSP parameter types.
void osp_connection_close | ( | osp_connection_t * | connection | ) |
Close a connection to an OSP server.
[in] | connection | Connection to OSP server to close. |
osp_connection_t* osp_connection_new | ( | const char * | , |
int | , | ||
const char * | , | ||
const char * | , | ||
const char * | |||
) |
int osp_delete_scan | ( | osp_connection_t * | connection, |
const char * | scan_id | ||
) |
Delete a scan from an OSP server.
[in] | connection | Connection to an OSP server. |
[in] | scan_id | ID of scan to delete. |
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.
[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. |
int osp_get_scanner_details | ( | osp_connection_t * | connection, |
char ** | desc, | ||
GSList ** | params | ||
) |
Get an OSP scanner's details.
[in] | connection | Connection to an OSP server. |
[out] | desc | Scanner's description. |
[out] | params | Scanner's parameters. |
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.
[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. |
const char* osp_param_default | ( | const osp_param_t * | param | ) |
Get an OSP parameter's default value.
[in] | param | OSP parameter. |
const char* osp_param_desc | ( | const osp_param_t * | param | ) |
Get an OSP parameter's description.
[in] | param | OSP parameter. |
void osp_param_free | ( | osp_param_t * | param | ) |
Free an OSP parameter.
[in] | param | OSP parameter to destroy. |
const char* osp_param_id | ( | const osp_param_t * | param | ) |
Get an OSP parameter's id.
[in] | param | OSP parameter. |
int osp_param_mandatory | ( | const osp_param_t * | param | ) |
Get an OSP parameter's mandatory value.
[in] | param | OSP parameter. |
const char* osp_param_name | ( | const osp_param_t * | param | ) |
Get an OSP parameter's name.
[in] | param | OSP parameter. |
osp_param_t* osp_param_new | ( | void | ) |
Create a new OSP parameter.
const char* osp_param_type_str | ( | const osp_param_t * | param | ) |
Get an OSP parameter in string format form its type.
[in] | param | OSP parameter. |
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.
[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. |
int osp_stop_scan | ( | osp_connection_t * | connection, |
const char * | scan_id, | ||
char ** | error | ||
) |
Stop a scan on an OSP server.
[in] | connection | Connection to an OSP server. |
[in] | scan_id | ID of scan to delete. |
[out] | error | Pointer to error, if any. |