From 96af1e0135e99d187e8b2f525fb2c1711855e865 Mon Sep 17 00:00:00 2001 From: vakarisz Date: Wed, 27 Jul 2022 17:08:54 +0300 Subject: [PATCH] Common: Add documentation to ScanTargetConfiguration dataclass --- .../agent_configuration/agent_sub_configurations.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py index f58bcd9b0..310c88e18 100644 --- a/monkey/common/agent_configuration/agent_sub_configurations.py +++ b/monkey/common/agent_configuration/agent_sub_configurations.py @@ -54,6 +54,18 @@ class PluginConfiguration: @dataclass(frozen=True) class ScanTargetConfiguration: + """ + Configuration of network targets to scan and exploit + + Attributes: + :param blocked_ips: Tuple of IP's that won't be scanned. Example: ("1.1.1.1", "2.2.2.2") + :param inaccessible_subnets: Tuple of subnet ranges that shouldn't be accessible for the + agent. Example: ("1.1.1.1", "2.2.2.2/24", "myserver") + :param local_network_scan: Boolean indicating if the agent should scan the local network + :param subnets: Tuple of subnet ranges to scan. Example: ("192.168.1.1-192.168.2.255", + "3.3.3.3", "2.2.2.2/24", "myHostname") + """ + blocked_ips: Tuple[str, ...] inaccessible_subnets: Tuple[str, ...] local_network_scan: bool