python-gvm 26.7.1__tar.gz → 26.9.0__tar.gz

{python_gvm-26.7.1 → python_gvm-26.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gvm
-Version: 26.7.1
+Version: 26.9.0
 Summary: Library to communicate with remote servers over GMP or OSP
 License: GPL-3.0-or-later
 License-File: LICENSE

{python_gvm-26.7.1 → python_gvm-26.9.0}/gvm/__version__.py

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

{python_gvm-26.7.1 → python_gvm-26.9.0}/gvm/protocols/gmp/_gmpnext.py

@@ -2,7 +2,7 @@
 #
 #  SPDX-License-Identifier: GPL-3.0-or-later
 
-from typing import Any, Mapping, Optional, Sequence
+from typing import Any, Mapping, Optional, Sequence, Union
 
 from gvm.protocols.gmp.requests import EntityID
 
@@ -13,6 +13,9 @@ from .requests.next import (
     AgentGroups,
     AgentInstallers,
     Agents,
+    Credentials,
+    CredentialStoreCredentialType,
+    CredentialStores,
     OCIImageTargets,
     Tasks,
 )
@@ -297,6 +300,174 @@ class GMPNext(GMPv227[T]):
             AgentGroups.clone_agent_group(agent_group_id)
         )
 
+    def create_credential_store_credential(
+        self,
+        name: str,
+        credential_type: Union[CredentialStoreCredentialType, str],
+        *,
+        comment: Optional[str] = None,
+        credential_store_id: Optional[EntityID] = None,
+        vault_id: Optional[str] = None,
+        host_identifier: Optional[str] = None,
+    ) -> T:
+        """Create a new credential store type credential
+
+        Args:
+            name: Name of the credential
+            credential_type: Type of the credential
+            comment: Optional comment for the credential object
+            credential_store_id: Optional credential store id to fetch the credential from
+            vault_id: Vault id used to fetch the credential from credential store
+            host_identifier: Host identifier used to fetch the credential from credential store
+        """
+        return self._send_request_and_transform_response(
+            Credentials.create_credential_store_credential(
+                name=name,
+                credential_type=credential_type,
+                comment=comment,
+                credential_store_id=credential_store_id,
+                vault_id=vault_id,
+                host_identifier=host_identifier,
+            )
+        )
+
+    def modify_credential_store_credential(
+        self,
+        credential_id: EntityID,
+        *,
+        name: Optional[str] = None,
+        comment: Optional[str] = None,
+        credential_store_id: Optional[EntityID] = None,
+        vault_id: Optional[str] = None,
+        host_identifier: Optional[str] = None,
+    ) -> T:
+        """Modify an existing credential stored in a credential store
+
+        Args:
+            credential_id: UUID of the credential to modify
+            name: Name of the credential
+            comment: Optional comment for the credential object
+            credential_store_id: Optional credential store id to fetch the credential from
+            vault_id: Vault id used to fetch the credential from credential store
+            host_identifier: Host identifier used to fetch the credential from credential store
+        """
+        return self._send_request_and_transform_response(
+            Credentials.modify_credential_store_credential(
+                credential_id=credential_id,
+                name=name,
+                comment=comment,
+                credential_store_id=credential_store_id,
+                vault_id=vault_id,
+                host_identifier=host_identifier,
+            )
+        )
+
+    def get_credential_store(
+        self,
+        credential_store_id: EntityID,
+        *,
+        details: Optional[bool] = None,
+    ) -> T:
+        """Request a credential store
+
+        Args:
+            credential_store_id: ID of credential store to fetch
+            details: True to request all details
+        """
+        return self._send_request_and_transform_response(
+            CredentialStores.get_credential_store(
+                credential_store_id=credential_store_id,
+                details=details,
+            )
+        )
+
+    def get_credential_stores(
+        self,
+        *,
+        filter_string: Optional[str] = None,
+        filter_id: Optional[EntityID] = None,
+        details: Optional[bool] = None,
+    ) -> T:
+        """Request a list of credential stores
+
+        Args:
+            filter_string: Filter term to use for the query
+            filter_id: UUID of an existing filter to use for the query
+            details: True to request all details
+        """
+        return self._send_request_and_transform_response(
+            CredentialStores.get_credential_stores(
+                filter_string=filter_string,
+                filter_id=filter_id,
+                details=details,
+            )
+        )
+
+    def modify_credential_store(
+        self,
+        credential_store_id: EntityID,
+        *,
+        active: Optional[bool] = None,
+        host: Optional[str] = None,
+        port: Optional[int] = None,
+        path: Optional[str] = None,
+        app_id: Optional[str] = None,
+        client_cert: Optional[str] = None,
+        client_key: Optional[str] = None,
+        client_pkcs12_file: Optional[str] = None,
+        passphrase: Optional[str] = None,
+        server_ca_cert: Optional[str] = None,
+        comment: Optional[str] = None,
+    ) -> T:
+        """Modify an existing credential store
+
+        Args:
+            credential_store_id: ID of credential store to fetch
+            active: Whether the credential store is active
+            host: The host to use for reaching the credential store
+            port: The port to use for reaching the credential store
+            path: The URI path the credential store is using
+            app_id: Depends on the credential store used. Usually called the same in the credential store
+            client_cert: The client certificate to use for authorization, as a plain string
+            client_key: The client key to use for authorization, as a plain string
+            client_pkcs12_file: The pkcs12 file contents to use for authorization, as a plain string
+                (alternative to using client_cert and client_key)
+            passphrase: The passphrase to use to decrypt client_pkcs12_file or client_key file
+            server_ca_cert: The server certificate, so the credential store can be trusted
+            comment: An optional comment to store alongside the credential store
+        """
+        return self._send_request_and_transform_response(
+            CredentialStores.modify_credential_store(
+                credential_store_id=credential_store_id,
+                active=active,
+                host=host,
+                port=port,
+                path=path,
+                app_id=app_id,
+                client_cert=client_cert,
+                client_key=client_key,
+                client_pkcs12_file=client_pkcs12_file,
+                passphrase=passphrase,
+                server_ca_cert=server_ca_cert,
+                comment=comment,
+            )
+        )
+
+    def verify_credential_store(
+        self,
+        credential_store_id: EntityID,
+    ) -> T:
+        """Verify that the connection to an existing credential store works
+
+        Args:
+            credential_store_id: The uuid of the credential store to verify
+        """
+        return self._send_request_and_transform_response(
+            CredentialStores.verify_credential_store(
+                credential_store_id=credential_store_id,
+            )
+        )
+
     def create_oci_image_target(
         self,
         name: str,
@@ -511,18 +682,29 @@ class GMPNext(GMPv227[T]):
             )
         )
 
