#3062 - rename identifier to discriminator

src/primaite/game/agent/actions/abstract.py

@@ -22,13 +22,20 @@ class AbstractAction(BaseModel, ABC):
 
     _registry: ClassVar[Dict[str, Type[AbstractAction]]] = {}
 
-    def __init_subclass__(cls, identifier: Optional[str] = None, **kwargs: Any) -> None:
+    def __init_subclass__(cls, discriminator: Optional[str] = None, **kwargs: Any) -> None:
+        """
+        Register an action type.
+
+        :param discriminator: discriminator used to uniquely specify action types.
+        :type discriminator: str
+        :raises ValueError: When attempting to create an action with a name that is already in use.
+        """
         super().__init_subclass__(**kwargs)
-        if identifier is None:
+        if discriminator is None:
             return
-        if identifier in cls._registry:
-            raise ValueError(f"Cannot create new action under reserved name {identifier}")
-        cls._registry[identifier] = cls
+        if discriminator in cls._registry:
+            raise ValueError(f"Cannot create new action under reserved name {discriminator}")
+        cls._registry[discriminator] = cls
 
     @classmethod
     def form_request(cls, config: ConfigSchema) -> RequestFormat:

src/primaite/game/agent/actions/acl.py

@@ -37,7 +37,7 @@ class ACLAddRuleAbstractAction(AbstractAction, ABC):
         dst_wildcard: Union[IPV4Address, Literal["NONE"]]
 
 
-class ACLRemoveRuleAbstractAction(AbstractAction, identifier="acl_remove_rule_abstract_action"):
+class ACLRemoveRuleAbstractAction(AbstractAction, discriminator="acl_remove_rule_abstract_action"):
     """Base abstract class for ACL remove rule actions."""
 
     config: ConfigSchema = "ACLRemoveRuleAbstractAction.ConfigSchema"
