Add: New openvasd scanner type and relay fields

The latest GMP protocol version now supports the openvasd scanner type
and the new scanner fields relay_host and relay_port.

Author: timopollmeier

gvm/protocols/gmp/_gmp226.py

@@ -21,6 +21,8 @@
     Reports,
     ResourceNames,
     ResourceType,
+    Scanners,
+    ScannerType,
 )
 
 
@@ -446,3 +448,156 @@ def modify_report_config(
                 report_config_id, name=name, comment=comment, params=params
             )
         )
+
+    def create_scanner(
+        self,
+        name: str,
+        host: str,
+        port: Union[str, int],
+        scanner_type: ScannerType,
+        credential_id: str,
+        *,
+        ca_pub: Optional[str] = None,
+        comment: Optional[str] = None,
+        relay_host: Optional[str] = None,
+        relay_port: Optional[Union[str, int]] = None,
+    ) -> T:
+        """Create a new scanner
+
+        Args:
+            name: Name of the new scanner
+            host: Hostname or IP address of the scanner
+            port: Port of the scanner
+            scanner_type: Type of the scanner
+            credential_id: UUID of client certificate credential for the
+                scanner
+            ca_pub: Certificate of CA to verify scanner certificate
+            comment: Comment for the scanner
+            relay_host: Hostname or IP address of the scanner relay
+            relay_port: Port of the scanner relay
+        """
+        return self._send_request_and_transform_response(
+            Scanners.create_scanner(
+                name,
+                host,
+                port,
+                scanner_type,
+                credential_id,
+                ca_pub=ca_pub,
+                comment=comment,
+                relay_host=relay_host,
+                relay_port=relay_port,
+            )
+        )
+
+    def modify_scanner(
+        self,
+        scanner_id: EntityID,
+        *,
+        name: Optional[str] = None,
+        host: Optional[str] = None,
+        port: Optional[int] = None,
+        scanner_type: Optional[ScannerType] = None,
+        credential_id: Optional[EntityID] = None,
+        ca_pub: Optional[str] = None,
+        comment: Optional[str] = None,
+        relay_host: Optional[str] = None,
+        relay_port: Optional[Union[str, int]] = None,
+    ) -> T:
+        """Modify an existing scanner
+
+        Args:
+            scanner_id: UUID of the scanner to modify
+            name: New name of the scanner
+            host: New hostname or IP address of the scanner
+            port: New port of the scanner
+            scanner_type: New type of the scanner
+            credential_id: New UUID of client certificate credential for the
+                scanner
+            ca_pub: New certificate of CA to verify scanner certificate
+            comment: New comment for the scanner
+            relay_host: Hostname or IP address of the scanner relay
+            relay_port: Port of the scanner relay
+        """
+        return self._send_request_and_transform_response(
+            Scanners.modify_scanner(
+                scanner_id,
+                name=name,
+                host=host,
+                port=port,
+                scanner_type=scanner_type,
+                credential_id=credential_id,
+                ca_pub=ca_pub,
+                comment=comment,
+                relay_host=relay_host,
+                relay_port=relay_port,
+            )
+        )
+
+    def get_scanners(
+        self,
+        *,
+        filter_string: Optional[str] = None,
+        filter_id: Optional[EntityID] = None,
+        trash: Optional[bool] = None,
+        details: Optional[bool] = None,
+    ) -> T:
+        """Request a list of scanners
+
+        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 scanners instead
+            details: Whether to include extra details like tasks using this
+                scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.get_scanners(
+                filter_string=filter_string,
+                filter_id=filter_id,
+                trash=trash,
+                details=details,
+            )
+        )
+
+    def get_scanner(self, scanner_id: EntityID) -> T:
+        """Request a single scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.get_scanner(scanner_id)
+        )
+
+    def verify_scanner(self, scanner_id: EntityID) -> T:
+        """Verify an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.verify_scanner(scanner_id)
+        )
+
+    def clone_scanner(self, scanner_id: EntityID) -> T:
+        """Clone an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.clone_scanner(scanner_id)
+        )
+
+    def delete_scanner(
+        self, scanner_id: EntityID, ultimate: Optional[bool] = False
+    ) -> T:
+        """Delete an existing scanner
+
+        Args:
+            scanner_id: UUID of an existing scanner
+        """
+        return self._send_request_and_transform_response(
+            Scanners.delete_scanner(scanner_id, ultimate=ultimate)
+        )

gvm/protocols/gmp/requests/v226/__init__.py

@@ -48,8 +48,6 @@
     Results,
     Roles,
     ScanConfigs,
-    Scanners,
-    ScannerType,
     Schedules,
     SecInfo,
     Severity,
@@ -71,6 +69,7 @@
 )
 from ._audit_reports import AuditReports
 from ._filters import Filters, FilterType
+from ._scanners import Scanners, ScannerType
 from ._report_configs import ReportConfigParameter, ReportConfigs
 from ._reports import Reports
 from ._resource_names import ResourceNames, ResourceType