Merge remote-tracking branch 'origin/dev' into feature/2402-add-acl-actions-for-routers-and-firewalls

src/primaite/simulator/network/hardware/base.py

@@ -5,7 +5,7 @@ import secrets
 from abc import ABC, abstractmethod
 from ipaddress import IPv4Address, IPv4Network
 from pathlib import Path
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional, Type, TypeVar, Union
 
 from prettytable import MARKDOWN, PrettyTable
 from pydantic import BaseModel, Field
@@ -35,8 +35,11 @@ from primaite.simulator.system.core.software_manager import SoftwareManager
 from primaite.simulator.system.core.sys_log import SysLog
 from primaite.simulator.system.processes.process import Process
 from primaite.simulator.system.services.service import Service
+from primaite.simulator.system.software import IOSoftware
 from primaite.utils.validators import IPV4Address
 
+IOSoftwareClass = TypeVar("IOSoftwareClass", bound=IOSoftware)
+
 _LOGGER = getLogger(__name__)
 
 
@@ -843,12 +846,58 @@ class Node(SimComponent):
         )
         rm.add_request("os", RequestType(func=self._os_request_manager, validator=_node_is_on))
 
+        self._software_request_manager = RequestManager()
+        rm.add_request("software_manager", RequestType(func=self._software_request_manager, validator=_node_is_on))
+        self._application_manager = RequestManager()
+        self._software_request_manager.add_request(
+            name="application", request_type=RequestType(func=self._application_manager)
+        )
+
+        self._application_manager.add_request(
+            name="install",
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(
+                    self.application_install_action(
+                        application=self._read_application_type(request[0]), ip_address=request[1]
+                    )
+                )
+            ),
+        )
+
+        self._application_manager.add_request(
+            name="uninstall",
+            request_type=RequestType(
+                func=lambda request, context: RequestResponse.from_bool(
+                    self.application_uninstall_action(application=self._read_application_type(request[0]))
+                )
+            ),
+        )
+
         return rm
 
     def _install_system_software(self):
         """Install System Software - software that is usually provided with the OS."""
         pass
 
+    def _read_application_type(self, application_class_str: str) -> Type[IOSoftwareClass]:
+        """Wrapper that converts the string from the request manager into the appropriate class for the application."""
+        if application_class_str == "DoSBot":
+            from primaite.simulator.system.applications.red_applications.dos_bot import DoSBot
+
+            return DoSBot
+        elif application_class_str == "DataManipulationBot":
+            from primaite.simulator.system.applications.red_applications.data_manipulation_bot import (
+                DataManipulationBot,
+            )
+
+            return DataManipulationBot
+        elif application_class_str == "WebBrowser":
+            from primaite.simulator.system.applications.web_browser import WebBrowser
+
+            return WebBrowser
+        else:
+            return 0
+
     def describe_state(self) -> Dict:
         """
         Produce a dictionary describing the current state of this object.
@@ -1257,6 +1306,75 @@ class Node(SimComponent):
         _LOGGER.info(f"Removed application {application.name} from node {self.hostname}")
         self._application_request_manager.remove_request(application.name)
 
+    def application_install_action(self, application: Application, ip_address: Optional[str] = None) -> bool:
+        """
+        Install an application on this node and configure it.
+
+        This method is useful for allowing agents to take this action.
+
+        :param application: Application object that has not been installed on any node yet.
+        :type application: Application
+        :param ip_address: IP address used to configure the application
+        (target IP for the DoSBot or server IP for the DataManipulationBot)
+        :type ip_address: str
+        :return: True if the application is installed successfully, otherwise False.
+        """
+        if application in self:
+            _LOGGER.warning(
+                f"Can't add application {application.__name__}" + f"to node {self.hostname}. It's already installed."
+            )
+            return True
+
+        self.software_manager.install(application)
+        application_instance = self.software_manager.software.get(str(application.__name__))
+        self.applications[application_instance.uuid] = application_instance
+        self.sys_log.info(f"Installed application {application_instance.name}")
+        _LOGGER.debug(f"Added application {application_instance.name} to node {self.hostname}")
+        self._application_request_manager.add_request(
+            application_instance.name, RequestType(func=application_instance._request_manager)
+        )
+
+        # Configure application if additional parameters are given
+        if ip_address:
+            if application_instance.name == "DoSBot":
+                application_instance.configure(target_ip_address=IPv4Address(ip_address))
+            elif application_instance.name == "DataManipulationBot":
+                application_instance.configure(server_ip_address=IPv4Address(ip_address))
+            else:
+                pass
+
+        if application_instance.name in self.software_manager.software:
+            return True
+        else:
+            return False
+
+    def application_uninstall_action(self, application: Application) -> bool:
+        """
+        Uninstall and completely remove application from this node.
+
+        This method is useful for allowing agents to take this action.
+
+        :param application: Application object that is currently associated with this node.
+        :type application: Application
+        :return: True if the application is uninstalled successfully, otherwise False.
+        """
+        if application.__name__ not in self.software_manager.software:
+            _LOGGER.warning(
+                f"Can't remove application {application.__name__}" + f"from node {self.hostname}. It's not installed."
+            )
+            return True
+
+        application_instance = self.software_manager.software.get(
+            str(application.__name__)
+        )  # This works because we can't have two applications with the same name on the same node
+        # self.uninstall_application(application_instance)
+        self.software_manager.uninstall(application_instance.name)
+
+        if application_instance.name not in self.software_manager.software:
+            return True
+        else:
+            return False
+
     def _shut_down_actions(self):
         """Actions to perform when the node is shut down."""
         # Turn off all the services in the node
@@ -1288,4 +1406,6 @@ class Node(SimComponent):
     def __contains__(self, item: Any) -> bool:
         if isinstance(item, Service):
             return item.uuid in self.services
+        elif isinstance(item, Application):
+            return item.uuid in self.applications
         return None