@@ -48,7 +48,7 @@ class ACLRemoveRuleAbstractAction(AbstractAction, identifier="acl_remove_rule_ab
         position: int
 
 
-class RouterACLAddRuleAction(ACLAddRuleAbstractAction, identifier="router_acl_add_rule"):
+class RouterACLAddRuleAction(ACLAddRuleAbstractAction, discriminator="router_acl_add_rule"):
     """Action which adds a rule to a router's ACL."""
 
     config: "RouterACLAddRuleAction.ConfigSchema"
@@ -79,7 +79,7 @@ class RouterACLAddRuleAction(ACLAddRuleAbstractAction, identifier="router_acl_ad
         ]
 
 
-class RouterACLRemoveRuleAction(ACLRemoveRuleAbstractAction, identifier="router_acl_remove_rule"):
+class RouterACLRemoveRuleAction(ACLRemoveRuleAbstractAction, discriminator="router_acl_remove_rule"):
     """Action which removes a rule from a router's ACL."""
 
     config: "RouterACLRemoveRuleAction.ConfigSchema"
@@ -95,7 +95,7 @@ class RouterACLRemoveRuleAction(ACLRemoveRuleAbstractAction, identifier="router_
         return ["network", "node", config.target_router, "acl", "remove_rule", config.position]
 
 
-class FirewallACLAddRuleAction(ACLAddRuleAbstractAction, identifier="firewall_acl_add_rule"):
+class FirewallACLAddRuleAction(ACLAddRuleAbstractAction, discriminator="firewall_acl_add_rule"):
     """Action which adds a rule to a firewall port's ACL."""
 
     config: "FirewallACLAddRuleAction.ConfigSchema"
@@ -130,7 +130,7 @@ class FirewallACLAddRuleAction(ACLAddRuleAbstractAction, identifier="firewall_ac
         ]
 
 
-class FirewallACLRemoveRuleAction(ACLRemoveRuleAbstractAction, identifier="firewall_acl_remove_rule"):
+class FirewallACLRemoveRuleAction(ACLRemoveRuleAbstractAction, discriminator="firewall_acl_remove_rule"):
     """Action which removes a rule from a firewall port's ACL."""
 
     config: "FirewallACLRemoveRuleAction.ConfigSchema"

src/primaite/game/agent/actions/application.py

@@ -45,7 +45,7 @@ class NodeApplicationAbstractAction(AbstractAction, ABC):
         ]
 
 
-class NodeApplicationExecuteAction(NodeApplicationAbstractAction, identifier="node_application_execute"):
+class NodeApplicationExecuteAction(NodeApplicationAbstractAction, discriminator="node_application_execute"):
     """Action which executes an application."""
 
     config: "NodeApplicationExecuteAction.ConfigSchema"
@@ -56,7 +56,7 @@ class NodeApplicationExecuteAction(NodeApplicationAbstractAction, identifier="no
         verb: str = "execute"
 
 
-class NodeApplicationScanAction(NodeApplicationAbstractAction, identifier="node_application_scan"):
+class NodeApplicationScanAction(NodeApplicationAbstractAction, discriminator="node_application_scan"):
     """Action which scans an application."""
 
     config: "NodeApplicationScanAction.ConfigSchema"
@@ -67,7 +67,7 @@ class NodeApplicationScanAction(NodeApplicationAbstractAction, identifier="node_
         verb: str = "scan"
 
 
-class NodeApplicationCloseAction(NodeApplicationAbstractAction, identifier="node_application_close"):
+class NodeApplicationCloseAction(NodeApplicationAbstractAction, discriminator="node_application_close"):
     """Action which closes an application."""
 
     config: "NodeApplicationCloseAction.ConfigSchema"
@@ -78,7 +78,7 @@ class NodeApplicationCloseAction(NodeApplicationAbstractAction, identifier="node
         verb: str = "close"
 
 
-class NodeApplicationFixAction(NodeApplicationAbstractAction, identifier="node_application_fix"):
+class NodeApplicationFixAction(NodeApplicationAbstractAction, discriminator="node_application_fix"):
     """Action which fixes an application."""
 
     config: "NodeApplicationFixAction.ConfigSchema"
@@ -89,7 +89,7 @@ class NodeApplicationFixAction(NodeApplicationAbstractAction, identifier="node_a
         verb: str = "fix"
 
 
-class NodeApplicationInstallAction(NodeApplicationAbstractAction, identifier="node_application_install"):
+class NodeApplicationInstallAction(NodeApplicationAbstractAction, discriminator="node_application_install"):
     """Action which installs an application."""
 
     config: "NodeApplicationInstallAction.ConfigSchema"
@@ -113,7 +113,7 @@ class NodeApplicationInstallAction(NodeApplicationAbstractAction, identifier="no
         ]
 
 
-class NodeApplicationRemoveAction(NodeApplicationAbstractAction, identifier="node_application_remove"):
+class NodeApplicationRemoveAction(NodeApplicationAbstractAction, discriminator="node_application_remove"):
     """Action which removes/uninstalls an application."""
 
     config: "NodeApplicationRemoveAction.ConfigSchema"

src/primaite/game/agent/actions/file.py

@@ -52,7 +52,7 @@ class NodeFileAbstractAction(AbstractAction, ABC):
         ]
 
 
-class NodeFileCreateAction(NodeFileAbstractAction, identifier="node_file_create"):
+class NodeFileCreateAction(NodeFileAbstractAction, discriminator="node_file_create"):
     """Action which creates a new file in a given folder."""
 
     config: "NodeFileCreateAction.ConfigSchema"
@@ -81,7 +81,7 @@ class NodeFileCreateAction(NodeFileAbstractAction, identifier="node_file_create"
         ]
 
 
-class NodeFileScanAction(NodeFileAbstractAction, identifier="node_file_scan"):
+class NodeFileScanAction(NodeFileAbstractAction, discriminator="node_file_scan"):
     """Action which scans a file."""
 
     config: "NodeFileScanAction.ConfigSchema"
@@ -92,7 +92,7 @@ class NodeFileScanAction(NodeFileAbstractAction, identifier="node_file_scan"):
         verb: ClassVar[str] = "scan"
 
 
-class NodeFileDeleteAction(NodeFileAbstractAction, identifier="node_file_delete"):
+class NodeFileDeleteAction(NodeFileAbstractAction, discriminator="node_file_delete"):
     """Action which deletes a file."""
 
     config: "NodeFileDeleteAction.ConfigSchema"
@@ -119,7 +119,7 @@ class NodeFileDeleteAction(NodeFileAbstractAction, identifier="node_file_delete"
         ]
 
 
-class NodeFileRestoreAction(NodeFileAbstractAction, identifier="node_file_restore"):
+class NodeFileRestoreAction(NodeFileAbstractAction, discriminator="node_file_restore"):
     """Action which restores a file."""
 
     config: "NodeFileRestoreAction.ConfigSchema"
@@ -130,7 +130,7 @@ class NodeFileRestoreAction(NodeFileAbstractAction, identifier="node_file_restor
         verb: ClassVar[str] = "restore"
 
 
-class NodeFileCorruptAction(NodeFileAbstractAction, identifier="node_file_corrupt"):
+class NodeFileCorruptAction(NodeFileAbstractAction, discriminator="node_file_corrupt"):
     """Action which corrupts a file."""
 
     config: "NodeFileCorruptAction.ConfigSchema"
@@ -141,7 +141,7 @@ class NodeFileCorruptAction(NodeFileAbstractAction, identifier="node_file_corrup
         verb: ClassVar[str] = "corrupt"
 
 
-class NodeFileAccessAction(NodeFileAbstractAction, identifier="node_file_access"):
+class NodeFileAccessAction(NodeFileAbstractAction, discriminator="node_file_access"):
     """Action which increases a file's access count."""
 
     config: "NodeFileAccessAction.ConfigSchema"
@@ -167,7 +167,7 @@ class NodeFileAccessAction(NodeFileAbstractAction, identifier="node_file_access"
         ]
 
 
-class NodeFileCheckhashAction(NodeFileAbstractAction, identifier="node_file_checkhash"):
+class NodeFileCheckhashAction(NodeFileAbstractAction, discriminator="node_file_checkhash"):
     """Action which checks the hash of a file."""
 
     config: "NodeFileCheckhashAction.ConfigSchema"
@@ -178,7 +178,7 @@ class NodeFileCheckhashAction(NodeFileAbstractAction, identifier="node_file_chec
         verb: ClassVar[str] = "checkhash"
 
 
-class NodeFileRepairAction(NodeFileAbstractAction, identifier="node_file_repair"):
+class NodeFileRepairAction(NodeFileAbstractAction, discriminator="node_file_repair"):
     """Action which repairs a file."""
 
     config: "NodeFileRepairAction.ConfigSchema"

src/primaite/game/agent/actions/folder.py

@@ -47,7 +47,7 @@ class NodeFolderAbstractAction(AbstractAction, ABC):
         ]
 
 
-class NodeFolderScanAction(NodeFolderAbstractAction, identifier="node_folder_scan"):
+class NodeFolderScanAction(NodeFolderAbstractAction, discriminator="node_folder_scan"):
     """Action which scans a folder."""
 
     config: "NodeFolderScanAction.ConfigSchema"
@@ -58,7 +58,7 @@ class NodeFolderScanAction(NodeFolderAbstractAction, identifier="node_folder_sca
         verb: ClassVar[str] = "scan"
 
 
-class NodeFolderCheckhashAction(NodeFolderAbstractAction, identifier="node_folder_checkhash"):
+class NodeFolderCheckhashAction(NodeFolderAbstractAction, discriminator="node_folder_checkhash"):
     """Action which checks the hash of a folder."""
 
     config: "NodeFolderCheckhashAction.ConfigSchema"
@@ -69,7 +69,7 @@ class NodeFolderCheckhashAction(NodeFolderAbstractAction, identifier="node_folde
         verb: ClassVar[str] = "checkhash"
 
 
-class NodeFolderRepairAction(NodeFolderAbstractAction, identifier="node_folder_repair"):
+class NodeFolderRepairAction(NodeFolderAbstractAction, discriminator="node_folder_repair"):
     """Action which repairs a folder."""
 
     config: "NodeFolderRepairAction.ConfigSchema"
@@ -80,7 +80,7 @@ class NodeFolderRepairAction(NodeFolderAbstractAction, identifier="node_folder_r
         verb: ClassVar[str] = "repair"
 
 
-class NodeFolderRestoreAction(NodeFolderAbstractAction, identifier="node_folder_restore"):
+class NodeFolderRestoreAction(NodeFolderAbstractAction, discriminator="node_folder_restore"):
     """Action which restores a folder."""
 
     config: "NodeFolderRestoreAction.ConfigSchema"
@@ -91,7 +91,7 @@ class NodeFolderRestoreAction(NodeFolderAbstractAction, identifier="node_folder_
         verb: ClassVar[str] = "restore"
 
 
-class NodeFolderCreateAction(NodeFolderAbstractAction, identifier="node_folder_create"):
+class NodeFolderCreateAction(NodeFolderAbstractAction, discriminator="node_folder_create"):
     """Action which creates a new folder."""
 
     config: "NodeFolderCreateAction.ConfigSchema"

src/primaite/game/agent/actions/host_nic.py

@@ -40,7 +40,7 @@ class HostNICAbstractAction(AbstractAction, ABC):
         ]
 
 
-class HostNICEnableAction(HostNICAbstractAction, identifier="host_nic_enable"):
+class HostNICEnableAction(HostNICAbstractAction, discriminator="host_nic_enable"):
     """Action which enables a NIC."""
 
     config: "HostNICEnableAction.ConfigSchema"
@@ -51,7 +51,7 @@ class HostNICEnableAction(HostNICAbstractAction, identifier="host_nic_enable"):
         verb: ClassVar[str] = "enable"
 
 
-class HostNICDisableAction(HostNICAbstractAction, identifier="host_nic_disable"):
+class HostNICDisableAction(HostNICAbstractAction, discriminator="host_nic_disable"):
     """Action which disables a NIC."""
 
     config: "HostNICDisableAction.ConfigSchema"

src/primaite/game/agent/actions/manager.py

@@ -24,7 +24,7 @@ from primaite.interface.request import RequestFormat
 __all__ = ("DoNothingAction", "ActionManager")
 
 
-class DoNothingAction(AbstractAction, identifier="do_nothing"):
+class DoNothingAction(AbstractAction, discriminator="do_nothing"):
     """Do Nothing Action."""
 
     class ConfigSchema(AbstractAction.ConfigSchema):

src/primaite/game/agent/actions/network.py

@@ -8,7 +8,7 @@ from primaite.interface.request import RequestFormat
 __all__ = ("NetworkPortEnableAction", "NetworkPortDisableAction")
 
 
-class NetworkPortAbstractAction(AbstractAction, identifier="network_port_abstract"):
+class NetworkPortAbstractAction(AbstractAction, discriminator="network_port_abstract"):
     """Base class for Network port actions."""
 
     config: "NetworkPortAbstractAction.ConfigSchema"
@@ -35,7 +35,7 @@ class NetworkPortAbstractAction(AbstractAction, identifier="network_port_abstrac
         ]
 
 
-class NetworkPortEnableAction(NetworkPortAbstractAction, identifier="network_port_enable"):
+class NetworkPortEnableAction(NetworkPortAbstractAction, discriminator="network_port_enable"):
     """Action which enables are port on a router or a firewall."""
 
     config: "NetworkPortEnableAction.ConfigSchema"
@@ -46,7 +46,7 @@ class NetworkPortEnableAction(NetworkPortAbstractAction, identifier="network_por
         verb: ClassVar[str] = "enable"
 
 
-class NetworkPortDisableAction(NetworkPortAbstractAction, identifier="network_port_disable"):
+class NetworkPortDisableAction(NetworkPortAbstractAction, discriminator="network_port_disable"):
     """Action which disables are port on a router or a firewall."""
 
     config: "NetworkPortDisableAction.ConfigSchema"

src/primaite/game/agent/actions/node.py

@@ -18,7 +18,7 @@ __all__ = (
 )
 
 
-class NodeAbstractAction(AbstractAction, identifier="node_abstract"):
+class NodeAbstractAction(AbstractAction, discriminator="node_abstract"):
     """
     Abstract base class for node actions.
 
@@ -39,7 +39,7 @@ class NodeAbstractAction(AbstractAction, identifier="node_abstract"):
         return ["network", "node", config.node_name, config.verb]
 
 
-class NodeOSScanAction(NodeAbstractAction, identifier="node_os_scan"):
+class NodeOSScanAction(NodeAbstractAction, discriminator="node_os_scan"):
     """Action which scans a node's OS."""
 
     config: "NodeOSScanAction.ConfigSchema"
@@ -50,7 +50,7 @@ class NodeOSScanAction(NodeAbstractAction, identifier="node_os_scan"):
         verb: ClassVar[str] = "scan"
 
 
-class NodeShutdownAction(NodeAbstractAction, identifier="node_shutdown"):
+class NodeShutdownAction(NodeAbstractAction, discriminator="node_shutdown"):
     """Action which shuts down a node."""
 
     config: "NodeShutdownAction.ConfigSchema"
@@ -61,7 +61,7 @@ class NodeShutdownAction(NodeAbstractAction, identifier="node_shutdown"):
         verb: ClassVar[str] = "shutdown"
 
 
-class NodeStartupAction(NodeAbstractAction, identifier="node_startup"):
+class NodeStartupAction(NodeAbstractAction, discriminator="node_startup"):
     """Action which starts up a node."""
 
     config: "NodeStartupAction.ConfigSchema"
@@ -72,7 +72,7 @@ class NodeStartupAction(NodeAbstractAction, identifier="node_startup"):
         verb: ClassVar[str] = "startup"
 
 
-class NodeResetAction(NodeAbstractAction, identifier="node_reset"):
+class NodeResetAction(NodeAbstractAction, discriminator="node_reset"):
     """Action which resets a node."""
 
     config: "NodeResetAction.ConfigSchema"
@@ -83,7 +83,7 @@ class NodeResetAction(NodeAbstractAction, identifier="node_reset"):
         verb: ClassVar[str] = "reset"
 
 
-class NodeNMAPAbstractAction(AbstractAction, identifier="node_nmap_abstract_action"):
+class NodeNMAPAbstractAction(AbstractAction, discriminator="node_nmap_abstract_action"):
     """Base class for NodeNMAP actions."""
 
     config: "NodeNMAPAbstractAction.ConfigSchema"
@@ -103,7 +103,7 @@ class NodeNMAPAbstractAction(AbstractAction, identifier="node_nmap_abstract_acti
         pass
 
 
-class NodeNMAPPingScanAction(NodeNMAPAbstractAction, identifier="node_nmap_ping_scan"):
+class NodeNMAPPingScanAction(NodeNMAPAbstractAction, discriminator="node_nmap_ping_scan"):
     """Action which performs an NMAP ping scan."""
 
     config: "NodeNMAPPingScanAction.ConfigSchema"
@@ -122,7 +122,7 @@ class NodeNMAPPingScanAction(NodeNMAPAbstractAction, identifier="node_nmap_ping_
         ]
 
 
-class NodeNMAPPortScanAction(NodeNMAPAbstractAction, identifier="node_nmap_port_scan"):
+class NodeNMAPPortScanAction(NodeNMAPAbstractAction, discriminator="node_nmap_port_scan"):
     """Action which performs an NMAP port scan."""
 
     config: "NodeNMAPPortScanAction.ConfigSchema"
@@ -154,7 +154,7 @@ class NodeNMAPPortScanAction(NodeNMAPAbstractAction, identifier="node_nmap_port_
         ]
 
 
-class NodeNetworkServiceReconAction(NodeNMAPAbstractAction, identifier="node_network_service_recon"):
+class NodeNetworkServiceReconAction(NodeNMAPAbstractAction, discriminator="node_network_service_recon"):
     """Action which performs an NMAP network service recon (ping scan followed by port scan)."""
 
     config: "NodeNetworkServiceReconAction.ConfigSchema"

src/primaite/game/agent/actions/service.py

@@ -17,7 +17,7 @@ __all__ = (
 )
 
 
-class NodeServiceAbstractAction(AbstractAction, identifier="node_service_abstract"):
+class NodeServiceAbstractAction(AbstractAction, discriminator="node_service_abstract"):
     """Abstract Action for Node Service related actions.
 
     Any actions which use node_name and service_name can inherit from this class.
@@ -36,7 +36,7 @@ class NodeServiceAbstractAction(AbstractAction, identifier="node_service_abstrac
         return ["network", "node", config.node_name, "service", config.service_name, config.verb]
 
 
-class NodeServiceScanAction(NodeServiceAbstractAction, identifier="node_service_scan"):
+class NodeServiceScanAction(NodeServiceAbstractAction, discriminator="node_service_scan"):
     """Action which scans a service."""
 
     config: "NodeServiceScanAction.ConfigSchema"
@@ -47,7 +47,7 @@ class NodeServiceScanAction(NodeServiceAbstractAction, identifier="node_service_
         verb: ClassVar[str] = "scan"
 
 
-class NodeServiceStopAction(NodeServiceAbstractAction, identifier="node_service_stop"):
+class NodeServiceStopAction(NodeServiceAbstractAction, discriminator="node_service_stop"):
     """Action which stops a service."""
 
     config: "NodeServiceStopAction.ConfigSchema"
@@ -58,7 +58,7 @@ class NodeServiceStopAction(NodeServiceAbstractAction, identifier="node_service_
         verb: ClassVar[str] = "stop"
 
 
-class NodeServiceStartAction(NodeServiceAbstractAction, identifier="node_service_start"):
+class NodeServiceStartAction(NodeServiceAbstractAction, discriminator="node_service_start"):
     """Action which starts a service."""
 
     config: "NodeServiceStartAction.ConfigSchema"
@@ -69,7 +69,7 @@ class NodeServiceStartAction(NodeServiceAbstractAction, identifier="node_service
         verb: ClassVar[str] = "start"
 
 
-class NodeServicePauseAction(NodeServiceAbstractAction, identifier="node_service_pause"):
+class NodeServicePauseAction(NodeServiceAbstractAction, discriminator="node_service_pause"):
     """Action which pauses a service."""
 
     config: "NodeServicePauseAction.ConfigSchema"
@@ -80,7 +80,7 @@ class NodeServicePauseAction(NodeServiceAbstractAction, identifier="node_service
         verb: ClassVar[str] = "pause"
 
 
-class NodeServiceResumeAction(NodeServiceAbstractAction, identifier="node_service_resume"):
+class NodeServiceResumeAction(NodeServiceAbstractAction, discriminator="node_service_resume"):
     """Action which resumes a service."""
 
     config: "NodeServiceResumeAction.ConfigSchema"
@@ -91,7 +91,7 @@ class NodeServiceResumeAction(NodeServiceAbstractAction, identifier="node_servic
         verb: ClassVar[str] = "resume"
 
 
-class NodeServiceRestartAction(NodeServiceAbstractAction, identifier="node_service_restart"):
+class NodeServiceRestartAction(NodeServiceAbstractAction, discriminator="node_service_restart"):
     """Action which restarts a service."""
 
     config: "NodeServiceRestartAction.ConfigSchema"
@@ -102,7 +102,7 @@ class NodeServiceRestartAction(NodeServiceAbstractAction, identifier="node_servi
         verb: ClassVar[str] = "restart"
 
 
-class NodeServiceDisableAction(NodeServiceAbstractAction, identifier="node_service_disable"):
+class NodeServiceDisableAction(NodeServiceAbstractAction, discriminator="node_service_disable"):
     """Action which disables a service."""
 
     config: "NodeServiceDisableAction.ConfigSchema"
@@ -113,7 +113,7 @@ class NodeServiceDisableAction(NodeServiceAbstractAction, identifier="node_servi
         verb: ClassVar[str] = "disable"
 
 
-class NodeServiceEnableAction(NodeServiceAbstractAction, identifier="node_service_enable"):
+class NodeServiceEnableAction(NodeServiceAbstractAction, discriminator="node_service_enable"):
     """Action which enables a service."""
 
     config: "NodeServiceEnableAction.ConfigSchema"
@@ -124,7 +124,7 @@ class NodeServiceEnableAction(NodeServiceAbstractAction, identifier="node_servic
         verb: ClassVar[str] = "enable"
 
 
-class NodeServiceFixAction(NodeServiceAbstractAction, identifier="node_service_fix"):
+class NodeServiceFixAction(NodeServiceAbstractAction, discriminator="node_service_fix"):
     """Action which fixes a service."""
 
     config: "NodeServiceFixAction.ConfigSchema"

src/primaite/game/agent/actions/session.py

@@ -11,7 +11,7 @@ __all__ = (
 )
 
 
-class NodeSessionAbstractAction(AbstractAction, identifier="node_session_abstract"):
+class NodeSessionAbstractAction(AbstractAction, discriminator="node_session_abstract"):
     """Base class for NodeSession actions."""
 
     config: "NodeSessionAbstractAction.ConfigSchema"
@@ -33,7 +33,7 @@ class NodeSessionAbstractAction(AbstractAction, identifier="node_session_abstrac
         pass
 
 
-class NodeSessionsRemoteLoginAction(NodeSessionAbstractAction, identifier="node_session_remote_login"):
+class NodeSessionsRemoteLoginAction(NodeSessionAbstractAction, discriminator="node_session_remote_login"):
     """Action which performs a remote session login."""
 
     config: "NodeSessionsRemoteLoginAction.ConfigSchema"
@@ -62,7 +62,7 @@ class NodeSessionsRemoteLoginAction(NodeSessionAbstractAction, identifier="node_
         ]
 
 
-class NodeSessionsRemoteLogoutAction(NodeSessionAbstractAction, identifier="node_session_remote_logoff"):
+class NodeSessionsRemoteLogoutAction(NodeSessionAbstractAction, discriminator="node_session_remote_logoff"):
     """Action which performs a remote session logout."""
 
     config: "NodeSessionsRemoteLogoutAction.ConfigSchema"
@@ -80,7 +80,7 @@ class NodeSessionsRemoteLogoutAction(NodeSessionAbstractAction, identifier="node
         return ["network", "node", config.node_name, "service", "Terminal", config.verb, config.remote_ip]
 
 
-class NodeAccountChangePasswordAction(NodeSessionAbstractAction, identifier="node_account_change_password"):
+class NodeAccountChangePasswordAction(NodeSessionAbstractAction, discriminator="node_account_change_password"):
     """Action which changes the password for a user."""
 
     config: "NodeAccountChangePasswordAction.ConfigSchema"

src/primaite/game/agent/actions/software.py

@@ -22,7 +22,7 @@ __all__ = (
 )
 
 
-class ConfigureRansomwareScriptAction(AbstractAction, identifier="configure_ransomware_script"):
+class ConfigureRansomwareScriptAction(AbstractAction, discriminator="configure_ransomware_script"):
     """Action which sets config parameters for a ransomware script on a node."""
 
     config: "ConfigureRansomwareScriptAction.ConfigSchema"
@@ -48,7 +48,9 @@ class ConfigureRansomwareScriptAction(AbstractAction, identifier="configure_rans
         return ["network", "node", config.node_name, "application", "RansomwareScript", "configure", data]
 
 
-class RansomwareConfigureC2ServerAction(ConfigureRansomwareScriptAction, identifier="c2_server_ransomware_configure"):
+class RansomwareConfigureC2ServerAction(
+    ConfigureRansomwareScriptAction, discriminator="c2_server_ransomware_configure"
+):
     """Action which causes a C2 server to send a command to set options on a ransomware script remotely."""
 
     @classmethod
@@ -59,7 +61,7 @@ class RansomwareConfigureC2ServerAction(ConfigureRansomwareScriptAction, identif
         return ["network", "node", config.node_name, "application", "C2Server", "ransomware_configure", data]
 
 
-class ConfigureDoSBotAction(AbstractAction, identifier="configure_dos_bot"):
+class ConfigureDoSBotAction(AbstractAction, discriminator="configure_dos_bot"):
     """Action which sets config parameters for a DoS bot on a node."""
 
     class ConfigSchema(AbstractAction.ConfigSchema):
@@ -91,7 +93,7 @@ class ConfigureDoSBotAction(AbstractAction, identifier="configure_dos_bot"):
         return ["network", "node", config.node_name, "application", "DoSBot", "configure", data]
 
 
-class ConfigureC2BeaconAction(AbstractAction, identifier="configure_c2_beacon"):
+class ConfigureC2BeaconAction(AbstractAction, discriminator="configure_c2_beacon"):
     """Action which configures a C2 Beacon based on the parameters given."""
 
     class ConfigSchema(AbstractAction.ConfigSchema):
@@ -115,7 +117,7 @@ class ConfigureC2BeaconAction(AbstractAction, identifier="configure_c2_beacon"):
         return ["network", "node", config.node_name, "application", "C2Beacon", "configure", data]
 
 
-class NodeSendRemoteCommandAction(AbstractAction, identifier="node_send_remote_command"):
+class NodeSendRemoteCommandAction(AbstractAction, discriminator="node_send_remote_command"):
     """Action which sends a terminal command to a remote node via SSH."""
 
     config: "NodeSendRemoteCommandAction.ConfigSchema"
@@ -142,7 +144,7 @@ class NodeSendRemoteCommandAction(AbstractAction, identifier="node_send_remote_c
         ]
 
 
-class TerminalC2ServerAction(AbstractAction, identifier="c2_server_terminal_command"):
+class TerminalC2ServerAction(AbstractAction, discriminator="c2_server_terminal_command"):
     """Action which causes the C2 Server to send a command to the C2 Beacon to execute the terminal command passed."""
 
     config: "TerminalC2ServerAction.ConfigSchema"
@@ -171,7 +173,7 @@ class TerminalC2ServerAction(AbstractAction, identifier="c2_server_terminal_comm
         return ["network", "node", config.node_name, "application", "C2Server", "terminal_command", command_model]
 
 
-class RansomwareLaunchC2ServerAction(AbstractAction, identifier="c2_server_ransomware_launch"):
+class RansomwareLaunchC2ServerAction(AbstractAction, discriminator="c2_server_ransomware_launch"):
     """Action which causes the C2 Server to send a command to the C2 Beacon to launch the RansomwareScript."""
 
     config: "RansomwareLaunchC2ServerAction.ConfigSchema"
@@ -190,7 +192,7 @@ class RansomwareLaunchC2ServerAction(AbstractAction, identifier="c2_server_ranso
         return ["network", "node", config.node_name, "application", "C2Server", "ransomware_launch"]
 
 
-class ExfiltrationC2ServerAction(AbstractAction, identifier="c2_server_data_exfiltrate"):
+class ExfiltrationC2ServerAction(AbstractAction, discriminator="c2_server_data_exfiltrate"):
     """Action which exfiltrates a target file from a certain node onto the C2 beacon and then the C2 Server."""
 
     config: "ExfiltrationC2ServerAction.ConfigSchema"
@@ -223,7 +225,7 @@ class ExfiltrationC2ServerAction(AbstractAction, identifier="c2_server_data_exfi
         return ["network", "node", config.node_name, "application", "C2Server", "exfiltrate", command_model]
 
 
-class ConfigureDatabaseClientAction(AbstractAction, identifier="configure_database_client"):
+class ConfigureDatabaseClientAction(AbstractAction, discriminator="configure_database_client"):
     """Action which sets config parameters for a database client on a node."""
 
     config: "ConfigureDatabaseClientAction.ConfigSchema"

src/primaite/game/agent/interface.py

@@ -79,13 +79,13 @@ class AbstractAgent(BaseModel, ABC):
 
     _registry: ClassVar[Dict[str, Type[AbstractAgent]]] = {}
 
-    def __init_subclass__(cls, identifier: Optional[str] = None, **kwargs: Any) -> None:
+    def __init_subclass__(cls, discriminator: Optional[str] = None, **kwargs: Any) -> None:
         super().__init_subclass__(**kwargs)
-        if identifier is None:
+        if discriminator is None:
             return
-        if identifier in cls._registry:
-            raise ValueError(f"Cannot create a new agent under reserved name {identifier}")
-        cls._registry[identifier] = cls
+        if discriminator in cls._registry:
+            raise ValueError(f"Cannot create a new agent under reserved name {discriminator}")
+        cls._registry[discriminator] = cls
 
     def model_post_init(self, __context: Any) -> None:
         """Overwrite the default empty action, observation, and rewards with ones defined through the config."""
@@ -161,7 +161,7 @@ class AbstractAgent(BaseModel, ABC):
         return agent_class(config=config)
 
 
-class AbstractScriptedAgent(AbstractAgent, identifier="AbstractScriptedAgent"):
+class AbstractScriptedAgent(AbstractAgent, discriminator="AbstractScriptedAgent"):
     """Base class for actors which generate their own behaviour."""
 
     config: "AbstractScriptedAgent.ConfigSchema" = Field(default_factory=lambda: AbstractScriptedAgent.ConfigSchema())
@@ -177,7 +177,7 @@ class AbstractScriptedAgent(AbstractAgent, identifier="AbstractScriptedAgent"):
         return super().get_action(obs=obs, timestep=timestep)
 
 
-class ProxyAgent(AbstractAgent, identifier="ProxyAgent"):
+class ProxyAgent(AbstractAgent, discriminator="ProxyAgent"):
     """Agent that sends observations to an RL model and receives actions from that model."""
 
     config: "ProxyAgent.ConfigSchema" = Field(default_factory=lambda: ProxyAgent.ConfigSchema())

src/primaite/game/agent/observations/acl_observation.py

@@ -16,7 +16,7 @@ from primaite.utils.validation.port import Port
 _LOGGER = getLogger(__name__)
 
 
-class ACLObservation(AbstractObservation, identifier="ACL"):
+class ACLObservation(AbstractObservation, discriminator="ACL"):
     """ACL observation, provides information about access control lists within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/file_system_observations.py

@@ -13,7 +13,7 @@ from primaite.game.agent.utils import access_from_nested_dict, NOT_PRESENT_IN_ST
 _LOGGER = getLogger(__name__)
 
 
-class FileObservation(AbstractObservation, identifier="FILE"):
+class FileObservation(AbstractObservation, discriminator="FILE"):
     """File observation, provides status information about a file within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):
@@ -125,7 +125,7 @@ class FileObservation(AbstractObservation, identifier="FILE"):
         )
 
 
-class FolderObservation(AbstractObservation, identifier="FOLDER"):
+class FolderObservation(AbstractObservation, discriminator="FOLDER"):
     """Folder observation, provides status information about a folder within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/firewall_observation.py

@@ -18,7 +18,7 @@ from primaite.utils.validation.port import Port
 _LOGGER = getLogger(__name__)
 
 
-class FirewallObservation(AbstractObservation, identifier="FIREWALL"):
+class FirewallObservation(AbstractObservation, discriminator="FIREWALL"):
     """Firewall observation, provides status information about a firewall within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/host_observations.py

@@ -18,7 +18,7 @@ from primaite.utils.validation.port import Port
 _LOGGER = getLogger(__name__)
 
 
-class HostObservation(AbstractObservation, identifier="HOST"):
+class HostObservation(AbstractObservation, discriminator="HOST"):
     """Host observation, provides status information about a host within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/link_observation.py

@@ -13,7 +13,7 @@ from primaite.game.agent.utils import access_from_nested_dict, NOT_PRESENT_IN_ST
 _LOGGER = getLogger(__name__)
 
 
-class LinkObservation(AbstractObservation, identifier="LINK"):
+class LinkObservation(AbstractObservation, discriminator="LINK"):
     """Link observation, providing information about a specific link within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):
@@ -90,7 +90,7 @@ class LinkObservation(AbstractObservation, identifier="LINK"):
         return cls(where=where)
 
 
-class LinksObservation(AbstractObservation, identifier="LINKS"):
+class LinksObservation(AbstractObservation, discriminator="LINKS"):
     """Collection of link observations representing multiple links within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/nic_observations.py

@@ -12,7 +12,7 @@ from primaite.utils.validation.ip_protocol import IPProtocol
 from primaite.utils.validation.port import Port
 
 
-class NICObservation(AbstractObservation, identifier="NETWORK_INTERFACE"):
+class NICObservation(AbstractObservation, discriminator="NETWORK_INTERFACE"):
     """Status information about a network interface within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):
@@ -227,7 +227,7 @@ class NICObservation(AbstractObservation, identifier="NETWORK_INTERFACE"):
         )
 
 
-class PortObservation(AbstractObservation, identifier="PORT"):
+class PortObservation(AbstractObservation, discriminator="PORT"):
     """Port observation, provides status information about a network port within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/node_observations.py

@@ -19,7 +19,7 @@ from primaite.utils.validation.port import Port
 _LOGGER = getLogger(__name__)
 
 
-class NodesObservation(AbstractObservation, identifier="NODES"):
+class NodesObservation(AbstractObservation, discriminator="NODES"):
     """Nodes observation, provides status information about nodes within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/observation_manager.py

@@ -11,7 +11,7 @@ from pydantic import BaseModel, computed_field, ConfigDict, Field, model_validat
 from primaite.game.agent.observations.observations import AbstractObservation, WhereType
 
 
-class NestedObservation(AbstractObservation, identifier="CUSTOM"):
+class NestedObservation(AbstractObservation, discriminator="CUSTOM"):
     """Observation type that allows combining other observations into a gymnasium.spaces.Dict space."""
 
     class NestedObservationItem(BaseModel):
@@ -19,7 +19,7 @@ class NestedObservation(AbstractObservation, identifier="CUSTOM"):
 
         model_config = ConfigDict(extra="forbid")
         type: str
-        """Select observation class. It maps to the identifier of the obs class by checking the registry."""
+        """Select observation class. It maps to the discriminator of the obs class by checking the registry."""
         label: str
         """Dict key in the final observation space."""
         options: Dict
@@ -119,7 +119,7 @@ class NestedObservation(AbstractObservation, identifier="CUSTOM"):
         return cls(components=instances)
 
 
-class NullObservation(AbstractObservation, identifier="NONE"):
+class NullObservation(AbstractObservation, discriminator="NONE"):
     """Empty observation that acts as a placeholder."""
 
     def __init__(self) -> None:
@@ -158,7 +158,7 @@ class ObservationManager(BaseModel):
 
         model_config = ConfigDict(extra="forbid")
         type: str = "NONE"
-        """Identifier name for the top-level observation."""
+        """discriminator name for the top-level observation."""
         options: AbstractObservation.ConfigSchema = Field(
             default_factory=lambda: NullObservation.ConfigSchema(), validate_default=True
         )
@@ -235,7 +235,7 @@ class ObservationManager(BaseModel):
         :param config: Dictionary containing the configuration for this observation space.
             If None, a blank observation space is created.
             Otherwise, this must be a Dict with a type field and options field.
-            type: string that corresponds to one of the observation identifiers that are provided when subclassing
+            type: string that corresponds to one of the observation discriminators that are provided when subclassing
             AbstractObservation
             options: this must adhere to the chosen observation type's ConfigSchema nested class.
         :type config: Dict

src/primaite/game/agent/observations/observations.py

@@ -31,20 +31,20 @@ class AbstractObservation(ABC):
         """Initialise an observation. This method must be overwritten."""
         self.default_observation: ObsType
 
-    def __init_subclass__(cls, identifier: Optional[str] = None, **kwargs: Any) -> None:
+    def __init_subclass__(cls, discriminator: Optional[str] = None, **kwargs: Any) -> None:
         """
         Register an observation type.
 
-        :param identifier: Identifier used to uniquely specify observation component types.
-        :type identifier: str
+        :param discriminator: discriminator used to uniquely specify observation component types.
+        :type discriminator: str
         :raises ValueError: When attempting to create a component with a name that is already in use.
         """
         super().__init_subclass__(**kwargs)
-        if identifier is None:
+        if discriminator is None:
             return
-        if identifier in cls._registry:
-            raise ValueError(f"Duplicate observation component type {identifier}")
-        cls._registry[identifier] = cls
+        if discriminator in cls._registry:
+            raise ValueError(f"Duplicate observation component type {discriminator}")
+        cls._registry[discriminator] = cls
 
     @abstractmethod
     def observe(self, state: Dict) -> Any:

src/primaite/game/agent/observations/router_observation.py

@@ -18,7 +18,7 @@ from primaite.utils.validation.port import Port
 _LOGGER = getLogger(__name__)
 
 
-class RouterObservation(AbstractObservation, identifier="ROUTER"):
+class RouterObservation(AbstractObservation, discriminator="ROUTER"):
     """Router observation, provides status information about a router within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/observations/software_observation.py

@@ -10,7 +10,7 @@ from primaite.game.agent.observations.observations import AbstractObservation, W
 from primaite.game.agent.utils import access_from_nested_dict, NOT_PRESENT_IN_STATE
 
 
-class ServiceObservation(AbstractObservation, identifier="SERVICE"):
+class ServiceObservation(AbstractObservation, discriminator="SERVICE"):
     """Service observation, shows status of a service in the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):
@@ -73,7 +73,7 @@ class ServiceObservation(AbstractObservation, identifier="SERVICE"):
         return cls(where=parent_where + ["services", config.service_name])
 
 
-class ApplicationObservation(AbstractObservation, identifier="APPLICATION"):
+class ApplicationObservation(AbstractObservation, discriminator="APPLICATION"):
     """Application observation, shows the status of an application within the simulation environment."""
 
     class ConfigSchema(AbstractObservation.ConfigSchema):

src/primaite/game/agent/rewards.py

@@ -55,13 +55,13 @@ class AbstractReward(BaseModel):
 
     _registry: ClassVar[Dict[str, Type["AbstractReward"]]] = {}
 
-    def __init_subclass__(cls, identifier: Optional[str] = None, **kwargs: Any) -> None:
+    def __init_subclass__(cls, discriminator: Optional[str] = None, **kwargs: Any) -> None:
         super().__init_subclass__(**kwargs)
-        if identifier is None:
+        if discriminator is None:
             return
-        if identifier in cls._registry:
-            raise ValueError(f"Duplicate reward {identifier}")
-        cls._registry[identifier] = cls
+        if discriminator in cls._registry:
+            raise ValueError(f"Duplicate reward {discriminator}")
+        cls._registry[discriminator] = cls
 
     @classmethod
     def from_config(cls, config: Dict) -> "AbstractReward":
@@ -92,7 +92,7 @@ class AbstractReward(BaseModel):
         return 0.0
 
 
-class DummyReward(AbstractReward, identifier="DUMMY"):
+class DummyReward(AbstractReward, discriminator="DUMMY"):
     """Dummy reward function component which always returns 0.0."""
 
     def calculate(self, state: Dict, last_action_response: "AgentHistoryItem") -> float:
@@ -108,7 +108,7 @@ class DummyReward(AbstractReward, identifier="DUMMY"):
         return 0.0
 
 
-class DatabaseFileIntegrity(AbstractReward, identifier="DATABASE_FILE_INTEGRITY"):
+class DatabaseFileIntegrity(AbstractReward, discriminator="DATABASE_FILE_INTEGRITY"):
     """Reward function component which rewards the agent for maintaining the integrity of a database file."""
 
     config: "DatabaseFileIntegrity.ConfigSchema"
@@ -161,7 +161,7 @@ class DatabaseFileIntegrity(AbstractReward, identifier="DATABASE_FILE_INTEGRITY"
             return 0
 
 
-class WebServer404Penalty(AbstractReward, identifier="WEB_SERVER_404_PENALTY"):
+class WebServer404Penalty(AbstractReward, discriminator="WEB_SERVER_404_PENALTY"):
     """Reward function component which penalises the agent when the web server returns a 404 error."""
 
     config: "WebServer404Penalty.ConfigSchema"
@@ -215,7 +215,7 @@ class WebServer404Penalty(AbstractReward, identifier="WEB_SERVER_404_PENALTY"):
         return self.reward
 
 
-class WebpageUnavailablePenalty(AbstractReward, identifier="WEBPAGE_UNAVAILABLE_PENALTY"):
+class WebpageUnavailablePenalty(AbstractReward, discriminator="WEBPAGE_UNAVAILABLE_PENALTY"):
     """Penalises the agent when the web browser fails to fetch a webpage."""
 
     config: "WebpageUnavailablePenalty.ConfigSchema"
@@ -289,7 +289,7 @@ class WebpageUnavailablePenalty(AbstractReward, identifier="WEBPAGE_UNAVAILABLE_
         return self.reward
 
 
-class GreenAdminDatabaseUnreachablePenalty(AbstractReward, identifier="GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY"):
+class GreenAdminDatabaseUnreachablePenalty(AbstractReward, discriminator="GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY"):
     """Penalises the agent when the green db clients fail to connect to the database."""
 
     config: "GreenAdminDatabaseUnreachablePenalty.ConfigSchema"
@@ -339,7 +339,7 @@ class GreenAdminDatabaseUnreachablePenalty(AbstractReward, identifier="GREEN_ADM
         return self.reward
 
 
-class SharedReward(AbstractReward, identifier="SHARED_REWARD"):
+class SharedReward(AbstractReward, discriminator="SHARED_REWARD"):
     """Adds another agent's reward to the overall reward."""
 
     config: "SharedReward.ConfigSchema"
@@ -376,7 +376,7 @@ class SharedReward(AbstractReward, identifier="SHARED_REWARD"):
         return self.callback(self.config.agent_name)
 
 
-class ActionPenalty(AbstractReward, identifier="ACTION_PENALTY"):
+class ActionPenalty(AbstractReward, discriminator="ACTION_PENALTY"):
     """Apply a negative reward when taking any action except do_nothing."""
 
     config: "ActionPenalty.ConfigSchema"

src/primaite/game/agent/scripted_agents/abstract_tap.py

@@ -13,7 +13,7 @@ from primaite.game.agent.scripted_agents.random_agent import PeriodicAgent
 __all__ = "AbstractTAPAgent"
 
 
-class AbstractTAPAgent(PeriodicAgent, identifier="AbstractTAP"):
+class AbstractTAPAgent(PeriodicAgent, discriminator="AbstractTAP"):
     """Base class for TAP agents to inherit from."""
 
     config: "AbstractTAPAgent.ConfigSchema" = Field(default_factory=lambda: AbstractTAPAgent.ConfigSchema())

src/primaite/game/agent/scripted_agents/data_manipulation_bot.py

@@ -9,7 +9,7 @@ from primaite.game.agent.scripted_agents.random_agent import PeriodicAgent
 __all__ = "DataManipulationAgent"
 
 
-class DataManipulationAgent(PeriodicAgent, identifier="RedDatabaseCorruptingAgent"):
+class DataManipulationAgent(PeriodicAgent, discriminator="RedDatabaseCorruptingAgent"):
     """Agent that uses a DataManipulationBot to perform an SQL injection attack."""
 
     class AgentSettingsSchema(PeriodicAgent.AgentSettingsSchema):

src/primaite/game/agent/scripted_agents/probabilistic_agent.py

@@ -13,7 +13,7 @@ from primaite.game.agent.interface import AbstractScriptedAgent
 __all__ = "ProbabilisticAgent"
 
 
-class ProbabilisticAgent(AbstractScriptedAgent, identifier="ProbabilisticAgent"):
+class ProbabilisticAgent(AbstractScriptedAgent, discriminator="ProbabilisticAgent"):
     """Scripted agent which randomly samples its action space with prescribed probabilities for each action."""
 
     rng: Generator = Field(default_factory=lambda: np.random.default_rng(np.random.randint(0, 65535)))

src/primaite/game/agent/scripted_agents/random_agent.py

@@ -11,7 +11,7 @@ from primaite.game.agent.interface import AbstractScriptedAgent
 __all__ = ("RandomAgent", "PeriodicAgent")
 
 
-class RandomAgent(AbstractScriptedAgent, identifier="RandomAgent"):
+class RandomAgent(AbstractScriptedAgent, discriminator="RandomAgent"):
     """Agent that ignores its observation and acts completely at random."""
 
     config: "RandomAgent.ConfigSchema" = Field(default_factory=lambda: RandomAgent.ConfigSchema())
@@ -34,7 +34,7 @@ class RandomAgent(AbstractScriptedAgent, identifier="RandomAgent"):
         return self.action_manager.get_action(self.action_manager.space.sample())
 
 
-class PeriodicAgent(AbstractScriptedAgent, identifier="PeriodicAgent"):
+class PeriodicAgent(AbstractScriptedAgent, discriminator="PeriodicAgent"):
     """Agent that does nothing most of the time, but executes application at regular intervals (with variance)."""
 
     config: "PeriodicAgent.ConfigSchema" = Field(default_factory=lambda: PeriodicAgent.ConfigSchema())