Go to the documentation of this file.
26 #ifndef _OPENVAS_LIBRARIES_OMP_H
27 #define _OPENVAS_LIBRARIES_OMP_H
29 #include "../base/array.h"
58 { 0, NULL, NULL, NULL, NULL, NULL, NULL };
105 "ROWID",
"ascending",
"a994b278-1f62-11e1-96ac-406186ea4fc5",
"hmlgd",
106 NULL, 1, -1, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
107 NULL, NULL, NULL, NULL, NULL, NULL, 0, 0, 0, 0, 0, 0, 0
127 {
"", 0, NULL, 0, 0 };
145 { NULL, NULL, 0, 0 };
178 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, NULL,
207 { 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, 0 };
226 { NULL, NULL, NULL, NULL, NULL, 0 };
248 { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL };
276 int omp_ping (gnutls_session_t *,
int);
281 const char *password);
289 const char *,
const char *, gchar **);
322 const void *, gsize);
337 const char *,
const char *, gchar **);
340 const char *,
const char *,
const char *,
341 const char *, gchar **);
int first_result
First result to get.
Definition: omp.h:70
const char * levels
Result levels to include.
Definition: omp.h:68
int omp_get_system_reports_ext(gnutls_session_t *, omp_get_system_reports_opts_t, entity_t *)
Get system reports.
Definition: omp.c:2160
char * pos
Position of report from end.
Definition: omp.h:80
const char * actions
Actions argument.
Definition: omp.h:117
char * search_phrase
Search phrase result filter.
Definition: omp.h:86
const char * community
SNMP community.
Definition: omp.h:234
int omp_create_lsc_credential(gnutls_session_t *, const char *, const char *, const char *, const char *, gchar **)
Create an LSC Credential.
Definition: omp.c:1841
int omp_create_lsc_credential_ext(gnutls_session_t *, omp_create_lsc_credential_opts_t, gchar **)
Create an LSC credential.
Definition: omp.c:1981
const char * name
Name of task.
Definition: omp.h:158
const char * observers
Comma-separated string of observer users.
Definition: omp.h:161
int brief
Brief flag.
Definition: omp.h:219
int timeout
Timeout for authentication.
Definition: omp.h:45
int omp_stop_task_c(openvas_connection_t *, const char *)
Stop a task and read the manager response.
Definition: omp.c:1026
const char * source_iface
Source iface preference.
Definition: omp.h:168
int omp_read_create_response(gnutls_session_t *, gchar **)
Read response status and resource UUID.
Definition: omp.c:951
int omp_resume_task_report_c(openvas_connection_t *, const char *, char **)
Resume a task and read the manager response.
Definition: omp.c:1105
Struct holding options for omp get_system_reports command.
Definition: omp.h:212
const char * comment
Comment on LSC credential.
Definition: omp.h:241
const char * report_id
ID of single report to get.
Definition: omp.h:69
int omp_authenticate_info_ext_c(openvas_connection_t *, omp_authenticate_info_opts_t)
Authenticate with the manager.
Definition: omp.c:412
int omp_ping_c(openvas_connection_t *, int, gchar **)
"Ping" the manager.
Definition: omp.c:199
int alterable
Whether the task is alterable.
Definition: omp.h:170
Struct holding options for omp get_tasks command.
Definition: omp.h:113
array_t * alert_ids
Array of alert IDs.
Definition: omp.h:152
const char * slave_id
ID of task schedule.
Definition: omp.h:156
const char * omp_task_status(entity_t status_response)
Get the task status from an OMP GET_TASKS response.
Definition: omp.c:119
int omp_create_task_ext(gnutls_session_t *, omp_create_task_opts_t, gchar **)
Create a task.
Definition: omp.c:508
const char * auth_algorithm
SNMP authentication algorithm.
Definition: omp.h:238
GPtrArray array_t
Definition: array.h:31
const char * passphrase
Passphrase.
Definition: omp.h:236
int omp_resume_task_report(gnutls_session_t *, const char *, char **)
Resume a task and read the manager response.
Definition: omp.c:1047
int omp_delete_lsc_credential_ext(gnutls_session_t *, const char *, omp_delete_opts_t)
Delete a LSC credential.
Definition: omp.c:2077
int omp_delete_port_list_ext(gnutls_session_t *, const char *, omp_delete_opts_t)
Delete a port list.
Definition: omp.c:1619
int omp_get_targets(gnutls_session_t *, const char *, int, int, entity_t *)
Get a target.
Definition: omp.c:1455
int host_max_results
Maximum number of results to return.
Definition: omp.h:74
int check_response(gnutls_session_t *)
Read response and convert status of response to a return value.
Definition: omp.c:863
const char * ssh_credential_id
ID of SSH credential.
Definition: omp.h:188
int details
Whether to include overrides in the tasks.
Definition: omp.h:137
int omp_create_target_ext(gnutls_session_t *, omp_create_target_opts_t, gchar **)
Create a target.
Definition: omp.c:1664
int apply_overrides
Whether overrides are applied.
Definition: omp.h:95
const char * private_key
Private key.
Definition: omp.h:237
int max_results
Maximum number of results to return.
Definition: omp.h:71
const char * login
Login.
Definition: omp.h:235
const char * privacy_algorithm
SNMP privacy algorithm.
Definition: omp.h:240
int notes_details
Whether to include details of above.
Definition: omp.h:92
const char * name
Name of LSC credential.
Definition: omp.h:233
const char * privacy_password
SNMP privacy password.
Definition: omp.h:239
const char * start_time
Time of first data point.
Definition: omp.h:216
int autofp
Whether to trust vendor security updates. 0 No, 1 full match, 2 partial.
Definition: omp.h:75
const char * max_checks
Max checks preference.
Definition: omp.h:167
const char * config_id
ID of config.
Definition: omp.h:153
const char * format_id
ID of required report format.
Definition: omp.h:67
const char * esxi_credential_id
ID of ESXi credential.
Definition: omp.h:190
Struct holding options for omp get_report command.
Definition: omp.h:63
char * min_qod
Minimum QoD filter.
Definition: omp.h:89
int omp_get_report_ext(gnutls_session_t *, omp_get_report_opts_t, entity_t *)
Get a report (generic version).
Definition: omp.c:1520
int omp_get_tasks(gnutls_session_t *, const char *, int, int, entity_t *)
Get the status of a task.
Definition: omp.c:1188
int timeout
Timeout for OMP response.
Definition: omp.h:72
const char * schedule_id
ID of task schedule.
Definition: omp.h:155
const char * username
Password.
Definition: omp.h:46
int omp_delete_task(gnutls_session_t *, const char *)
Delete a task and read the manager response.
Definition: omp.c:1434
const char * max_hosts
Max hosts preference.
Definition: omp.h:166
Connection.
Definition: openvas_server.h:58
const char * alive_tests
Alive tests.
Definition: omp.h:197
int omp_authenticate(gnutls_session_t *session, const char *username, const char *password)
Authenticate with the manager.
Definition: omp.c:271
char ** pw_warning
[out] Password warning, NULL if password is okay.
Definition: omp.h:51
int omp_delete_target_ext(gnutls_session_t *, const char *, omp_delete_opts_t)
Delete a target.
Definition: omp.c:1792
int notes
Whether to include associated notes.
Definition: omp.h:91
char ** role
[out] Role.
Definition: omp.h:48
int omp_get_tasks_ext(gnutls_session_t *, omp_get_tasks_opts_t, entity_t *)
Get all tasks (generic version).
Definition: omp.c:1313
int rcfile
Ignored. Removed since OMP 6.0.
Definition: omp.h:120
int omp_delete_config_ext(gnutls_session_t *, const char *, omp_delete_opts_t)
Delete a config.
Definition: omp.c:1815
const char * duration
Duration.
Definition: omp.h:215
char * host_search_phrase
Search phrase result filter.
Definition: omp.h:87
int omp_modify_task_file(gnutls_session_t *, const char *, const char *, const void *, gsize)
Modify a file on a task.
Definition: omp.c:1381
array_t * observer_groups
IDs of observer groups.
Definition: omp.h:162
char ** timezone
[out] Timezone if any, else NULL.
Definition: omp.h:50
char * host
Host for asset report.
Definition: omp.h:79
int overrides
Whether to include overrides in the report.
Definition: omp.h:93
const char * scanner_id
ID of task scanner.
Definition: omp.h:154
int omp_start_task_report(gnutls_session_t *, const char *, char **)
Start a task and read the manager response.
Definition: omp.c:744
int omp_get_task_ext(gnutls_session_t *, omp_get_task_opts_t, entity_t *)
Get a task (generic version).
Definition: omp.c:1250
const char * port_range
Port range.
Definition: omp.h:192
const char * hosts
Name of target.
Definition: omp.h:195
const char * comment
Comment on task.
Definition: omp.h:159
int schedule_periods
Number of periods the schedule must run for.
Definition: omp.h:163
Struct holding options for authentication.
Definition: omp.h:43
int omp_start_task_report_c(openvas_connection_t *, const char *, char **)
Start a task and read the manager response.
Definition: omp.c:802
const char * actions
Actions argument.
Definition: omp.h:134
int omp_delete_report(gnutls_session_t *, const char *)
Remove a report.
Definition: omp.c:1641
const char * comment
Comment on target.
Definition: omp.h:194
int omp_delete_task_ext(gnutls_session_t *, const char *, omp_delete_opts_t)
Delete a task and read the manager response.
Definition: omp.c:1163
const char * slave_id
ID of the slave to get report from.
Definition: omp.h:218
char * delta_states
Delta states (Changed Gone New Same) to include.
Definition: omp.h:84
char * filter
Term to filter results.
Definition: omp.h:77
char * min_cvss_base
Minimum CVSS base filter.
Definition: omp.h:88
int timeout
Timeout for OMP response.
Definition: omp.h:116
const char * filter
Filter argument.
Definition: omp.h:115
int result_hosts_only
Whether to include only hosts that have results.
Definition: omp.h:96
const char * name
Name of report.
Definition: omp.h:214
const char * password
Username.
Definition: omp.h:47
const char * in_assets
In assets preference.
Definition: omp.h:165
const char * smb_credential_id
ID of SMB credential.
Definition: omp.h:189
const char * exclude_hosts
Hosts to exclude.
Definition: omp.h:196
const char * end_time
Time of last data point.
Definition: omp.h:217
int omp_authenticate_info_ext(gnutls_session_t *, omp_authenticate_info_opts_t)
Authenticate with the manager.
Definition: omp.c:327
char ** severity
[out] Severity class setting.
Definition: omp.h:49
int omp_ping(gnutls_session_t *, int)
"Ping" the manager.
Definition: omp.c:141
int omp_create_task(gnutls_session_t *, const char *, const char *, const char *, const char *, gchar **)
Create a task given a config and target.
Definition: omp.c:703
int details
Whether to include overrides in the tasks.
Definition: omp.h:119
XML element.
Definition: xml.h:48
const char * name
Name of target.
Definition: omp.h:193
char * alert_id
ID of alert.
Definition: omp.h:82
int omp_stop_task(gnutls_session_t *, const char *)
Stop a task and read the manager response.
Definition: omp.c:1006
Struct holding options for various omp delete_[...] commands.
Definition: omp.h:253
int omp_get_system_reports(gnutls_session_t *, const char *, int, entity_t *)
Get system reports.
Definition: omp.c:2103
Struct holding options for omp create_task command.
Definition: omp.h:150
int ssh_credential_port
Port for SSH access.
Definition: omp.h:187
const char * sort_field
Definition: omp.h:65
const char * target_id
ID of target.
Definition: omp.h:157
char * filt_id
ID of filter, to filter results.
Definition: omp.h:78
char * delta_report_id
ID of report to compare single report to.
Definition: omp.h:83
int ultimate
Definition: omp.h:255
Struct holding options for omp create_lsc_credential command.
Definition: omp.h:231
char * type
Type of report.
Definition: omp.h:76
char * timezone
Timezone.
Definition: omp.h:81
const char * sort_order
Definition: omp.h:66
int override_details
If overrides, whether to include details.
Definition: omp.h:94
int ignore_pagination
Whether to ignore pagination filters.
Definition: omp.h:97
const char * hosts_ordering
Order for scanning target hosts.
Definition: omp.h:160
int rcfile
Ignored. Removed since OMP 6.0.
Definition: omp.h:138
char * host_levels
Letter encoded threat level filter, for hosts.
Definition: omp.h:85
int reverse_lookup_only
Scanner pref reverse_lookup_only.
Definition: omp.h:199
Struct holding options for omp create_target command.
Definition: omp.h:185
int omp_create_lsc_credential_key(gnutls_session_t *, const char *, const char *, const char *, const char *, const char *, gchar **)
Create an LSC Credential with a key.
Definition: omp.c:1920
int reverse_lookup_unify
Scanner pref reverse_lookup_unify.
Definition: omp.h:200
int host_first_result
Skip over results before this result number.
Definition: omp.h:73
const char * snmp_credential_id
ID of SNMP credential.
Definition: omp.h:191
const char * task_id
ID of single task to get.
Definition: omp.h:135
Struct holding options for omp get_tasks command.
Definition: omp.h:132