omp.h File Reference

#include "xml.h"

Go to the source code of this file.

Data Structures
struct	omp_get_report_opts_t
	Struct holding options for omp get_report command. More...
struct	omp_get_tasks_opts_t
	Struct holding options for omp get_tasks command. More...
struct	omp_get_task_opts_t
	Struct holding options for omp get_tasks command. More...
struct	omp_create_task_opts_t
	Struct holding options for omp create_task command. More...
struct	omp_create_target_opts_t
	Struct holding options for omp create_target command. More...
struct	omp_get_system_reports_opts_t
	Struct holding options for omp get_system_reports command. More...

Functions
int	check_response (gnutls_session_t *)
	Read response and convert status of response to a return value. More...
int	omp_read_create_response (gnutls_session_t *, gchar **)
	Read response status and resource UUID. More...
const char *	omp_task_status (entity_t status_response)
	Get the task status from an OMP GET_TASKS response. More...
int	omp_ping (gnutls_session_t *, int)
	"Ping" the manager. More...
int	omp_get_nvt_all (gnutls_session_t *session, entity_t *response)
	Issue an OMP <get_nvts\/> command and wait for the response. More...
int	omp_get_nvt_feed_checksum (gnutls_session_t *session, entity_t *response)
	Issue an OMP <get_nvt_feed_checksum algoithm=md5/> command and. More...
int	omp_get_dependencies_503 (gnutls_session_t *session, entity_t *response)
	Issue an OMP <get_dependencies/> command and wait for the response. More...
int	omp_authenticate (gnutls_session_t *session, const char *username, const char *password)
	Authenticate with the manager. More...
int	omp_authenticate_info (gnutls_session_t *session, const char *username, const char *, char **, char **)
	Authenticate with the manager. More...
int	omp_authenticate_env (gnutls_session_t *session)
	Authenticate, getting credentials from the environment. More...
int	omp_create_task_rc (gnutls_session_t *, const char *, unsigned int, const char *, const char *, char **)
	Create a task, given the task description as an RC file. More...
int	omp_create_task (gnutls_session_t *, const char *, const char *, const char *, const char *, gchar **)
	Create a task given a config and target. More...
int	omp_create_task_ext (gnutls_session_t *, omp_create_task_opts_t, gchar **)
	Create a task. More...
int	omp_create_task_rc_file (gnutls_session_t *, const char *, const char *, const char *, char **)
	Create a task, given the task description as an RC file. More...
int	omp_start_task_report (gnutls_session_t *, const char *, char **)
	Start a task and read the manager response. More...
int	omp_start_task (gnutls_session_t *, const char *)
	Start a task and read the manager response. More...
int	omp_resume_or_start_task_report (gnutls_session_t *, const char *, char **)
	Resume or start a task and read the manager response. More...
int	omp_resume_or_start_task (gnutls_session_t *, const char *)
	Resume or start a task and read the manager response. More...
int	omp_abort_task (gnutls_session_t *, const char *)
	Deprecated wrapper function for /ref omp_stop_task. More...
int	omp_stop_task (gnutls_session_t *, const char *)
	Stop a task and read the manager response. More...
int	omp_pause_task (gnutls_session_t *, const char *)
	Pause a task and read the manager response. More...
int	omp_resume_paused_task (gnutls_session_t *, const char *)
	Resume a paused task and read the manager response. More...
int	omp_resume_stopped_task (gnutls_session_t *, const char *)
	Resume a stopped task and read the manager response. More...
int	omp_resume_stopped_task_report (gnutls_session_t *, const char *, char **)
	Resume a stopped task and read the manager response. More...
int	omp_wait_for_task_end (gnutls_session_t *, const char *)
	Wait for a task to finish running on the server. More...
int	omp_wait_for_task_start (gnutls_session_t *, const char *)
	Wait for a task to start running on the server. More...
int	omp_wait_for_task_stop (gnutls_session_t *, const char *)
	Wait for a task to stop on the server. More...
int	omp_wait_for_task_delete (gnutls_session_t *, const char *)
	Wait for the manager to actually remove a task. More...
