Skip to content

Docs: update documentation regarding targets #1048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

Docs: update documentation regarding targets #1048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c63628
Docs: update documentation regarding targets
jjnicola Jul 29, 2025
f8f6d1a
Merge branch 'main' into doc-targets
jjnicola Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions docs/OSP.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ SPDX-License-Identifier: GPL-2.0-or-later

<element>
<name>targets</name>
<summary>List of targets</summary>
<summary>Includes one target element (deprecated)</summary>
<pattern>
<e>target</e>
</pattern>
Expand All @@ -240,7 +240,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
<e>
<targets>
<target>...</target>
<target>...</target>
</targets>
</e>
</example>
Expand Down Expand Up @@ -1531,7 +1530,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
</ele>
<ele>
<name>targets</name>
<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>
<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>
</ele>
<response>
<pattern>
Expand Down Expand Up @@ -1570,7 +1569,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
</response>
</example>
<example>
<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>
<summary>Start a new scan with. Target element has port list and credentials for authenticated scans.</summary>
<request>
<start_scan parallel='10'>
<scanner_params>
Expand All @@ -1580,9 +1579,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
....
</vt_selection>
<targets>
<target>
...
</target>
<target>
<hosts>192.168.1.0/24</hosts>
<ports>1,2,3,80,443</ports>
Expand Down Expand Up @@ -1931,14 +1927,6 @@ SPDX-License-Identifier: GPL-2.0-or-later
</description>
<version>1.1</version>
</change>
<change>
<command>Scanner Parameters Types</command>
<summary>Type credential_up added</summary>
<description>
Introduce an aggregated type to express a username:password tuple.
</description>
<version>1.1</version>
</change>
<change>
<command>GET_PERFORMANCE</command>
<summary>Command added</summary>
Expand All @@ -1947,5 +1935,12 @@ SPDX-License-Identifier: GPL-2.0-or-later
</description>
<version>1.2</version>
</change>

<change>
<command>START_SCAN</command>
<summary>Deprecation of targets and parallel</summary>
<description>
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.
</description>
<version>1.3</version>
</change>
</protocol>
2 changes: 1 addition & 1 deletion ospd/command/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ def handle_xml(self, xml: Element) -> bytes:

if xml.get('parallel'):
logger.warning(
"parallel attribute of start_scan will be ignored, sice "
"parallel attribute of start_scan will be ignored, since "
"parallel scan is not supported by OSPd."
)

Expand Down
Loading