python-gvm 27.1.0__tar.gz → 27.3.0__tar.gz

{python_gvm-27.1.0 → python_gvm-27.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gvm
-Version: 27.1.0
+Version: 27.3.0
 Summary: Library to communicate with remote servers over GMP or OSP
 Project-URL: Homepage, https://github.com/greenbone/python-gvm/
 Project-URL: Repository, https://github.com/greenbone/python-gvm/

{python_gvm-27.1.0 → python_gvm-27.3.0}/gvm/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "27.1.0"
+__version__ = "27.3.0"

{python_gvm-27.1.0 → python_gvm-27.3.0}/gvm/protocols/gmp/_gmpnext.py

@@ -12,8 +12,10 @@ from .._protocol import T
 from ._gmp227 import GMPv227
 from .requests.next import (
     AgentGroups,
-    AgentInstallers,
+    AgentInstallerInstructionLanguageType,
+    AgentInstallerInstructions,
     Agents,
+    AliveTest,
     Credentials,
     CredentialStoreCredentialType,
     CredentialStores,
@@ -27,8 +29,12 @@ from .requests.next import (
     ReportOperatingSystems,
     ReportPorts,
     ReportTlsCertificates,
+    ReportVulnerabilities,
+    Targets,
     Tasks,
+    WebApplicationTargets,
 )
+from .requests.v224 import AliveTest as AliveTestV224
 from .requests.v224 import HostsOrdering
 
 
@@ -54,52 +60,25 @@ class GMPNext(GMPv227[T]):
     def get_protocol_version() -> tuple[int, int]:
         return (22, 8)
 
-    def get_agent_installers(
+    def get_agent_installer_instruction(
         self,
         *,
-        filter_string: str | None = None,
-        filter_id: EntityID | None = None,
-        trash: bool | None = None,
-        details: bool | None = None,
+        scanner_id: EntityID,
+        language_type: AgentInstallerInstructionLanguageType,
     ) -> T:
-        """Request a list of agent installers
+        """Request an agent installer instruction.
 
         Args:
-            filter_string: Filter term to use for the query
-            filter_id: UUID of an existing filter to use for the query
-            trash: Whether to get the trashcan agent installers instead
-            details: Whether to include extra details like tasks using this
-                scanner
+            scanner_id: UUID of the Agent controller to get the installer instruction for.
+            language_type: Language of the installer instruction.
         """
         return self._send_request_and_transform_response(
-            AgentInstallers.get_agent_installers(
-                filter_string=filter_string,
-                filter_id=filter_id,
-                trash=trash,
-                details=details,
+            AgentInstallerInstructions.get_agent_installer_instruction(
+                scanner_id=scanner_id,
+                language_type=language_type,
             )
         )
 
-    def get_agent_installer(self, agent_installer_id: EntityID) -> T:
-        """Request a single agent installer
-
-        Args:
-            agent_installer_id: UUID of an existing agent installer
-        """
-        return self._send_request_and_transform_response(
-            AgentInstallers.get_agent_installer(agent_installer_id)
-        )
-
-    def get_agent_installer_file(self, agent_installer_id: EntityID) -> T:
-        """Request a single agent installer file
-
-        Args:
-            agent_installer_id: UUID of an existing agent installer
-        """
-        return self._send_request_and_transform_response(
-            AgentInstallers.get_agent_installer_file(agent_installer_id)
-        )
-
     def get_agents(
         self,
         *,
@@ -227,6 +206,7 @@ class GMPNext(GMPv227[T]):
         self,
         name: str,
         agent_ids: list[str],
+        scheduler_cron_time: str,
         *,
         comment: str | None = None,
     ) -> T:
@@ -235,6 +215,7 @@ class GMPNext(GMPv227[T]):
         Args:
             name: Name of the new agent group.
             agent_ids: List of agent UUIDs to include in the group (required).
+            scheduler_cron_time: Scheduler cron to use.
             comment: Optional comment for the group.
 
         Raises:
@@ -245,12 +226,14 @@ class GMPNext(GMPv227[T]):
                 name=name,
                 comment=comment,
                 agent_ids=agent_ids,
+                scheduler_cron_time=scheduler_cron_time,
             )
         )
 
     def modify_agent_group(
         self,
         agent_group_id: EntityID,
+        scheduler_cron_time: str,
         *,
         name: str | None = None,
         comment: str | None = None,
@@ -261,6 +244,7 @@ class GMPNext(GMPv227[T]):
         Args:
             agent_group_id: UUID of the group to modify.
             name: Optional new name for the group.
+            scheduler_cron_time: Scheduler cron to use.
             comment: Optional comment for the group.
             agent_ids: Optional list of agent UUIDs to set for the group.
 
@@ -273,6 +257,7 @@ class GMPNext(GMPv227[T]):
                 name=name,
                 comment=comment,
                 agent_ids=agent_ids,
+                scheduler_cron_time=scheduler_cron_time,
             )
         )
 
@@ -724,6 +709,49 @@ class GMPNext(GMPv227[T]):
             Tasks.create_container_task(name=name, comment=comment)
         )
 
+    def create_web_application_task(
+        self,
+        name: str,
+        web_application_target_id: EntityID,
+        scanner_id: EntityID,
+        *,
+        comment: str | None = None,
+        alterable: bool | None = None,
+        schedule_id: EntityID | None = None,
+        alert_ids: Sequence[EntityID] | None = None,
+        schedule_periods: int | None = None,
+        observers: Sequence[str] | None = None,
+        preferences: Mapping[str, SupportsStr] | None = None,
+    ) -> T:
+        """Create a new scan task using a web application target.
+
+        Args:
+            name: Name of the new task.
+            web_application_target_id: UUID of the web application target to be scanned.
+            scanner_id: UUID of scanner to use for scanning the agents.
+            comment: Optional comment for the task.
+            alterable: Whether the task should be alterable.
+            alert_ids: List of UUIDs for alerts to be applied to the task.
+            schedule_id: UUID of a schedule when the task should be run.
+            schedule_periods: Limit to number of scheduled runs, 0 for unlimited.
+            observers: List of usernames or IDs allowed to observe the task.
+            preferences: Scanner preferences as name/value pairs.
+        """
+        return self._send_request_and_transform_response(
+            Tasks.create_web_application_task(
+                name=name,
+                web_application_target_id=web_application_target_id,
+                scanner_id=scanner_id,
+                comment=comment,
+                alterable=alterable,
+                schedule_id=schedule_id,
+                alert_ids=alert_ids,
+                schedule_periods=schedule_periods,
+                observers=observers,
+                preferences=preferences,
+            )
+        )
+
     def create_task(
         self,
         name: str,
@@ -841,6 +869,7 @@ class GMPNext(GMPv227[T]):
         scanner_id: EntityID | None = None,
         agent_group_id: EntityID | None = None,
         oci_image_target_id: EntityID | None = None,
+        web_application_target_id: EntityID | None = None,
         alterable: bool | None = None,
         hosts_ordering: HostsOrdering | None = None,
         schedule_id: EntityID | None = None,
@@ -860,6 +889,7 @@ class GMPNext(GMPv227[T]):
             scanner_id: UUID of scanner to use for scanning the target
             agent_group_id: UUID of agent group to use for scanning
             oci_image_target_id: UUID of the OCI Image target to be scanned.
+            web_application_target_id: UUID of the web application target to be scanned.
             comment: The comment on the task.
             alert_ids: List of UUIDs for alerts to be applied to the task
             hosts_ordering: The order hosts are scanned in
@@ -879,6 +909,7 @@ class GMPNext(GMPv227[T]):
                 scanner_id=scanner_id,
                 agent_group_id=agent_group_id,
                 oci_image_target_id=oci_image_target_id,
+                web_application_target_id=web_application_target_id,
                 alterable=alterable,
                 hosts_ordering=hosts_ordering,
                 schedule_id=schedule_id,
@@ -1234,3 +1265,353 @@ class GMPNext(GMPv227[T]):
                 details=details,
             )
         )
+
+    def get_report_vulnerabilities(
+        self,
+        report_id: EntityID,
+        *,
+        filter_string: str | None = None,
+        filter_id: str | None = None,
+        ignore_pagination: bool | None = None,
+        details: bool | None = True,
+    ) -> T:
+        """Request vulnerabilities of a single report.
+
+        Args:
+            report_id: UUID of an existing report.
+            filter_string: Filter term to use to filter results in the report
+            filter_id: UUID of filter to use to filter results in the report
+            ignore_pagination: Whether to ignore the filter terms "first" and
+                "rows".
+            details: Request additional report vulnerability information details.
+                Defaults to True.
+        """
+        return self._send_request_and_transform_response(
+            ReportVulnerabilities.get_report_vulnerabilities(
+                report_id=report_id,
+                filter_string=filter_string,
+                filter_id=filter_id,
+                ignore_pagination=ignore_pagination,
+                details=details,
+            )
+        )
+
+    def create_web_application_target(
+        self,
+        name: str,
+        urls: list[str],
+        *,
+        comment: str | None = None,
+        exclude_urls: list[str] | None = None,
+        credential_id: EntityID | None = None,
+    ) -> T:
+        """Create a new web application target.
+
+        Args:
+            name: Name of the web application target.
+            urls: List of URLs to scan.
+            comment: Comment for the target.
+            exclude_urls: List of URLs to exclude from the scan.
+            credential_id: UUID of a credential to use on target.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.create_web_application_target(
+                name=name,
+                urls=urls,
+                comment=comment,
+                exclude_urls=exclude_urls,
+                credential_id=credential_id,
+            )
+        )
+
+    def modify_web_application_target(
+        self,
+        web_application_target_id: EntityID,
+        *,
+        name: str | None = None,
+        comment: str | None = None,
+        urls: list[str] | None = None,
+        exclude_urls: list[str] | None = None,
+        credential_id: EntityID | None = None,
+    ) -> T:
+        """Modify an existing web application target.
+
+        Args:
+            web_application_target_id: UUID of target to modify.
+            name: Name of target.
+            comment: Comment on target.
+            urls: List of URLs to scan.
+            exclude_urls: List of URLs to exclude from the scan.
+            credential_id: UUID of credential to use on target.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.modify_web_application_target(
+                web_application_target_id,
+                name=name,
+                comment=comment,
+                urls=urls,
+                exclude_urls=exclude_urls,
+                credential_id=credential_id,
+            )
+        )
+
+    def clone_web_application_target(
+        self, web_application_target_id: EntityID
+    ) -> T:
+        """Clone an existing web application target.
+
+        Args:
+            web_application_target_id: UUID of an existing web application target to clone.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.clone_web_application_target(
+                web_application_target_id
+            )
+        )
+
+    def delete_web_application_target(
+        self,
+        web_application_target_id: EntityID,
+        *,
+        ultimate: bool | None = False,
+    ) -> T:
+        """Delete an existing web application target.
+
+        Args:
+            web_application_target_id: UUID of an existing web application target to delete.
+            ultimate: Whether to remove entirely or to the trashcan.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.delete_web_application_target(
+                web_application_target_id,
+                ultimate=ultimate,
+            )
+        )
+
+    def get_web_application_target(
+        self,
+        web_application_target_id: EntityID,
+        *,
+        tasks: bool | None = None,
+    ) -> T:
+        """Request a single web application target.
+
+        Args:
+            web_application_target_id: UUID of the web application target to request.
+            tasks: Whether to include list of tasks that use the target.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.get_web_application_target(
+                web_application_target_id,
+                tasks=tasks,
+            )
+        )
+
+    def get_web_application_targets(
+        self,
+        *,
+        filter_string: str | None = None,
+        filter_id: EntityID | None = None,
+        trash: bool | None = None,
+        tasks: bool | None = None,
+    ) -> T:
+        """Request a list of web application targets.
+
+        Args:
+            filter_string: Filter term to use for the query.
+            filter_id: UUID of an existing filter to use for the query.
+            trash: Whether to include targets in the trashcan.
+            tasks: Whether to include list of tasks that use the target.
+        """
+        return self._send_request_and_transform_response(
+            WebApplicationTargets.get_web_application_targets(
+                filter_string=filter_string,
+                filter_id=filter_id,
+                trash=trash,
+                tasks=tasks,
+            )
+        )
+
+    def create_target(
+        self,
+        name: str,
+        *,
+        asset_hosts_filter: str | None = None,
+        hosts: list[str] | None = None,
+        comment: str | None = None,
+        exclude_hosts: list[str] | None = None,
+        ssh_credential_id: EntityID | None = None,
+        ssh_credential_port: int | str | None = None,
+        smb_credential_id: EntityID | None = None,
+        esxi_credential_id: EntityID | None = None,
+        snmp_credential_id: EntityID | None = None,
+        alive_test: str | AliveTest | AliveTestV224 | None = None,
+        allow_simultaneous_ips: bool | None = None,
+        reverse_lookup_only: bool | None = None,
+        reverse_lookup_unify: bool | None = None,
+        port_range: str | None = None,
+        port_list_id: EntityID | None = None,
+    ) -> T:
+        """Create a new target
+
+        Args:
+            name: Name of the target
+            asset_hosts_filter: Filter to select target host from assets hosts
+            hosts: List of hosts addresses to scan
+            exclude_hosts: List of hosts addresses to exclude from scan
+            comment: Comment for the target
+            ssh_credential_id: UUID of a ssh credential to use on target
+            ssh_credential_port: The port to use for ssh credential
+            smb_credential_id: UUID of a smb credential to use on target
+            snmp_credential_id: UUID of a snmp credential to use on target
+            esxi_credential_id: UUID of a esxi credential to use on target
+            alive_test: Which alive test to use
+            allow_simultaneous_ips: Whether to scan multiple IPs of the
+                same host simultaneously
+            reverse_lookup_only: Whether to scan only hosts that have names
+            reverse_lookup_unify: Whether to scan only one IP when multiple IPs
+                have the same name.
+            port_range: Port range for the target
+            port_list_id: UUID of the port list to use on target
+        """
+        return self._send_request_and_transform_response(
+            Targets.create_target(
+                name,
+                asset_hosts_filter=asset_hosts_filter,
+                hosts=hosts,
+                comment=comment,
+                exclude_hosts=exclude_hosts,
+                ssh_credential_id=ssh_credential_id,
+                ssh_credential_port=ssh_credential_port,
+                smb_credential_id=smb_credential_id,
+                esxi_credential_id=esxi_credential_id,
+                snmp_credential_id=snmp_credential_id,
+                alive_test=alive_test,
+                allow_simultaneous_ips=allow_simultaneous_ips,
+                reverse_lookup_only=reverse_lookup_only,
+                reverse_lookup_unify=reverse_lookup_unify,
+                port_range=port_range,
+                port_list_id=port_list_id,
+            )
+        )
+
+    def modify_target(
+        self,
+        target_id: EntityID,
+        *,
+        name: str | None = None,
+        comment: str | None = None,
+        hosts: list[str] | None = None,
+        exclude_hosts: list[str] | None = None,
+        ssh_credential_id: EntityID | None = None,
+        ssh_credential_port: str | int | None = None,
+        smb_credential_id: EntityID | None = None,
+        esxi_credential_id: EntityID | None = None,
+        snmp_credential_id: EntityID | None = None,
+        alive_test: str | AliveTest | AliveTestV224 | None = None,
+        allow_simultaneous_ips: bool | None = None,
+        reverse_lookup_only: bool | None = None,
+        reverse_lookup_unify: bool | None = None,
+        port_list_id: EntityID | None = None,
+    ) -> T:
+        """Modify an existing target.
+
+        Args:
+            target_id: UUID of target to modify.
+            comment: Comment on target.
+            name: Name of target.
+            hosts: List of target hosts.
+            exclude_hosts: A list of hosts to exclude.
+            ssh_credential_id: UUID of SSH credential to use on target.
+            ssh_credential_port: The port to use for ssh credential
+            smb_credential_id: UUID of SMB credential to use on target.
+            esxi_credential_id: UUID of ESXi credential to use on target.
+            snmp_credential_id: UUID of SNMP credential to use on target.
+            port_list_id: UUID of port list describing ports to scan.
+            alive_test: Which alive tests to use.
+            allow_simultaneous_ips: Whether to scan multiple IPs of the
+                same host simultaneously
+            reverse_lookup_only: Whether to scan only hosts that have names.
+            reverse_lookup_unify: Whether to scan only one IP when multiple IPs
+                have the same name.
+        """
+        return self._send_request_and_transform_response(
+            Targets.modify_target(
+                target_id,
+                name=name,
+                comment=comment,
+                hosts=hosts,
+                exclude_hosts=exclude_hosts,
+                ssh_credential_id=ssh_credential_id,
+                ssh_credential_port=ssh_credential_port,
+                smb_credential_id=smb_credential_id,
+                esxi_credential_id=esxi_credential_id,
+                snmp_credential_id=snmp_credential_id,
+                alive_test=alive_test,
+                allow_simultaneous_ips=allow_simultaneous_ips,
+                reverse_lookup_only=reverse_lookup_only,
+                reverse_lookup_unify=reverse_lookup_unify,
+                port_list_id=port_list_id,
+            )
+        )
+
+    def clone_target(self, target_id: EntityID) -> T:
+        """Clone an existing target.
+
+        Args:
+            target_id: UUID of an existing target to clone.
+        """
+        return self._send_request_and_transform_response(
+            Targets.clone_target(target_id)
+        )
+
+    def delete_target(
+        self, target_id: EntityID, *, ultimate: bool | None = False
+    ) -> T:
+        """Delete an existing target.
+
+        Args:
+            target_id: UUID of an existing target to delete.
+            ultimate: Whether to remove entirely or to the trashcan.
+        """
+        return self._send_request_and_transform_response(
+            Targets.delete_target(target_id, ultimate=ultimate)
+        )
+
+    def get_target(
+        self, target_id: EntityID, *, tasks: bool | None = None
+    ) -> T:
+        """Request a single target.
+
+        Args:
+            target_id: UUID of the target to request.
+            tasks: Whether to include list of tasks that use the target
+        """
+        return self._send_request_and_transform_response(
+            Targets.get_target(target_id, tasks=tasks)
+        )
+
+    def get_targets(
+        self,
+        *,
+        filter_string: str | None = None,
+        filter_id: EntityID | None = None,
+        trash: bool | None = None,
+        tasks: bool | None = None,
+    ) -> T:
+        """Request a list of targets.
+
+        Args:
+            filter_string: Filter term to use for the query.
+            filter_id: UUID of an existing filter to use for the query.
+            trash: Whether to include targets in the trashcan.
+            tasks: Whether to include list of tasks that use the target.
+        """
+        return self._send_request_and_transform_response(
+            Targets.get_targets(
+                filter_string=filter_string,
+                filter_id=filter_id,
+                trash=trash,
+                tasks=tasks,
+            )
+        )

