p15670423
/
monkey
1
0
Fork 5
Code Issues Pull Requests 3 Projects Releases Wiki Activity

Island: Add docstrings to the Agent model

This commit is contained in:
Mike Salvatore 2022-09-01 12:17:34 -04:00
parent 693ce9e486
commit 3ab800f119
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
monkey/monkey_island/cc/models/agent.py
View File

@ -13,10 +13,25 @@ AgentID: TypeAlias = UUID
class Agent(MutableInfectionMonkeyBaseModel): class Agent(MutableInfectionMonkeyBaseModel):
"""Represents an agent that has run on a victim machine"""
id: AgentID = Field(..., allow_mutation=False) id: AgentID = Field(..., allow_mutation=False)
"""Uniquely identifies an instance of an agent"""
machine_id: MachineID = Field(..., allow_mutation=False) machine_id: MachineID = Field(..., allow_mutation=False)
"""The machine that the agent ran on"""
start_time: datetime = Field(..., allow_mutation=False) start_time: datetime = Field(..., allow_mutation=False)
"""The time the agent process started"""
stop_time: Optional[datetime] stop_time: Optional[datetime]
"""The time the agent process exited"""
parent_id: Optional[AgentID] = Field(allow_mutation=False) parent_id: Optional[AgentID] = Field(allow_mutation=False)
"""The ID of the parent agent that spawned this agent"""
cc_server: str = Field(default="") cc_server: str = Field(default="")
"""The address that the agent used to communicate with the island"""
log_contents: str = Field(default="") log_contents: str = Field(default="")
"""The contents of the agent's log (empty until the agent shuts down)"""