Merge branch 'dev' into feature/1816_Database-Service-(Network-and-User-Interaction)

src/primaite/simulator/system/services/red_services/data_manipulator_service.py

@@ -0,0 +1,34 @@
+from ipaddress import IPv4Address
+from typing import Any, Optional
+
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.services.service import Service
+
+
+class DataManipulatorService(Service):
+    """
+    Red Agent Data Integration Service.
+
+    The Service represents a bot that causes files/folders in the File System to
+    become corrupted.
+    """
+
+    def __init__(self, **kwargs):
+        kwargs["name"] = "DataManipulatorBot"
+        kwargs["port"] = Port.POSTGRES_SERVER
+        kwargs["protocol"] = IPProtocol.TCP
+        super().__init__(**kwargs)
+
+    def start(self, target_ip_address: IPv4Address, payload: Optional[Any] = "DELETE TABLE users", **kwargs):
+        """
+        Run the DataManipulatorService actions.
+
+        :param: target_ip_address: The IP address of the target machine to attack
+        :param: payload: The payload to send to the target machine
+        """
+        super().start()
+
+        self.software_manager.send_payload_to_session_manager(
+            payload=payload, dest_ip_address=target_ip_address, dest_port=self.port
+        )

src/primaite/simulator/system/services/service.py

@@ -1,4 +1,3 @@
-from abc import abstractmethod
 from enum import Enum
 from typing import Any, Dict, Optional
 
@@ -33,7 +32,7 @@ class Service(IOSoftware):
     Services are programs that run in the background and may perform input/output operations.
     """
 
-    operating_state: ServiceOperatingState
+    operating_state: ServiceOperatingState = ServiceOperatingState.STOPPED
     "The current operating state of the Service."
     restart_duration: int = 5
     "How many timesteps does it take to restart this service."
@@ -51,7 +50,6 @@ class Service(IOSoftware):
         am.add_action("enable", Action(func=lambda request, context: self.enable()))
         return am
 
-    @abstractmethod
     def describe_state(self) -> Dict:
         """
         Produce a dictionary describing the current state of this object.
@@ -102,49 +100,49 @@ class Service(IOSoftware):
         """Stop the service."""
         _LOGGER.debug(f"Stopping service {self.name}")
         if self.operating_state in [ServiceOperatingState.RUNNING, ServiceOperatingState.PAUSED]:
-            self.parent.sys_log.info(f"Stopping service {self.name}")
+            self.sys_log.info(f"Stopping service {self.name}")
             self.operating_state = ServiceOperatingState.STOPPED
 
-    def start(self) -> None:
+    def start(self, **kwargs) -> None:
         """Start the service."""
         _LOGGER.debug(f"Starting service {self.name}")
         if self.operating_state == ServiceOperatingState.STOPPED:
-            self.parent.sys_log.info(f"Starting service {self.name}")
+            self.sys_log.info(f"Starting service {self.name}")
             self.operating_state = ServiceOperatingState.RUNNING
 
     def pause(self) -> None:
         """Pause the service."""
         _LOGGER.debug(f"Pausing service {self.name}")
         if self.operating_state == ServiceOperatingState.RUNNING:
-            self.parent.sys_log.info(f"Pausing service {self.name}")
+            self.sys_log.info(f"Pausing service {self.name}")
             self.operating_state = ServiceOperatingState.PAUSED
 
     def resume(self) -> None:
         """Resume paused service."""
         _LOGGER.debug(f"Resuming service {self.name}")
         if self.operating_state == ServiceOperatingState.PAUSED:
-            self.parent.sys_log.info(f"Resuming service {self.name}")
+            self.sys_log.info(f"Resuming service {self.name}")
             self.operating_state = ServiceOperatingState.RUNNING
 
     def restart(self) -> None:
         """Restart running service."""
         _LOGGER.debug(f"Restarting service {self.name}")
         if self.operating_state in [ServiceOperatingState.RUNNING, ServiceOperatingState.PAUSED]:
-            self.parent.sys_log.info(f"Pausing service {self.name}")
+            self.sys_log.info(f"Pausing service {self.name}")
             self.operating_state = ServiceOperatingState.RESTARTING
             self.restart_countdown = self.restarting_duration
 
     def disable(self) -> None:
         """Disable the service."""
         _LOGGER.debug(f"Disabling service {self.name}")
-        self.parent.sys_log.info(f"Disabling Application {self.name}")
+        self.sys_log.info(f"Disabling Application {self.name}")
         self.operating_state = ServiceOperatingState.DISABLED
 
     def enable(self) -> None:
         """Enable the disabled service."""
         _LOGGER.debug(f"Enabling service {self.name}")
         if self.operating_state == ServiceOperatingState.DISABLED:
-            self.parent.sys_log.info(f"Enabling Application {self.name}")
+            self.sys_log.info(f"Enabling Application {self.name}")
             self.operating_state = ServiceOperatingState.STOPPED
 
     def apply_timestep(self, timestep: int) -> None: