From 184a6b2ae17979c48df8584e14f8ebcdd77a85d4 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 13:58:28 +0200 Subject: [PATCH 01/18] Docs: Remove trailing full stops from summaries --- src/schema_formats/XML/GMP.xml.in | 34 +++++++++++++++++-------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 1137994ba..3ffdc96f6 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -5001,7 +5001,7 @@ along with this program. If not, see . ca_pub - Certificate of CA to verify scanner certificate. + Certificate of CA to verify scanner certificate text @@ -5090,7 +5090,7 @@ along with this program. If not, see . icalendar - iCalendar text containing the time data. Replaces first_time, duration and period. + iCalendar text containing the time data. Replaces first_time, duration and period text @@ -7299,8 +7299,10 @@ END:VCALENDAR sort_field - The column to sort the aggregated rows by. - With a subgroup column, groups will be sorted by the group_column first. + The column to sort the aggregated rows by + + With a subgroup column, groups will be sorted by the group_column first. + text @@ -7369,8 +7371,10 @@ END:VCALENDAR field - The column to sort the aggregated rows by. - With a subgroup column, groups will be sorted by the group_column first + The column to sort the aggregated rows by + + With a subgroup column, groups will be sorted by the group_column first. + text @@ -7553,7 +7557,7 @@ END:VCALENDAR text - The value of a simple text column. + The value of a simple text column name @@ -16613,7 +16617,7 @@ END:VCALENDAR details Whether to get the details of the reports including the - results, hosts, ports etc. + results, hosts, ports etc boolean @@ -16662,7 +16666,7 @@ END:VCALENDAR ignore_pagination Whether to ignore info used to split the report into pages - like the filter terms "first" and "rows". + like the filter terms "first" and "rows" boolean @@ -17052,7 +17056,7 @@ END:VCALENDAR resource_id - ID of single resource to get. + ID of single resource to get text @@ -18983,7 +18987,7 @@ END:VCALENDAR icalendar - iCalendar text containing the time data. + iCalendar text containing the time data text @@ -20955,7 +20959,7 @@ END:VCALENDAR ignore_pagination Whether to ignore info used to split the report into pages - like the filter terms "first" and "rows". + like the filter terms "first" and "rows" boolean @@ -21373,12 +21377,12 @@ END:VCALENDAR icalendar - iCalendar text containing the time data. + iCalendar text containing the time data iso_time timezone - The timezone the schedule will follow. + The timezone the schedule will follow text @@ -26054,7 +26058,7 @@ END:VCALENDAR icalendar - iCalendar text containing the time data. Replaces first_time, duration and period. + iCalendar text containing the time data. Replaces first_time, duration and period text From 7f401614c12faa9aee3691482a9fc5831feb73cb Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 14:36:40 +0200 Subject: [PATCH 02/18] Docs: Sort GET_RESULTS keywords --- src/schema_formats/XML/GMP.xml.in | 210 +++++++++++++++--------------- 1 file changed, 105 insertions(+), 105 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 3ffdc96f6..73a47597d 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -17202,29 +17202,6 @@ END:VCALENDAR 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 of the NVT + compliant + + + yes + no + incomplete + undefined + + + Compliance status created @@ -17291,26 +17278,24 @@ END:VCALENDAR Creation time - modified - iso_time - Modification time + cve + text + List of CVEs of the result - owner - name - Name of the owner + cvss_base + severity + CVSS base score of the NVT that generated the result - compliant - - - yes - no - incomplete - undefined - - - Compliance status + date + iso_time + Time the result was generated + + + description + text + Description of the result host @@ -17328,9 +17313,14 @@ END:VCALENDAR Port and protocol of the result - path - text - The local path on the host, e.g. a file location + modified + iso_time + Modification time + + + name + name + Name of the NVT nvt @@ -17338,9 +17328,14 @@ END:VCALENDAR Unique ID of the test that produced the result - type - threat - Severity type of the result with overrides + nvt_version + text + Version of the NVT that generated the result + + + original_severity + severity + Original severity of the result original_type @@ -17348,14 +17343,24 @@ END:VCALENDAR Original severity type of the result - description + owner + name + Name of the owner + + + path text - Description of the result + The local path on the host, e.g. a file location - task + qod + integer + QoD of the result + + + qod_type text - Name of the task + QoD type of the result report @@ -17363,14 +17368,9 @@ END:VCALENDAR 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 + report_id + uuid + UUID of the report severity @@ -17378,49 +17378,49 @@ END:VCALENDAR Severity of the result with overrides - original_severity - severity - Original severity of the result - - - vulnerability + solution_type text - Name of the NVT that generated result + Solution type of the result - date - iso_time - Time the result was generated + tag + text + + Name and optional "=" separted value of an attached tag + (e.g. "mytag" or "mytag=myvalue") + - report_id - uuid - UUID of the report + tag_id + UUID + + UUID of an attached tag + - solution_type + task text - Solution type of the result + Name of the task - qod - integer - QoD of the result + task_id + uuid + UUID of the task - qod_type - text - QoD type of the result + type + threat + Severity type of the result with overrides - task_id + uuid uuid - UUID of the task + Unique ID - cve + vulnerability text - List of CVEs of the result + Name of the NVT that generated result From f76518f4b9431a72a72b4e9d20bc3736d3f67551 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 16:18:25 +0200 Subject: [PATCH 03/18] Docs: remove timezone from GET_RESULTS filter keywords --- src/schema_formats/XML/GMP.xml.in | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 73a47597d..133bfc058 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -17255,11 +17255,6 @@ END:VCALENDAR text Column to sort by in descending order - compliant From f5de54c3907d26600fd0241b5726993600100e1a Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 16:34:31 +0200 Subject: [PATCH 04/18] Docs: add details attrib to GET_TARGETS --- src/schema_formats/XML/GMP.xml.in | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 133bfc058..d6ae29026 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -20058,6 +20058,11 @@ END:VCALENDAR Whether to include list of tasks that use the target boolean + + details + Whether to include port range and tag info + boolean + @@ -20103,7 +20108,7 @@ END:VCALENDAR snmp_credential ssh_elevate_credential permissions - port_range + port_range port_list alive_tests reverse_lookup_only From ef00b44e7e5505c17ef9ec2fcfbde43f1264672b Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 16:40:37 +0200 Subject: [PATCH 05/18] Docs: add active to CREATE_ALERT --- src/schema_formats/XML/GMP.xml.in | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index d6ae29026..edafee948 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -3225,6 +3225,7 @@ along with this program. If not, see . event method filter + active name @@ -3329,6 +3330,13 @@ along with this program. If not, see . + + active + Whether to alert will be active + + boolean + + From 11470ff9afb051bead142685ae4d34f3a2ff7c94 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 16:58:51 +0200 Subject: [PATCH 06/18] Docs: add summary in GET_NOTES --- src/schema_formats/XML/GMP.xml.in | 1 + 1 file changed, 1 insertion(+) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index edafee948..f40bbe058 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -13120,6 +13120,7 @@ END:VCALENDAR details + Whether to include full details boolean From 711268cd57ebe972edd3dd862863888ca5c782bb Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 18:26:46 +0200 Subject: [PATCH 07/18] Docs: correct nvt and nvt_id in GET_NOTES --- src/gmp.c | 1 - src/schema_formats/XML/GMP.xml.in | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/gmp.c b/src/gmp.c index 06f5f743f..53fca3b6c 100644 --- a/src/gmp.c +++ b/src/gmp.c @@ -13514,7 +13514,6 @@ handle_get_notes (gmp_parser_t *gmp_parser, GError **error) } get_notes_data_reset (get_notes_data); set_client_state (CLIENT_AUTHENTIC); - } /** diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index f40bbe058..416b58737 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -13061,7 +13061,7 @@ END:VCALENDAR nvt oid - OID of the NVT the Note applies to + Name of the NVT the Note applies to text @@ -13071,7 +13071,7 @@ END:VCALENDAR nvt_id oid - Alias of nvt + OID of the NVT the Note applies to task_name From 2a6e3b7d29cc102066a79f312ca89521493b77a4 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 19:09:23 +0200 Subject: [PATCH 08/18] Docs: flesh out result in GET_NOTES --- src/schema_formats/XML/GMP.xml.in | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 416b58737..2a3a66947 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -13126,6 +13126,8 @@ END:VCALENDAR result boolean + Whether to include the associated result + Requires "details" to be true. From 33327079e17b4390ae2979b91809fcb20c9bca46 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 19:23:53 +0200 Subject: [PATCH 09/18] Docs: remove very old GET_NOTES attributes now covered by filter --- src/schema_formats/XML/GMP.xml.in | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index 2a3a66947..f3bb9726a 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -13110,14 +13110,6 @@ END:VCALENDAR ID of filter to use to filter query uuid - - nvt_oid - oid - - - task_id - uuid - details Whether to include full details From c002ec9a318bccec9c84a2928a1a3fa4eddfdad4 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 15 Jan 2024 20:05:22 +0200 Subject: [PATCH 10/18] Docs: make the same changes to GET_OVERRIDES --- src/schema_formats/XML/GMP.xml.in | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/schema_formats/XML/GMP.xml.in b/src/schema_formats/XML/GMP.xml.in index f3bb9726a..24695d494 100644 --- a/src/schema_formats/XML/GMP.xml.in +++ b/src/schema_formats/XML/GMP.xml.in @@ -13957,7 +13957,7 @@ END:VCALENDAR nvt oid - OID of the NVT the Override applies to + Name of the NVT the Override applies to text @@ -13967,7 +13967,7 @@ END:VCALENDAR nvt_id oid - Alias of nvt + OID of the NVT the Override applies to task_name @@ -14026,21 +14026,16 @@ END:VCALENDAR ID of filter to use to filter query uuid - - nvt_oid - oid - - - task_id - uuid - details + Whether to include full details boolean result boolean + Whether to include the associated result + Requires "details" to be true. From f5db691a79a30e0a8df9b66c06093646c7b1768d Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 15:19:26 +0200 Subject: [PATCH 11/18] Add: hiding of top level items --- src/schema_formats/HTML/HTML.xsl | 107 ++++++++++++++++++++++--------- 1 file changed, 78 insertions(+), 29 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 1065fdcb6..1a990aaa0 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -260,15 +260,29 @@ along with this program. If not, see . + + + + +

+ + + -

4 RNC Preamble

-
- 
-        
-
-
+
+ + + + +
+ 
+          
+
+
+
@@ -285,10 +299,15 @@ along with this program. If not, see . -

1 Summary of Data Types

- - -
+
+ + + + + + +
+
@@ -325,8 +344,13 @@ along with this program. If not, see . -

5 Data Type Details

- +
+ + + + + +
@@ -343,15 +367,25 @@ along with this program. If not, see . -

2 Summary of Elements

- - -
+
+ + + + + + +
+
-

6 Element Details

- +
+ + + + + +
@@ -691,15 +725,25 @@ along with this program. If not, see . -

3 Summary of Commands

- - -
+
+ + + + + + +
+
-

7 Command Details

- +
+ + + + + +
@@ -749,11 +793,16 @@ along with this program. If not, see . -

- 8 Compatibility Changes in Version - -

- +
+ + + + + + + + +
From 72e36e722287939bac2a31f8bfd4ddaab28522aa Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 15:20:57 +0200 Subject: [PATCH 12/18] Close RNC Preamble initially --- src/schema_formats/HTML/HTML.xsl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 1a990aaa0..9fd734f28 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -272,7 +272,7 @@ along with this program. If not, see . -
+
From b66d2ff050b9520d51a1a98c04caf12f248ae8ac Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 15:48:05 +0200 Subject: [PATCH 13/18] Add: hiding of second level items --- src/schema_formats/HTML/HTML.xsl | 52 +++++++++++++++++++------------- 1 file changed, 31 insertions(+), 21 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 9fd734f28..3e3dd2108 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -269,6 +269,16 @@ along with this program. If not, see . + + + + + +

+ + + @@ -312,12 +322,12 @@ along with this program. If not, see . 5. -
-
-

- - Data Type

-
+
+ + + + +

In short: .

@@ -340,7 +350,7 @@ along with this program. If not, see .
- +
@@ -390,12 +400,12 @@ along with this program. If not, see . 6. -
-
-

- - Element

-
+
+ + + + +

In short: .

@@ -417,7 +427,7 @@ along with this program. If not, see .
- +
@@ -646,12 +656,12 @@ along with this program. If not, see . 7. -
-
-

- - Command

-
+
+ + + + +

In short: .

@@ -714,7 +724,7 @@ along with this program. If not, see . -
+ From a2cdeafcd038fcb7f4f6b86091eb508d9b8fdede Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 16:01:12 +0200 Subject: [PATCH 14/18] Add: hiding of third level items --- src/schema_formats/HTML/HTML.xsl | 162 ++++++++++++++++++------------- 1 file changed, 97 insertions(+), 65 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 3e3dd2108..6bef5fba1 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -279,6 +279,13 @@ along with this program. If not, see . + + + +

+ + + @@ -335,20 +342,24 @@ along with this program. If not, see . -

.1 RNC

+
+ + + -
- 
-          
-           = 
-          
-            
-              
-            
-          
-          
-
-
+
+ 
+            
+             = 
+            
+              
+                
+              
+            
+            
+
+
+
@@ -411,21 +422,29 @@ along with this program. If not, see . -

.1 Structure

+
+ + + -
    -
  • - -
    • -
+
    +
  • + +
    • +
+
-

.2 RNC

+
+ + + -
-
- +
+
+ +
-
+
@@ -667,57 +686,70 @@ along with this program. If not, see . -

.1 Structure

+
+ + + -
    -
  • - Command - -
    • -
  • - Response - +
      +
    • + Command - -
      • -
    +
    • +
  • + Response + + + +
    • +
+
-

.2 RNC

+
+ + + -
- Command -
- -
- Response -
- +
+ Command +
+ +
+ Response +
+ +
-
+
-

.3 Example:

- -
- Client -
- - 
-                    
-
- -
- Manager -
- - 
-                    
-
- +
+ + + + + +
+ Client +
+ + 
+                      
+
+ +
+ Manager +
+ + 
+                      
+
+ +
-
+ From 211eb3876492d37f2f4401421d56d9c1475d9acd Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 16:03:03 +0200 Subject: [PATCH 15/18] Add heading number to details-summary --- src/schema_formats/HTML/HTML.xsl | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 6bef5fba1..3805f1d92 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -260,7 +260,7 @@ along with this program. If not, see . - + .
- + @@ -317,7 +317,7 @@ along with this program. If not, see .
- + @@ -366,7 +366,7 @@ along with this program. If not, see .
- + @@ -389,7 +389,7 @@ along with this program. If not, see .
- + @@ -401,7 +401,7 @@ along with this program. If not, see .
- + @@ -768,7 +768,7 @@ along with this program. If not, see .
- + @@ -780,7 +780,7 @@ along with this program. If not, see .
- + @@ -836,7 +836,7 @@ along with this program. If not, see .
- + From 0645dc658797c4b4160a0d3d99c55e6fd75184a3 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 16:06:37 +0200 Subject: [PATCH 16/18] Start with all RNC sections closed --- src/schema_formats/HTML/HTML.xsl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index 3805f1d92..ac78792e7 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -342,7 +342,7 @@ along with this program. If not, see . -
+
@@ -434,7 +434,7 @@ along with this program. If not, see .
-
+
@@ -705,7 +705,7 @@ along with this program. If not, see .
-
+
From b83800bcb8f6e1d2ab0684b519ce2bf241e82b40 Mon Sep 17 00:00:00 2001 From: Matt Mundell Date: Mon, 22 Jan 2024 16:19:31 +0200 Subject: [PATCH 17/18] Soften the RNC boxes --- src/schema_formats/HTML/HTML.xsl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl index ac78792e7..584dc0759 100644 --- a/src/schema_formats/HTML/HTML.xsl +++ b/src/schema_formats/HTML/HTML.xsl @@ -294,7 +294,7 @@ along with this program. If not, see . -
+
@@ -347,7 +347,7 @@ along with this program. If not, see . -
+ 
             
              = 
@@ -439,7 +439,7 @@ along with this program.  If not, see .
           
         
 
-        

+        

           

             
           

@@ -710,7 +710,7 @@ along with this program.  If not, see .
           
         
 
-        

+        

           Command
           

             

From aab6174e9b99a8bc62134245e4694316a2daa389 Mon Sep 17 00:00:00 2001
From: Matt Mundell 
Date: Mon, 22 Jan 2024 16:35:30 +0200
Subject: [PATCH 18/18] Put boxes around the example XML

---
 src/schema_formats/HTML/HTML.xsl | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/schema_formats/HTML/HTML.xsl b/src/schema_formats/HTML/HTML.xsl
index 584dc0759..82f15e0fe 100644
--- a/src/schema_formats/HTML/HTML.xsl
+++ b/src/schema_formats/HTML/HTML.xsl
@@ -733,17 +733,17 @@ along with this program.  If not, see .
               
               

                 Client
-                

+                

                   
-                    
+                    
                       
                     

                   
                 

                 Manager
-                

+                

                   
-                    
+