From 945224b3e97541936ea79378a7eb571f9c459912 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 4 Dec 2023 19:53:46 +0200 Subject: [PATCH 1/5] Add: show descriptions of command attributes --- src/schema_formats/HTML/HTML.xsl | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 536bdc82a..ba766fe4b 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -453,6 +453,16 @@ along with this program. If not, see . . + +
+ + More Details + +
+ +
+
+ From 85817e7c9f721b0e7b1bc944a228ad9d0d601383 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 4 Dec 2023 20:37:40 +0200 Subject: [PATCH 2/5] Add: show descriptions of command elements --- src/schema_formats/HTML/HTML.xsl | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index ba766fe4b..04787acd3 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -455,9 +455,7 @@ along with this program. If not, see .
- - More Details - + More Details
@@ -507,6 +505,14 @@ along with this program. If not, see . + +
+ More Details +
+ +
+
+ Date: Mon, 4 Dec 2023 21:09:49 +0200 Subject: [PATCH 3/5] Support multi lines of More Details --- src/schema_formats/HTML/HTML.xsl | 37 ++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 04787acd3..1065fdcb6 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -117,6 +117,35 @@ along with this program. If not, see . + + + + +
+ + + + + +
+ + +
+ +
    + +
    • +     +
+ +
+ + + + + + + 1 @@ -457,7 +486,9 @@ along with this program. If not, see .
More Details
- + + +
@@ -509,7 +540,9 @@ along with this program. If not, see .
More Details
- + + +
From 5bc49eb51d05dc03adb58fd12db91d91ac818124 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 11 Dec 2023 17:03:51 +0200 Subject: [PATCH 4/5] Convert GMP doc tabs to spaces --- src/schema_formats/XML/GMP.xml.in | 446 +++++++++++++++--------------- 1 file changed, 223 insertions(+), 223 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 33d054e42..28a3c9180 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -530,12 +530,12 @@ along with this program. If not, see . Whether the certificate is valid, expired or not active yet - - expired - inactive - unknown - valid - + + expired + inactive + unknown + valid + @@ -628,7 +628,7 @@ along with this program. If not, see . value - The value of the QoD + The value of the QoD integer @@ -2064,10 +2064,10 @@ along with this program. If not, see . order Sort order of field - - ascending - descending - + + ascending + descending + @@ -2147,12 +2147,12 @@ along with this program. If not, see . filter Level filter - - High - Medium - Low - Log - + + High + Medium + Low + Log + @@ -3626,10 +3626,10 @@ along with this program. If not, see . usage_type Usage type (scan or policy) for the config. Can overwrite the one in get_configs_response - - scan - policy - + + scan + policy + @@ -3817,10 +3817,10 @@ along with this program. If not, see . auth_algorithm Authentication algorithm for SNMP, either md5 or sha1 - - md5 - sha1 - + + md5 + sha1 + @@ -3833,10 +3833,10 @@ along with this program. If not, see . algorithm The SNMP privacy algorithm, either aes or des - - aes - des - + + aes + des + @@ -3851,15 +3851,15 @@ along with this program. If not, see . type The type of credential to create - - cc - pgp - pw - smime - snmp - up - usk - + + cc + pgp + pw + smime + snmp + up + usk + @@ -5593,10 +5593,10 @@ END:VCALENDAR usage_type Usage type for the task (scan or audit), defaulting to scan - - scan - audit - + + scan + audit + @@ -7538,20 +7538,20 @@ END:VCALENDAR type The type of the config (0 = OpenVAS, 1 OSP) - - 0 - 1 - + + 0 + 1 + usage_type The usage type of the config (scan or policy) - - scan - policy - + + scan + policy + @@ -7929,10 +7929,10 @@ END:VCALENDAR order - - ascending - descending - + + ascending + descending + @@ -9164,10 +9164,10 @@ END:VCALENDAR order - - ascending - descending - + + ascending + descending + @@ -9984,10 +9984,10 @@ END:VCALENDAR order - - ascending - descending - + + ascending + descending + @@ -10406,15 +10406,15 @@ END:VCALENDAR type The type of the credential - - cc - pgp - pw - smime - snmp - up - usk - + + cc + pgp + pw + smime + snmp + up + usk + @@ -10434,13 +10434,13 @@ END:VCALENDAR format Format as used in the command - - key - rpm - deb - exe - pem - + + key + rpm + deb + exe + pem + @@ -10448,10 +10448,10 @@ END:VCALENDAR auth_algorithm The SNMP authentication algorithm - - md5 - sha1 - + + md5 + sha1 + @@ -10463,10 +10463,10 @@ END:VCALENDAR algorithm The SNMP privacy algorithm - - aes - des - + + aes + des + @@ -10635,10 +10635,10 @@ END:VCALENDAR order - - ascending - descending - + + ascending + descending + @@ -16054,12 +16054,12 @@ END:VCALENDAR filter A severity level that is included in the report - - High - Medium - Low - Log - + + High + Medium + Low + Log + @@ -16731,14 +16731,14 @@ END:VCALENDAR min max options - - boolean - integer - selection - string - text - report_format_list - + + boolean + integer + selection + string + text + report_format_list + min @@ -21176,10 +21176,10 @@ END:VCALENDAR usage_type The usage type of the task (scan or audit) - - scan - audit - + + scan + audit + @@ -21836,97 +21836,97 @@ END:VCALENDAR - - 0 - - - m - - Container Example - This task provides for uploading reports - 2019-08-13T12:28:43+02:00 - - 2019-08-13T12:28:44+02:00 - 1 - 0 - - - Everything - - - 0 - scan - - - -1 - 0 - - - - 0 - - - - - 0 - 0 - - Done - -1 - 1 - 1 - + + 0 + + + m + + Container Example + This task provides for uploading reports + 2019-08-13T12:28:43+02:00 + + 2019-08-13T12:28:44+02:00 + 1 + 0 + + + Everything + + + 0 + scan + + + -1 + 0 + + + + 0 + + + + + 0 + 0 + + Done + -1 + 1 + 1 + 0 - - - 2019-08-13T12:29:25+02:00 - 2019-04-24T14:26:01+02:00 - 2019-04-24T14:50:59+02:00 - - 1 - 0 - 77 - 8 - 0 - - 9.0 - - - - - - Maximum concurrently executed NVTs per host - max_checks - 4 - - ... - - - - apply_overrides=0 min_qod=70 - uuid=f404781f-6d2b-420c-b7a1-0d3f27f1a43b first=1 rows=10 - sort=name - - - apply_overrides - = - 0 - + + + 2019-08-13T12:29:25+02:00 + 2019-04-24T14:26:01+02:00 + 2019-04-24T14:50:59+02:00 + + 1 + 0 + 77 + 8 + 0 + + 9.0 + + + + + + Maximum concurrently executed NVTs per host + max_checks + 4 + ... - - - - name - ascending - - - 21 - 1 - 1 - + + + + apply_overrides=0 min_qod=70 + uuid=f404781f-6d2b-420c-b7a1-0d3f27f1a43b first=1 rows=10 + sort=name + + + apply_overrides + = + 0 + + ... + + + + name + ascending + + + 21 + 1 + 1 + @@ -22922,11 +22922,11 @@ END:VCALENDAR source Authentication source - - file - ldap_connect - radius_connect - + + file + ldap_connect + radius_connect + @@ -25106,10 +25106,10 @@ END:VCALENDAR auth_algorithm Authentication algorithm for SNMP, either md5 or sha1 - - md5 - sha1 - + + md5 + sha1 + @@ -25122,10 +25122,10 @@ END:VCALENDAR algorithm The SNMP privacy algorithm, either aes or des - - aes - des - + + aes + des + @@ -26895,8 +26895,8 @@ END:VCALENDAR If 0 then password is left alone, otherwise password is modified boolean - text - + text + role @@ -26912,20 +26912,20 @@ END:VCALENDAR sources List of authentication sources for this user (if omitted, no changes) - - source - - - source - Authentication source - - - file - ldap_connect - radius_connect - - - + + source + + + source + Authentication source + + + file + ldap_connect + radius_connect + + + From 99d995878ad5abd6bf9c8996345480bbccdbd772 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 11 Dec 2023 17:50:37 +0200 Subject: [PATCH 5/5] Sort commands in GMP doc alphabetically --- src/schema_formats/XML/GMP.xml.in | 10838 ++++++++++++++-------------- 1 file changed, 5419 insertions(+), 5419 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 28a3c9180..1137994ba 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -6038,6 +6038,58 @@ END:VCALENDAR + + delete_alert + Delete an alert + +

+ The client uses the delete_alert command to delete an existing + alert. +

+

+ Since this is a destructive command, the client is advised to ask + for confirmation from the user before sending this command to the + Manager. +

+ + + + alert_id + uuid + 1 + + + ultimate + Whether to remove entirely, or to the trashcan + boolean + 1 + + + + + + status + status + 1 + + + status_text + text + 1 + + + + + Delete an alert + + + + + + + + + delete_asset Delete an asset @@ -6148,58 +6200,6 @@ END:VCALENDAR - - delete_alert - Delete an alert - -

- The client uses the delete_alert command to delete an existing - alert. -

-

- Since this is a destructive command, the client is advised to ask - for confirmation from the user before sending this command to the - Manager. -

- - - - alert_id - uuid - 1 - - - ultimate - Whether to remove entirely, or to the trashcan - boolean - 1 - - - - - - status - status - 1 - - - status_text - text - 1 - - - - - Delete an alert - - - - - - - - - delete_credential Delete a credential @@ -6458,11 +6458,11 @@ END:VCALENDAR - delete_report - Delete a report + delete_permission + Delete a permission

- The client uses the delete_report command to delete an existing report. + The client uses the delete_permission command to delete an existing permission.

Since this is a destructive command, the client is advised to ask @@ -6472,10 +6472,16 @@ END:VCALENDAR - report_id + permission_id uuid 1 + + ultimate +

Whether to remove entirely, or to the trashcan + boolean + 1 + @@ -6492,22 +6498,23 @@ END:VCALENDAR - Delete a report + Delete a permission - - + + - + - delete_permission - Delete a permission + delete_port_list + Delete a port list

- The client uses the delete_permission command to delete an existing permission. + The client uses the delete_port_list command to delete an existing + port list.

Since this is a destructive command, the client is advised to ask @@ -6517,7 +6524,7 @@ END:VCALENDAR - permission_id + port_list_id uuid 1 @@ -6543,23 +6550,23 @@ END:VCALENDAR -

Delete a permission + Delete a port list - - + + - + - delete_port_list - Delete a port list + delete_port_range + Delete a port range

- The client uses the delete_port_list command to delete an existing - port list. + The client uses the delete_port_range command to delete an existing + port range.

Since this is a destructive command, the client is advised to ask @@ -6569,16 +6576,10 @@ END:VCALENDAR - port_list_id + port_range_id uuid 1 - - ultimate -

Whether to remove entirely, or to the trashcan - boolean - 1 - @@ -6595,23 +6596,22 @@ END:VCALENDAR - Delete a port list + Delete a port range - - + + - + - delete_port_range - Delete a port range + delete_report + Delete a report

- The client uses the delete_port_range command to delete an existing - port range. + The client uses the delete_report command to delete an existing report.

Since this is a destructive command, the client is advised to ask @@ -6621,7 +6621,7 @@ END:VCALENDAR - port_range_id + report_id uuid 1 @@ -6641,13 +6641,13 @@ END:VCALENDAR -

Delete a port range + Delete a report - - + + - + @@ -7252,176 +7252,163 @@ END:VCALENDAR - get_configs - Get one or many configs + get_aggregates + Get aggregates of various resources - The client uses the get_configs command to get config information. - If the command sent by the client was valid, the manager will - reply with a list of configs to the client. +

+ The client uses the get_aggregate command to get aggregated data like + counts or averages of various resources. +

+

+ Unlike other get_... commands, get_aggregates ignores the filter + keywords "first" and "rows". It also does not support selecting single + items by id or getting items from the trashcan. +

