Common: Add ExploiterConfiguration

monkey/common/configuration/__init__.py

@@ -3,4 +3,6 @@ from .agent_configuration import (
     PluginConfigurationSchema,
     CustomPBAConfiguration,
     CustomPBAConfigurationSchema,
+    ExploiterConfiguration,
+    ExploiterConfigurationSchema,
 )

monkey/common/configuration/agent_configuration.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Dict
+from typing import Dict, List
 
 from marshmallow import RAISE, Schema, fields, post_load
 
@@ -42,3 +42,23 @@ class PluginConfigurationSchema(Schema):
     @post_load
     def make_plugin_configuration(self, data, **kwargs):
         return PluginConfiguration(**data)
+
+
+@dataclass(frozen=True)
+class ExploiterConfiguration:
+    name: str
+    options: Dict
+    supported_os: List[str]
+
+
+class ExploiterConfigurationSchema(Schema):
+    class Meta:
+        unknown = RAISE
+
+    name = fields.Str()
+    options = fields.Mapping()
+    supported_os = fields.List(fields.Str())
+
+    @post_load
+    def make_exploiter_configuration(self, data, **kwargs):
+        return ExploiterConfiguration(**data)

monkey/tests/unit_tests/common/test_agent_configuration.py

@@ -1,4 +1,8 @@
-from common.configuration import CustomPBAConfigurationSchema, PluginConfigurationSchema
+from common.configuration import (
+    CustomPBAConfigurationSchema,
+    ExploiterConfigurationSchema,
+    PluginConfigurationSchema,
+)
 
 
 def test_build_plugin_configuration():
@@ -32,3 +36,16 @@ def test_custom_pba_configuration_schema():
     assert config.linux_filename == linux_filename
     assert config.windows_command == windows_command
     assert config.windows_filename == windows_filename
+
+
+def test_exploiter_configuration_schema():
+    name = "bond"
+    options = {"gun": "Walther PPK", "car": "Aston Martin DB5"}
+    supported_os = ["linux", "windows"]
+    schema = ExploiterConfigurationSchema()
+
+    config = schema.load({"name": name, "options": options, "supported_os": supported_os})
+
+    assert config.name == name
+    assert config.options == options
+    assert config.supported_os == supported_os

vulture_allowlist.py

@@ -188,6 +188,7 @@ Meta  # unused class(monkey/common/configuration/agent_configuration.py:13)
 unknown  # unused variable(monkey/common/configuration/agent_configuration.py:14)
 make_plugin_configuration  # unused method(monkey/common/configuration/agent_configuration.py:19)
 make_custom_pba_configuration  # unused method(monkey/common/configuration/agent_configuration.py:34)
+make_exploiter_configuration  # unused method(monkey/common/configuration/agent_configuration.py:62)
 
 
 # TODO DELETE AFTER RESOURCE REFACTORING