EnterpriseGreenAgent
Bases: BaseAgent
Green Agent to be used for the Enterprise scenario (CC4).
Attributes:
Name | Type | Description |
---|---|---|
own_ip |
IPv4Address
|
ip address of the host the green agent is located on |
fp_detection_rate |
float
|
the decimal rate at which a blue detection false positive occurs from the green action (0 <= value <= 1) |
phishing_error_rate |
float
|
the decimal rate at which a phishing email subaction occurs due to a green action (0 <= value <= 1) |
Functions
__init__
__init__(name: str, own_ip: IPv4Address, np_random: IPv4Address = None, fp_detection_rate: float = 0.01, phishing_error_rate: float = 0.01)
Initialisation of the EnterpriseGreenAgent class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
name of the agent (form of unique id) |
required |
own_ip |
IPv4Address
|
ip address of the host the agent is located on |
required |
fp_detection_rate |
float
|
the decimal rate at which a blue detection false positive occurs from the green action (0 <= value <= 1) |
0.01
|
phishing_error_rate |
float
|
the decimal rate at which a phishing email subaction occurs due to a green action (0 <= value <= 1) |
0.01
|
get_action
Returns one of the 3 possible actions of the green agent in CC4
The 3 possible actions are: GreenLocalWork, GreenAccessService, and Sleep. The action is chosen at random from this list.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
observation |
Observation
|
current observation of the state |
required |
action_space |
ActionSpace
|
the action space of the agent at the current step |
required |
Returns:
Type | Description |
---|---|
Action
|
One of the 3 listed actions, where each inherit from base class Action |