- config_id - ID of single config to get + filter + Filter term to use to filter query of the resources to aggregate (see get_... commands of selected type for keywords) + text + + + filt_id + ID of filter to use to filter query of the resources to aggregate uuid - filter - Filter term to use to filter query + type + The GMP resource type to gather data from text - - - - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - name - name - Name - - - comment - text - Comment text - - - created - iso_time - Creation time - - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - nvt_selector - uuid - NVT selector UUID - - - families_total - integer - Total number of selected NVT families - - - nvts_total - integer - Total number of selected NVTs - - - families_trend - boolean - Whether new NVT families will be added - - - nvts_trend - boolean - Whether new NVTs will be added - - - usage_type - - - scan - policy - - - Usage type - - - predefined - boolean - Whether the config was created from the feed - - + 1 - filt_id - ID of filter to use to filter query - uuid + data_column + A single column to get the data to aggregate from + text - trash - Whether to get the trashcan configs instead - boolean + group_column + The field to group the resources by + text - details - Whether to get config families, preferences and nvt selectors - boolean + subgroup_column + The field to further group the resources inside groups by + text - families - Whether to include the families if no details are requested - boolean + sort_field + The column to sort the aggregated rows by. + With a subgroup column, groups will be sorted by the group_column first. + text - preferences - Whether to include the preferences if no details are requested - boolean + sort_order + The order to sort by + + + ascending + descending + + - tasks - Whether to get tasks using this config - boolean + sort_stat + The statistic to sort the aggregated rows by + + + min + max + mean + sum + count + value + + + + + first_group + The index of the first aggregate group to return + integer + + + max_groups + The maximum number of aggregate groups to return, -1 for all + integer + + + mode + Special mode for aggregation + + + + word_counts + + usage_type - Optional usage type to limit the configs to. Affects total count unlike filter + Optional usage type to limit configs and tasks to + audit policy scan + sort + data_column + text_column + + sort + Optional tuples of sort criteria + + + field + The column to sort the aggregated rows by. + With a subgroup column, groups will be sorted by the group_column first + text + + + order + The order to sort by + + + ascending + descending + + + + + stat + The statistic to sort the aggregated rows by + + + min + max + mean + sum + count + value + + + + + + + data_column + A column to get the data to aggregate from + text + + + text_column + A simple text column which no statistics are calculated for + text + @@ -7434,426 +7421,281 @@ END:VCALENDAR text 1 - config + aggregate filters - sort - configs - config_count - config + aggregate + A collection of aggregated data of the selected type - - id - uuid - 1 - - owner - name - comment - creation_time - modification_time - family_count - nvt_count - type - usage_type - max_nvt_count - known_nvt_count - scanner - in_use - writable - permissions - user_tags - tasks - families - preferences - nvt_selectors - predefined - deprecated + data_type + data_column + group_column + text_column + + group + overall + + subgroups + column_info - owner - Owner of the config - - name - - - name - The name of the owner - name - + data_type + The resource type the data is aggregated from + text - name - The name of the config - name + data_column + A column the data is aggregated from + text - comment - The comment on the config - text - - - creation_time - Creation time of the config - iso_time + group_column + The column the data is grouped by + text - modification_time - Last time the config was modified - iso_time + text_column + A simple text column + text - family_count - The number of families selected by the config + group + Aggregate data for a group of resources - integer - growing + value + subgroup + count + c_count + stats + text - growing - - Whether new families are automatically added to the - config - - boolean + value + Value of the group column + text - - - nvt_count - The number of NVTs selected by the config - - integer - growing - - growing - - Whether new NVTs are automatically added to the config - - boolean + subgroup + Aggregate data for a subgroup of resources + + value + count + c_count + stats + + + value + Value of the subgroup column + text + + + count + Number of resources in the subgroup + integer + + + c_count + Cumulative number of resources in the current subgroup + integer + + + stats + Statistics of a data column for the current subgroup + + + column + Name of the column the stats apply to + text + + min + max + mean + sum + c_sum + + + min + Minimum value of the data column + text + + + max + Maximum value of the data column + text + + + mean + Arithmetic mean of the numeric values of the data + text + + + sum + Sum of the numeric values of the data column + text + + + c_sum + Cumulative sum of the data column + text + + - - - type - The type of the config (0 = OpenVAS, 1 OSP) - - - 0 - 1 - - - - - usage_type - The usage type of the config (scan or policy) - - - scan - policy - - - - - max_nvt_count - Total number of NVTs in the families selected by the config - - integer - - - - known_nvt_count - Total number of known NVTs selected by the config - - integer - - - - scanner - The scanner used by the config if it is an OSP one - - text - - id - uuid - UUID of the scanner - 1 - - trash - - trash - Whether the scanner is in the trashcan + count + Number of resources in the group + integer + + + c_count + Cumulative number of resources in all groups up to and including the current one + integer + + + text + The value of a simple text column. - boolean + + name + Name of the text column + text + + text - - - in_use - Whether any tasks are using the config - boolean - - - writable - - Whether any tasks are using the config, including trashcan tasks - - boolean - - - permissions - Permissions that the current user has on the target - - permission - - permission + stats + Statistics of a data column - name + + column + Name of the column the stats apply to + text + + min + max + mean + sum + c_sum - name - The name of the permission - name + min + Minimum value of the data column + text + + + max + Maximum value of the data column + text + + + mean + Arithmetic mean of the numeric values of the data + text + + + sum + Sum of the numeric values of the data column + text + + + c_sum + Cumulative sum of the numeric values of the data column for all groups up to and including the current one + text - user_tags - Info on tags attached to the config + overall + Aggregate data for all resources of the selected type count - tag + min + max + mean + sum count - Number of attached tags + Overall number of resources integer - tag - - Short info on an individual tag - (only if details were requested) - - - - id - uuid - UUID of the tag - 1 - - name - value - comment - - - name - Name of the tag (usually namespace:predicate) - text - - - value - Value of the tag - text - - - comment - Comment for the tag - text - + min + Overall minimum value of the data column + text - - - tasks - All tasks using the config - - task - - task - - - id - uuid - 1 - - name - permissions - - - name - The name of the task - name - - - permissions - Permissions the user has on the task - - + max + Overall maximum value of the data column + text - - - families - All families selected by the config - - family - - family - - name - nvt_count - max_nvt_count - growing - - - name - The name of the family - name - - - type - The type of the config. 0 = OpenVAS scanner, 1 = OSP Scanner - integer - - - nvt_count - The number of NVTs selected in the family - integer - - - max_nvt_count - The total number of NVTs in the family - integer - - - growing - - Whether new NVTs in the family are automatically added to the selection - - boolean - + mean + Overall arithmetic mean of the numeric values of the data + text + + + sum + Overall sum of the numeric values of the data column + text - preferences - Preferences for all NVTs selected by the config + subgroups + Overview of all subgroup values - preference + value - preference - - nvt - name - id - type - value - default - alt - - - nvt - NVT to which preference applies - - - oid - oid - 1 - - name - - - name - The name of the NVT - name - - - - name - The compact name of the preference as used by the scanner - name - - - id - The ID of the preference - text - - - type - The type of the preference - text - - - value - The value of the preference - text - - - default - The default value of the preference - text - - - alt - An alternate value for the preference - text - + value + Value of the subgroup column + text - nvt_selectors - All NVT selectors of the config + column_info + Info on the aggregate columns - nvt_selector + aggregate_column - nvt_selector - An NVT selector + aggregate_column + Info on one column of the aggregate name - include + stat type - family_or_nvt + column + data_type name - Name of the selector - text + Name of the column as it appears in the group or overall element + text - include - Whether the selector is an include selector - - boolean - + stat + The type of statistic in the column, e.g. min, max, mean + text type - Selector type: 0 = all, 1 = family, 2 = NVT - - integer - + The resource type + text - family_or_nvt - Name of the family or OID of the NVT - text + column + Name of the column in the non-aggregated table + text + + + data_type + The data type of the column, e.g. integer, text, cvss + text - - predefined - Whether the config was predefined by the feed - boolean - - - deprecated - Whether the config is deprecated - boolean - filters @@ -7915,301 +7757,231 @@ END:VCALENDAR - - sort - - text - field - - - field - - order - - - order - - - ascending - descending - - - - - - - configs - - - start - First config - integer - 1 - - - max - Maximum number of configs - integer - 1 - - - - - config_count - - filtered - page - - - filtered - Number of configs after filtering - integer - - - page - Number of configs on current page - integer - - - Get one or many configs - - - - - - - Full and fast - All NVT's; optimized by using previously collected information. - 2012-11-23T10:44:00+01:00 - 2013-01-23T10:44:00+01:00 - - 4 - 1 - - - 12 - 1 - - 1 - 0 - - ... - - - - - Get a single config, including preference, family lists and tasks using this config + Get severity statistics of NVTs by family - - + + - - - Full and fast - All NVT's; optimized by using previously collected information. - - 4 - 1 - - - 12 - 1 - - 1 - - - Web Servers - - ... - - - - Credentials - 8 - 8 - 1 - - ... - - - - - Services - - 1 - Network connection timeout : - entry - 5 - + + + nvt + severity + family + + AIX Local Security Checks + 1 + 1 + 3.3 + 3.3 + 3.3 + 3.3 + 3.3 + + + Brute force attacks + 8 + 9 + 0 + 7.8 + 6.275 + 50.2 + 53.5 + + + Buffer overflow + 519 + 528 + 10 + 9.7 + 8.63083 + 4479.4 + 4532.9 + + ... + + + value + value + nvt + family + text + + + count + count + nvt + + integer + + + c_count + c_count + nvt + + integer + + + min + min + nvt + severity + cvss + ... - - - ... - + + + + first=1 rows=-1 sort=name + + + first + = + 1 + + + rows + = + -1 + + + sort + = + name + + + + - get_aggregates - Get aggregates of various resources + get_alerts + Get one or many alerts -

- The client uses the get_aggregate command to get aggregated data like - counts or averages of various resources. -

-

- Unlike other get_... commands, get_aggregates ignores the filter - keywords "first" and "rows". It also does not support selecting single - items by id or getting items from the trashcan. -