int	omp_get_status (gnutls_session_t *, const char *, int, entity_t *)
	Deprecated wrapper function for /ref omp_get_tasks. More...
int	omp_get_tasks (gnutls_session_t *, const char *, int, int, entity_t *)
	Get the status of a task. More...
int	omp_get_tasks_ext (gnutls_session_t *, omp_get_tasks_opts_t, entity_t *)
	Get all tasks (generic version). More...
int	omp_get_task_ext (gnutls_session_t *, omp_get_task_opts_t, entity_t *)
	Get a task (generic version). More...
int	omp_get_targets (gnutls_session_t *, const char *, int, int, entity_t *)
	Get a target. More...
int	omp_get_report (gnutls_session_t *, const char *, const char *, int, entity_t *)
	Get a report. More...
int	omp_get_report_ext (gnutls_session_t *, omp_get_report_opts_t, entity_t *)
	Get a report (generic version). More...
int	omp_get_report_format (gnutls_session_t *, const char *, const char *, void **, gsize *)
	Get a report in a given format. More...
int	omp_delete_report (gnutls_session_t *, const char *)
	Remove a report. More...
int	omp_get_results (gnutls_session_t *, const char *, int, int, int, int, int, entity_t *)
	Get results. More...
int	omp_delete_task (gnutls_session_t *, const char *)
	Delete a task and read the manager response. More...
int	omp_modify_task (gnutls_session_t *, const char *, const char *, const char *, const char *)
	Modify a task. More...
int	omp_modify_task_file (gnutls_session_t *, const char *, const char *, const void *, gsize)
	Modify a file on a task. More...
int	omp_get_preferences (gnutls_session_t *, entity_t *)
	Get the manager preferences. More...
int	omp_get_preferences_503 (gnutls_session_t *, entity_t *)
	Get the manager preferences, waiting for them to appear. More...
int	omp_get_certificates (gnutls_session_t *, entity_t *)
	Get the manager certificates. More...
int	omp_until_up (int(*)(gnutls_session_t *, entity_t *), gnutls_session_t *, entity_t *)
	Poll an OMP service until it is up. More...
int	omp_create_target (gnutls_session_t *, const char *, const char *, const char *, const char *, const char *, gchar **)
	Create a target. More...
int	omp_create_target_ext (gnutls_session_t *, omp_create_target_opts_t, gchar **)
	Create a target. More...
int	omp_delete_target (gnutls_session_t *, const char *)
	Delete a target. More...
int	omp_create_config (gnutls_session_t *, const char *, const char *, const char *, unsigned int)
	Create a config, given the config description as a string. More...
int	omp_create_config_from_rc_file (gnutls_session_t *, const char *, const char *, const char *)
	Create a config, given the config description as an RC file. More...
int	omp_delete_config (gnutls_session_t *, const char *)
	Delete a config. More...
int	omp_create_lsc_credential (gnutls_session_t *, const char *, const char *, const char *, const char *, gchar **)
	Create an LSC Credential. More...
int	omp_create_lsc_credential_key (gnutls_session_t *, const char *, const char *, const char *, const char *, const char *, const char *, gchar **)
	Create an LSC Credential with a key. More...
int	omp_delete_lsc_credential (gnutls_session_t *, const char *)
	Delete a LSC credential. More...
int	omp_create_agent (gnutls_session_t *, const char *, const char *)
	Create an agent. More...
int	omp_delete_agent (gnutls_session_t *, const char *)
	Delete an agent. More...
int	omp_get_nvt_details_503 (gnutls_session_t *, const char *, entity_t *)
	Get NVT Information. More...
int	omp_get_system_reports (gnutls_session_t *, const char *, int, entity_t *)
	Get system reports. More...
int	omp_get_system_reports_ext (gnutls_session_t *, omp_get_system_reports_opts_t, entity_t *)
	Get system reports. More...

Function Documentation

int check_response

(

gnutls_session_t *

session)

Read response and convert status of response to a return value.

Todo:

Use this in the other functions.

Parameters

[in]

session

Pointer to GNUTLS session.

Returns

0 on success, -1 or OMP response code on error.

int omp_abort_task	(	gnutls_session_t *	session,
		const char *	id
	)

