Merge branch '2786-plugin-manifest-endpoint' into develop

Issue #2786
PR #2814

Author: mssalvatore

CHANGELOG.md

@@ -32,6 +32,7 @@ Changelog](https://keepachangelog.com/en/1.0.0/).
 - Scrollbar to preview pane's exploit timeline in the map page. #2455
 - `api/agent-plugins/<string:type>/<string:name>` endpoint. #2578
 - `/api/agent-configuration-schema` endpoint. #2710
+- `api/agent-plugins/<string:type>/<string:name>/manifest` endpoint. #2786
 
 ### Changed
 - Reset workflow. Now it's possible to delete data gathered by agents without

monkey/monkey_island/cc/app.py

@@ -18,6 +18,7 @@
     AgentHeartbeat,
     AgentLogs,
     AgentPlugins,
+    AgentPluginsManifest,
     Agents,
     AgentSignals,
     ClearSimulationData,
@@ -157,6 +158,7 @@ def init_restful_endpoints(api: FlaskDIWrapper):
     api.add_resource(AgentConfigurationSchema)
     api.add_resource(AgentBinaries)
     api.add_resource(AgentPlugins)
+    api.add_resource(AgentPluginsManifest)
     api.add_resource(Machines)
 
     api.add_resource(SecurityReport)

monkey/monkey_island/cc/resources/__init__.py

@@ -7,6 +7,7 @@
 from .agent_configuration import AgentConfiguration
 from .agent_events import AgentEvents
 from .agent_plugins import AgentPlugins
+from .agent_plugins_manifest import AgentPluginsManifest
 from .agents import Agents
 from .agent_signals import AgentSignals, TerminateAllAgents
 from .agent_logs import AgentLogs

monkey/monkey_island/cc/resources/agent_plugins_manifest.py

@@ -0,0 +1,42 @@
+import logging
+from http import HTTPStatus
+
+from flask import make_response
+
+from common.agent_plugins import AgentPluginType
+from monkey_island.cc.repositories import IAgentPluginRepository, UnknownRecordError
+from monkey_island.cc.resources.AbstractResource import AbstractResource
+
+logger = logging.getLogger(__name__)
+
+
+class AgentPluginsManifest(AbstractResource):
+    urls = ["/api/agent-plugins/<string:plugin_type>/<string:name>/manifest"]
+
+    def __init__(self, agent_plugin_repository: IAgentPluginRepository):
+        self._agent_plugin_repository = agent_plugin_repository
+
+    # Used by monkey. can't secure.
+    def get(self, plugin_type: str, name: str):
+        """
+        Get the plugin manifest of the specified type and name.
+
+        :param type: The type of plugin (e.g. Exploiter)
+        :param name: The name of the plugin
+        """
+        try:
+            agent_plugin_type = AgentPluginType(plugin_type)
+        except ValueError:
+            message = f"Invalid type '{plugin_type}'."
+            logger.warning(message)
+            return make_response({"message": message}, HTTPStatus.NOT_FOUND)
+
+        try:
+            agent_plugin_manifest = self._agent_plugin_repository.get_plugin(
+                plugin_type=agent_plugin_type, name=name
+            ).plugin_manifest
+            return make_response(agent_plugin_manifest.dict(simplify=True), HTTPStatus.OK)
+        except UnknownRecordError:
+            message = f"Plugin '{name}' of type '{plugin_type}' not found."
+            logger.warning(message)
+            return make_response({"message": message}, HTTPStatus.NOT_FOUND)

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

@@ -0,0 +1,82 @@
+from http import HTTPStatus
+
+import pytest
+from tests.common import StubDIContainer
+from tests.monkey_island import InMemoryAgentPluginRepository
+from tests.unit_tests.common.agent_plugins.test_agent_plugin_manifest import FAKE_TYPE
+from tests.unit_tests.monkey_island.cc.fake_agent_plugin_data import FAKE_AGENT_PLUGIN_1
+from tests.unit_tests.monkey_island.conftest import get_url_for_resource
+
+from monkey_island.cc.repositories import IAgentPluginRepository, RetrievalError
+from monkey_island.cc.resources import AgentPluginsManifest
+
+
+@pytest.fixture
+def agent_plugin_repository():
+    return InMemoryAgentPluginRepository()
+
+
+@pytest.fixture
+def flask_client(build_flask_client, agent_plugin_repository):
+    container = StubDIContainer()
+    container.register_instance(IAgentPluginRepository, agent_plugin_repository)
+
+    with build_flask_client(container) as flask_client:
+        yield flask_client
+
+
+def test_get_plugin_manifest(flask_client, agent_plugin_repository):
+    agent_plugin_repository.save_plugin(FAKE_AGENT_PLUGIN_1)
+
+    expected_response = {
+        "description": None,
+        "link_to_documentation": "www.beefface.com",
+        "name": "rdp_exploiter",
+        "plugin_type": "Exploiter",
+        "safe": False,
+        "supported_operating_systems": ["linux"],
+        "title": "Remote Desktop Protocol exploiter",
+    }
+    resp = flask_client.get(
+        get_url_for_resource(
+            AgentPluginsManifest,
+            plugin_type=FAKE_TYPE,
+            name=FAKE_AGENT_PLUGIN_1.plugin_manifest.name,
+        )
+    )
+
+    assert resp.status_code == HTTPStatus.OK
+    assert resp.json == expected_response
+
+
+def test_get_plugins_manifest__not_found_if_name_does_not_exist(flask_client):
+    resp = flask_client.get(
+        get_url_for_resource(AgentPluginsManifest, plugin_type="Payload", name="name")
+    )
+
+    assert resp.status_code == HTTPStatus.NOT_FOUND
+
+
+@pytest.mark.parametrize(
+    "type_",
+    ["DummyType", "ExploiteR"],
+)
+def test_get_plugins_manifest__not_found_if_type_is_invalid(flask_client, type_):
+    resp = flask_client.get(
+        get_url_for_resource(AgentPluginsManifest, plugin_type=type_, name="name")
+    )
+
+    assert resp.status_code == HTTPStatus.NOT_FOUND
+
+
+def test_get_plugins_manifest__server_error(flask_client, agent_plugin_repository):
+    def raise_retrieval_error(plugin_type, name):
+        raise RetrievalError
+
+    agent_plugin_repository.get_plugin = raise_retrieval_error
+
+    resp = flask_client.get(
+        get_url_for_resource(AgentPluginsManifest, plugin_type="Payload", name="name")
+    )
+
+    assert resp.status_code == HTTPStatus.INTERNAL_SERVER_ERROR