Skip to content

Commit fbdb88a

Browse files
authored
Docs: update documentation regarding targets (#1048)
1 parent 05c2382 commit fbdb88a

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

docs/OSP.xml

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
231231

232232
<element>
233233
<name>targets</name>
234-
<summary>List of targets</summary>
234+
<summary>Includes one target element (deprecated)</summary>
235235
<pattern>
236236
<e>target</e>
237237
</pattern>
@@ -240,7 +240,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
240240
<e>
241241
<targets>
242242
<target>...</target>
243-
<target>...</target>
244243
</targets>
245244
</e>
246245
</example>
@@ -1531,7 +1530,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
15311530
</ele>
15321531
<ele>
15331532
<name>targets</name>
1534-
<summary>Contains elements that represent a target to execute a scan against. If target and port attributes are present this element is not take into account</summary>
1533+
<summary>Contains a single element that represent a target to execute a scan against. If target and port attributes are present this element is not take into account</summary>
15351534
</ele>
15361535
<response>
15371536
<pattern>
@@ -1570,7 +1569,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
15701569
</response>
15711570
</example>
15721571
<example>
1573-
<summary>Start a new scan with multi-targets running simultaneously. Each one has a different port list and one of them has credentials for authenticated scans.</summary>
1572+
<summary>Start a new scan with. Target element has port list and credentials for authenticated scans.</summary>
15741573
<request>
15751574
<start_scan parallel='10'>
15761575
<scanner_params>
@@ -1580,9 +1579,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
15801579
....
15811580
</vt_selection>
15821581
<targets>
1583-
<target>
1584-
...
1585-
</target>
15861582
<target>
15871583
<hosts>192.168.1.0/24</hosts>
15881584
<ports>1,2,3,80,443</ports>
@@ -1931,14 +1927,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
19311927
</description>
19321928
<version>1.1</version>
19331929
</change>
1934-
<change>
1935-
<command>Scanner Parameters Types</command>
1936-
<summary>Type credential_up added</summary>
1937-
<description>
1938-
Introduce an aggregated type to express a username:password tuple.
1939-
</description>
1940-
<version>1.1</version>
1941-
</change>
19421930
<change>
19431931
<command>GET_PERFORMANCE</command>
19441932
<summary>Command added</summary>
@@ -1947,5 +1935,12 @@ SPDX-License-Identifier: GPL-2.0-or-later
19471935
</description>
19481936
<version>1.2</version>
19491937
</change>
1950-
1938+
<change>
1939+
<command>START_SCAN</command>
1940+
<summary>Deprecation of targets and parallel</summary>
1941+
<description>
1942+
Possibility of running multi-targets was not implemented. Currently, only the first target element is used and the following are ignored as well as parallel attribute.
1943+
</description>
1944+
<version>1.3</version>
1945+
</change>
19511946
</protocol>

ospd/command/command.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ def handle_xml(self, xml: Element) -> bytes:
585585

586586
if xml.get('parallel'):
587587
logger.warning(
588-
"parallel attribute of start_scan will be ignored, sice "
588+
"parallel attribute of start_scan will be ignored, since "
589589
"parallel scan is not supported by OSPd."
590590
)
591591

0 commit comments

Comments
 (0)