+ The client uses the get_alerts command to get alert information. + If the command sent by the client was valid, the manager will + reply with a list of alerts to the client. - filter - Filter term to use to filter query of the resources to aggregate (see get_... commands of selected type for keywords) - text - - - filt_id - ID of filter to use to filter query of the resources to aggregate + alert_id + ID of single alert to get uuid - type - The GMP resource type to gather data from - text - 1 - - - data_column - A single column to get the data to aggregate from - text - - - group_column - The field to group the resources by - text - - - subgroup_column - The field to further group the resources inside groups by - text - - - sort_field - The column to sort the aggregated rows by. - With a subgroup column, groups will be sorted by the group_column first. + filter + Filter term to use to filter query text + + + + + + + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + + + + tag_id + UUID + + UUID of an attached tag + + + + uuid + uuid + Unique ID + + + name + name + Name + + + comment + text + Comment text + + + created + iso_time + Creation time + + + modified + iso_time + Modification time + + + owner + name + Name of the owner + + + event + integer + The event that triggers the alert + + + condition + integer + The condition for the alert + + + method + integer + The method of the alert + + + filter + uuid + UUID of the filter applied to the report + + - sort_order - The order to sort by - - - ascending - descending - - - - - sort_stat - The statistic to sort the aggregated rows by - - - min - max - mean - sum - count - value - - - - - first_group - The index of the first aggregate group to return - integer - - - max_groups - The maximum number of aggregate groups to return, -1 for all - integer + filt_id + ID of filter to use to filter query + uuid - mode - Special mode for aggregation - - - - word_counts - - + trash + Whether to get the trashcan alerts instead + boolean - usage_type - Optional usage type to limit configs and tasks to - - - audit - policy - scan - - - + tasks + Whether to get the tasks using the alerts + boolean - sort - data_column - text_column - - sort - Optional tuples of sort criteria - - - field - The column to sort the aggregated rows by. - With a subgroup column, groups will be sorted by the group_column first - text - - - order - The order to sort by - - - ascending - descending - - - - - stat - The statistic to sort the aggregated rows by - - - min - max - mean - sum - count - value - - - - - - - data_column - A column to get the data to aggregate from - text - - - text_column - A simple text column which no statistics are calculated for - text - @@ -8222,278 +7994,297 @@ END:VCALENDAR text 1 - aggregate + alert filters + sort + alerts + alert_count - aggregate - A collection of aggregated data of the selected type + alert - data_type - data_column - group_column - text_column - - group - overall - - subgroups - column_info + + id + uuid + 1 + + owner + name + comment + creation_time + modification_time + in_use + writable + permissions + user_tags + condition + event + method + filter + tasks - data_type - The resource type the data is aggregated from - text + owner + Owner of the alert + + name + + + name + The name of the owner + name + - data_column - A column the data is aggregated from - text + name + The name of the alert + name - group_column - The column the data is grouped by - text + comment + The comment on the alert + + text + - text_column - A simple text column - text + in_use + Whether any tasks are using the alert + boolean - group - Aggregate data for a group of resources + writable + Whether the alert is writable or not + boolean + + + creation_time + Creation time of the alert + iso_time + + + modification_time + Last time the alert was modified + iso_time + + + permissions + Permissions that the current user has on the alert - value - subgroup - count - c_count - stats - text + permission - value - Value of the group column - text - - - subgroup - Aggregate data for a subgroup of resources + permission - value - count - c_count - stats + name - value - Value of the subgroup column - text - - - count - Number of resources in the subgroup - integer - - - c_count - Cumulative number of resources in the current subgroup - integer - - - stats - Statistics of a data column for the current subgroup - - - column - Name of the column the stats apply to - text - - min - max - mean - sum - c_sum - - - min - Minimum value of the data column - text - - - max - Maximum value of the data column - text - - - mean - Arithmetic mean of the numeric values of the data - text - - - sum - Sum of the numeric values of the data column - text - - - c_sum - Cumulative sum of the data column - text - + name + The name of the permission + name + + + user_tags + Info on tags attached to the alert + + count + tag + count - Number of resources in the group - integer - - - c_count - Cumulative number of resources in all groups up to and including the current one + Number of attached tags integer - text - The value of a simple text column. - - - name - Name of the text column - text - - text - - - - stats - Statistics of a data column + tag + + Short info on an individual tag + (only if details were requested) + - column - Name of the column the stats apply to - text + id + uuid + UUID of the tag + 1 - min - max - mean - sum - c_sum + name + value + comment - min - Minimum value of the data column - text - - - max - Maximum value of the data column - text - - - mean - Arithmetic mean of the numeric values of the data - text + name + Name of the tag (usually namespace:predicate) + text - sum - Sum of the numeric values of the data column - text + value + Value of the tag + text - c_sum - Cumulative sum of the numeric values of the data column for all groups up to and including the current one - text + comment + Comment for the tag + text - overall - Aggregate data for all resources of the selected type + condition + + The condition that must be satisfied for the alert to occur + - count - min - max - mean - sum + text + data - count - Overall number of resources - integer - - - min - Overall minimum value of the data column - text - - - max - Overall maximum value of the data column - text - - - mean - Overall arithmetic mean of the numeric values of the data - text - - - sum - Overall sum of the numeric values of the data column - text + data + Some data that defines the condition + + text + name + + + name + The name of the condition data + + text + + - subgroups - Overview of all subgroup values + event + The event that must happen for the alert to occur - value + text + data - value - Value of the subgroup column - text + data + Some data that defines the event + + text + name + + + name + The name of the event data + + text + + - column_info - Info on the aggregate columns + method + The method by which he alert must occur - aggregate_column + text + data - aggregate_column - Info on one column of the aggregate + data + Some data that defines the method + text name - stat - type - column - data_type + credential + certificate_info name - Name of the column as it appears in the group or overall element - text + The name of the method data + + text + - stat - The type of statistic in the column, e.g. min, max, mean - text + credential + Credential information if the data is a credential ID + + + id + uuid + UUID of the credential + + name + login + + + name + The name of the credential + name + + + login + The username of the credential + name + - type - The resource type - text + certificate_info + Certificate info if the data is a TLS certificate + certificate_info + + + + filter + + + id + uuid + + name + permissions + trash + + + name + The name of the filter + name + + + permissions + Permissions the user has on the filter + + + + trash + Whether the filter is in the trashcan + boolean + + + + tasks + Tasks using the alert + + task + + + task + + + id + uuid + 1 + + name + permissions + - column - Name of the column in the non-aggregated table - text + name + The name of the task + name - data_type - The data type of the column, e.g. integer, text, cvss - text + permissions + Permissions the user has on the task + @@ -8558,118 +8349,122 @@ END:VCALENDAR + + sort + + text + field + + + field + + order + + + order + + + ascending + descending + + + + + + + alerts + + + start + First alert + integer + 1 + + + max + Maximum number of alerts + integer + 1 + + + + + alert_count + + filtered + page + + + filtered + Number of alerts after filtering + integer + + + page + Number of alerts on current page + integer + + - Get severity statistics of NVTs by family + Get the alerts - - + - - - nvt - severity - family - - AIX Local Security Checks - 1 - 1 - 3.3 - 3.3 - 3.3 - 3.3 - 3.3 - - - Brute force attacks - 8 - 9 - 0 - 7.8 - 6.275 - 50.2 - 53.5 - - - Buffer overflow - 519 - 528 - 10 - 9.7 - 8.63083 - 4479.4 - 4532.9 - - ... - - - value - value - nvt - family - text - - - count - count - nvt - - integer - - - c_count - c_count - nvt - - integer - - - min - min - nvt - severity - cvss - - ... - - - - first=1 rows=-1 sort=name - - - first - = - 1 - - - rows - = - -1 - - - sort - = - name - - - - - - - - - get_alerts - Get one or many alerts + + + Team alert + + 2012-04-27T12:44:00+01:00 + 2012-08-28T12:14:00+01:00 + 1 + 1 + + Threat level at least + + level + High + + + + Task run status changed + + status + Done + + + + Email + + to_address + team@example.org + + + from_address + admin@example.org + + + notice + 0 + + + + ... + + + + + + get_assets + Get one or many assets - The client uses the get_alerts command to get alert information. - If the command sent by the client was valid, the manager will - reply with a list of alerts to the client. + The client uses the get_assets command to get asset information. - alert_id - ID of single alert to get + asset_id + ID of single asset to get uuid @@ -8745,25 +8540,109 @@ END:VCALENDAR name Name of the owner + + + type is "host" + + + best_os_cpe + text + CPE-ID of best matching OS + - event - integer - The event that triggers the alert + severity + severity + Highest severity of the asset from latest report - condition + severity_level + threat + + Highest severity level of the asset from latest report, + e.g. "High" or "Low" + + + + os + text + Best matching OS, either name or CPE-ID + + + oss + text + Comma-separated list of all OSs of the host + + + hostname + text + Hostname + + + ip + text + IP address + + + updated + iso_time + Time of last update (alias of modified) + + + + type is "os" + + all_hosts integer - The condition for the alert + + Number of all hosts using the asset, even if the OS + is not the best match + - method + title + text + CPE title of the asset + + + hosts integer - The method of the alert + Number of hosts using the asset as best OS match - filter - uuid - UUID of the filter applied to the report + latest_severity + severity + Latest severity of the asset + + + highest_severity + severity + Latest severity of the asset + + + average_severity + severity + Average severity of the asset + + + severity + severity + + Average severity of the asset (alias of average_severity) + + + + average_severity_score + decimal + + Average severity times the number of hosts the asset was found on + @@ -8773,13 +8652,26 @@ END:VCALENDAR uuid - trash - Whether to get the trashcan alerts instead + ignore_pagination + + Whether to ignore info used to split the report into pages + like the filter terms "first" and "rows" + boolean - tasks - Whether to get the tasks using the alerts + type + Type of assets to get + + + host + os + + + + + details + Whether to include additional information (e.g., tags) boolean @@ -8795,14 +8687,14 @@ END:VCALENDAR text 1 - alert + asset filters sort - alerts - alert_count + assets + asset_count - alert + asset id @@ -8814,19 +8706,19 @@ END:VCALENDAR comment creation_time modification_time - in_use writable + in_use permissions user_tags - condition - event - method - filter - tasks + identifiers + + host + os + owner - Owner of the alert + Owner of the asset name @@ -8838,254 +8730,381 @@ END:VCALENDAR name - The name of the alert + The name of the asset name comment - The comment on the alert - - text - - - - in_use - Whether any tasks are using the alert - boolean - - - writable - Whether the alert is writable or not - boolean + The comment on the asset + text creation_time - Creation time of the alert + Date and time the asset was created iso_time modification_time - Last time the alert was modified + Date and time the asset was last modified iso_time - permissions - Permissions that the current user has on the alert + identifiers + Host identifiers - permission + identifier - permission + identifier + A single identifier name + value + creation_time + modification_time + source + os name - The name of the permission + The name of the identifier name - - - - user_tags - Info on tags attached to the alert - - count - tag - - - count - Number of attached tags - integer - - - tag - - Short info on an individual tag - (only if details were requested) - - - - id - uuid - UUID of the tag - 1 - - name - value - comment - - name - Name of the tag (usually namespace:predicate) + value + The value of the identifier text - value - Value of the tag - text + creation_time + Date and time the identifier was created + iso_time - comment - Comment for the tag - text + modification_time + Date and time the identifier was last modified + iso_time - - - - condition - - The condition that must be satisfied for the alert to occur - - - text - data - - - data - Some data that defines the condition - - text - name - - name - The name of the condition data + source + The source of the identifier - text + + id + uuid + 1 + + type + data + deleted + + + type + Type of source + text + + + data + Extra data, depends on type of source + text + + + deleted + Whether the source has been deleted + boolean + + + + os + + + id + uuid + 1 + + title + + title + Title of OS + text + - event - The event that must happen for the alert to occur + host + A host - text - data + severity + detail + routes - data - Some data that defines the event + severity + Severity of the host - text - name + value - name - The name of the event data - - text - + value + severity - - - method - The method by which he alert must occur - - text - data - - data - Some data that defines the method + detail + A host detail - text name - credential - certificate_info + value + source name - The name of the method data - - text - + The name of the detail + name - credential - Credential information if the data is a credential ID + value + The value of the detail + text + + + source + The source of the detail id uuid - UUID of the credential + 1 - name - login + type - name - The name of the credential - name - - - login - The username of the credential - name + type + Type of source + text + + + routes + List of routes to the host, with most recent ones first + + route + - certificate_info - Certificate info if the data is a TLS certificate - certificate_info + route + List of hosts on the route to the host + + host + + + host + A host on the route + + + id + UUID if the host is in the asset management + uuid + + + distance + Distance from the scanner + number + + + same_source + Whether the current host asset has the same source as the target host + boolean + + ip + + + ip + IP address of the host + text + + - filter + os + An OS - - id - uuid - - name - permissions - trash + title + installs + all_installs + latest_severity + highest_severity + average_severity + hosts - name - The name of the filter - name + title + Title of the OS + text - permissions - Permissions the user has on the filter - + + installs + + Number of hosts on which OS has been detected as the best match + + integer - trash - Whether the filter is in the trashcan - boolean + all_installs + + Number of hosts on which OS has been detected, + not necessarily as the best match + + integer - - - tasks - Tasks using the alert - - task - - task - + latest_severity + Latest severity + + value + + + value + text + + + + highest_severity + Highest severity + + value + + + value + text + + + + average_severity + Average severity + + value + + + value + text + + + + hosts + + Hosts on which this OS has been detected as the best match + + + asset + + + asset + The host + + + id + uuid + 1 + + name + severity + + + name + The name of the host + name + + + severity + Severity of the host + + value + + + value + text + + + + + + + in_use + Whether any tasks are using the asset + boolean + + + writable + Whether the asset is writable + boolean + + + permissions + Permissions that the current user has on the asset + + permission + + + permission + + name + + + name + The name of the permission + name + + + + + user_tags + Info on tags attached to the asset + + count + tag + + + count + Number of attached tags + integer + + + tag + + Short info on an individual tag + (only if details were requested) + + id uuid + UUID of the tag 1 name - permissions + value + comment name - The name of the task - name + Name of the tag (usually namespace:predicate) + text - permissions - Permissions the user has on the task - + value + Value of the tag + text + + + comment + Comment for the tag + text @@ -9173,99 +9192,119 @@ END:VCALENDAR - alerts + assets start - First alert + First asset integer 1 max - Maximum number of alerts + Maximum number of assets integer 1 - alert_count + asset_count filtered page filtered - Number of alerts after filtering + Number of assets after filtering integer page - Number of alerts on current page + Number of assets on current page integer - Get the alerts + Get one or many assets - + - - - Team alert + + + Localhost - 2012-04-27T12:44:00+01:00 - 2012-08-28T12:14:00+01:00 - 1 - 1 - - Threat level at least - - level - High - - - - Task run status changed - - status - Done - - - - Email - - to_address - team@example.org - - - from_address - admin@example.org - - - notice - 0 - - - + 2018-08-29T20:21:33Z + 2018-08-29T20:21:33Z + 0 + 7 + localhost + 1 + + + + + + + + + + ... - + + + + + Get a single asset, including tasks using the asset + + + + + + + + dik + dik mm + 2018-08-29T20:21:33Z + 2018-08-29T20:21:33Z + 0 + 4 + dik.example.org + 1 + + mm + + + + + + + + + + dik mm + + ... + + + - get_assets - Get one or many assets + get_configs + Get one or many configs - The client uses the get_assets command to get asset information. + The client uses the get_configs command to get config information. + If the command sent by the client was valid, the manager will + reply with a list of configs to the client. - asset_id - ID of single asset to get + config_id + ID of single config to get uuid @@ -9341,109 +9380,45 @@ END:VCALENDAR name Name of the owner - - - type is "host" - - - best_os_cpe - text - CPE-ID of best matching OS - - - severity - severity - Highest severity of the asset from latest report - - - severity_level - threat - - Highest severity level of the asset from latest report, - e.g. "High" or "Low" - - - os - text - Best matching OS, either name or CPE-ID - - - oss - text - Comma-separated list of all OSs of the host - - - hostname - text - Hostname - - - ip - text - IP address - - - updated - iso_time - Time of last update (alias of modified) + nvt_selector + uuid + NVT selector UUID - - - type is "os" - all_hosts + families_total integer - - Number of all hosts using the asset, even if the OS - is not the best match - - - - title - text - CPE title of the asset + Total number of selected NVT families - hosts + nvts_total integer - Number of hosts using the asset as best OS match - - - latest_severity - severity - Latest severity of the asset + Total number of selected NVTs - highest_severity - severity - Latest severity of the asset + families_trend + boolean + Whether new NVT families will be added - average_severity - severity - Average severity of the asset + nvts_trend + boolean + Whether new NVTs will be added - severity - severity - - Average severity of the asset (alias of average_severity) - + usage_type + + + scan + policy + + + Usage type - average_severity_score - decimal - - Average severity times the number of hosts the asset was found on - + predefined + boolean + Whether the config was created from the feed @@ -9453,28 +9428,41 @@ END:VCALENDAR uuid - ignore_pagination - - Whether to ignore info used to split the report into pages - like the filter terms "first" and "rows" - + trash + Whether to get the trashcan configs instead boolean - type - Type of assets to get + details + Whether to get config families, preferences and nvt selectors + boolean + + + families + Whether to include the families if no details are requested + boolean + + + preferences + Whether to include the preferences if no details are requested + boolean + + + tasks + Whether to get tasks using this config + boolean + + + usage_type + Optional usage type to limit the configs to. Affects total count unlike filter - host - os + policy + scan + - - details - Whether to include additional information (e.g., tags) - boolean - @@ -9488,14 +9476,14 @@ END:VCALENDAR text 1 - asset + config filters sort - assets - asset_count + configs + config_count - asset + config id @@ -9507,19 +9495,27 @@ END:VCALENDAR comment creation_time modification_time - writable + family_count + nvt_count + type + usage_type + max_nvt_count + known_nvt_count + scanner in_use + writable permissions user_tags - identifiers - - host - os - + tasks + families + preferences + nvt_selectors + predefined + deprecated owner - Owner of the asset + Owner of the config name @@ -9531,384 +9527,375 @@ END:VCALENDAR name - The name of the asset + The name of the config name comment - The comment on the asset + The comment on the config text creation_time - Date and time the asset was created + Creation time of the config iso_time modification_time - Date and time the asset was last modified + Last time the config was modified iso_time - identifiers - Host identifiers + family_count + The number of families selected by the config - identifier + integer + growing - identifier - A single identifier - - name - value - creation_time - modification_time - source - os - - - name - The name of the identifier - name - - - value - The value of the identifier - text - - - creation_time - Date and time the identifier was created - iso_time - - - modification_time - Date and time the identifier was last modified - iso_time - - - source - The source of the identifier - - - id - uuid - 1 - - type - data - deleted - - - type - Type of source - text - - - data - Extra data, depends on type of source - text - - - deleted - Whether the source has been deleted - boolean - - - - os - - - id - uuid - 1 - - title - - - title - Title of OS - text - - + growing + + Whether new families are automatically added to the + config + + boolean - host - A host + nvt_count + The number of NVTs selected by the config - severity - detail - routes + integer + growing - severity - Severity of the host + growing + + Whether new NVTs are automatically added to the config + + boolean + + + + type + The type of the config (0 = OpenVAS, 1 OSP) + + + 0 + 1 + + + + + usage_type + The usage type of the config (scan or policy) + + + scan + policy + + + + + max_nvt_count + Total number of NVTs in the families selected by the config + + integer + + + + known_nvt_count + Total number of known NVTs selected by the config + + integer + + + + scanner + The scanner used by the config if it is an OSP one + + text + + id + uuid + UUID of the scanner + 1 + + trash + + + trash + Whether the scanner is in the trashcan - value + boolean - - value - severity - + + + in_use + Whether any tasks are using the config + boolean + + + writable + + Whether any tasks are using the config, including trashcan tasks + + boolean + + + permissions + Permissions that the current user has on the target + + permission + - detail - A host detail + permission name - value - source name - The name of the detail + The name of the permission name - - value - The value of the detail - text - - - source - The source of the detail - - - id - uuid - 1 - - type - - - type - Type of source - text - - - - - routes - List of routes to the host, with most recent ones first - - route - - - route - List of hosts on the route to the host - - host - - - host - A host on the route - - - id - UUID if the host is in the asset management - uuid - - - distance - Distance from the scanner - number - - - same_source - Whether the current host asset has the same source as the target host - boolean - - ip - - - ip - IP address of the host - text - - - - os - An OS + user_tags + Info on tags attached to the config - title - installs - all_installs - latest_severity - highest_severity - average_severity - hosts + count + tag - title - Title of the OS - text - - - - installs - - Number of hosts on which OS has been detected as the best match - - integer + count + Number of attached tags + integer - all_installs + tag - Number of hosts on which OS has been detected, - not necessarily as the best match + Short info on an individual tag + (only if details were requested) - integer - - - latest_severity - Latest severity + + id + uuid + UUID of the tag + 1 + + name value + comment - value + name + Name of the tag (usually namespace:predicate) text - - - highest_severity - Highest severity - - value - value + Value of the tag text - - - average_severity - Average severity - - value - - value + comment + Comment for the tag text + + + tasks + All tasks using the config + + task + - hosts - - Hosts on which this OS has been detected as the best match - + task - asset + + id + uuid + 1 + + name + permissions - asset - The host - - - id - uuid - 1 - - name - severity - - - name - The name of the host - name - - - severity - Severity of the host - - value - - - value - text - - + name + The name of the task + name + + + permissions + Permissions the user has on the task + - in_use - Whether any tasks are using the asset - boolean - - - writable - Whether the asset is writable - boolean - - - permissions - Permissions that the current user has on the asset + families + All families selected by the config - permission + family - permission + family name + nvt_count + max_nvt_count + growing name - The name of the permission + The name of the family name + + type + The type of the config. 0 = OpenVAS scanner, 1 = OSP Scanner + integer + + + nvt_count + The number of NVTs selected in the family + integer + + + max_nvt_count + The total number of NVTs in the family + integer + + + growing + + Whether new NVTs in the family are automatically added to the selection + + boolean + - user_tags - Info on tags attached to the asset + preferences + Preferences for all NVTs selected by the config - count - tag + preference - count - Number of attached tags - integer - - - tag - - Short info on an individual tag - (only if details were requested) - + preference - - id - uuid - UUID of the tag - 1 - + nvt name + id + type value - comment + default + alt + + nvt + NVT to which preference applies + + + oid + oid + 1 + + name + + + name + The name of the NVT + name + + name - Name of the tag (usually namespace:predicate) + The compact name of the preference as used by the scanner + name + + + id + The ID of the preference + text + + + type + The type of the preference text value - Value of the tag + The value of the preference text - comment - Comment for the tag + default + The default value of the preference + text + + + alt + An alternate value for the preference + text + + + + + nvt_selectors + All NVT selectors of the config + + nvt_selector + + + nvt_selector + An NVT selector + + name + include + type + family_or_nvt + + + name + Name of the selector + text + + + include + Whether the selector is an include selector + + boolean + + + + type + Selector type: 0 = all, 1 = family, 2 = NVT + + integer + + + + family_or_nvt + Name of the family or OID of the NVT text + + predefined + Whether the config was predefined by the feed + boolean + + + deprecated + Whether the config is deprecated + boolean + filters @@ -9993,104 +9980,117 @@ END:VCALENDAR - assets + configs start - First asset + First config integer 1 max - Maximum number of assets + Maximum number of configs integer 1 - asset_count + config_count filtered page filtered - Number of assets after filtering + Number of configs after filtering integer page - Number of assets on current page + Number of configs on current page integer - Get one or many assets + Get one or many configs - + - - - Localhost - - 2018-08-29T20:21:33Z - 2018-08-29T20:21:33Z - 0 - 7 - localhost - 1 - - - - - - - - - - + + + Full and fast + All NVT's; optimized by using previously collected information. + 2012-11-23T10:44:00+01:00 + 2013-01-23T10:44:00+01:00 + + 4 + 1 + + + 12 + 1 + + 1 + 0 + ... - + - Get a single asset, including tasks using the asset + Get a single config, including preference, family lists and tasks using this config - - + + - - - dik - dik mm - 2018-08-29T20:21:33Z - 2018-08-29T20:21:33Z - 0 - 4 - dik.example.org - 1 - - mm - - - - - - - + + + Full and fast + All NVT's; optimized by using previously collected information. + + 4 + 1 + + + 12 + 1 + + 1 - dik mm + Web Servers ... - - + + + Credentials + 8 + 8 + 1 + + ... + + + + + Services + + 1 + Network connection timeout : + entry + 5 + + ... + + + ... + @@ -12755,160 +12755,18 @@ END:VCALENDAR - get_notes - Get one or many notes + get_license + Get the current license - The client uses the get_notes command to get note information. - If the command sent by the client was valid, the manager will - reply with a list of notes to the client. +

