add: support agent support bundle encryption

Add the optional `encryption` parameter to `get_agent_support_bundle`.

Default to encrypted support bundles and allow requesting a plain support
bundle by setting `encryption` to `0`.

Add tests for the new parameter.

Author: ozgen

gvm/protocols/gmp/_gmpnext.py

@@ -314,13 +314,15 @@ def get_agent_support_bundle(
         self,
         agent_id: EntityID,
         days: int = 0,
+        encryption: bool = True,
     ) -> T:
         """Request a support bundle for an agent.
 
         Args:
             agent_id: ID of the agent to get the support bundle for.
             days: Number of days of logs to include. If None, zero is sent so the
                 Agent Controller uses its configured default.
+            encryption: Whether an encrypted or plain support bundle is requested.
 
         Raises:
             RequiredArgument: If agent_id is missing.
@@ -330,6 +332,7 @@ def get_agent_support_bundle(
             Agents.get_agent_support_bundle(
                 agent_id,
                 days=days,
+                encryption=encryption,
             )
         )
 

gvm/protocols/gmp/requests/next/_agents.py

@@ -438,13 +438,15 @@ def get_agent_support_bundle(
         agent_id: EntityID,
         *,
         days: int = 0,
+        encryption: bool = True,
     ) -> Request:
         """Request a support bundle for an agent.
 
         Args:
             agent_id: ID of the agent to get the support bundle for.
             days: Number of days of logs to include. If None, zero is sent so the
                 Agent Controller uses its configured default.
+            encryption: Whether an encrypted or plain support bundle is requested.
 
         Raises:
             RequiredArgument: If agent_id is missing.
@@ -462,5 +464,6 @@ def get_agent_support_bundle(
         cmd = XmlCommand("get_agent_support_bundle")
         cmd.set_attribute("agent_uuid", str(agent_id))
         cmd.set_attribute("days", str(days))
+        cmd.set_attribute("encryption", to_bool(encryption))
 
         return cmd

tests/protocols/gmpnext/entities/agents/test_get_agent_support_bundle.py

@@ -13,7 +13,7 @@ def test_get_agent_support_bundle(self):
         )
 
         self.connection.send.has_been_called_with(
-            b'<get_agent_support_bundle agent_uuid="agent-123" days="7"/>'
+            b'<get_agent_support_bundle agent_uuid="agent-123" days="7" encryption="1"/>'
         )
 
     def test_get_agent_support_bundle_without_days_uses_zero(self):
@@ -22,7 +22,7 @@ def test_get_agent_support_bundle_without_days_uses_zero(self):
         )
 
         self.connection.send.has_been_called_with(
-            b'<get_agent_support_bundle agent_uuid="agent-123" days="0"/>'
+            b'<get_agent_support_bundle agent_uuid="agent-123" days="0" encryption="1"/>'
         )
 
     def test_get_agent_support_bundle_with_zero_days(self):
@@ -32,7 +32,18 @@ def test_get_agent_support_bundle_with_zero_days(self):
         )
 
         self.connection.send.has_been_called_with(
-            b'<get_agent_support_bundle agent_uuid="agent-123" days="0"/>'
+            b'<get_agent_support_bundle agent_uuid="agent-123" days="0" encryption="1"/>'
+        )
+
+    def test_get_agent_support_bundle_with_zero_days_false_encryption(self):
+        self.gmp.get_agent_support_bundle(
+            agent_id="agent-123",
+            days=0,
+            encryption=False,
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_agent_support_bundle agent_uuid="agent-123" days="0" encryption="0"/>'
         )
 
     def test_get_agent_support_bundle_without_agent_id(self):