Common: Add AgentPluginManifest.remediation_suggestion

Issue #2857
PR #2871

Author: mssalvatore

monkey/common/agent_plugins/agent_plugin_manifest.py

@@ -30,5 +30,6 @@ class AgentPluginManifest(InfectionMonkeyBaseModel):
     )
     title: Optional[str]
     description: Optional[str]
+    remediation_suggestion: Optional[str]
     link_to_documentation: Optional[str]
     safe: bool = False

monkey/tests/unit_tests/common/agent_plugins/test_agent_plugin_manifest.py

@@ -25,6 +25,7 @@
 FAKE_AGENT_MANIFEST_DICT_OUT: Dict[str, Any] = copy.deepcopy(FAKE_AGENT_MANIFEST_DICT_IN)
 FAKE_AGENT_MANIFEST_DICT_OUT["description"] = None
 FAKE_AGENT_MANIFEST_DICT_OUT["safe"] = False
+FAKE_AGENT_MANIFEST_DICT_OUT["remediation_suggestion"] = None
 
 FAKE_AGENT_MANIFEST_DICT = {
     "name": FAKE_NAME,
@@ -81,3 +82,13 @@ def test_agent_plugin_manifest__invalid_name(name):
             title=FAKE_TITLE,
             link_to_documentation=FAKE_LINK,
         )
+
+
+def test_agent_plugin_manifest__remediation_suggestion():
+    remediation_suggestion = "test remediation suggestion"
+    agent_manifest_dict = FAKE_AGENT_MANIFEST_DICT.copy()
+    agent_manifest_dict["remediation_suggestion"] = remediation_suggestion
+
+    agent_manifest_object = AgentPluginManifest(**agent_manifest_dict)
+
+    assert agent_manifest_object.remediation_suggestion == remediation_suggestion

monkey/tests/unit_tests/monkey_island/cc/resources/test_agent_plugins.py

@@ -41,6 +41,7 @@ def test_get_plugin(flask_client, agent_plugin_repository):
             "name": FAKE_NAME,
             "plugin_type": FAKE_TYPE,
             "safe": False,
+            "remediation_suggestion": None,
             "supported_operating_systems": ["linux"],
             "title": "Remote Desktop Protocol exploiter",
         },

monkey/tests/unit_tests/monkey_island/cc/resources/test_agent_plugins_manifest.py

@@ -34,6 +34,7 @@ def test_get_plugin_manifest(flask_client, agent_plugin_repository):
         "name": "rdp_exploiter",
         "plugin_type": "Exploiter",
         "safe": False,
+        "remediation_suggestion": None,
         "supported_operating_systems": ["linux"],
         "title": "Remote Desktop Protocol exploiter",
     }

vulture_allowlist.py

@@ -50,6 +50,7 @@
 AgentPluginManifest.description
 AgentPluginManifest.link_to_documentation
 AgentPluginManifest.safe
+AgentPluginManifest.remediation_suggestion
 AgentPluginManifest.supported_operating_systems
 
 # Unused, but kept for future potential