+ The client uses the get_license command to get the current license. +

+

+ This command is only available if gvmd is built with the licensing + library (libtheia). +

- - note_id - ID of single note to get - uuid - - - filter - Filter term to use to filter query - text - - - - - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - name - name - Name - - - created - iso_time - Creation time - - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - nvt - oid - OID of the NVT the Note applies to - - - text - text - Text of the Note - - - nvt_id - oid - Alias of nvt - - - task_name - text - Name of the Task the Note applies to - - - hosts - text - Hosts the Note applies to - - - port - text - Port (location) the Note applies to - - - active - boolean - Whether the Note is active - - - result - uuid - UUID of the result the Note applies to - - - severity - severity - Minimum severity of results the Note applies to - - - - - filt_id - ID of filter to use to filter query - uuid - - - nvt_oid - oid - - - task_id - uuid - - - details - boolean - - - result - boolean - @@ -12922,230 +12780,11 @@ END:VCALENDAR text 1 - note - filters - sort - notes - note_count + license - filters - - - id - UUID of filter if any, else 0 - uuid - 1 - - term - name - keywords - - - term - Filter term - text - - - name - Filter name, if applicable - text - - - keywords - Filter broken down into keywords - keyword - - keyword - - column - relation - value - - - column - Column prefix - text - - - relation - Relation operator - - - = - : - ~ - > - < - - - - - value - The filter text - text - - - - - - sort - - text - field - - - field - - order - - - order - - - ascending - descending - - - - - - - notes - - - start - First note - integer - 1 - - - max - Maximum number of notes - integer - 1 - - - - - note_count - - filtered - page - - - filtered - Number of notes after filtering - integer - - - page - Number of notes on current page - integer - - - - note - note - - - - Get one or many notes - - - - - - - - Test NVT: long lines - - 2013-01-09T09:47:41+01:00 - 2013-01-09T09:47:41+01:00 - 1 - 0 - 1 - 1 - This is the full text of the note. - - ... - - - - - Get details of a single note and result to which it applies - - - - - - - - - Test NVT: control chars in report result - - 2015-07-15T15:05:55Z - 2015-07-15T15:05:55Z - 1 - 0 - 1 - - note fixed to result - 127.0.0.1 - general/tcp - - test - - 0 - - 127.0.0.1 - general/tcp - - Test NVT: control chars in report result - 5 - - - - Medium - Warning with control char between fullstops: . . - - - ... - - - - - - get_license - Get the current license - -

- The client uses the get_license command to get the current license. -

-

- This command is only available if gvmd is built with the licensing - library (libtheia). -

- - - - - - - status - status - 1 - - - status_text - text - 1 - - license - - - license - The license information + license + The license information status content @@ -13321,109 +12960,160 @@ END:VCALENDAR - get_nvts - Get one or many NVTs + get_notes + Get one or many notes -

- The client uses the get_nvts command to get NVT information. -

- -

- This command may always include a details flag, a config, a sort - order and a sort field. If the command includes a details flag, the - manager also consults the timeout, preference_count and preferences - flags. -

-

- The NVT OID, family name and config attributes limit the listing to - a single NVT or all NVTs in a particular family and/or config. -

-

- If the details flag is present the manager will send full details - of the NVT, otherwise it will send just the NVT name. -

-

- With the preferences flag the manager includes in the listing, the - values of each listed NVT's preferences for the given config. The - timeout flag does the same for the special timeout preference. - If the config contains no values for a preference, the default value - of the preference is returned. The same applies if no config is given. -

-

- If the manager possesses an NVT collection, it will reply with the - NVT information. If the manager cannot access a list of available - NVTs at that time, it will reply with the 503 response. -

-

- NVT categories: 0 init, 1 scanner, 2 settings, 3 infos, 4 attack, 5 mixed, - 6 destructive attack, 7 denial, 8 kill host, 9 flood, 10 end, and 11 unknown. -

+ The client uses the get_notes command to get note information. + If the command sent by the client was valid, the manager will + reply with a list of notes to the client. - nvt_oid - Single NVT to get - oid - 1 - - - details - Whether to include full details - boolean + note_id + ID of single note to get + uuid - lean - Whether to send fewer details - boolean + filter + Filter term to use to filter query + text + + + + + + + + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + + + + tag_id + UUID + + UUID of an attached tag + + + + uuid + uuid + Unique ID + + + name + name + Name + + + created + iso_time + Creation time + + + modified + iso_time + Modification time + + + owner + name + Name of the owner + + + nvt + oid + OID of the NVT the Note applies to + + + text + text + Text of the Note + + + nvt_id + oid + Alias of nvt + + + task_name + text + Name of the Task the Note applies to + + + hosts + text + Hosts the Note applies to + + + port + text + Port (location) the Note applies to + + + active + boolean + Whether the Note is active + + + result + uuid + UUID of the result the Note applies to + + + severity + severity + Minimum severity of results the Note applies to + + - preferences - Whether to include preference - boolean + filt_id + ID of filter to use to filter query + uuid - preference_count - Whether to include preference count - boolean + nvt_oid + oid - skip_cert_refs - Whether to exclude refs of types cert-bund and dfn-cert - boolean + task_id + uuid - skip_tags - Whether to exclude user tags + details boolean - timeout - Whether to include the special timeout preference + result boolean - - config_id - ID of config to which to limit the NVT listing - uuid - - - preferences_config_id - ID of config to use for preference values - uuid - - - family - Family to which to limit NVT listing - text - - - sort_order - sort_order - - - sort_field - text - @@ -13437,352 +13127,196 @@ END:VCALENDAR text 1 - nvt + note + filters + sort + notes + note_count - nvt + filters - oid - oid + id + UUID of filter if any, else 0 + uuid 1 - name - user_tags - - - creation_time - modification_time - category - summary - family - cvss_base - severities - qod - refs - tags - preference_count - timeout - default_timeout - solution - preferences - - + term + name + keywords - name - The name of the NVT - name - - - category - The category of the NVT - integer - - - creation_time - The creation time of the NVT - iso_time + term + Filter term + text - modification_time - The modification time of the NVT - iso_time + name + Filter name, if applicable + text - user_tags - Info on tags attached to the NVT - - count - tag - - - count - Number of attached tags - integer - + keywords + Filter broken down into keywords + keyword - tag - - Short info on an individual tag - (only if details were requested) - + keyword - - id - uuid - UUID of the tag - 1 - - name + column + relation value - comment - name - Name of the tag (usually namespace:predicate) + column + Column prefix text - value - Value of the tag - text + relation + Relation operator + + + = + : + ~ + > + < + + - comment - Comment for the tag + value + The filter text text + + + sort + + text + field + - summary - Short description of the NVT - text - - - family - Name of the family the NVT belongs to - text - - - cvss_base - CVSS base score of the NVT - text - - - severities - Severity information of the NVT - severities - - - qod - The quality of detection (QoD) of the NVT - - value - type - - - value - The numeric QoD value - integer - - - type - The QoD type - text - - - - refs - List of references of various types for this vulnerability test + field - ref - warning + order - ref - A reference - - - id - ID of the reference - text - - - type - Type of the reference, for example "cve", "dfn-cert", "cert-bund" - text - - - - - warning - A warning message, e.g. when the CERT database is not available + order - text + + ascending + descending + + + + notes + + + start + First note + integer + 1 + + + max + Maximum number of notes + integer + 1 + + + + + note_count + + filtered + page + - tags - The tags of the NVT, separated by vertical bars - text - - - preference_count - The number of preferences for the NVT - text - - - timeout - The timeout of the NVT - text - - - default_timeout - The default_timeout of the NVT - text - - - solution - Solution for the vulnerability - - - type - The solution type, for example "VendorFix" - text - - - method - The solution method, for example "DebianAPTUpgrade" - text - - text - + filtered + Number of notes after filtering + integer - preferences - List of preferences of the NVT - - timeout - default_timeout - preference - text - - - timeout - The timeout of the NVT - text - - - default_timeout - The default timeout of the NVT - text - - - preference - - nvt - name - id - type - value - alt - default - - - nvt - NVT to which preference applies - - - oid - oid - 1 - - name - - - name - The name of the NVT - name - - - - name - The name of the preference - text - - - id - The ID of the preference - text - - - type - The type of the preference - text - - - value - The value of the preference - text - - - alt - An alternate value of the preference - text - - - default - The default value of the preference - text - - + page + Number of notes on current page + integer + + note + note + - Get full NVT listing with details + Get one or many notes - - + - - - Services - 2011-01-14T10:12:23+01:00 - 2012-09-19T20:56:15+02:00 - 3 - Find what is listening on which port - Service detection - - - - NOTAG - -1 - - - - - - - Services - - 1 - Network connection timeout : - entry - 5 - 5 - - ... - - - - FooBar 21 - 2011-01-14T10:12:23+01:00 - 2012-09-19T20:56:15+02:00 - 3 - This script detects whether the FooBar 2.1 XSS vulnerability is present. - ... - + + + + Test NVT: long lines + + 2013-01-09T09:47:41+01:00 + 2013-01-09T09:47:41+01:00 + 1 + 0 + 1 + 1 + This is the full text of the note. + ... - + - Get minimal information about one NVT + Get details of a single note and result to which it applies - - + + - - - Services - - + + + + Test NVT: control chars in report result + + 2015-07-15T15:05:55Z + 2015-07-15T15:05:55Z + 1 + 0 + 1 + + note fixed to result + 127.0.0.1 + general/tcp + + test + + 0 + + 127.0.0.1 + general/tcp + + Test NVT: control chars in report result + 5 + + + + Medium + Warning with control char between fullstops: . . + + + ... + @@ -13861,179 +13395,108 @@ END:VCALENDAR - get_overrides - Get one or many overrides + get_nvts + Get one or many NVTs - The client uses the get_overrides command to get override information. - If the command sent by the client was valid, the manager will - reply with a list of overrides to the client. +

+ The client uses the get_nvts command to get NVT information. +

+ +

+ This command may always include a details flag, a config, a sort + order and a sort field. If the command includes a details flag, the + manager also consults the timeout, preference_count and preferences + flags. +

+

+ The NVT OID, family name and config attributes limit the listing to + a single NVT or all NVTs in a particular family and/or config. +

+

+ If the details flag is present the manager will send full details + of the NVT, otherwise it will send just the NVT name. +

+

+ With the preferences flag the manager includes in the listing, the + values of each listed NVT's preferences for the given config. The + timeout flag does the same for the special timeout preference. + If the config contains no values for a preference, the default value + of the preference is returned. The same applies if no config is given. +

+

+ If the manager possesses an NVT collection, it will reply with the + NVT information. If the manager cannot access a list of available + NVTs at that time, it will reply with the 503 response. +

+

+ NVT categories: 0 init, 1 scanner, 2 settings, 3 infos, 4 attack, 5 mixed, + 6 destructive attack, 7 denial, 8 kill host, 9 flood, 10 end, and 11 unknown. +

