Common: Add docstring to CustomPBAConfiguration dataclass

This commit is contained in:
Shreya Malviya 2022-07-26 14:38:03 +05:30
parent 48e34049fe
commit 4116ebd24d
1 changed files with 18 additions and 0 deletions

View File

@ -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