From 706b5758d4b9102f5e38738bcb0387b6bb9c1d92 Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Wed, 27 Jul 2022 17:59:29 +0530 Subject: [PATCH 1/2] Common: Add docstring to ExploitationConfiguration dataclass --- .../agent_configuration/agent_sub_configurations.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py index ab05a55cc..d175b6ef3 100644 --- a/monkey/common/agent_configuration/agent_sub_configurations.py +++ b/monkey/common/agent_configuration/agent_sub_configurations.py @@ -111,6 +111,15 @@ class ExploitationOptionsConfiguration: @dataclass(frozen=True) class ExploitationConfiguration: + """ + A configuration for exploitation + + Attributes: + :param options: Configuration for exploitation options + :param brute_force: Configuration for brute force exploiters + :param vulnerability: Configuration for vulnerability exploiters + """ + options: ExploitationOptionsConfiguration brute_force: Tuple[PluginConfiguration, ...] vulnerability: Tuple[PluginConfiguration, ...] From fa98631642963db4f78579cb579274e51d6bd298 Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Wed, 27 Jul 2022 18:04:29 +0530 Subject: [PATCH 2/2] Common: Reword ExploitationConfiguration docstring Co-authored-by: Mike Salvatore --- monkey/common/agent_configuration/agent_sub_configurations.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py index d175b6ef3..d0e66f672 100644 --- a/monkey/common/agent_configuration/agent_sub_configurations.py +++ b/monkey/common/agent_configuration/agent_sub_configurations.py @@ -115,7 +115,7 @@ class ExploitationConfiguration: A configuration for exploitation Attributes: - :param options: Configuration for exploitation options + :param options: Exploitation options shared by all exploiters :param brute_force: Configuration for brute force exploiters :param vulnerability: Configuration for vulnerability exploiters """