- override_id - ID of single override to get + nvt_oid + Single NVT to get + oid + 1 + + + details + Whether to include full details + boolean + + + lean + Whether to send fewer details + boolean + + + preferences + Whether to include preference + boolean + + + preference_count + Whether to include preference count + boolean + + + skip_cert_refs + Whether to exclude refs of types cert-bund and dfn-cert + boolean + + + skip_tags + Whether to exclude user tags + boolean + + + timeout + Whether to include the special timeout preference + boolean + + + config_id + ID of config to which to limit the NVT listing uuid - filter - Filter term to use to filter query + preferences_config_id + ID of config to use for preference values + uuid + + + family + Family to which to limit NVT listing text - - - - - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - name - name - Name - - - created - iso_time - Creation time - - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - nvt - oid - OID of the NVT the Override applies to - - - text - text - Text of the Override - - - nvt_id - oid - Alias of nvt - - - task_name - text - Name of the Task the Override applies to - - - hosts - text - Hosts the Override applies to - - - port - text - Port (location) the Override applies to - - - threat - threat - Minimum severity level the Override applies to - - - new_threat - threat - Severity level results are changed to by the Override - - - active - boolean - Whether the Override is active - - - result - uuid - UUID of the result the Override applies to - - - severity - severity - Minimum severity of results the Override applies to - - - new_severity - severity - Severity level results are changed to by the Override - - - active_days - integer - Number of days the override will still be active - - - - - filt_id - ID of filter to use to filter query - uuid - - - nvt_oid - oid - - - task_id - uuid - details - boolean + sort_order + sort_order - result - boolean + sort_field + text @@ -14048,203 +13511,367 @@ END:VCALENDAR text 1 - override - filters - sort - overrides - override_count + nvt - filters + nvt - id - UUID of filter if any, else 0 - uuid + oid + oid 1 - term - name - keywords + name + user_tags + + + creation_time + modification_time + category + summary + family + cvss_base + severities + qod + refs + tags + preference_count + timeout + default_timeout + solution + preferences + + - term - Filter term - text + name + The name of the NVT + name - name - Filter name, if applicable - text + category + The category of the NVT + integer - keywords - Filter broken down into keywords - keyword + creation_time + The creation time of the NVT + iso_time + + + modification_time + The modification time of the NVT + iso_time + + + user_tags + Info on tags attached to the NVT + + count + tag + - keyword + count + Number of attached tags + integer + + + tag + + Short info on an individual tag + (only if details were requested) + - column - relation + + id + uuid + UUID of the tag + 1 + + name value + comment - column - Column prefix + name + Name of the tag (usually namespace:predicate) text - relation - Relation operator - - - = - : - ~ - > - < - - + value + Value of the tag + text - value - The filter text + comment + Comment for the tag text - - - sort - - text - field - - field + summary + Short description of the NVT + text + + + family + Name of the family the NVT belongs to + text + + + cvss_base + CVSS base score of the NVT + text + + + severities + Severity information of the NVT + severities + + + qod + The quality of detection (QoD) of the NVT - order + value + type - order - - - ascending - descending - - + value + The numeric QoD value + integer + + + type + The QoD type + text - - - overrides - - - start - First override - integer - 1 - - - max - Maximum number of overrides - integer - 1 - - - - - override_count - - filtered - page - - filtered - Number of overrides after filtering - integer + refs + List of references of various types for this vulnerability test + + ref + warning + + + ref + A reference + + + id + ID of the reference + text + + + type + Type of the reference, for example "cve", "dfn-cert", "cert-bund" + text + + + + + warning + A warning message, e.g. when the CERT database is not available + + text + + - page - Number of overrides on current page - integer + tags + The tags of the NVT, separated by vertical bars + text + + + preference_count + The number of preferences for the NVT + text + + + timeout + The timeout of the NVT + text + + + default_timeout + The default_timeout of the NVT + text + + + solution + Solution for the vulnerability + + + type + The solution type, for example "VendorFix" + text + + + method + The solution method, for example "DebianAPTUpgrade" + text + + text + + + + preferences + List of preferences of the NVT + + timeout + default_timeout + preference + text + + + timeout + The timeout of the NVT + text + + + default_timeout + The default timeout of the NVT + text + + + preference + + nvt + name + id + type + value + alt + default + + + nvt + NVT to which preference applies + + + oid + oid + 1 + + name + + + name + The name of the NVT + name + + + + name + The name of the preference + text + + + id + The ID of the preference + text + + + type + The type of the preference + text + + + value + The value of the preference + text + + + alt + An alternate value of the preference + text + + + default + The default value of the preference + text + + - - - override - override - Get one or many overrides + Get full NVT listing with details - + + - - - - Test NVT: long lines - - 2013-01-09T09:50:10+01:00 - 2013-01-09T09:50:10+01:00 - 1 - 0 - 1 - This is the full text of the override. - Log - 0.0 - 1 - + + + Services + 2011-01-14T10:12:23+01:00 + 2012-09-19T20:56:15+02:00 + 3 + Find what is listening on which port + Service detection + + + + NOTAG + -1 + + + + + + + Services + + 1 + Network connection timeout : + entry + 5 + 5 + + ... + + + + FooBar 21 + 2011-01-14T10:12:23+01:00 + 2012-09-19T20:56:15+02:00 + 3 + This script detects whether the FooBar 2.1 XSS vulnerability is present. + ... + ... - + - Get details of a single override + Get minimal information about one NVT - - + + - - - - Test NVT: control chars in report result - - 2015-07-15T15:05:55Z - 2015-07-15T15:05:55Z - 1 - 0 - 1 - - override fixed to result - 127.0.0.1 - general/tcp - Medium - Low - 2.0 - - test - - 0 - - - ... - + + + Services + + - get_permissions - Get one or many permissions + get_overrides + Get one or many overrides - The client uses the get_permissions command to get permission information. + The client uses the get_overrides command to get override information. + If the command sent by the client was valid, the manager will + reply with a list of overrides to the client. - permission_id - ID of single permission to get + override_id + ID of single override to get uuid @@ -14275,6 +13902,11 @@ END:VCALENDAR text Column to sort by in descending order + tag text @@ -14300,11 +13932,6 @@ END:VCALENDAR name Name - - comment - text - Comment text - created iso_time @@ -14321,39 +13948,69 @@ END:VCALENDAR Name of the owner - type - text - The resource type the permission is for + nvt + oid + OID of the NVT the Override applies to - resource_uuid + text text - UUID of the resource the permission is for + Text of the Override - subject_type - text - Type of the subject of the permission + nvt_id + oid + Alias of nvt - subject + task_name text - Name of the subject of the permission + Name of the Task the Override applies to - resource + hosts text - Name of the resource the permission is for + Hosts the Override applies to - subject_uuid + port text - UUID of the subject of the permission + Port (location) the Override applies to - orphan + threat + threat + Minimum severity level the Override applies to + + + new_threat + threat + Severity level results are changed to by the Override + + + active boolean - Whether the resource of the permission is in the trashcan + Whether the Override is active + + + result + uuid + UUID of the result the Override applies to + + + severity + severity + Minimum severity of results the Override applies to + + + new_severity + severity + Severity level results are changed to by the Override + + + active_days + integer + Number of days the override will still be active @@ -14363,8 +14020,19 @@ END:VCALENDAR uuid - trash - Whether to get the trashcan permissions instead + nvt_oid + oid + + + task_id + uuid + + + details + boolean + + + result boolean @@ -14380,291 +14048,82 @@ END:VCALENDAR text 1 - permission + override filters sort - permissions - permission_count + overrides + override_count - permission + filters id + UUID of filter if any, else 0 uuid 1 - owner - name - comment - - creation_time - modification_time - writable - in_use - permissions - user_tags - resource - subject + term + name + keywords - owner - Owner of the permission - - name - - - name - The name of the owner - name - + term + Filter term + text name - The name of the permission - name - - - comment - The comment on the permission + Filter name, if applicable text - creation_time - Date and time the permission was created - iso_time - - - modification_time - Date and time the permission was last modified - iso_time - - - resource - The resource the permission applies to - - - id - uuid - UUID if permission applies to a resource, else 0 - - name - permissions - type - trash - deleted - - - name - text - - - permissions - Permissions the user has on the resource - - - - type - The GMP type of the resource - text - - - trash - Whether the resource is in the trash - boolean - + keywords + Filter broken down into keywords + keyword - deleted - Whether the resource has been deleted - boolean + keyword + + column + relation + value + + + column + Column prefix + text + + + relation + Relation operator + + + = + : + ~ + > + < + + + + + value + The filter text + text + + + + sort + + text + field + - subject - The subject the permission applies to + field - - id - uuid - UUID of the subject - - name - permissions - type - trash - - - name - text - - - permissions - Permissions the user has on the subject - - - - type - The GMP type of the subject: group, role or user - text - - - trash - Whether the subject is in the trash - boolean - - - deleted - Whether the subject has been deleted - boolean - - - - writable - Whether the permission is writable - boolean - - - in_use - Whether the permission is in use - boolean - - - permissions - - Permissions that the current user has on the permission - - - permission - - - permission - - name - - - name - The name of the permission - name - - - - - user_tags - Info on tags attached to the permission - - count - tag - - - count - Number of attached tags - integer - - - tag - - Short info on an individual tag - (only if details were requested) - - - - id - uuid - UUID of the tag - 1 - - name - value - comment - - - name - Name of the tag (usually namespace:predicate) - text - - - value - Value of the tag - text - - - comment - Comment for the tag - text - - - - - - filters - - - id - UUID of filter if any, else 0 - uuid - 1 - - term - name - keywords - - - term - Filter term - text - - - name - Filter name, if applicable - text - - - keywords - Filter broken down into keywords - keyword - - keyword - - column - relation - value - - - column - Column prefix - text - - - relation - Relation operator - - - = - : - ~ - > - < - - - - - value - The filter text - text - - - - - - sort - - text - field - - - field - - order + order order @@ -14678,100 +14137,117 @@ END:VCALENDAR - permissions + overrides start - First permission + First override integer 1 max - Maximum number of permissions + Maximum number of overrides integer 1 - permission_count + override_count filtered page filtered - Number of permissions after filtering + Number of overrides after filtering integer page - Number of permissions on current page + Number of overrides on current page integer + + override + override + - Get one or many permissions + Get one or many overrides - + - - - Management - Managers - 2018-08-29T20:21:33Z - 2018-08-29T20:21:33Z + + + + Test NVT: long lines + + 2013-01-09T09:50:10+01:00 + 2013-01-09T09:50:10+01:00 1 0 - sarah, frank - + 1 + This is the full text of the override. + Log + 0.0 + 1 + ... - - first=1 rows=-1 sort=name - - - first - = - 1 - - ... - - - - - name - ascending - - - - - 1 - 1 - 1 - - + - - - get_port_lists - Get one or many port lists - -

- The client uses the get_port_lists command to get port list - information. -

- - - - port_list_id - ID of single port list to get - uuid - - + + Get details of a single override + + + + + + + + + Test NVT: control chars in report result + + 2015-07-15T15:05:55Z + 2015-07-15T15:05:55Z + 1 + 0 + 1 + + override fixed to result + 127.0.0.1 + general/tcp + Medium + Low + 2.0 + + test + + 0 + + + ... + + + + + + get_permissions + Get one or many permissions + + The client uses the get_permissions command to get permission information. + + + + permission_id + ID of single permission to get + uuid + + filter Filter term to use to filter query text @@ -14845,24 +14321,39 @@ END:VCALENDAR Name of the owner - total - integer - Total number of ports in the Port List + type + text + The resource type the permission is for - tcp - integer - Number of TCP ports in the Port List + resource_uuid + text + UUID of the resource the permission is for - udp - integer - Number of UDP ports in the Port List + subject_type + text + Type of the subject of the permission - predefined + subject + text + Name of the subject of the permission + + + resource + text + Name of the resource the permission is for + + + subject_uuid + text + UUID of the subject of the permission + + + orphan boolean - Whether the Port List was created from the feed + Whether the resource of the permission is in the trashcan @@ -14871,19 +14362,9 @@ END:VCALENDAR ID of filter to use to filter query uuid - - details - Whether to include full port list details - boolean - - - targets - Whether to include targets using this port list - boolean - trash - Whether to get the trashcan port lists instead + Whether to get the trashcan permissions instead boolean @@ -14899,14 +14380,14 @@ END:VCALENDAR text 1 - port_list + permission filters sort - port_lists - port_list_count + permissions + permission_count - port_list + permission id @@ -14916,21 +14397,19 @@ END:VCALENDAR owner name comment + creation_time modification_time writable in_use permissions user_tags - port_count - port_ranges - targets - predefined - deprecated + resource + subject owner - Owner of the port list + Owner of the permission name @@ -14942,36 +14421,117 @@ END:VCALENDAR name - The name of the port list + The name of the permission name comment - The comment on the port list + The comment on the permission text creation_time + Date and time the permission was created iso_time modification_time + Date and time the permission was last modified iso_time + + resource + The resource the permission applies to + + + id + uuid + UUID if permission applies to a resource, else 0 + + name + permissions + type + trash + deleted + + + name + text + + + permissions + Permissions the user has on the resource + + + + type + The GMP type of the resource + text + + + trash + Whether the resource is in the trash + boolean + + + deleted + Whether the resource has been deleted + boolean + + + + subject + The subject the permission applies to + + + id + uuid + UUID of the subject + + name + permissions + type + trash + + + name + text + + + permissions + Permissions the user has on the subject + + + + type + The GMP type of the subject: group, role or user + text + + + trash + Whether the subject is in the trash + boolean + + + deleted + Whether the subject has been deleted + boolean + + writable - Whether the port list is writable + Whether the permission is writable boolean in_use - Whether any targets are using the port list + Whether the permission is in use boolean permissions - Permissions that the current user has on the port list + Permissions that the current user has on the permission permission @@ -14990,7 +14550,7 @@ END:VCALENDAR user_tags - Info on tags attached to the port list + Info on tags attached to the permission count tag @@ -15034,126 +14594,24 @@ END:VCALENDAR + + + filters + + + id + UUID of filter if any, else 0 + uuid + 1 + + term + name + keywords + - port_count - - all - tcp - udp - - - all - Total number of ports - integer - - - tcp - Total number of TCP ports - integer - - - udp - Total number of UDP ports - integer - - - - port_ranges - - port_range - - - port_range - - - id - uuid - 1 - - start - end - type - comment - - - start - First port in range - integer - - - end - Last port in range - integer - - - type - The type of port: TCP, UDP, ... - text - - - comment - The comment on the port range - text - - - - - targets - The targets using the port list - - target - - - target - - - id - uuid - 1 - - name - permissions - - - name - The name of the target - name - - - permissions - Permissions the user has on the target - - - - - - predefined - Whether the port list was predefined by the feed - boolean - - - deprecated - Whether the port list is deprecated - boolean - - - - filters - - - id - UUID of filter if any, else 0 - uuid - 1 - - term - name - keywords - - - term - Filter term - text + term + Filter term + text name @@ -15220,301 +14678,102 @@ END:VCALENDAR - port_lists + permissions start - First port list + First permission integer 1 max - Maximum number of port lists + Maximum number of permissions integer 1 - port_list_count + permission_count filtered page filtered - Number of port lists after filtering + Number of permissions after filtering integer page - Number of port lists on current page + Number of permissions on current page integer - Export a port list + Get one or many permissions - - + - - - All TCP - Every single TCP port. - 2012-12-31T16:38:45+01:00 - 2012-12-31T16:38:45+01:00 - 0 - 1 - - 65535 - 65535 - 0 - - - - TCP - 1 - 65535 - - - - - Web server - - - - + + + Management + Managers + 2018-08-29T20:21:33Z + 2018-08-29T20:21:33Z + 1 + 0 + sarah, frank + + ... + + first=1 rows=-1 sort=name + + + first + = + 1 + + ... + + + + + name + ascending + + + + + 1 + 1 + 1 + + - get_preferences - Get one or many preferences + get_port_lists + Get one or many port lists