Deprecated wrapper function for /ref omp_stop_task.

Deprecated:

Use /ref omp_stop_task instead.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, -1 on error.

int omp_authenticate	(	gnutls_session_t *	session,
		const char *	username,
		const char *	password
	)

Authenticate with the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	username	Username.
[in]	password	Password.

Returns

0 on success, 1 if manager closed connection, 2 if auth failed, -1 on error.

int omp_authenticate_env

(

gnutls_session_t *

session)

Authenticate, getting credentials from the environment.

Get the user name from environment variable OPENVAS_TEST_USER if that is set, else from USER. Get the password from OPENVAS_TEST_PASSWORD.

Parameters

[in]

session

Pointer to GNUTLS session.

Returns

0 on success, 1 if manager closed connection, -1 on error.

int omp_authenticate_info	(	gnutls_session_t *	session,
		const char *	username,
		const char *	password,
		char **	role,
		char **	timezone
	)

Authenticate with the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	username	Username.
[in]	password	Password.
[out]	role	Role.
[out]	timezone	Timezone if any, else NULL.

Returns

0 on success, 1 if manager closed connection, 2 if auth failed, -1 on error.

int omp_create_agent	(	gnutls_session_t *	session,
		const char *	name,
		const char *	comment
	)

Create an agent.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of agent.
[in]	comment	Agent comment.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_config	(	gnutls_session_t *	session,
		const char *	name,
		const char *	comment,
		const char *	config,
		unsigned int	config_len
	)

Create a config, given the config description as a string.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Config name.
[in]	comment	Config comment.
[in]	config	Config configuration.
[in]	config_len	Length of config.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_config_from_rc_file	(	gnutls_session_t *	session,
		const char *	name,
		const char *	comment,
		const char *	file_name
	)

Create a config, given the config description as an RC file.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Config name.
[in]	comment	Config comment.
[in]	file_name	Name of RC file.

Returns

0 on success, -1 on error.

int omp_create_lsc_credential	(	gnutls_session_t *	session,
		const char *	name,
		const char *	login,
		const char *	password,
		const char *	comment,
		gchar **	uuid
	)

Create an LSC Credential.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of LSC Credential.
[in]	login	Login associated with name.
[in]	password	Password, or NULL for autogenerated credentials.
[in]	comment	LSC Credential comment.
[out]	uuid	Either NULL or address for UUID of created credential.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_lsc_credential_key	(	gnutls_session_t *	session,
		const char *	name,
		const char *	login,
		const char *	passphrase,
		const char *	public_key,
		const char *	private_key,
		const char *	comment,
		gchar **	uuid
	)

Create an LSC Credential with a key.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of LSC Credential.
[in]	login	Login associated with name.
[in]	passphrase	Passphrase for public key.
[in]	public_key	Public key.
[in]	private_key	Private key.
[in]	comment	LSC Credential comment.
[out]	uuid	Either NULL or address for UUID of created credential.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_target	(	gnutls_session_t *	session,
		const char *	name,
		const char *	hosts,
		const char *	comment,
		const char *	ssh_credential,
		const char *	smb_credential,
		gchar **	uuid
	)

Create a target.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of target.
[in]	hosts	Target hosts.
[in]	comment	Target comment.
[in]	ssh_credential	UUID of SSH LSC credential.
[in]	smb_credential	UUID of SMB LSC credential.
[out]	uuid	Either NULL or address for UUID of created target.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_target_ext	(	gnutls_session_t *	session,
		omp_create_target_opts_t	opts,
		gchar **	id
	)

Create a target.

FIXME: Using the according opts it should be possible to generate any type of create_target request defined by the spec.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	id	Pointer for newly allocated ID of new target, or NULL. Only set on successful return.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_task	(	gnutls_session_t *	session,
		const char *	name,
		const char *	config,
		const char *	target,
		const char *	comment,
		gchar **	id
	)

Create a task given a config and target.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Task name.
[in]	config	Task config name.
[in]	target	Task target name.
[in]	comment	Task comment.
[out]	id	Pointer for newly allocated ID of new task. Only set on successful return.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_task_ext	(	gnutls_session_t *	session,
		omp_create_task_opts_t	opts,
		gchar **	id
	)

