From 85a11b62bde23c9848757966ab622bf6bcb0b490 Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Wed, 27 Jul 2022 18:26:32 +0530 Subject: [PATCH] Common: Add docstring to AgentConfiguration dataclass --- .../agent_configuration/agent_configuration.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/monkey/common/agent_configuration/agent_configuration.py b/monkey/common/agent_configuration/agent_configuration.py index 00b39dce4..0b45c5c5f 100644 --- a/monkey/common/agent_configuration/agent_configuration.py +++ b/monkey/common/agent_configuration/agent_configuration.py @@ -32,6 +32,19 @@ class InvalidConfigurationError(Exception): @dataclass(frozen=True) class AgentConfiguration: + """ + A configuration for Infection Monkey agents + + Attributes: + :param keep_tunnel_open_time: Maximum time in seconds to keep a tunnel open after + the last exploit + :param custom_pbas: Configuration for custom post-breach actions + :param post_breach_actions: Configuration for post-breach actions + :param credential_collectors: Configuration for credential collectors + :param payloads: Configuration for payloads + :param propagation: Configuration for propagation + """ + keep_tunnel_open_time: float custom_pbas: CustomPBAConfiguration post_breach_actions: Tuple[PluginConfiguration, ...]