- The client uses the get_preferences command to get preference information. - If the command sent by the client was valid, the manager will reply with - a list of preferences to the client. If the manager cannot access a list - of available NVTs at present, it will reply with the 503 response. -

-

- When the command includes a config_id attribute, the preference element - includes the preference name, type and value, and the NVT to which the - preference applies. Otherwise, the preference element includes just the - name and value, with the NVT and type built into the name. + The client uses the get_port_lists command to get port list + information.

- nvt_oid - oid - - - config_id - ID of config of which to show preference values + port_list_id + ID of single port list to get uuid - preference - The name of a particular preference to get - text - - - - - - status - status - 1 - - - status_text - text - 1 - - preference - - - preference - - nvt - name - id - type - value - alt - default - - - nvt - NVT to which preference applies - - - oid - oid - 1 - - name - - - name - The name of the NVT - name - - - - name - The name of the preference - name - - - id - The ID of the preference - text - - - type - The type of the preference - text - - - value - The value of the preference - text - - - alt - An alternate value of the preference - text - - - default - The default value of the preference - text - - - - - Get default preferences for all NVTs - - - - - - - 1.3.6.1.4.1.25623.1.0.10330:1:entry:Network connection timeout : - 5 - - ... - - - - - Get default preferences for a single NVT - - - - - - - - 1.3.6.1.4.1.25623.1.0.10330:1:entry:Network connection timeout : - 5 - 5 - - ... - - - - - Get preferences from a config for all NVTs - - - - - - - - - Services - - 1 - Network connection timeout : - entry - 5 - - ... - - - - - Get preferences from a config for a single NVT - - - - - - - - - Services - - 1 - Network connection timeout : - entry - 5 - 5 - - - - - - - get_reports - Get one or many reports - -

- The client uses the get_reports command to get report information. -

-

- The XML report format is sent as XML. All other formats are sent in - Base64 encoding. -

-

- The "lean" attribute requests a reduced report. This option is - specifically to support GSA performance when loading big reports, so - the effect of "lean" may change between versions, even between minor - versions. -

-

- Currently "lean" skips certain result elements (MODIFICATION_TIME, - SCAN_NVT_VERSION, THREAT, ORIGINAL_THREAT), skips SOURCE/TYPE of host - details, skips certain host details ("EXIT_CODE" when equal to - "EXIT_NONVULN", "scanned_with_scanner", "scanned_with_feedtype", - "scanned_with_feedversion", "OS" and "traceroute"), skips certain - elements when they are empty (REFS, QOD/TYPE, ...), and skips - ORIGINAL_SEVERITY when it is the same as SEVERITY. -

-

- "lean" will always work with the XML report format, but will not - necessarily work with any others. -

- - - - report_id - ID of single report to get - uuid - - - filter - Filter term to use to filter results, when getting a single report + filter + Filter term to use to filter query text - - - - - - - - - tag + tag text Name and optional "=" separted value of an attached tag @@ -15603,7 +14822,12 @@ END:VCALENDAR name name - Name of the NVT + Name + + + comment + text + Comment text created @@ -15621,379 +14845,45 @@ END:VCALENDAR Name of the owner - compliant - - - yes - no - incomplete - undefined - - - Compliance status - - - host - text - Host IP address of the result - - - hostname - text - Hostname of the result - - - location - text - Port and protocol of the result - - - path - text - The local path on the host, e.g. a file location - - - nvt - text - Unique ID of the test that produced the result - - - type - threat - Severity type of the result with overrides - - - original_type - threat - Original severity type of the result - - - description - text - Description of the result + total + integer + Total number of ports in the Port List - task - text - Name of the task + tcp + integer + Number of TCP ports in the Port List - report - number - Internal ID of the report + udp + integer + Number of UDP ports in the Port List - cvss_base - severity - CVSS base score of the NVT that generated the result - - - nvt_version - text - Version of the NVT that generated the result - - - severity - severity - Severity of the result with overrides - - - original_severity - severity - Original severity of the result - - - vulnerability - text - Name of the NVT that generated result - - - date - iso_time - Time the result was generated - - - report_id - uuid - UUID of the report - - - solution_type - text - Solution type of the result - - - qod - integer - QoD of the result - - - qod_type - text - QoD type of the result - - - task_id - uuid - UUID of the task - - - cve - text - List of CVEs of the result + predefined + boolean + Whether the Port List was created from the feed filt_id - ID of filter to use to filter results, when getting a single report - uuid - - - report_filter - Filter term to use to filter reports - text - - - - - - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - created - iso_time - Creation time - - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - task_id - uuid - UUID of the Task of the Report - - - name - iso_time - Time the scan was started - - - date - iso_time - Time of the scan - - - status - text - Status of scan - - - task - text - Name of the Task the report belongs to - - - severity - severity - Highest severity of the results in the report - - - false_positive - integer - Number of false positive results - - - log - integer - Number of log results - - - low - integer - Number of low severity results - - - medium - integer - Number of medium severity results - - - high - integer - Number of high severity results - - - hosts - integer - Total number of hosts - - - result_hosts - integer - Number of hosts with results matching the min_qod - - - fp_per_host - integer - Number of false positive results per host with results - - - log_per_host - integer - Number of log results per host with results - - - low_per_host - integer - Number of low severity results per host with results - - - medium_per_host - integer - Number of medium severity results per host with results - - - high_per_host - integer - Number of high severity results per host with results - - - start_time - iso_time - Scan start time - - - end_time - iso_time - Scan end time - - - scan_start - iso_time - Scan start time - - - scan_end - iso_time - Scan end time - - - - - report_filt_id - ID of filter to use to filter reports + ID of filter to use to filter query uuid details - - Whether to get the details of the reports including the - results, hosts, ports etc. - + Whether to include full port list details boolean - format_id - ID of required report format - uuid + targets + Whether to include targets using this port list + boolean - alert_id - ID of alert to pass generated report to - -

- In this case the response is empty, and simply indicates success - via the status code. -

- - uuid - - - lean - Whether to return a streamlined response - boolean - - - notes_details - If notes are included, whether to include note details - boolean - - - overrides_details - If overrides are included, whether to include override details - boolean - - - result_tags - Whether to include tags in the results - boolean - - - delta_report_id - ID of second report, for producing a delta report - uuid - - - ignore_pagination - - Whether to ignore info used to split the report into pages - like the filter terms "first" and "rows". - + trash + Whether to get the trashcan port lists instead boolean @@ -16009,508 +14899,430 @@ END:VCALENDAR text 1 - report - - - filters - sort - reports - report_count - - + port_list + filters + sort + port_lists + port_list_count - report - Actually attributes and either base64 or a report - report - - - filters + port_list id - UUID of filter if any, else 0 uuid 1 - term - name - filter - host - delta - keywords + owner + name + comment + creation_time + modification_time + writable + in_use + permissions + user_tags + port_count + port_ranges + targets + predefined + deprecated - term - Filter term - text + owner + Owner of the port list + + name + + + name + The name of the owner + name + name - Filter name, if applicable + The name of the port list + name + + + comment + The comment on the port list text - filter - A severity level that is included in the report - - - High - Medium - Low - Log - - + creation_time + iso_time - host - Single host selected for delta report + modification_time + iso_time + + + writable + Whether the port list is writable + boolean + + + in_use + Whether any targets are using the port list + boolean + + + permissions + + Permissions that the current user has on the port list + - ip + permission - ip - IP address of the host - text + permission + + name + + + name + The name of the permission + name + - delta - Delta states + user_tags + Info on tags attached to the port list - text - changed - gone - new - same + count + tag - changed - Whether changed results are included - boolean - - - gone - Whether results that have vanished are included - boolean - - - new - Whether new results are included - boolean - - - same - Whether results that are equal are included - boolean + count + Number of attached tags + integer - - - keywords - Filter broken down into keywords - keyword - keyword + tag + + Short info on an individual tag + (only if details were requested) + - column - relation + + id + uuid + UUID of the tag + 1 + + name value + comment - column - Column prefix + name + Name of the tag (usually namespace:predicate) text - relation - Relation operator - - - = - : - ~ - > - < - - + value + Value of the tag + text - value - The filter text + comment + Comment for the tag text - - - sort - - text - field - - field + port_count - order + all + tcp + udp - order - - - ascending - descending - - + all + Total number of ports + integer - - - - reports - - - start - First report + + tcp + Total number of TCP ports + integer + + + udp + Total number of UDP ports + integer + + + + port_ranges + + port_range + + + port_range + + + id + uuid + 1 + + start + end + type + comment + + + start + First port in range + integer + + + end + Last port in range + integer + + + type + The type of port: TCP, UDP, ... + text + + + comment + The comment on the port range + text + + + + + targets + The targets using the port list + + target + + + target + + + id + uuid + 1 + + name + permissions + + + name + The name of the target + name + + + permissions + Permissions the user has on the target + + + + + + predefined + Whether the port list was predefined by the feed + boolean + + + deprecated + Whether the port list is deprecated + boolean + + + + filters + + + id + UUID of filter if any, else 0 + uuid + 1 + + term + name + keywords + + + term + Filter term + text + + + name + Filter name, if applicable + text + + + keywords + Filter broken down into keywords + keyword + + keyword + + column + relation + value + + + column + Column prefix + text + + + relation + Relation operator + + + = + : + ~ + > + < + + + + + value + The filter text + text + + + + + + sort + + text + field + + + field + + order + + + order + + + ascending + descending + + + + + + + port_lists + + + start + First port list integer 1 max - Maximum number of reports + Maximum number of port lists integer 1 - report_count + port_list_count filtered page filtered - Number of reports after filtering + Number of port lists after filtering integer page - Number of reports on current page + Number of port lists on current page integer - Get a report in PDF + Export a port list - - + + - - - hsisn3qaVFhkjFRG4... - - - - - - Get a report in XML - - - - - - - - - - @GMP_VERSION@ - - - - type - descending - - - - first=1 rows=-1 sort=name - High - Medium - Low - Log - - - first - = - 1 - - - rows - = - -1 - - - sort - = - name - - - - Done - - 1 - - - 0 - - - 3 - - - 1 - - - 2 - - - 0 - - - 10 - 10 - - 0 - 0 - - - 7 - 7 - - - 0 - 0 - - - 3 - 3 - - - - dik mm - - - - - - 2010-02-02T19:11:21+00:00 - 2010-02-02T19:11:21+00:00 - UTC - UTC - - - general/tcp - 127.0.1.1 - 5.0 - Medium - - ... - - - - 127.0.1.1 - general/tcp - - Test NVT: fields with ISO-8859-1 chars () - 5.0 - - - [...] - - - NOTAGS - - - - - - Medium - Test with umlaut Warning Port 0. - - ... - - - 127.0.1.1 - - 2010-02-21T15:35:31Z - 2010-02-21T16:31:13Z - ... - - 2010-02-02T19:11:52+00:00 - - 0 - - - - + + + All TCP + Every single TCP port. + 2012-12-31T16:38:45+01:00 + 2012-12-31T16:38:45+01:00 + 0 + 1 + + 65535 + 65535 + 0 + + + + TCP + 1 + 65535 + + + + + Web server + + + + - get_report_formats - Get one or many report formats + get_preferences + Get one or many preferences

- The client uses the get_report_formats command to get report format - information. + The client uses the get_preferences command to get preference information. + If the command sent by the client was valid, the manager will reply with + a list of preferences to the client. If the manager cannot access a list + of available NVTs at present, it will reply with the 503 response. +

+

+ When the command includes a config_id attribute, the preference element + includes the preference name, type and value, and the NVT to which the + preference applies. Otherwise, the preference element includes just the + name and value, with the NVT and type built into the name.

- report_format_id - ID of single report format to get - uuid - - - filter - Filter term to use to filter query - text - - - - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - name - name - Name - - - created - iso_time - Creation time - - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - extension - text - File extension of the report format - - - content_type - text - Content type of the report format - - - summary - text - Short summary of the report format - - - description - text - Description of the report format - - - trust - boolean - Whether the report format is trusted - - - trust_time - iso_time - Time the report format was last verified - - - active - boolean - Whether the report format is active - - - predefined - boolean - Whether the report format was created from the feed - - + nvt_oid + oid - filt_id - ID of filter to use to filter query + config_id + ID of config of which to show preference values uuid - trash - Whether to get the trashcan report formats instead - boolean - - - alerts - Whether to include alerts that use the report format - boolean - - - params - Whether to include report format parameters - boolean - - - details - Include report format file, signature and parameters - boolean + preference + The name of a particular preference to get + text @@ -16525,248 +15337,549 @@ END:VCALENDAR text 1 - report_format - filters - sort - report_formats - report_format_count + preference - report_format + preference - - id - uuid - 1 - - owner + nvt name - creation_time - modification_time - writable - in_use - permissions - user_tags - extension - content_type - summary - description - alerts - - - file - signature - - - trust - active - predefined - deprecated - param + id + type + value + alt + default - owner - Owner of the report format + nvt + NVT to which preference applies + + oid + oid + 1 + name name - The name of the owner + The name of the NVT name name - The name of the report format + The name of the preference name - creation_time - iso_time - - - modification_time - iso_time - - - writable - Whether the report format is global or in use - boolean - - - in_use - Whether any alerts are using the report format - boolean - - - permissions - - Permissions that the current user has on the report format - - - permission - - - permission - - name - - - name - The name of the permission - name - - - - - user_tags - Info on tags attached to the report format - - count - tag - - - count - Number of attached tags - integer - - - tag - - Short info on an individual tag - (only if details were requested) - - - - id - uuid - UUID of the tag - 1 - - name - value - comment - - - name - Name of the tag (usually namespace:predicate) - text - - - value - Value of the tag - text - - - comment - Comment for the tag - text - - - - - summary + id + The ID of the preference text - description + type + The type of the preference text - extension + value + The value of the preference text - content_type + alt + An alternate value of the preference text - alerts - Alerts using the report format - - alert - - - alert - - - id - uuid - UUID of the alert - 1 - - name - permissions - - - name - Name of the alert - name - - - permissions - Permissions the user has on the permission - - - + default + The default value of the preference + text - - param - - name - type - value - default - - - name - The name of the param - name - - - type - The type of the param - - min - max - options - - boolean - integer - selection - string - text - report_format_list - - - - min - Minimum - text - - - max - Maximum - text - - - options - Selection options - option - - option - Option value - text - - - - - value - The value of the param - - report_format - + + + + Get default preferences for all NVTs + + + + + + + 1.3.6.1.4.1.25623.1.0.10330:1:entry:Network connection timeout : + 5 + + ... + + + + + Get default preferences for a single NVT + + + + + + + + 1.3.6.1.4.1.25623.1.0.10330:1:entry:Network connection timeout : + 5 + 5 + + ... + + + + + Get preferences from a config for all NVTs + + + + + + + + + Services + + 1 + Network connection timeout : + entry + 5 + + ... + + + + + Get preferences from a config for a single NVT + + + + + + + + + Services + + 1 + Network connection timeout : + entry + 5 + 5 + + + + + + + get_report_formats + Get one or many report formats + +

