Skip to content

Session

Bases: Entity

Details of the session created between an agent and a host.

Attributes:

Name Type Description
ident int

session id

hostname str

name of host with session

username str

username of session on host

agent str

name of agent on host

timeout int
pid int

process id linked to the session

parent int

parent session id (if exists)

session_type str

type of session

active bool

is the session active/live

children {}

session id of child sessions

name str

name of session

is_escalate_sandbox bool

is the session a decoy sandbox

num_children int

the number of child sessions

action_queue list

queuing actions of multiple time step duration

Functions

dead_child

dead_child(child_id: int)

Remove a specific child session.

get_state

get_state()

Returns a dictionary representing the state of the session.

has_privileged_access

has_privileged_access() -> bool

Does the session have privileged access, based on the username.

set_orphan

set_orphan()

Make the session an orphan session.