Create a task.

FIXME: Using the according opts it should be possible to generate any type of create_task request defined by the spec.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	id	Pointer for newly allocated ID of new task, or NULL. Only set on successful return.

Returns

0 on success, -1 or OMP response code on error.

int omp_create_task_rc	(	gnutls_session_t *	session,
		const char *	config,
		unsigned int	config_len,
		const char *	name,
		const char *	comment,
		char **	id
	)

Create a task, given the task description as an RC file.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	config	Task configuration.
[in]	config_len	Length of config.
[in]	name	Task name.
[in]	comment	Task comment.
[out]	id	Pointer for newly allocated ID of new task. Only set on successful return.

Returns

0 on success, -1 on error.

int omp_create_task_rc_file	(	gnutls_session_t *	session,
		const char *	file_name,
		const char *	name,
		const char *	comment,
		char **	id
	)

Create a task, given the task description as an RC file.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	file_name	Name of the RC file.
[in]	name	Task name.
[in]	comment	Task comment.
[out]	id	ID of new task.

Returns

0 on success, -1 on error.

int omp_delete_agent	(	gnutls_session_t *	session,
		const char *	name
	)

Delete an agent.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of agent.

Returns

0 on success, -1 or OMP response code on error.

int omp_delete_config	(	gnutls_session_t *	session,
		const char *	id
	)

Delete a config.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	UUID of config.

Returns

0 on success, -1 or OMP response code on error.

int omp_delete_lsc_credential	(	gnutls_session_t *	session,
		const char *	id
	)

Delete a LSC credential.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	uuid	UUID of LSC credential.

Returns

0 on success, -1 or OMP response code on error.

int omp_delete_report	(	gnutls_session_t *	session,
		const char *	id
	)

Remove a report.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of report.

Returns

0 on success, OMP response code on failure, -1 on error.

int omp_delete_target	(	gnutls_session_t *	session,
		const char *	id
	)

Delete a target.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	UUID of target.

Returns

0 on success, -1 or OMP response code on error.

int omp_delete_task	(	gnutls_session_t *	session,
		const char *	id
	)

Delete a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, OMP response code on failure, -1 on error.

int omp_get_certificates	(	gnutls_session_t *	session,
		entity_t *	response
	)

Get the manager certificates.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	response	On success contains GET_CERTIFICATES response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_dependencies_503	(	gnutls_session_t *	session,
		entity_t *	response
	)

Issue an OMP <get_dependencies/> command and wait for the response.

Parameters

[in]	session	Session to the server.
[out]	response	Entity containing the response, must be freed.

Returns

0 in case of success. -1 otherwise (e.g. invalid session).

int omp_get_nvt_all	(	gnutls_session_t *	session,
		entity_t *	response
	)

Issue an OMP <get_nvts\/> command and wait for the response.

Parameters

[in]	session	Session to the server.
[out]	response	Entity containing the response, must be freed.

Returns

0 in case of success. -1 otherwise (e.g. invalid session).

int omp_get_nvt_details_503	(	gnutls_session_t *	session,
		const char *	oid,
		entity_t *	response
	)

Get NVT Information.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	oid	OID of NVT or NULL for all NVTs.
[out]	response	Status return. On success contains GET_TASKS response.

Returns

0 on success, -1 on error.

int omp_get_nvt_feed_checksum	(	gnutls_session_t *	session,
		entity_t *	response
	)

Issue an OMP <get_nvt_feed_checksum algoithm=md5/> command and.

wait for the response.

Parameters

[in]	session	Session to the server.
[out]	response	Entity containing the response, must be freed.

Returns

0 in case of success. -1 otherwise (e.g. invalid session).

int omp_get_preferences	(	gnutls_session_t *	session,
		entity_t *	response
	)

Get the manager preferences.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	response	On success contains GET_PREFERENCES response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_preferences_503	(	gnutls_session_t *	session,
		entity_t *	response
	)

Get the manager preferences, waiting for them to appear.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	response	On success contains GET_PREFERENCES response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_report	(	gnutls_session_t *	session,
		const char *	id,
		const char *	format,
		int	first_result_number,
		entity_t *	response
	)

