python-gvm 26.5.0__tar.gz → 26.6.0__tar.gz

{python_gvm-26.5.0 → python_gvm-26.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-gvm
-Version: 26.5.0
+Version: 26.6.0
 Summary: Library to communicate with remote servers over GMP or OSP
 License: GPL-3.0-or-later
 Author: Greenbone AG

{python_gvm-26.5.0 → python_gvm-26.6.0}/gvm/__version__.py

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

{python_gvm-26.5.0 → python_gvm-26.6.0}/gvm/protocols/gmp/_gmpnext.py

@@ -454,6 +454,49 @@ class GMPNext(GMPv227[T]):
             )
         )
 
+    def create_container_image_task(
+        self,
+        name: str,
+        oci_image_target_id: EntityID,
+        scanner_id: EntityID,
+        *,
+        comment: Optional[str] = None,
+        alterable: Optional[bool] = None,
+        schedule_id: Optional[EntityID] = None,
+        alert_ids: Optional[Sequence[EntityID]] = None,
+        schedule_periods: Optional[int] = None,
+        observers: Optional[Sequence[str]] = None,
+        preferences: Optional[Mapping[str, SupportsStr]] = None,
+    ) -> T:
+        """Create a new scan task using an OCI image target.
+
+        Args:
+            name: Name of the new task.
+            oci_image_target_id: UUID of the OCI image 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_container_image_task(
+                name=name,
+                oci_image_target_id=oci_image_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_container_task(
         self, name: str, *, comment: Optional[str] = None
     ) -> T:
@@ -586,6 +629,7 @@ class GMPNext(GMPv227[T]):
         target_id: Optional[EntityID] = None,
         scanner_id: Optional[EntityID] = None,
         agent_group_id: Optional[EntityID] = None,
+        oci_image_target_id: Optional[EntityID] = None,
         alterable: Optional[bool] = None,
         hosts_ordering: Optional[HostsOrdering] = None,
         schedule_id: Optional[EntityID] = None,
@@ -604,6 +648,7 @@ class GMPNext(GMPv227[T]):
             target_id: UUID of target to be scanned
             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.
             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
@@ -622,6 +667,7 @@ class GMPNext(GMPv227[T]):
                 target_id=target_id,
                 scanner_id=scanner_id,
                 agent_group_id=agent_group_id,
+                oci_image_target_id=oci_image_target_id,
                 alterable=alterable,
                 hosts_ordering=hosts_ordering,
                 schedule_id=schedule_id,

{python_gvm-26.5.0 → python_gvm-26.6.0}/gvm/protocols/gmp/requests/next/_tasks.py

@@ -119,6 +119,96 @@ class Tasks:
 
         return cmd
 
+    @classmethod
+    def create_container_image_task(
+        cls,
+        name: str,
+        oci_image_target_id: EntityID,
+        scanner_id: EntityID,
+        *,
+        comment: Optional[str] = None,
+        alterable: Optional[bool] = None,
+        schedule_id: Optional[EntityID] = None,
+        alert_ids: Optional[Sequence[EntityID]] = None,
+        schedule_periods: Optional[int] = None,
+        observers: Optional[Sequence[str]] = None,
+        preferences: Optional[Mapping[str, SupportsStr]] = None,
+    ) -> Request:
+        """Create a new scan task using an OCI image target.
+
+        Args:
+            name: Name of the new task.
+            oci_image_target_id: UUID of the OCI Image 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.
+        """
+        if not name:
+            raise RequiredArgument(
+                function=cls.create_container_image_task.__name__,
+                argument="name",
+            )
+
+        if not oci_image_target_id:
+            raise RequiredArgument(
+                function=cls.create_container_image_task.__name__,
+                argument="oci_image_target_id",
+            )
+
+        if not scanner_id:
+            raise RequiredArgument(
+                function=cls.create_container_image_task.__name__,
+                argument="scanner_id",
+            )
+
+        cmd = XmlCommand("create_task")
+        cmd.add_element("name", name)
+        cmd.add_element("usage_type", "scan")
+        cmd.add_element(
+            "oci_image_target", attrs={"id": str(oci_image_target_id)}
+        )
+        cmd.add_element("scanner", attrs={"id": str(scanner_id)})
+
+        if comment:
+            cmd.add_element("comment", comment)
+
+        if alterable is not None:
+            cmd.add_element("alterable", to_bool(alterable))
+
+        if alert_ids:
+            for alert in alert_ids:
+                cmd.add_element("alert", attrs={"id": str(alert)})
+
+        if schedule_id:
+            cmd.add_element("schedule", attrs={"id": str(schedule_id)})
+
+            if schedule_periods is not None:
+                if (
+                    not isinstance(schedule_periods, Integral)
+                    or schedule_periods < 0
+                ):
+                    raise InvalidArgument(
+                        "schedule_periods must be an integer greater or equal than 0"
+                    )
+                cmd.add_element("schedule_periods", str(schedule_periods))
+
+        if observers:
+            cmd.add_element("observers", to_comma_list(observers))
+
+        if preferences is not None:
+            xml_prefs = cmd.add_element("preferences")
+            for pref_name, pref_value in preferences.items():
+                xml_pref = xml_prefs.add_element("preference")
+                xml_pref.add_element("scanner_name", pref_name)
+                xml_pref.add_element("value", str(pref_value))
+
+        return cmd
+
     @classmethod
     def create_container_task(
         cls, name: str, *, comment: Optional[str] = None
@@ -350,6 +440,7 @@ class Tasks:
         target_id: Optional[EntityID] = None,
         scanner_id: Optional[EntityID] = None,
         agent_group_id: Optional[EntityID] = None,
+        oci_image_target_id: Optional[EntityID] = None,
         alterable: Optional[bool] = None,
         hosts_ordering: Optional[HostsOrdering] = None,
         schedule_id: Optional[EntityID] = None,
@@ -368,6 +459,7 @@ class Tasks:
             target_id: UUID of target to be scanned
             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.
             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
@@ -383,11 +475,17 @@ class Tasks:
                 function=cls.modify_task.__name__, argument="task_id"
             )
 
-        if target_id and agent_group_id:
+        if (
+            sum(
+                id is not None
+                for id in (target_id, agent_group_id, oci_image_target_id)
+            )
+            > 1
+        ):
             raise InvalidArgument(
                 function=cls.modify_task.__name__,
-                argument="target_id/agent_group_id",
-                message="Only one of target_id or agent_group_id can be modified at a time",
+                argument="target_id/agent_group_id/oci_image_target_id",
+                message="Only one of target_id, agent_group_id or oci_image_target_id can be modified at a time",
             )
 
         cmd = XmlCommand("modify_task")
@@ -408,6 +506,11 @@ class Tasks:
         if agent_group_id:
             cmd.add_element("agent_group", attrs={"id": str(agent_group_id)})
 
+        if oci_image_target_id:
+            cmd.add_element(
+                "oci_image_target", attrs={"id": str(oci_image_target_id)}
+            )
+
         if alterable is not None:
             cmd.add_element("alterable", to_bool(alterable))
 

{python_gvm-26.5.0 → python_gvm-26.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "python-gvm"
-version = "26.5.0"
+version = "26.6.0"
 description = "Library to communicate with remote servers over GMP or OSP"
 license = "GPL-3.0-or-later"
 authors = ["Greenbone AG <info@greenbone.net>"]

{python_gvm-26.5.0 → python_gvm-26.6.0}/tests/protocols/gmpnext/entities/tasks/__init__.py

@@ -5,6 +5,9 @@
 
 from .test_clone_task import GmpCloneTaskTestMixin
 from .test_create_agent_group_task import GmpCreateAgentGroupTaskTestMixin
+from .test_create_container_image_task import (
+    GmpCreateContainerImageTaskTestMixin,
+)
 from .test_create_container_task import GmpCreateContainerTaskTestMixin
 from .test_create_task import GmpCreateTaskTestMixin
 from .test_delete_task import GmpDeleteTaskTestMixin
@@ -19,6 +22,7 @@ from .test_stop_task import GmpStopTaskTestMixin
 __all__ = (
     "GmpCloneTaskTestMixin",
     "GmpCreateAgentGroupTaskTestMixin",
+    "GmpCreateContainerImageTaskTestMixin",
     "GmpCreateContainerTaskTestMixin",
     "GmpCreateTaskTestMixin",
     "GmpDeleteTaskTestMixin",

python_gvm-26.6.0/tests/protocols/gmpnext/entities/tasks/test_create_container_image_task.py

@@ -0,0 +1,219 @@
+# SPDX-FileCopyrightText: 2018-2025 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+from collections import OrderedDict
+
+from gvm.errors import InvalidArgument, RequiredArgument
+
+
+class GmpCreateContainerImageTaskTestMixin:
+    def test_create_container_image_task(self):
+        self.gmp.create_container_image_task(
+            name="foo", oci_image_target_id="it1", scanner_id="s1"
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_missing_name(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name=None, oci_image_target_id="it1", scanner_id="s1"
+            )
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name="", oci_image_target_id="it1", scanner_id="s1"
+            )
+
+    def test_create_container_image_task_missing_oci_image_target_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name="foo", oci_image_target_id=None, scanner_id="s1"
+            )
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name="foo", oci_image_target_id="", scanner_id="s1"
+            )
+
+    def test_create_container_image_task_missing_scanner_id(self):
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name="foo", oci_image_target_id="it1", scanner_id=None
+            )
+        with self.assertRaises(RequiredArgument):
+            self.gmp.create_container_image_task(
+                name="foo", oci_image_target_id="it1", scanner_id=""
+            )
+
+    def test_create_container_image_task_with_comment(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            comment="my comment",
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"<comment>my comment</comment>"
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_with_alerts(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            alert_ids=["a1", "a2"],
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b'<alert id="a1"/>'
+            b'<alert id="a2"/>'
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_with_empty_alerts(self):
+        self.gmp.create_container_image_task(
+            name="foo", oci_image_target_id="it1", scanner_id="s1", alert_ids=[]
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_with_schedule(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            schedule_id="s1",
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b'<schedule id="s1"/>'
+            b"</create_task>"
+        )
+
+    def test_create_create_container_image_task_with_schedule_periods(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            schedule_id="s1",
+            schedule_periods=5,
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b'<schedule id="s1"/>'
+            b"<schedule_periods>5</schedule_periods>"
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_with_invalid_schedule_periods(self):
+        with self.assertRaises(InvalidArgument):
+            self.gmp.create_container_image_task(
+                name="foo",
+                oci_image_target_id="it1",
+                scanner_id="s1",
+                schedule_id="s1",
+                schedule_periods="invalid",
+            )
+
+        with self.assertRaises(InvalidArgument):
+            self.gmp.create_container_image_task(
+                name="foo",
+                oci_image_target_id="it1",
+                scanner_id="s1",
+                schedule_id="s1",
+                schedule_periods=-1,
+            )
+
+    def test_create_container_image_task_with_alterable(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            alterable=True,
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"<alterable>1</alterable>"
+            b"</create_task>"
+        )
+
+    def test_create__container_image_task_with_observers(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            observers=["u1", "u2"],
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"<observers>u1,u2</observers>"
+            b"</create_task>"
+        )
+
+    def test_create_container_image_task_with_preferences(self):
+        self.gmp.create_container_image_task(
+            name="foo",
+            oci_image_target_id="it1",
+            scanner_id="s1",
+            preferences=OrderedDict([("pref1", "val1"), ("pref2", "val2")]),
+        )
+
+        self.connection.send.has_been_called_with(
+            b"<create_task>"
+            b"<name>foo</name>"
+            b"<usage_type>scan</usage_type>"
+            b'<oci_image_target id="it1"/>'
+            b'<scanner id="s1"/>'
+            b"<preferences>"
+            b"<preference><scanner_name>pref1</scanner_name><value>val1</value></preference>"
+            b"<preference><scanner_name>pref2</scanner_name><value>val2</value></preference>"
+            b"</preferences>"
+            b"</create_task>"
+        )

{python_gvm-26.5.0 → python_gvm-26.6.0}/tests/protocols/gmpnext/entities/tasks/test_modify_task.py

@@ -62,12 +62,31 @@ class GmpModifyTaskTestMixin:
             b'<modify_task task_id="t1"><agent_group id="ag1"/></modify_task>'
         )
 
+    def test_modify_task_with_oci_image_target_id(self):
+        self.gmp.modify_task(task_id="t1", oci_image_target_id="it1")
+
+        self.connection.send.has_been_called_with(
+            b'<modify_task task_id="t1"><oci_image_target id="it1"/></modify_task>'
+        )
+
     def test_modify_task_with_target_and_agent_group(self):
         with self.assertRaises(InvalidArgument):
             self.gmp.modify_task(
                 task_id="t1", target_id="t1", agent_group_id="ag1"
             )
 
+    def test_modify_task_with_target_and_oci_image_target(self):
+        with self.assertRaises(InvalidArgument):
+            self.gmp.modify_task(
+                task_id="t1", target_id="t1", oci_image_target_id="it1"
+            )
+
+    def test_modify_task_with_agent_group_and_oci_image_target(self):
+        with self.assertRaises(InvalidArgument):
+            self.gmp.modify_task(
+                task_id="t1", agent_group_id="ag1", oci_image_target_id="it1"
+            )
+
     def test_modify_task_with_schedule_id(self):
         self.gmp.modify_task(task_id="t1", schedule_id="s1")
 

{python_gvm-26.5.0 → python_gvm-26.6.0}/tests/protocols/gmpnext/entities/test_tasks.py

@@ -7,6 +7,7 @@ from ...gmpnext import GMPTestCase
 from ...gmpnext.entities.tasks import (
     GmpCloneTaskTestMixin,
     GmpCreateAgentGroupTaskTestMixin,
+    GmpCreateContainerImageTaskTestMixin,
     GmpCreateContainerTaskTestMixin,
     GmpCreateTaskTestMixin,
     GmpDeleteTaskTestMixin,
@@ -30,6 +31,12 @@ class GmpCreateAgentGroupTaskTestCase(
     pass
 
 
+class GMPCreateContainerImageTaskTestCase(
+    GmpCreateContainerImageTaskTestMixin, GMPTestCase
+):
+    pass
+
+
 class GMPCreateContainerTaskTestCase(
     GmpCreateContainerTaskTestMixin, GMPTestCase
 ):