+ The client uses the get_report_formats command to get report format + information. +

+ + + + report_format_id + ID of single report format to get + uuid + + + filter + Filter term to use to filter query + text + + + + + + + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + + + + tag_id + UUID + + UUID of an attached tag + + + + uuid + uuid + Unique ID + + + name + name + Name + + + created + iso_time + Creation time + + + modified + iso_time + Modification time + + + owner + name + Name of the owner + + + extension + text + File extension of the report format + + + content_type + text + Content type of the report format + + + summary + text + Short summary of the report format + + + description + text + Description of the report format + + + trust + boolean + Whether the report format is trusted + + + trust_time + iso_time + Time the report format was last verified + + + active + boolean + Whether the report format is active + + + predefined + boolean + Whether the report format was created from the feed + + + + + filt_id + ID of filter to use to filter query + uuid + + + trash + Whether to get the trashcan report formats instead + boolean + + + alerts + Whether to include alerts that use the report format + boolean + + + params + Whether to include report format parameters + boolean + + + details + Include report format file, signature and parameters + boolean + + + + + + status + status + 1 + + + status_text + text + 1 + + report_format + filters + sort + report_formats + report_format_count + + + report_format + + + id + uuid + 1 + + owner + name + creation_time + modification_time + writable + in_use + permissions + user_tags + extension + content_type + summary + description + alerts + + + file + signature + + + trust + active + predefined + deprecated + param + + + owner + Owner of the report format + + name + + + name + The name of the owner + name + + + + name + The name of the report format + name + + + creation_time + iso_time + + + modification_time + iso_time + + + writable + Whether the report format is global or in use + boolean + + + in_use + Whether any alerts are using the report format + boolean + + + permissions + + Permissions that the current user has on the report format + + + permission + + + permission + + name + + + name + The name of the permission + name + + + + + user_tags + Info on tags attached to the report format + + count + tag + + + count + Number of attached tags + integer + + + tag + + Short info on an individual tag + (only if details were requested) + + + + id + uuid + UUID of the tag + 1 + + name + value + comment + + + name + Name of the tag (usually namespace:predicate) + text + + + value + Value of the tag + text + + + comment + Comment for the tag + text + + + + + summary + text + + + description + text + + + extension + text + + + content_type + text + + + alerts + Alerts using the report format + + alert + + + alert + + + id + uuid + UUID of the alert + 1 + + name + permissions + + + name + Name of the alert + name + + + permissions + Permissions the user has on the permission + + + + + + param + + name + type + value + default + + + name + The name of the param + name + + + type + The type of the param + + min + max + options + + boolean + integer + selection + string + text + report_format_list + + + + min + Minimum + text + + + max + Maximum + text + + + options + Selection options + option + + option + Option value + text + + + + + value + The value of the param + + report_format + report_format Report format info if type is report_format_list @@ -16841,11 +15954,746 @@ END:VCALENDAR boolean - deprecated - Whether the report format is deprecated - boolean + deprecated + Whether the report format is deprecated + boolean + + + + filters + + + id + UUID of filter if any, else 0 + uuid + 1 + + term + name + keywords + + + term + Filter term + text + + + name + Filter name, if applicable + text + + + keywords + Filter broken down into keywords + keyword + + keyword + + column + relation + value + + + column + Column prefix + text + + + relation + Relation operator + + + = + : + ~ + > + < + + + + + value + The filter text + text + + + + + + sort + + text + field + + + field + + order + + + order + + + ascending + descending + + + + + + + report_formats + + + start + First report format + integer + 1 + + + max + Maximum number of report formats + integer + 1 + + + + + report_format_count + + filtered + page + + + filtered + Number of report formats after filtering + integer + + + page + Number of report formats on current page + integer + + + Get information about a report format + + + + + + + + HTML + 2013-01-31T16:46:32+01:00 + 2013-01-31T16:46:32+01:00 + 1 + 0 + html + text/html + Single page HTML report. + + A single HTML page listing results of a scan. Style information + ... + + + no + + + 1 + + ... + + + + + Export a report format + + + + + + + + HTML + + 2013-01-18T18:23:53+01:00 + 2013-01-18T18:24:10+01:00 + 1 + 0 + html + text/html + Single page HTML report. + + A single HTML page listing results of a scan. Style information + ... + + + PD9ldD4K + ... + + + IyEvAk + ... + + + + ... + + + + + + get_reports + Get one or many reports + +

+ The client uses the get_reports command to get report information. +

+

+ The XML report format is sent as XML. All other formats are sent in + Base64 encoding. +

+

+ The "lean" attribute requests a reduced report. This option is + specifically to support GSA performance when loading big reports, so + the effect of "lean" may change between versions, even between minor + versions. +

+

+ Currently "lean" skips certain result elements (MODIFICATION_TIME, + SCAN_NVT_VERSION, THREAT, ORIGINAL_THREAT), skips SOURCE/TYPE of host + details, skips certain host details ("EXIT_CODE" when equal to + "EXIT_NONVULN", "scanned_with_scanner", "scanned_with_feedtype", + "scanned_with_feedversion", "OS" and "traceroute"), skips certain + elements when they are empty (REFS, QOD/TYPE, ...), and skips + ORIGINAL_SEVERITY when it is the same as SEVERITY. +

+

+ "lean" will always work with the XML report format, but will not + necessarily work with any others. +

+ + + + report_id + ID of single report to get + uuid + + + filter + Filter term to use to filter results, when getting a single report + text + + + + + + + + + + + + + + + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + + + + tag_id + UUID + + UUID of an attached tag + + + + uuid + uuid + Unique ID + + + name + name + Name of the NVT + + + created + iso_time + Creation time + + + modified + iso_time + Modification time + + + owner + name + Name of the owner + + + compliant + + + yes + no + incomplete + undefined + + + Compliance status + + + host + text + Host IP address of the result + + + hostname + text + Hostname of the result + + + location + text + Port and protocol of the result + + + path + text + The local path on the host, e.g. a file location + + + nvt + text + Unique ID of the test that produced the result + + + type + threat + Severity type of the result with overrides + + + original_type + threat + Original severity type of the result + + + description + text + Description of the result + + + task + text + Name of the task + + + report + number + Internal ID of the report + + + cvss_base + severity + CVSS base score of the NVT that generated the result + + + nvt_version + text + Version of the NVT that generated the result + + + severity + severity + Severity of the result with overrides + + + original_severity + severity + Original severity of the result + + + vulnerability + text + Name of the NVT that generated result + + + date + iso_time + Time the result was generated + + + report_id + uuid + UUID of the report + + + solution_type + text + Solution type of the result + + + qod + integer + QoD of the result + + + qod_type + text + QoD type of the result + + + task_id + uuid + UUID of the task + + + cve + text + List of CVEs of the result + + + + + filt_id + ID of filter to use to filter results, when getting a single report + uuid + + + report_filter + Filter term to use to filter reports + text + + + + + + + + + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + + + + tag_id + UUID + + UUID of an attached tag + + + + uuid + uuid + Unique ID + + + created + iso_time + Creation time + + + modified + iso_time + Modification time + + + owner + name + Name of the owner + + + task_id + uuid + UUID of the Task of the Report + + + name + iso_time + Time the scan was started + + + date + iso_time + Time of the scan + + + status + text + Status of scan + + + task + text + Name of the Task the report belongs to + + + severity + severity + Highest severity of the results in the report + + + false_positive + integer + Number of false positive results + + + log + integer + Number of log results + + + low + integer + Number of low severity results + + + medium + integer + Number of medium severity results + + + high + integer + Number of high severity results + + + hosts + integer + Total number of hosts + + + result_hosts + integer + Number of hosts with results matching the min_qod + + + fp_per_host + integer + Number of false positive results per host with results + + + log_per_host + integer + Number of log results per host with results + + + low_per_host + integer + Number of low severity results per host with results + + + medium_per_host + integer + Number of medium severity results per host with results + + + high_per_host + integer + Number of high severity results per host with results + + + start_time + iso_time + Scan start time + + + end_time + iso_time + Scan end time + + + scan_start + iso_time + Scan start time + + + scan_end + iso_time + Scan end time + + + + + report_filt_id + ID of filter to use to filter reports + uuid + + + details + + Whether to get the details of the reports including the + results, hosts, ports etc. + + boolean + + + format_id + ID of required report format + uuid + + + alert_id + ID of alert to pass generated report to + +

+ In this case the response is empty, and simply indicates success + via the status code. +

+ + uuid + + + lean + Whether to return a streamlined response + boolean + + + notes_details + If notes are included, whether to include note details + boolean + + + overrides_details + If overrides are included, whether to include override details + boolean + + + result_tags + Whether to include tags in the results + boolean + + + delta_report_id + ID of second report, for producing a delta report + uuid + + + ignore_pagination + + Whether to ignore info used to split the report into pages + like the filter terms "first" and "rows". + + boolean + + + + + + status + status + 1 + + + status_text + text + 1 + + report + + + filters + sort + reports + report_count + + + + + report + Actually attributes and either base64 or a report + report + filters @@ -16857,6 +16705,9 @@ END:VCALENDAR term name + filter + host + delta keywords @@ -16869,6 +16720,61 @@ END:VCALENDAR Filter name, if applicable text + + filter + A severity level that is included in the report + + + High + Medium + Low + Log + + + + + host + Single host selected for delta report + + ip + + + ip + IP address of the host + text + + + + delta + Delta states + + text + changed + gone + new + same + + + changed + Whether changed results are included + boolean + + + gone + Whether results that have vanished are included + boolean + + + new + Whether new results are included + boolean + + + same + Whether results that are equal are included + boolean + + keywords Filter broken down into keywords @@ -16929,106 +16835,200 @@ END:VCALENDAR - report_formats + reports start - First report format + First report integer 1 max - Maximum number of report formats + Maximum number of reports integer 1 - report_format_count + report_count filtered page filtered - Number of report formats after filtering + Number of reports after filtering integer page - Number of report formats on current page + Number of reports on current page integer - Get information about a report format - - - - - - - - HTML - 2013-01-31T16:46:32+01:00 - 2013-01-31T16:46:32+01:00 - 1 - 0 - html - text/html - Single page HTML report. - - A single HTML page listing results of a scan. Style information - ... - - - no - - - 1 - - ... - - - - - Export a report format + Get a report in PDF - - + + - - - HTML - - 2013-01-18T18:23:53+01:00 - 2013-01-18T18:24:10+01:00 - 1 - 0 - html - text/html - Single page HTML report. - - A single HTML page listing results of a scan. Style information - ... - - - PD9ldD4K - ... - - - IyEvAk - ... - - - - ... - + + + hsisn3qaVFhkjFRG4... + + + + + + Get a report in XML + + + + + + + + + + @GMP_VERSION@ + + + + type + descending + + + + first=1 rows=-1 sort=name + High + Medium + Low + Log + + + first + = + 1 + + + rows + = + -1 + + + sort + = + name + + + + Done + + 1 + + + 0 + + + 3 + + + 1 + + + 2 + + + 0 + + + 10 + 10 + + 0 + 0 + + + 7 + 7 + + + 0 + 0 + + + 3 + 3 + + + + dik mm + + + + + + 2010-02-02T19:11:21+00:00 + 2010-02-02T19:11:21+00:00 + UTC + UTC + + + general/tcp + 127.0.1.1 + 5.0 + Medium + + ... + + + + 127.0.1.1 + general/tcp + + Test NVT: fields with ISO-8859-1 chars () + 5.0 + + + [...] + + + NOTAGS + + + + + + Medium + Test with umlaut Warning Port 0. + + ... + + + 127.0.1.1 + + 2010-02-21T15:35:31Z + 2010-02-21T16:31:13Z + ... + + 2010-02-02T19:11:52+00:00 + + 0 + + + + @@ -22576,18 +22576,18 @@ END:VCALENDAR - get_users - Get one or many users + get_tls_certificates + Get one or many TLS certificates

- The client uses the "get_users" command to retrieve the list of user - accounts on the Scanner. + The client uses the "get_tls_certificates" command to retrieve one + or more TLS certificates.

