From 4116ebd24d4422ae219107a9b10ce79e07e1b552 Mon Sep 17 00:00:00 2001 From: Shreya Malviya Date: Tue, 26 Jul 2022 14:38:03 +0530 Subject: [PATCH] Common: Add docstring to CustomPBAConfiguration dataclass --- .../agent_sub_configurations.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/monkey/common/agent_configuration/agent_sub_configurations.py b/monkey/common/agent_configuration/agent_sub_configurations.py index ad321b3d0..d49bf970e 100644 --- a/monkey/common/agent_configuration/agent_sub_configurations.py +++ b/monkey/common/agent_configuration/agent_sub_configurations.py @@ -4,6 +4,24 @@ from typing import Dict, Tuple @dataclass(frozen=True) class CustomPBAConfiguration: + """ + Dataclass for the configuration of custom post-breach actions + + Attributes: + linux_command (str): Command to run on Linux victim machines. If a file is uploaded, + use this field to change its permissions, execute it, and/or delete + it. + Example: `chmod +x file.sh; ./file.sh; rm file.sh` + linux_filename (str): Name of the file to upload and run on Linux victim machines. + Example: `i-am-custom-pba-file.sh` + windows_command (str): Command to run on Windows victim machines. If a file is uploaded, + use this field to change its permissions, execute it, and/or delete + it. + Example: `file.bat & del file.bat` + windows_filename (str): Name of the file to upload and run on Windows victim machines. + Example: `i-am-custom-pba-file.bat` + """ + linux_command: str linux_filename: str windows_command: str