Greenbone Vulnerability Management Libraries 22.12.2
|
API for Open Scanner Protocol communication. More...
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. | |
int | osp_check_feed (osp_connection_t *, int *, int *, char **, char **) |
Gets additional status info about the feed. | |
int | osp_get_version (osp_connection_t *, char **, char **, char **, char **, char **, char **) |
Get the scanner version from an OSP server. | |
int | osp_get_vts_version (osp_connection_t *, char **, char **error) |
Get the VTs version from an OSP server. | |
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. | |
int | osp_get_vts (osp_connection_t *, entity_t *) |
Get all VTs from an OSP server. | |
int | osp_get_vts_ext (osp_connection_t *, osp_get_vts_opts_t, entity_t *) |
Get filtered set of VTs from an OSP server. | |
int | osp_get_vts_ext_str (osp_connection_t *, osp_get_vts_opts_t, gchar **) |
Get filtered set of VTs from an OSP server. | |
int | osp_start_scan (osp_connection_t *, const char *, const char *, GHashTable *, const char *, char **) |
Start an OSP scan against a target. | |
int | osp_start_scan_ext (osp_connection_t *, osp_start_scan_opts_t, char **) |
Start an OSP scan against a target. | |
int | osp_get_scan (osp_connection_t *, const char *, char **, int, char **) |
Get a scan from an OSP server. | |
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. | |
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. | |
int | osp_delete_scan (osp_connection_t *, const char *) |
Delete a scan from an OSP server. | |
int | osp_stop_scan (osp_connection_t *, const char *, char **) |
Stop a scan on an OSP server. | |
int | osp_get_scanner_details (osp_connection_t *, char **, GSList **) |
Get an OSP scanner's details. | |
int | osp_get_performance_ext (osp_connection_t *, osp_get_performance_opts_t, char **, char **) |
Get performance graphics from an OSP server. | |
osp_param_t * | osp_param_new (void) |
Create a new OSP parameter. | |
const char * | osp_param_id (const osp_param_t *) |
Get an OSP parameter's id. | |
const char * | osp_param_name (const osp_param_t *) |
Get an OSP parameter's name. | |
const char * | osp_param_desc (const osp_param_t *) |
Get an OSP parameter's description. | |
const char * | osp_param_default (const osp_param_t *) |
Get an OSP parameter's default value. | |
const char * | osp_param_type_str (const osp_param_t *) |
Get an OSP parameter in string format form its type. | |
int | osp_param_mandatory (const osp_param_t *) |
Get an OSP parameter's mandatory value. | |
void | osp_param_free (osp_param_t *) |
Free an OSP parameter. | |
osp_credential_t * | osp_credential_new (const char *, const char *, const char *) |
Allocate and initialize a new OSP credential. | |
void | osp_credential_free (osp_credential_t *) |
Free an OSP credential. | |
const gchar * | osp_credential_get_auth_data (osp_credential_t *, const char *) |
Get authentication data from an OSP credential. | |
void | osp_credential_set_auth_data (osp_credential_t *, const char *, const char *) |
Get authentication data from an OSP credential. | |
osp_target_t * | osp_target_new (const char *, const char *, const char *, int, int, int) |
Create a new OSP target. | |
void | osp_target_set_finished_hosts (osp_target_t *, const char *) |
Set the finished hosts of an OSP target. | |
void | osp_target_free (osp_target_t *) |
Free an OSP target, including all added credentials. | |
void | osp_target_add_alive_test_methods (osp_target_t *, gboolean, gboolean, gboolean, gboolean, gboolean) |
Add alive test methods to OSP target. | |
void | osp_target_add_credential (osp_target_t *, osp_credential_t *) |
Add a credential to an OSP target. | |
osp_vt_group_t * | osp_vt_group_new (const char *) |
Create a new OSP VT group. | |
void | osp_vt_group_free (osp_vt_group_t *) |
Free a OSP VT group. | |
osp_vt_single_t * | osp_vt_single_new (const char *) |
Create a new single OSP VT. | |
void | osp_vt_single_free (osp_vt_single_t *) |
Free a single OSP VT, including all preference values. | |
void | osp_vt_single_add_value (osp_vt_single_t *, const char *, const char *) |
Add a preference value to an OSP VT. This creates a copy of the name and value. | |
Variables | |
static const osp_get_vts_opts_t | osp_get_vts_opts_default = {NULL, 0} |
Sensible default values for osp_get_vts_opts_t. | |
API for Open Scanner Protocol communication.
typedef struct osp_connection osp_connection_t |
typedef struct osp_credential osp_credential_t |
typedef struct osp_param osp_param_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 |
enum osp_param_type_t |
OSP parameter types.
enum osp_scan_status_t |
OSP scan status.
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.
[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. |
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 * | ) |
void osp_credential_free | ( | osp_credential_t * | credential | ) |
Free an OSP credential.
[in] | credential | The credential to free. |
const gchar * osp_credential_get_auth_data | ( | osp_credential_t * | credential, |
const char * | name ) |
Get authentication data from an OSP credential.
[in] | credential | The credential to get the data from. |
[in] | name | The name of the data item to get. |
osp_credential_t * osp_credential_new | ( | const char * | type, |
const char * | service, | ||
const char * | port ) |
Allocate and initialize a new OSP credential.
[in] | type | The credential type. |
[in] | service | The service the credential is for. |
[in] | port | The port. |
void osp_credential_set_auth_data | ( | osp_credential_t * | credential, |
const char * | name, | ||
const char * | value ) |
Get authentication data from an OSP credential.
[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. |
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_performance_ext | ( | osp_connection_t * | connection, |
osp_get_performance_opts_t | opts, | ||
char ** | graph, | ||
char ** | error ) |
Get performance graphics from an OSP server.
[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. |
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_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.
[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. |
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.
[in] | connection | Connection to an OSP server. |
[in] | opts | Struct containing the options to apply. |
[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. |
int osp_get_vts | ( | osp_connection_t * | connection, |
entity_t * | vts ) |
Get all VTs from an OSP server.
[in] | connection | Connection to an OSP server. |
[out] | vts | VTs. |
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.
[in] | connection | Connection to an OSP server. |
[in] | opts | Struct containing the options to apply. |
[out] | vts | VTs. |
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.
[in] | connection | Connection to an OSP server. |
[in] | opts | Struct containing the options to apply. |
[out] | str | Response. |
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.
[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. |
int osp_get_vts_version | ( | osp_connection_t * | connection, |
char ** | vts_version, | ||
char ** | error ) |
Get the VTs version from an OSP server.
[in] | connection | Connection to an OSP server. |
[out] | vts_version | Parsed scanner version. |
[out] | error | Pointer to error, if any. |
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_start_scan_ext | ( | osp_connection_t * | connection, |
osp_start_scan_opts_t | opts, | ||
char ** | error ) |
Start an OSP scan against a target.
[in] | connection | Connection to an OSP server. |
[in] | opts | Struct containing the options to apply. |
[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. |
void osp_target_add_alive_test_methods | ( | osp_target_t * | target, |
gboolean | icmp, | ||
gboolean | tcp_syn, | ||
gboolean | tcp_ack, | ||
gboolean | arp, | ||
gboolean | consider_alive ) |
Add alive test methods to OSP target.
[in] | target | The OSP target to add the methods to. |
[in] | icmp | Use ICMP ping. |
[in] | tcp_syn | Use TCP-SYN ping. |
[in] | tcp_ack | Use TCP-ACK ping. |
[in] | arp | Use ARP ping. |
[in] | consider_alive | Consider host to be alive. |
void osp_target_add_credential | ( | osp_target_t * | target, |
osp_credential_t * | credential ) |
Add a credential to an OSP target.
[in] | target | The OSP target to add the credential to. |
[in] | credential | The credential to add. Will be freed with target. |
void osp_target_free | ( | osp_target_t * | target | ) |
Free an OSP target, including all added credentials.
[in] | target | The OSP target to free. |
osp_target_t * osp_target_new | ( | const char * | hosts, |
const char * | ports, | ||
const char * | exclude_hosts, | ||
int | alive_test, | ||
int | reverse_lookup_unify, | ||
int | reverse_lookup_only ) |
Create a new OSP target.
[in] | hosts | The hostnames of the target. |
[in] | ports | The ports of the target. |
[in] | exclude_hosts | The excluded hosts of the target. |
[in] | alive_test | The alive test method of the target. |
[in] | reverse_lookup_unify | Lookup flag. |
[in] | reverse_lookup_only | Lookup flag. |
void osp_target_set_finished_hosts | ( | osp_target_t * | target, |
const char * | finished_hosts ) |
Set the finished hosts of an OSP target.
[in] | target | The OSP target to modify. |
[in] | finished_hosts | The hostnames to consider finished. |
void osp_vt_group_free | ( | osp_vt_group_t * | vt_group | ) |
Free a OSP VT group.
[in] | vt_group | The VT group to free. |
osp_vt_group_t * osp_vt_group_new | ( | const char * | filter | ) |
Create a new OSP VT group.
[in] | filter | The filter string for the VT group. |
void osp_vt_single_add_value | ( | osp_vt_single_t * | vt_single, |
const char * | name, | ||
const char * | value ) |
Add a preference value to an OSP VT. This creates a copy of the name and value.
[in] | vt_single | The VT to add the preference to. |
[in] | name | The name / identifier of the preference. |
[in] | value | The value of the preference. |
void osp_vt_single_free | ( | osp_vt_single_t * | vt_single | ) |
Free a single OSP VT, including all preference values.
[in] | vt_single | The OSP VT to free. |
osp_vt_single_t * osp_vt_single_new | ( | const char * | vt_id | ) |
Create a new single OSP VT.
[in] | vt_id | The id of the VT. |
|
static |
Sensible default values for osp_get_vts_opts_t.