Get a report.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of report.
[out]	response	Report. On success contains GET_REPORT response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_report_ext	(	gnutls_session_t *	session,
		omp_get_report_opts_t	opts,
		entity_t *	response
	)

Get a report (generic version).

FIXME: Using the according opts it should be possible to generate any type of get_reports request defined by the spec.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	response	Report. On success contains GET_REPORT response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_report_format	(	gnutls_session_t *	session,
		const char *	id,
		const char *	format,
		void **	report,
		gsize *	report_size
	)

Get a report in a given format.

Todo:

This now has a bad name, because there is an OMP GET_REPORT_FORMATS.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of report.
[in]	format	Required format.
[out]	report	Report. On success contains the report.
[out]	report_size	Size of report in bytes.

Returns

0 on success, -1 on error.

FIXME: should be using omp_get_report_ext.

int omp_get_results	(	gnutls_session_t *	session,
		const char *	task_id,
		int	notes,
		int	notes_details,
		int	overrides,
		int	overrides_details,
		int	apply_overrides,
		entity_t *	response
	)

Get results.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task whose to get, NULL for all.
[in]	notes	Whether to include notes.
[in]	notes_details	If notes, whether to include details.
[in]	overrides	Whether to include notes.
[in]	overrides_details	If overrides, whether to include details.
[in]	apply_overrides	Whether to apply overrides.
[out]	response	On success contains the GET_RESULTS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_status	(	gnutls_session_t *	session,
		const char *	id,
		int	include_rcfile,
		entity_t *	status
	)

Deprecated wrapper function for /ref omp_get_tasks.

Deprecated:

Use /ref omp_get_tasks instead.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task or NULL for all tasks.
[in]	include_rcfile	Request rcfile in status if true.
[out]	status	Status return. On success contains GET_TASKS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_system_reports	(	gnutls_session_t *	session,
		const char *	name,
		int	brief,
		entity_t *	reports
	)

Get system reports.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	name	Name of system report. NULL for all.
[in]	brief	Whether to request brief response.
[out]	reports	Reports return. On success contains GET_SYSTEM_REPORTS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_system_reports_ext	(	gnutls_session_t *	session,
		omp_get_system_reports_opts_t	opts,
		entity_t *	reports
	)

Get system reports.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	reports	Reports return. On success contains GET_SYSTEM_REPORTS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_targets	(	gnutls_session_t *	session,
		const char *	id,
		int	tasks,
		int	include_rcfile,
		entity_t *	target
	)

Get a target.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of target or NULL for all targets.
[in]	tasks	Whether to include tasks that use the target.
[out]	target	Target return. On success contains GET_TARGETS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_task_ext	(	gnutls_session_t *	session,
		omp_get_task_opts_t	opts,
		entity_t *	response
	)

Get a task (generic version).

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	response	Task. On success contains GET_TASKS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_tasks	(	gnutls_session_t *	session,
		const char *	id,
		int	details,
		int	include_rcfile,
		entity_t *	status
	)

Get the status of a task.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task or NULL for all tasks.
[in]	details	Whether to request task details.
[in]	include_rcfile	Request rcfile in status if true.
[out]	status	Status return. On success contains GET_TASKS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_get_tasks_ext	(	gnutls_session_t *	session,
		omp_get_tasks_opts_t	opts,
		entity_t *	response
	)

Get all tasks (generic version).

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	opts	Struct containing the options to apply.
[out]	response	Tasks. On success contains GET_TASKS response.

Returns

0 on success, -1 or OMP response code on error.

int omp_modify_task	(	gnutls_session_t *	session,
		const char *	id,
		const char *	rcfile,
		const char *	name,
		const char *	comment
	)

Modify a task.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.
[in]	rcfile	NULL or new RC file (as plain text).
[in]	name	NULL or new name.
[in]	comment	NULL or new comment.

Returns

0 on success, -1 or OMP response code on error.

int omp_modify_task_file	(	gnutls_session_t *	session,
		const char *	id,
		const char *	name,
		const void *	content,
		gsize	content_len
	)

