osp.h File Reference

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...

Detailed Description

API for Open Scanner Protocol communication.

Typedef Documentation

osp_connection_t

typedef struct osp_connection osp_connection_t

osp_param_t

typedef struct osp_param osp_param_t

Enumeration Type Documentation

osp_param_type_t

enum osp_param_type_t

OSP parameter types.

Enumerator
OSP_PARAM_TYPE_INT	Integer type.
OSP_PARAM_TYPE_STR	String type.
OSP_PARAM_TYPE_PASSWORD	Password type.
OSP_PARAM_TYPE_FILE	File type.
OSP_PARAM_TYPE_BOOLEAN	Boolean type.
OSP_PARAM_TYPE_OVALDEF_FILE	Oval definition type.
OSP_PARAM_TYPE_SELECTION	Selection type.
OSP_PARAM_TYPE_CRD_UP	Credential user/pass type.

Function Documentation

osp_connection_close()

void osp_connection_close

(

osp_connection_t *

connection

)

Close a connection to an OSP server.

Parameters

[in]

connection

Connection to OSP server to close.

osp_connection_new()

osp_connection_t* osp_connection_new	(	const char *	,
		int	,
		const char *	,
		const char *	,
		const char *
	)

osp_delete_scan()

int osp_delete_scan	(	osp_connection_t *	connection,
		const char *	scan_id
	)

Delete a scan from an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to delete.

Returns

0 if success, 1 if error.

osp_get_scan()

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.

Parameters

[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.

Returns

Scan progress if success, -1 if error.

osp_get_scanner_details()

int osp_get_scanner_details	(	osp_connection_t *	connection,
		char **	desc,
		GSList **	params
	)

Get an OSP scanner's details.

Parameters

[in]	connection	Connection to an OSP server.
[out]	desc	Scanner's description.
[out]	params	Scanner's parameters.

Returns

0 if success, 1 if failure.

osp_get_version()

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.

Parameters

[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.

Returns

0 if success, 1 if error.

osp_param_default()

const char* osp_param_default

(

const osp_param_t *

param

)

Get an OSP parameter's default value.

Parameters

[in]

param

OSP parameter.

Returns

Default value of OSP parameter.

osp_param_desc()

const char* osp_param_desc

(

const osp_param_t *

param

)

Get an OSP parameter's description.

Parameters

[in]

param

OSP parameter.

Returns

Description of OSP parameter.

osp_param_free()

void osp_param_free

(

osp_param_t *

param

)

Free an OSP parameter.

Parameters

[in]

param

OSP parameter to destroy.

osp_param_id()

const char* osp_param_id

(

const osp_param_t *

param

)

Get an OSP parameter's id.

Parameters

[in]

param

OSP parameter.

Returns

ID of OSP parameter.

osp_param_mandatory()

int osp_param_mandatory

(

const osp_param_t *

param

)

Get an OSP parameter's mandatory value.

Parameters

[in]

param

OSP parameter.

Returns

Mandatory value of OSP parameter.

osp_param_name()

const char* osp_param_name

(

const osp_param_t *

param

)

Get an OSP parameter's name.

Parameters

[in]

param

OSP parameter.

Returns

Name of OSP parameter.

osp_param_new()

osp_param_t* osp_param_new

(

void

)

Create a new OSP parameter.

Returns

New OSP parameter.

osp_param_type_str()

const char* osp_param_type_str

(

const osp_param_t *

param

)

Get an OSP parameter in string format form its type.

Parameters

[in]

param

OSP parameter.

Returns

OSP parameter in string format.

osp_start_scan()

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.

Parameters

[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.

Returns

0 on success, -1 otherwise.

osp_stop_scan()

int osp_stop_scan	(	osp_connection_t *	connection,
		const char *	scan_id,
		char **	error
	)

Stop a scan on an OSP server.

Parameters

[in]	connection	Connection to an OSP server.
[in]	scan_id	ID of scan to delete.
[out]	error	Pointer to error, if any.

Returns

Scan progress if success, -1 if error.