-    def create_container_task(
+    def create_import_task(
         self, name: str, *, comment: Optional[str] = None
     ) -> T:
-        """Create a new container task
+        """Create a new import task
 
-        A container task is a "meta" task to import and view reports from other
+        An import task is a "meta" task to import and view reports from other
         systems.
 
         Args:
             name: Name of the task
             comment: Comment for the task
         """
+        return self._send_request_and_transform_response(
+            Tasks.create_import_task(name=name, comment=comment)
+        )
+
+    def create_container_task(
+        self, name: str, *, comment: Optional[str] = None
+    ) -> T:
+        """[DEPRECATED] Use create_import_task instead.
+
+        This method will be removed in a future version.
+        """
         return self._send_request_and_transform_response(
             Tasks.create_container_task(name=name, comment=comment)
         )

{python_gvm-26.7.1 → python_gvm-26.9.0}/gvm/protocols/gmp/requests/next/__init__.py

@@ -5,6 +5,11 @@
 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._agents import Agents
+from gvm.protocols.gmp.requests.next._credential_stores import CredentialStores
+from gvm.protocols.gmp.requests.next._credentials import (
+    Credentials,
+    CredentialStoreCredentialType,
+)
 from gvm.protocols.gmp.requests.next._oci_image_targets import OCIImageTargets
 from gvm.protocols.gmp.requests.next._tasks import Tasks
 
@@ -24,7 +29,6 @@ from ..v227 import (
     CertBundAdvisories,
     Cpes,
     CredentialFormat,
-    Credentials,
     CredentialType,
     Cves,
     DfnCertAdvisories,
@@ -98,6 +102,8 @@ __all__ = (
     "Credentials",
     "CredentialFormat",
     "CredentialType",
+    "CredentialStoreCredentialType",
+    "CredentialStores",
     "Cves",
     "DfnCertAdvisories",
     "EntityID",

python_gvm-26.9.0/gvm/protocols/gmp/requests/next/_credential_stores.py

@@ -0,0 +1,171 @@
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from base64 import b64encode
+from typing import Optional
+
+from gvm.errors import RequiredArgument
+from gvm.protocols.core import Request
+from gvm.utils import to_bool
+from gvm.xml import XmlCommand
+
+from .._entity_id import EntityID
+
+
+class CredentialStores:
+    @classmethod
+    def get_credential_store(
+        cls,
+        credential_store_id: EntityID,
+        *,
+        details: Optional[bool] = None,
+    ) -> Request:
+        """Request a credential store
+
+        Args:
+            credential_store_id: ID of credential store to fetch
+            details: True to request all details
+        """
+
+        if not credential_store_id:
+            raise RequiredArgument(
+                function=cls.get_credential_store.__name__,
+                argument="credential_store_id",
+            )
+
+        cmd = XmlCommand("get_credential_stores")
+        cmd.add_element("credential_store_id", str(credential_store_id))
+
+        if details is not None:
+            cmd.set_attribute("details", to_bool(details))
+
+        return cmd
+
+    @classmethod
+    def get_credential_stores(
+        cls,
+        *,
+        filter_string: Optional[str] = None,
+        filter_id: Optional[EntityID] = None,
+        details: Optional[bool] = None,
+    ) -> Request:
+        """Request a list of credential stores
+
+        Args:
+            filter_string: Filter term to use for the query
+            filter_id: UUID of an existing filter to use for the query
+            details: True to request all details
+        """
+
+        cmd = XmlCommand("get_credential_stores")
+        cmd.add_filter(filter_string, filter_id)
+
+        if details is not None:
+            cmd.set_attribute("details", to_bool(details))
+
+        return cmd
+
+    @classmethod
+    def modify_credential_store(
+        cls,
+        credential_store_id: EntityID,
+        *,
+        active: Optional[bool] = None,
+        host: Optional[str] = None,
+        port: Optional[int] = None,
+        path: Optional[str] = None,
+        app_id: Optional[str] = None,
+        client_cert: Optional[str] = None,
+        client_key: Optional[str] = None,
+        client_pkcs12_file: Optional[str] = None,
+        passphrase: Optional[str] = None,
+        server_ca_cert: Optional[str] = None,
+        comment: Optional[str] = None,
+    ) -> Request:
+        """Modify a credential store
+
+        Args:
+            credential_store_id: ID of credential store to fetch
+            active: Whether the credential store is active
+            host: The host to use for reaching the credential store
+            port: The port to use for reaching the credential store
+            path: The URI path the credential store is using
+            app_id: Depends on the credential store used. Usually called the same in the credential store
+            client_cert: The client certificate to use for authorization, as a plain string
+            client_key: The client key to use for authorization, as a plain string
+            client_pkcs12_file: The pkcs12 file contents to use for authorization, as a plain string
+                (alternative to using client_cert and client_key)
+            passphrase: The passphrase to use to decrypt client_pkcs12_file or client_key file
+            server_ca_cert: The server certificate, so the credential store can be trusted
+            comment: An optional comment to store alongside the credential store
+        """
+
+        if not credential_store_id:
+            raise RequiredArgument(
+                function=cls.verify_credential_store.__name__,
+                argument="credential_store_id",
+            )
+
+        cmd = XmlCommand("modify_credential_store")
+        cmd.set_attribute("credential_store_id", str(credential_store_id))
+
+        if active is not None:
+            cmd.add_element("active", to_bool(active))
+        if host:
+            cmd.add_element("host", host)
+        if port:
+            cmd.add_element("port", str(port))
+        if path:
+            cmd.add_element("path", path)
+        if comment:
+            cmd.add_element("comment", comment)
+
+        preferences = cmd.add_element("preferences")
+
+        if app_id:
+            preferences.add_element("app_id", app_id)
+        if client_cert:
+            preferences.add_element(
+                "client_cert",
+                b64encode(client_cert.encode("ascii")).decode("ascii"),
+            )
+        if client_key:
+            preferences.add_element(
+                "client_key",
+                b64encode(client_key.encode("ascii")).decode("ascii"),
+            )
+        if client_pkcs12_file:
+            preferences.add_element(
+                "client_pkcs12_file",
+                b64encode(client_pkcs12_file.encode("ascii")).decode("ascii"),
+            )
+        if passphrase:
+            preferences.add_element("passphrase", passphrase)
+        if server_ca_cert:
+            preferences.add_element(
+                "server_ca_cert",
+                b64encode(server_ca_cert.encode("ascii")).decode("ascii"),
+            )
+
+        return cmd
+
+    @classmethod
+    def verify_credential_store(
+        cls,
+        credential_store_id: EntityID,
+    ) -> Request:
+        """Verify that the connection to a credential store works
+
+        Args:
+            credential_store_id: The uuid of the credential store to verify
+        """
+        if not credential_store_id:
+            raise RequiredArgument(
+                function=cls.verify_credential_store.__name__,
+                argument="credential_store_id",
+            )
+
+        cmd = XmlCommand("verify_credential_store")
+        cmd.set_attribute("credential_store_id", str(credential_store_id))
+        return cmd

python_gvm-26.9.0/gvm/protocols/gmp/requests/next/_credentials.py

@@ -0,0 +1,179 @@
+# SPDX-FileCopyrightText: 2025 Greenbone AG
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from typing import Optional, Union
+
+from gvm._enum import Enum
+from gvm.errors import InvalidArgument, RequiredArgument
+from gvm.protocols.core import Request
+from gvm.xml import XmlCommand
+
+from .._entity_id import EntityID
+from ..v224._credentials import (
+    Credentials as CredentialsV224,
+)
+
+
+class CredentialStoreCredentialType(Enum):
+    """Enum for credential store credential types"""
+
+    CLIENT_CERTIFICATE = "cs_cc"
+    SNMP = "cs_snmp"
+    USERNAME_PASSWORD = "cs_up"
+    USERNAME_SSH_KEY = "cs_usk"
+    SMIME_CERTIFICATE = "cs_smime"
+    PGP_ENCRYPTION_KEY = "cs_pgp"
+    PASSWORD_ONLY = "cs_pw"
+
+
+class Credentials(CredentialsV224):
+    @classmethod
+    def create_credential_store_credential(
+        cls,
+        name: str,
+        credential_type: Union[CredentialStoreCredentialType, str],
+        *,
+        comment: Optional[str] = None,
+        credential_store_id: Optional[EntityID] = None,
+        vault_id: Optional[str] = None,
+        host_identifier: Optional[str] = None,
+    ) -> Request:
+        """Create a new credential that is fetched from a credential store
+
+        Create a new credential e.g. to be used in the method of an alert.
+
+        Currently the following credential types are supported:
+
+            - Username + Password
+            - Username + SSH-Key
+            - Client Certificates
+            - SNMPv1 or SNMPv2c protocol
+            - S/MIME Certificate
+            - OpenPGP Key
+            - Password only
+
+        Arguments:
+            name: Name of the new credential
+            credential_type: The credential type.
+            comment: Comment for the credential
+            credential_store_id: Optional id of the credential store to use
+                (gvmd will pick default one if none is provided)
+            vault_id: Vault-ID used to access the secret in credential store
+            host_identifier: Host-Identifier used to access the secret in credential store
+
+        Examples:
+            Creating a Password-Only credential stored in a Credential Store
+
+            .. code-block:: python
+
+                request = Credentials.create_credential(
+                    name='Credential-Store Password-Only Credential',
+                    credential_type=CredentialType.CREDENTIAL_STOREPASSWORD_ONLY,
+                    vault_id='a5f84dd4-da18-447c-a9fb-b77b5df49076',
+                    host_identifier='/My/Secret',
+                )
+        """
+        if not name:
+            raise RequiredArgument(
+                function=cls.create_credential.__name__, argument="name"
+            )
+
+        if not credential_type:
+            raise RequiredArgument(
+                function=cls.create_credential.__name__,
+                argument="credential_type",
+            )
+
+        if not isinstance(credential_type, CredentialStoreCredentialType):
+            credential_type = CredentialStoreCredentialType(credential_type)
+
+        cmd = XmlCommand("create_credential")
+        cmd.add_element("name", name)
+
+        cmd.add_element("type", credential_type.value)
+
+        if comment:
+            cmd.add_element("comment", comment)
+
+        if (
+            credential_type != CredentialStoreCredentialType.CLIENT_CERTIFICATE
+            and credential_type != CredentialStoreCredentialType.SNMP
+            and credential_type
+            != CredentialStoreCredentialType.USERNAME_PASSWORD
+            and credential_type
+            != CredentialStoreCredentialType.USERNAME_SSH_KEY
+            and credential_type
+            != CredentialStoreCredentialType.SMIME_CERTIFICATE
+            and credential_type
+            != CredentialStoreCredentialType.PGP_ENCRYPTION_KEY
+            and credential_type != CredentialStoreCredentialType.PASSWORD_ONLY
+        ):
+            raise InvalidArgument(
+                function=cls.create_credential.__name__,
+                argument="credential_type",
+            )
+
+        if not vault_id:
+            raise RequiredArgument(
+                function=cls.create_credential.__name__,
+                argument="vault_id",
+            )
+        if not host_identifier:
+            raise RequiredArgument(
+                function=cls.create_credential.__name__,
+                argument="host_identifier",
+            )
+
+        if credential_store_id:
+            cmd.add_element("credential_store_id", str(credential_store_id))
+
+        cmd.add_element("vault_id", vault_id)
+        cmd.add_element("host_identifier", host_identifier)
+
+        return cmd
+
+    @classmethod
+    def modify_credential_store_credential(
+        cls,
+        credential_id: EntityID,
+        *,
+        name: Optional[str] = None,
+        comment: Optional[str] = None,
+        credential_store_id: Optional[EntityID] = None,
+        vault_id: Optional[str] = None,
+        host_identifier: Optional[str] = None,
+    ) -> Request:
+        """Modifies an existing credential.
+
+        Arguments:
+            credential_id: UUID of the credential
+            name: Name of the credential
+            comment: Comment for the credential
+            credential_store_id: Optional id of the credential store to use
+                (gvmd will pick default one if none is provided)
+            vault_id: Vault-ID used to access the secret in credential store
+            host_identifier: Host-Identifier used to access the secret in credential store
+        """
+        if not credential_id:
+            raise RequiredArgument(
+                function=cls.modify_credential.__name__,
+                argument="credential_id",
+            )
+
+        cmd = XmlCommand("modify_credential")
+        cmd.set_attribute("credential_id", str(credential_id))
+
+        if name:
+            cmd.add_element("name", name)
+        if comment:
+            cmd.add_element("comment", comment)
+
+        if credential_store_id:
+            cmd.add_element("credential_store_id", str(credential_store_id))
+        if vault_id:
+            cmd.add_element("vault_id", vault_id)
+        if host_identifier:
+            cmd.add_element("host_identifier", host_identifier)
+
+        return cmd

{python_gvm-26.7.1 → python_gvm-26.9.0}/gvm/protocols/gmp/requests/next/_tasks.py

@@ -7,7 +7,7 @@ from typing import Mapping, Optional, Sequence
 
 from gvm.errors import InvalidArgument, RequiredArgument
 from gvm.protocols.core import Request
-from gvm.utils import SupportsStr, to_bool, to_comma_list
+from gvm.utils import SupportsStr, deprecated, to_bool, to_comma_list
 from gvm.xml import XmlCommand
 
 from .._entity_id import EntityID
@@ -210,12 +210,12 @@ class Tasks:
         return cmd
 
     @classmethod
-    def create_container_task(
+    def create_import_task(
         cls, name: str, *, comment: Optional[str] = None
     ) -> Request:
-        """Create a new container task
+        """Create a new import task
 
-        A container task is a "meta" task to import and view reports from other
+        An import task is a "meta" task to import and view reports from other
         systems.
 
         Args:
@@ -224,7 +224,7 @@ class Tasks:
         """
         if not name:
             raise RequiredArgument(
-                function=cls.create_container_task.__name__, argument="name"
+                function=cls.create_import_task.__name__, argument="name"
             )
 
         cmd = XmlCommand("create_task")
@@ -236,6 +236,19 @@ class Tasks:
 
         return cmd
 
+    @classmethod
+    @deprecated(
+        "The function is obsolete. Please use create_import_task instead."
+    )
+    def create_container_task(
+        cls, name: str, *, comment: Optional[str] = None
+    ) -> "Request":
+        """[DEPRECATED] Use create_import_task instead.
+
+        This method will be removed in a future version.
+        """
+        return cls.create_import_task(name=name, comment=comment)
+
     @classmethod
     def create_task(
         cls,

{python_gvm-26.7.1 → python_gvm-26.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "python-gvm"
-version = "26.7.1"
+version = "26.9.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.9.0/tests/protocols/gmpnext/entities/credential_stores/__init__.py

@@ -0,0 +1,13 @@
+#  SPDX-FileCopyrightText: 2025 Greenbone AG
+#
+#  SPDX-License-Identifier: GPL-3.0-or-later
+
+from .test_get_credential_stores import GmpGetCredentialStoresTestMixin
+from .test_modify_credential_stores import GmpModifyCredentialStoreTestMixin
+from .test_verify_credential_stores import GmpVerifyCredentialStoreTestMixin
+
+__all__ = (
+    "GmpGetCredentialStoresTestMixin",
+    "GmpModifyCredentialStoreTestMixin",
+    "GmpVerifyCredentialStoreTestMixin",
+)