- user_id - ID of single user to get + tls_certificate_id + ID of single TLS certificate to get uuid @@ -22618,6 +22618,16 @@ END:VCALENDAR text Column to sort by in descending order + + tag text @@ -22664,24 +22674,86 @@ END:VCALENDAR Name of the owner - method + subject_dn text - Methods allowed for authentication + + Distinguished name (DN) of the certificate subject + - roles + issuer_dn text - Comma-separated list of roles + + Distinguished name (DN) of the certificate issuer + - groups + sha256_fingerprint text - Comma-separated list of groups + + SHA256 fingerprint of the certificate + - hosts + md5_fingerprint text - List of host that are either allowed of forbidden + + MD5 fingerprint of the certificate + + + + time_status + + Whether the certificate is valid, expired or not active yet + + + + expired + inactive + unknown + valid + + + + + activates + iso_time + Time before which the certificate is not valid + + + expires + iso_time + Time after which the certificate is not valid + + + valid + boolean + Whether the certificate is currently valid + + + serial + text + + Hexadecimal serial number of the certificate + + + + last_seen + iso_time + Most recent time the TLS certificate was imported or found in a scan + + + certificate_format + + + DER + PEM + unknown + + + + File format of the certificate + @@ -22690,6 +22762,11 @@ END:VCALENDAR ID of filter to use to filter query uuid + + include_certificate_data + Whether to include certificate_data even if details are not requested + boolean + @@ -22703,18 +22780,18 @@ END:VCALENDAR text 1 - user + tls_certificate filters - sort - users - user_count + sort + tls_certificates + tls_certificate_count - user + tls_certificate id - ID of user + ID of TLS certificate uuid 1 @@ -22725,16 +22802,23 @@ END:VCALENDAR modification_time writable in_use - role - groups - hosts permissions - user_tags - sources + certificate + sha256_fingerprint + md5_fingerprint + trust + time_status + activation_time + expiration_time + subject_dn + issuer_dn + serial + last_seen + sources owner - Owner of the user + Owner of the TLS certificate name @@ -22746,190 +22830,283 @@ END:VCALENDAR name - The name of the user + The name of the TLS certificate text comment - The comment on the user + The comment on the TLS certificate text creation_time - Creation time of the user + Creation time of the TLS certificate iso_time modification_time - Last time the user was modified + Last time the TLS certificate was modified iso_time writable - Whether the user is writable + Whether the TLS certificate is writable boolean in_use - Whether this user is currently in use + Whether this TLS certificate is currently in use boolean - role - The role of the user - - - id - uuid - 1 - - name - permissions - - - name - Name of role - name - - - permissions - Permissions the user has on the role - - - - - groups - The groups the user belongs to + permissions + + Permissions that the current user has on the TLS certificate + - group + permission - group + permission - - id - uuid - 1 - name - permissions name - Name of group + The name of the permission name - - permissions - Permissions the user has on the group - - - hosts - Host access rule for the user + certificate + The Base64 encoded certificate data if details are requested, empty otherwise - allow - 0 forbidden, 1 allowed, 2 all allowed, 3 custom + format + The format of the certificate - 0 - 1 - 2 - 3 + DER + PEM + unknown 1 - text - permissions + md5_fingerprint + The MD5 fingerprint of the certificate + text + + + sha256_fingerprint + The SHA256 fingerprint of the certificate + text + + + trust + Whether the certificate is trusted + boolean + + + valid + Whether the certificate is currently valid + boolean + + + time_status - Permissions that the current user has on the user + Whether the certificate is valid, expired or not active yet - permission + + expired + inactive + unknown + valid + - - permission - - name - - - name - The name of the permission - name - - - user_tags - Info on tags attached to the user + activation_time + Time before which the certificate is not valid + iso_time + + + expiration_time + Time after which the certificate is not valid + iso_time + + + subject_dn + Distinguished name (DN) of the certificate subject + text + + + issuer_dn + Distinguished name (DN) of the certificate issuer + text + + + serial + Hexadecimal serial number of the certificate + text + + + last_seen + Most recent time the TLS certificate was imported or found in a scan + iso_time + + + sources + List of sources - count - tag + source - count - Number of attached tags - integer - - - tag - - Short info on an individual tag - (only if details were requested) - + source + A certificate source id + UUID of the source uuid - UUID of the tag 1 - name - value - comment + timestamp + tls_versions + location + origin - name - Name of the tag (usually namespace:predicate) - text + timestamp + Time the certificate was found or imported + iso_time - value - Value of the tag + tls_versions + SSL and TLS versions of the service using the certificate, separated with ", " text - comment - Comment for the tag - text + location + A location where the certificate was found + + + id + UUID of the location + uuid + 1 + + host + port + + + host + Host where the certificate was found + + ip + asset + + + ip + IP address of the host + text + + + asset + Host asset + + + id + UUID of the host asset + uuid + 0 + + + + + + port + Port where the certificate was found + integer + + + + origin + Origin of the certificate data, e.g. a scan report + + + id + UUID of the location + uuid + 1 + + origin_type + origin_id + origin_data + report + + + origin_type + Type of origin, e.g. "Import" or "Report" + text + + + origin_id + Identifier of origin, e.g. a report UUID + text + + + origin_data + Extra origin data, e.g. OID of the detection NVT + text + + + report + Report data if the origin is a report + + + id + UUID of the report + uuid + 0 + + date + task + + + date + Timestamp of the report + + iso_time + + + + task + Task the report belongs to + + + id + UUID of the task + uuid + 1 + + name + + + name + Name of the task + text + + + - - sources - Sources allowed for authentication for this user - - source - - - source - Authentication source - - - file - ldap_connect - radius_connect - - - - filters @@ -23014,72 +23191,116 @@ END:VCALENDAR - users + tls_certificates start - First user + First TLS certificate integer 1 max - Maximum number of users + Maximum number of TLS certificates integer 1 - user_count + tls_certificate_count filtered page filtered - Number of users after filtering + Number of TLS certificate after filtering integer page - Number of users on current page + Number of TLS certificate on current page integer - Get the users + Get the TLS certificates - + - - - foobar - - User - - - file - - + + + + admin + + Example Certificate + + 2019-06-12T14:36:53Z + 2019-06-13T08:56:36Z + 1 + 0 + + + Everything + + + MIIDNjCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQQFADCBqTELM[...] + ba:ec:16:30:27:ca:99:17:ff:df:a4:4c:bc:bf:1b:98 + 1 + 1 + 2019-02-26T14:24:15Z + 2021-02-25T14:24:15Z + CN=localhost,O=GVM Users,L=Osnabrueck,C=DE + OU=Certificate Authority for localhost,O=GVM Users,L=Osnabrueck,C=DE + + + first=1 rows=10 sort=name + + + first + = + 1 + + + rows + = + 1000 + + + sort + = + name + + + + + nameascending + + + 1 + 1 + 1 + + - get_tls_certificates - Get one or many TLS certificates + get_users + Get one or many users

- The client uses the "get_tls_certificates" command to retrieve one - or more TLS certificates. + The client uses the "get_users" command to retrieve the list of user + accounts on the Scanner.

- tls_certificate_id - ID of single TLS certificate to get + user_id + ID of single user to get uuid @@ -23110,142 +23331,70 @@ END:VCALENDAR text Column to sort by in descending order - - - - tag - text - - Name and optional "=" separted value of an attached tag - (e.g. "mytag" or "mytag=myvalue") - - - - tag_id - UUID - - UUID of an attached tag - - - - uuid - uuid - Unique ID - - - name - name - Name - - - comment - text - Comment text - - - created - iso_time - Creation time - - modified - iso_time - Modification time - - - owner - name - Name of the owner - - - subject_dn - text - - Distinguished name (DN) of the certificate subject - - - - issuer_dn - text - - Distinguished name (DN) of the certificate issuer - - - - sha256_fingerprint - text - - SHA256 fingerprint of the certificate - - - - md5_fingerprint + tag text - MD5 fingerprint of the certificate + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") - time_status + tag_id + UUID - Whether the certificate is valid, expired or not active yet + UUID of an attached tag - - - expired - inactive - unknown - valid - - - activates + uuid + uuid + Unique ID + + + name + name + Name + + + comment + text + Comment text + + + created iso_time - Time before which the certificate is not valid + Creation time - expires + modified iso_time - Time after which the certificate is not valid + Modification time - valid - boolean - Whether the certificate is currently valid + owner + name + Name of the owner - serial + method text - - Hexadecimal serial number of the certificate - + Methods allowed for authentication - last_seen - iso_time - Most recent time the TLS certificate was imported or found in a scan + roles + text + Comma-separated list of roles - certificate_format - - - DER - PEM - unknown - - - - File format of the certificate - + groups + text + Comma-separated list of groups + + + hosts + text + List of host that are either allowed of forbidden @@ -23254,11 +23403,6 @@ END:VCALENDAR ID of filter to use to filter query uuid - - include_certificate_data - Whether to include certificate_data even if details are not requested - boolean - @@ -23272,18 +23416,18 @@ END:VCALENDAR text 1 - tls_certificate + user filters sort - tls_certificates - tls_certificate_count + users + user_count - tls_certificate + user id - ID of TLS certificate + ID of user uuid 1 @@ -23294,23 +23438,16 @@ END:VCALENDAR modification_time writable in_use + role + groups + hosts permissions - certificate - sha256_fingerprint - md5_fingerprint - trust - time_status - activation_time - expiration_time - subject_dn - issuer_dn - serial - last_seen - sources + user_tags + sources owner - Owner of the TLS certificate + Owner of the user name @@ -23322,283 +23459,190 @@ END:VCALENDAR name - The name of the TLS certificate + The name of the user text comment - The comment on the TLS certificate + The comment on the user text creation_time - Creation time of the TLS certificate + Creation time of the user iso_time modification_time - Last time the TLS certificate was modified + Last time the user was modified iso_time writable - Whether the TLS certificate is writable + Whether the user is writable boolean in_use - Whether this TLS certificate is currently in use + Whether this user is currently in use boolean - permissions - - Permissions that the current user has on the TLS certificate - + role + The role of the user - permission + + id + uuid + 1 + + name + permissions - permission + name + Name of role + name + + + permissions + Permissions the user has on the role + + + + + groups + The groups the user belongs to + + group + + + group + + id + uuid + 1 + name + permissions name - The name of the permission + Name of group name + + permissions + Permissions the user has on the group + + - certificate - The Base64 encoded certificate data if details are requested, empty otherwise + hosts + Host access rule for the user - format - The format of the certificate + allow + 0 forbidden, 1 allowed, 2 all allowed, 3 custom - DER - PEM - unknown + 0 + 1 + 2 + 3 1 + text - md5_fingerprint - The MD5 fingerprint of the certificate - text - - - sha256_fingerprint - The SHA256 fingerprint of the certificate - text - - - trust - Whether the certificate is trusted - boolean - - - valid - Whether the certificate is currently valid - boolean - - - time_status + permissions - Whether the certificate is valid, expired or not active yet + Permissions that the current user has on the user - - expired - inactive - unknown - valid - + permission + + permission + + name + + + name + The name of the permission + name + + - activation_time - Time before which the certificate is not valid - iso_time - - - expiration_time - Time after which the certificate is not valid - iso_time - - - subject_dn - Distinguished name (DN) of the certificate subject - text - - - issuer_dn - Distinguished name (DN) of the certificate issuer - text - - - serial - Hexadecimal serial number of the certificate - text - - - last_seen - Most recent time the TLS certificate was imported or found in a scan - iso_time - - - sources - List of sources + user_tags + Info on tags attached to the user - source + count + tag - source - A certificate source + count + Number of attached tags + integer + + + tag + + Short info on an individual tag + (only if details were requested) + id - UUID of the source uuid + UUID of the tag 1 - timestamp - tls_versions - location - origin + name + value + comment - timestamp - Time the certificate was found or imported - iso_time - - - tls_versions - SSL and TLS versions of the service using the certificate, separated with ", " + name + Name of the tag (usually namespace:predicate) text - location - A location where the certificate was found - - - id - UUID of the location - uuid - 1 - - host - port - - - host - Host where the certificate was found - - ip - asset - - - ip - IP address of the host - text - - - asset - Host asset - - - id - UUID of the host asset - uuid - 0 - - - - - - port - Port where the certificate was found - integer - + value + Value of the tag + text - origin - Origin of the certificate data, e.g. a scan report - - - id - UUID of the location - uuid - 1 - - origin_type - origin_id - origin_data - report - - - origin_type - Type of origin, e.g. "Import" or "Report" - text - - - origin_id - Identifier of origin, e.g. a report UUID - text - - - origin_data - Extra origin data, e.g. OID of the detection NVT - text - - - report - Report data if the origin is a report - - - id - UUID of the report - uuid - 0 - - date - task - - - date - Timestamp of the report - - iso_time - - - - task - Task the report belongs to - - - id - UUID of the task - uuid - 1 - - name - - - name - Name of the task - text - - - + comment + Comment for the tag + text + + sources + Sources allowed for authentication for this user + + source + + + source + Authentication source + + + file + ldap_connect + radius_connect + + + + filters @@ -23683,100 +23727,56 @@ END:VCALENDAR - tls_certificates + users start - First TLS certificate + First user integer 1 max - Maximum number of TLS certificates + Maximum number of users integer 1 - - tls_certificate_count - - filtered - page - - - filtered - Number of TLS certificate after filtering - integer - - - page - Number of TLS certificate on current page - integer - - - - - Get the TLS certificates - - - - - - - - admin - - Example Certificate - - 2019-06-12T14:36:53Z - 2019-06-13T08:56:36Z - 1 - 0 - - - Everything - - - MIIDNjCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQQFADCBqTELM[...] - ba:ec:16:30:27:ca:99:17:ff:df:a4:4c:bc:bf:1b:98 - 1 - 1 - 2019-02-26T14:24:15Z - 2021-02-25T14:24:15Z - CN=localhost,O=GVM Users,L=Osnabrueck,C=DE - OU=Certificate Authority for localhost,O=GVM Users,L=Osnabrueck,C=DE - - - first=1 rows=10 sort=name - - - first - = - 1 - - - rows - = - 1000 - - - sort - = - name - - - - - nameascending - - - 1 - 1 - 1 - - + + user_count + + filtered + page + + + filtered + Number of users after filtering + integer + + + page + Number of users on current page + integer + + + + + Get the users + + + + + + + foobar + + User + + + file + + @@ -26150,6 +26150,117 @@ END:VCALENDAR + + modify_tag + Modify a tag + +

+ The client uses the modify_tag command to change an existing tag. +

+ + + + tag_id + uuid + 1 + + name + resources + value + comment + active + + + name + A full tag name consisting of namespace and predicate + text + + + resources + Identifies the resources the tag is to be attached to + + + action + + + + add + set + remove + + + Whether to add or remove resources instead of overwriting + 0 + + + filter + text + Filter term to select resources the tag is to be attached to + 0 + + resource + type + + + resource + + + id + ID of a resource the tag is to be attached to + uuid + 0 + + + + + type + GMP type of the resources the tag is to be attached to + text + + + + value + Value associated with the tag + text + + + comment + Comment to add to the tag + text + + + active + Whether the tag is active + boolean + + + + + status + status + 1 + + + status_text + text + 1 + + + + + Deactivate a tag + + + 0 + + + + + + + + modify_target Modify an existing target @@ -26367,117 +26478,6 @@ END:VCALENDAR - - modify_tag - Modify a tag - -

- The client uses the modify_tag command to change an existing tag. -

- - - - tag_id - uuid - 1 - - name - resources - value - comment - active - - - name - A full tag name consisting of namespace and predicate - text - - - resources - Identifies the resources the tag is to be attached to - - - action - - - - add - set - remove - - - Whether to add or remove resources instead of overwriting - 0 - - - filter - text - Filter term to select resources the tag is to be attached to - 0 - - resource - type - - - resource - - - id - ID of a resource the tag is to be attached to - uuid - 0 - - - - - type - GMP type of the resources the tag is to be attached to - text - - - - value - Value associated with the tag - text - - - comment - Comment to add to the tag - text - - - active - Whether the tag is active - boolean - - - - - status - status - 1 - - - status_text - text - 1 - - - - - Deactivate a tag - - - 0 - - - - - - - - modify_task Modify an existing task