{python_gvm-27.1.0 → python_gvm-27.3.0}/gvm/protocols/gmp/requests/next/__init__.py

@@ -3,7 +3,10 @@
 #  SPDX-License-Identifier: GPL-3.0-or-later
 
 from gvm.protocols.gmp.requests.next._agent_groups import AgentGroups
-from gvm.protocols.gmp.requests.next._agent_installers import AgentInstallers
+from gvm.protocols.gmp.requests.next._agent_installer_instructions import (
+    AgentInstallerInstructionLanguageType,
+    AgentInstallerInstructions,
+)
 from gvm.protocols.gmp.requests.next._agents import Agents
 from gvm.protocols.gmp.requests.next._credential_stores import CredentialStores
 from gvm.protocols.gmp.requests.next._credentials import (
@@ -38,7 +41,14 @@ from gvm.protocols.gmp.requests.next._report_ports import (
 from gvm.protocols.gmp.requests.next._report_tls_certificates import (
     ReportTlsCertificates,
 )
+from gvm.protocols.gmp.requests.next._report_vulnerabilities import (
+    ReportVulnerabilities,
+)
+from gvm.protocols.gmp.requests.next._targets import AliveTest, Targets
 from gvm.protocols.gmp.requests.next._tasks import Tasks
+from gvm.protocols.gmp.requests.next._web_application_targets import (
+    WebApplicationTargets,
+)
 
 from .._entity_id import EntityID
 from .._version import Version
@@ -49,7 +59,6 @@ from ..v227 import (
     AlertEvent,
     AlertMethod,
     Alerts,
-    AliveTest,
     AuditReports,
     Audits,
     Authentication,
@@ -99,7 +108,6 @@ from ..v227 import (
     SortOrder,
     SystemReports,
     Tags,
-    Targets,
     Tickets,
     TicketStatus,
     TLSCertificates,
@@ -112,7 +120,8 @@ from ..v227 import (
 
 __all__ = (
     "AgentGroups",
-    "AgentInstallers",
+    "AgentInstallerInstructionLanguageType",
+    "AgentInstallerInstructions",
     "Agents",
     "AggregateStatistic",
     "Aggregates",
@@ -168,6 +177,7 @@ __all__ = (
     "ReportOperatingSystems",
     "ReportPorts",
     "ReportTlsCertificates",
+    "ReportVulnerabilities",
     "Reports",
     "ResourceNames",
     "ResourceType",
@@ -195,4 +205,5 @@ __all__ = (
     "Users",
     "Version",
     "Vulnerabilities",
+    "WebApplicationTargets",
 )

{python_gvm-27.1.0 → python_gvm-27.3.0}/gvm/protocols/gmp/requests/next/_agent_groups.py

@@ -16,6 +16,7 @@ class AgentGroups:
         cls,
         name: str,
         agent_ids: list[str],
+        scheduler_cron_time: str,
         *,
         comment: str | None = None,
     ) -> Request:
@@ -24,6 +25,7 @@ class AgentGroups:
         Args:
             name: Name of the new agent group.
             agent_ids: List of agent UUIDs to include in the group (required).
+            scheduler_cron_time: Cron-like time to schedule new agent groups (required).
             comment: Optional comment for the group.
 
         Raises:
@@ -38,9 +40,15 @@ class AgentGroups:
             raise RequiredArgument(
                 function=cls.create_agent_group.__name__, argument="agent_ids"
             )
+        if not scheduler_cron_time:
+            raise RequiredArgument(
+                function=cls.create_agent_group.__name__,
+                argument="scheduler_cron_time",
+            )
 
         cmd = XmlCommand("create_agent_group")
         cmd.add_element("name", name)
+        cmd.add_element("scheduler_cron_time", scheduler_cron_time)
 
         if comment:
             cmd.add_element("comment", comment)
@@ -76,6 +84,7 @@ class AgentGroups:
     def modify_agent_group(
         cls,
         agent_group_id: EntityID,
+        scheduler_cron_time: str,
         *,
         name: str | None = None,
         comment: str | None = None,
@@ -85,6 +94,7 @@ class AgentGroups:
 
         Args:
             agent_group_id: UUID of the group to modify.
+            scheduler_cron_time: Cron-like time to schedule the agent groups.
             name: Optional new name for the group.
             comment: Optional comment for the group.
             agent_ids: Optional list of agent UUIDs to set for the group.
@@ -98,9 +108,15 @@ class AgentGroups:
                 argument="agent_group_id",
             )
 
+        if not scheduler_cron_time:
+            raise RequiredArgument(
+                function=cls.modify_agent_group.__name__,
+                argument="scheduler_cron_time",
+            )
+
         cmd = XmlCommand("modify_agent_group")
         cmd.set_attribute("agent_group_id", str(agent_group_id))
-
+        cmd.add_element("scheduler_cron_time", scheduler_cron_time)
         if name:
             cmd.add_element("name", name)