Modify a file on a task.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.
[in]	name	Name of file.
[in]	content	New content. NULL to remove file.
[in]	content_len	Length of content.

Returns

0 on success, -1 or OMP response code on error.

int omp_pause_task	(	gnutls_session_t *	session,
		const char *	task_id
	)

Pause a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.

Returns

0 on success, OMP response code on failure, -1 on error.

int omp_ping	(	gnutls_session_t *	session,
		int	timeout
	)

"Ping" the manager.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	timeout	Server idle time before giving up, in milliseconds. 0 to wait forever.

Returns

0 on success, 1 if manager closed connection, 2 on timeout, -1 on error.

int omp_read_create_response	(	gnutls_session_t *	session,
		gchar **	uuid
	)

Read response status and resource UUID.

Parameters

[in]	session	Pointer to GNUTLS session.
[out]	uuid	Either NULL or address for freshly allocated UUID of created response.

Returns

OMP response code on success, -1 on error.

int omp_resume_or_start_task	(	gnutls_session_t *	session,
		const char *	task_id
	)

Resume or start a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.

Returns

0 on success, 1 on failure, -1 on error.

int omp_resume_or_start_task_report	(	gnutls_session_t *	session,
		const char *	task_id,
		char **	report_id
	)

Resume or start a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.
[out]	report_id	ID of report.

Returns

0 on success, 1 on failure, -1 on error.

int omp_resume_paused_task	(	gnutls_session_t *	session,
		const char *	task_id
	)

Resume a paused task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.

Returns

0 on success, OMP response code on failure, -1 on error.

int omp_resume_stopped_task	(	gnutls_session_t *	session,
		const char *	task_id
	)

Resume a stopped task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.

Returns

0 on success, OMP response code on failure, -1 on error.

int omp_resume_stopped_task_report	(	gnutls_session_t *	session,
		const char *	task_id,
		char **	report_id
	)

Resume a stopped task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.
[out]	report_id	ID of report.

Returns

0 on success, 1 on OMP failure, -1 on error.

int omp_start_task	(	gnutls_session_t *	session,
		const char *	task_id
	)

Start a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.

Returns

0 on success, 1 on failure, -1 on error.

int omp_start_task_report	(	gnutls_session_t *	session,
		const char *	task_id,
		char **	report_id
	)

Start a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	task_id	ID of task.
[out]	report_id	ID of report.

Returns

0 on success, 1 on failure, -1 on error.

int omp_stop_task	(	gnutls_session_t *	session,
		const char *	id
	)

Stop a task and read the manager response.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, OMP response code on failure, -1 on error.

const char* omp_task_status

(

entity_t

response)

Get the task status from an OMP GET_TASKS response.

Parameters

[in]

response

GET_TASKS response.

Returns

The entity_text of the status entity if the entity is found, else NULL.

int omp_until_up	(	int(*)(gnutls_session_t *, entity_t *)	function,
		gnutls_session_t *	session,
		entity_t *	response
	)

Poll an OMP service until it is up.

Repeatedly call a function while it returns the value 503.

Parameters

[in]	function	Function to call to do polling.
[in]	session	Pointer to GNUTLS session.
[out]	response	On success contains GET_CERTIFICATES response.

Returns

The value returned from the function.

int omp_wait_for_task_delete	(	gnutls_session_t *	session,
		const char *	id
	)

Wait for the manager to actually remove a task.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, -1 on error.

int omp_wait_for_task_end	(	gnutls_session_t *	session,
		const char *	id
	)

Wait for a task to finish running on the server.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, 1 on internal error in task, -1 on error.

int omp_wait_for_task_start	(	gnutls_session_t *	session,
		const char *	id
	)

Wait for a task to start running on the server.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, 1 on internal error in task, -1 on error.

Todo:

Reconsider this (more below).

int omp_wait_for_task_stop	(	gnutls_session_t *	session,
		const char *	id
	)

Wait for a task to stop on the server.

Parameters

[in]	session	Pointer to GNUTLS session.
[in]	id	ID of task.

Returns

0 on success, 1 on internal error in task, -1 on error, -2 on failure to find the task.