p34709852
/
monkey
forked from p15670423/monkey
1
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Common: Add documentation to ScanTargetConfiguration dataclass

This commit is contained in:
vakarisz 2022-07-27 17:08:54 +03:00
parent a943891567
commit 96af1e0135
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
monkey/common/agent_configuration/agent_sub_configurations.py
View File

@ -54,6 +54,18 @@ class PluginConfiguration:
@dataclass(frozen=True) @dataclass(frozen=True)
class ScanTargetConfiguration: 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, ...] blocked_ips: Tuple[str, ...]
inaccessible_subnets: Tuple[str, ...] inaccessible_subnets: Tuple[str, ...]
local_network_scan: bool local_network_scan: bool