oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2470: changed default log level to warning + changed sys logging in code to be more aligned with severity of messages

Browse Source
This commit is contained in:
Czar Echavez
2024-04-19 11:37:52 +01:00
parent 833fd18936
commit b8d4a8cc8d
30 changed files with 87 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/primaite/config/_package_data/data_manipulation.yaml
View File

@@ -3,6 +3,7 @@ io_settings:
save_step_metadata: false save_step_metadata: false
save_pcap_logs: false save_pcap_logs: false
save_sys_logs: false save_sys_logs: false
sys_log_level: WARNING
game: game:

2
src/primaite/simulator/__init__.py
View File

@@ -31,7 +31,7 @@ class _SimOutput:
self.save_pcap_logs: bool = False self.save_pcap_logs: bool = False
self.save_sys_logs: bool = False self.save_sys_logs: bool = False
self.write_sys_log_to_terminal: bool = False self.write_sys_log_to_terminal: bool = False
self.sys_log_level: LogLevel = LogLevel.INFO # default log level is at INFO self.sys_log_level: LogLevel = LogLevel.WARNING # default log level is at WARNING
@property @property
def path(self) -> Path: def path(self) -> Path:

2
src/primaite/simulator/file_system/file.py
View File

@@ -223,5 +223,5 @@ class File(FileSystemItemABC):
self.num_access += 1 # file was accessed self.num_access += 1 # file was accessed
self.deleted = True self.deleted = True
self.sys_log.info(f"File deleted {self.folder_name}/{self.name}") self.sys_log.warning(f"File deleted {self.folder_name}/{self.name}")
return True return True

13
src/primaite/simulator/file_system/file_system.py
View File

@@ -6,7 +6,6 @@ from typing import Dict, Optional
from prettytable import MARKDOWN, PrettyTable from prettytable import MARKDOWN, PrettyTable
from primaite import getLogger
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import RequestManager, RequestType, SimComponent from primaite.simulator.core import RequestManager, RequestType, SimComponent
from primaite.simulator.file_system.file import File from primaite.simulator.file_system.file import File
@@ -14,8 +13,6 @@ from primaite.simulator.file_system.file_type import FileType
from primaite.simulator.file_system.folder import Folder from primaite.simulator.file_system.folder import Folder
from primaite.simulator.system.core.sys_log import SysLog from primaite.simulator.system.core.sys_log import SysLog
_LOGGER = getLogger(__name__)
class FileSystem(SimComponent): class FileSystem(SimComponent):
"""Class that contains all the simulation File System.""" """Class that contains all the simulation File System."""
@@ -163,11 +160,11 @@ class FileSystem(SimComponent):
:param folder_name: The name of the folder. :param folder_name: The name of the folder.
""" """
if folder_name == "root": if folder_name == "root":
self.sys_log.warning("Cannot delete the root folder.") self.sys_log.error("Cannot delete the root folder.")
return False return False
folder = self.get_folder(folder_name) folder = self.get_folder(folder_name)
if not folder: if not folder:
_LOGGER.debug(f"Cannot delete folder as it does not exist: {folder_name}") self.sys_log.error(f"Cannot delete folder as it does not exist: {folder_name}")
return False return False
# set folder to deleted state # set folder to deleted state
@@ -180,7 +177,7 @@ class FileSystem(SimComponent):
folder.remove_all_files() folder.remove_all_files()
self.deleted_folders[folder.uuid] = folder self.deleted_folders[folder.uuid] = folder
self.sys_log.info(f"Deleted folder /{folder.name} and its contents") self.sys_log.warning(f"Deleted folder /{folder.name} and its contents")
return True return True
def delete_folder_by_id(self, folder_uuid: str) -> None: def delete_folder_by_id(self, folder_uuid: str) -> None:
@@ -283,7 +280,7 @@ class FileSystem(SimComponent):
folder = self.get_folder(folder_name, include_deleted=include_deleted) folder = self.get_folder(folder_name, include_deleted=include_deleted)
if folder: if folder:
return folder.get_file(file_name, include_deleted=include_deleted) return folder.get_file(file_name, include_deleted=include_deleted)
self.sys_log.info(f"File not found /{folder_name}/{file_name}") self.sys_log.warning(f"File not found /{folder_name}/{file_name}")
def get_file_by_id( def get_file_by_id(
self, file_uuid: str, folder_uuid: Optional[str] = None, include_deleted: Optional[bool] = False self, file_uuid: str, folder_uuid: Optional[str] = None, include_deleted: Optional[bool] = False
@@ -499,7 +496,7 @@ class FileSystem(SimComponent):
""" """
folder = self.get_folder(folder_name=folder_name) folder = self.get_folder(folder_name=folder_name)
if not folder: if not folder:
_LOGGER.debug(f"Cannot restore file {file_name} in folder {folder_name} as the folder does not exist.") self.sys_log.error(f"Cannot restore file {file_name} in folder {folder_name} as the folder does not exist.")
return False return False
file = folder.get_file(file_name=file_name, include_deleted=True) file = folder.get_file(file_name=file_name, include_deleted=True)

5
src/primaite/simulator/file_system/folder.py
View File

@@ -4,14 +4,11 @@ from typing import Dict, Optional
from prettytable import MARKDOWN, PrettyTable from prettytable import MARKDOWN, PrettyTable
from primaite import getLogger
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import RequestManager, RequestType from primaite.simulator.core import RequestManager, RequestType
from primaite.simulator.file_system.file import File from primaite.simulator.file_system.file import File
from primaite.simulator.file_system.file_system_item_abc import FileSystemItemABC, FileSystemItemHealthStatus from primaite.simulator.file_system.file_system_item_abc import FileSystemItemABC, FileSystemItemHealthStatus
_LOGGER = getLogger(__name__)
class Folder(FileSystemItemABC): class Folder(FileSystemItemABC):
"""Simulation Folder.""" """Simulation Folder."""
@@ -254,7 +251,7 @@ class Folder(FileSystemItemABC):
file.delete() file.delete()
self.sys_log.info(f"Removed file {file.name} (id: {file.uuid})") self.sys_log.info(f"Removed file {file.name} (id: {file.uuid})")
else: else:
_LOGGER.debug(f"File with UUID {file.uuid} was not found.") self.sys_log.error(f"File with UUID {file.uuid} was not found.")
def remove_file_by_id(self, file_uuid: str): def remove_file_by_id(self, file_uuid: str):
""" """

2
src/primaite/simulator/network/airspace.py
View File

@@ -161,7 +161,7 @@ class WirelessNetworkInterface(NetworkInterface, ABC):
return return
if self._connected_node.operating_state != NodeOperatingState.ON: if self._connected_node.operating_state != NodeOperatingState.ON:
self._connected_node.sys_log.info( self._connected_node.sys_log.error(
f"Interface {self} cannot be enabled as the connected Node is not powered on" f"Interface {self} cannot be enabled as the connected Node is not powered on"
) )
return return

8
src/primaite/simulator/network/hardware/base.py
View File

@@ -307,13 +307,13 @@ class WiredNetworkInterface(NetworkInterface, ABC):
return False return False
if self._connected_node.operating_state != NodeOperatingState.ON: if self._connected_node.operating_state != NodeOperatingState.ON:
self._connected_node.sys_log.info( self._connected_node.sys_log.error(
f"Interface {self} cannot be enabled as the connected Node is not powered on" f"Interface {self} cannot be enabled as the connected Node is not powered on"
) )
return False return False
if not self._connected_link: if not self._connected_link:
self._connected_node.sys_log.info(f"Interface {self} cannot be enabled as there is no Link connected.") self._connected_node.sys_log.warning(f"Interface {self} cannot be enabled as there is no Link connected.")
return False return False
self.enabled = True self.enabled = True
@@ -1201,7 +1201,7 @@ class Node(SimComponent):
self._nic_request_manager.add_request(new_nic_num, RequestType(func=network_interface._request_manager)) self._nic_request_manager.add_request(new_nic_num, RequestType(func=network_interface._request_manager))
else: else:
msg = f"Cannot connect NIC {network_interface} as it is already connected" msg = f"Cannot connect NIC {network_interface} as it is already connected"
self.sys_log.logger.error(msg) self.sys_log.logger.warning(msg)
raise NetworkError(msg) raise NetworkError(msg)
def disconnect_nic(self, network_interface: Union[NetworkInterface, str]): def disconnect_nic(self, network_interface: Union[NetworkInterface, str]):
@@ -1228,7 +1228,7 @@ class Node(SimComponent):
self._nic_request_manager.remove_request(network_interface_num) self._nic_request_manager.remove_request(network_interface_num)
else: else:
msg = f"Cannot disconnect Network Interface {network_interface} as it is not connected" msg = f"Cannot disconnect Network Interface {network_interface} as it is not connected"
self.sys_log.logger.error(msg) self.sys_log.logger.warning(msg)
raise NetworkError(msg) raise NetworkError(msg)
def ping(self, target_ip_address: Union[IPv4Address, str], pings: int = 4) -> bool: def ping(self, target_ip_address: Union[IPv4Address, str], pings: int = 4) -> bool:

2
src/primaite/simulator/network/hardware/nodes/host/host_node.py
View File

@@ -147,7 +147,7 @@ class HostARP(ARP):
super()._process_arp_request(arp_packet, from_network_interface) super()._process_arp_request(arp_packet, from_network_interface)
# Unmatched ARP Request # Unmatched ARP Request
if arp_packet.target_ip_address != from_network_interface.ip_address: if arp_packet.target_ip_address != from_network_interface.ip_address:
self.sys_log.info( self.sys_log.warning(
f"Ignoring ARP request for {arp_packet.target_ip_address}. Current IP address is " f"Ignoring ARP request for {arp_packet.target_ip_address}. Current IP address is "
f"{from_network_interface.ip_address}" f"{from_network_interface.ip_address}"
) )

4
src/primaite/simulator/network/hardware/nodes/network/router.py
View File

@@ -933,7 +933,7 @@ class RouterICMP(ICMP):
) )
if not network_interface: if not network_interface:
self.sys_log.error( self.sys_log.warning(
"Cannot send ICMP echo reply as there is no outbound Network Interface to use. Try configuring the " "Cannot send ICMP echo reply as there is no outbound Network Interface to use. Try configuring the "
"default gateway." "default gateway."
) )
@@ -1483,7 +1483,7 @@ class Router(NetworkNode):
frame.ethernet.dst_mac_addr = target_mac frame.ethernet.dst_mac_addr = target_mac
network_interface.send_frame(frame) network_interface.send_frame(frame)
else: else:
self.sys_log.error(f"Frame dropped as there is no route to {frame.ip.dst_ip_address}") self.sys_log.warning(f"Frame dropped as there is no route to {frame.ip.dst_ip_address}")
def configure_port(self, port: int, ip_address: Union[IPv4Address, str], subnet_mask: Union[IPv4Address, str]): def configure_port(self, port: int, ip_address: Union[IPv4Address, str], subnet_mask: Union[IPv4Address, str]):
""" """

2
src/primaite/simulator/network/hardware/nodes/network/switch.py
View File

@@ -74,7 +74,7 @@ class SwitchPort(WiredNetworkInterface):
if self.enabled: if self.enabled:
frame.decrement_ttl() frame.decrement_ttl()
if frame.ip and frame.ip.ttl < 1: if frame.ip and frame.ip.ttl < 1:
self._connected_node.sys_log.info("Frame discarded as TTL limit reached") self._connected_node.sys_log.warning("Frame discarded as TTL limit reached")
return False return False
self.pcap.capture_inbound(frame) self.pcap.capture_inbound(frame)
self._connected_node.receive_frame(frame=frame, from_network_interface=self) self._connected_node.receive_frame(frame=frame, from_network_interface=self)

2
src/primaite/simulator/network/hardware/nodes/network/wireless_router.py
View File

@@ -68,7 +68,7 @@ class WirelessAccessPoint(IPWirelessNetworkInterface):
if self.enabled: if self.enabled:
frame.decrement_ttl() frame.decrement_ttl()
if frame.ip and frame.ip.ttl < 1: if frame.ip and frame.ip.ttl < 1:
self._connected_node.sys_log.info("Frame discarded as TTL limit reached") self._connected_node.sys_log.warning("Frame discarded as TTL limit reached")
return False return False
frame.set_received_timestamp() frame.set_received_timestamp()
self.pcap.capture_inbound(frame) self.pcap.capture_inbound(frame)

5
src/primaite/simulator/system/applications/application.py
View File

@@ -2,13 +2,10 @@ from abc import abstractmethod
from enum import Enum from enum import Enum
from typing import Any, Dict, Set from typing import Any, Dict, Set
from primaite import getLogger
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import RequestManager, RequestType from primaite.simulator.core import RequestManager, RequestType
from primaite.simulator.system.software import IOSoftware, SoftwareHealthState from primaite.simulator.system.software import IOSoftware, SoftwareHealthState
_LOGGER = getLogger(__name__)
class ApplicationOperatingState(Enum): class ApplicationOperatingState(Enum):
"""Enumeration of Application Operating States.""" """Enumeration of Application Operating States."""
@@ -99,7 +96,7 @@ class Application(IOSoftware):
if self.operating_state is not self.operating_state.RUNNING: if self.operating_state is not self.operating_state.RUNNING:
# service is not running # service is not running
_LOGGER.debug(f"Cannot perform action: {self.name} is {self.operating_state.name}") self.sys_log.error(f"Cannot perform action: {self.name} is {self.operating_state.name}")
return False return False
return True return True

15
src/primaite/simulator/system/applications/database_client.py
View File

@@ -2,7 +2,6 @@ from ipaddress import IPv4Address
from typing import Any, Dict, Optional from typing import Any, Dict, Optional
from uuid import uuid4 from uuid import uuid4
from primaite import getLogger
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import RequestManager, RequestType from primaite.simulator.core import RequestManager, RequestType
from primaite.simulator.network.transmission.network_layer import IPProtocol from primaite.simulator.network.transmission.network_layer import IPProtocol
@@ -10,8 +9,6 @@ from primaite.simulator.network.transmission.transport_layer import Port
from primaite.simulator.system.applications.application import Application from primaite.simulator.system.applications.application import Application
from primaite.simulator.system.core.software_manager import SoftwareManager from primaite.simulator.system.core.software_manager import SoftwareManager
_LOGGER = getLogger(__name__)
class DatabaseClient(Application): class DatabaseClient(Application):
""" """
@@ -136,7 +133,7 @@ class DatabaseClient(Application):
self.server_ip_address = server_ip_address self.server_ip_address = server_ip_address
return True return True
else: else:
self.sys_log.info( self.sys_log.warning(
f"{self.name} {connection_id=}: DatabaseClient connection to {server_ip_address} declined" f"{self.name} {connection_id=}: DatabaseClient connection to {server_ip_address} declined"
) )
return False return False
@@ -156,12 +153,12 @@ class DatabaseClient(Application):
def disconnect(self) -> bool: def disconnect(self) -> bool:
"""Disconnect from the Database Service.""" """Disconnect from the Database Service."""
if not self._can_perform_action(): if not self._can_perform_action():
self.sys_log.error(f"Unable to disconnect - {self.name} is {self.operating_state.name}") self.sys_log.warning(f"Unable to disconnect - {self.name} is {self.operating_state.name}")
return False return False
# if there are no connections - nothing to disconnect # if there are no connections - nothing to disconnect
if not self._server_connection_id: if not self._server_connection_id:
self.sys_log.error(f"Unable to disconnect - {self.name} has no active connections.") self.sys_log.warning(f"Unable to disconnect - {self.name} has no active connections.")
return False return False
# if no connection provided, disconnect the first connection # if no connection provided, disconnect the first connection
@@ -196,7 +193,7 @@ class DatabaseClient(Application):
if success: if success:
self.sys_log.info(f"{self.name}: Query successful {sql}") self.sys_log.info(f"{self.name}: Query successful {sql}")
return True return True
self.sys_log.info(f"{self.name}: Unable to run query {sql}") self.sys_log.error(f"{self.name}: Unable to run query {sql}")
return False return False
else: else:
software_manager: SoftwareManager = self.software_manager software_manager: SoftwareManager = self.software_manager
@@ -236,7 +233,7 @@ class DatabaseClient(Application):
if not connection_id: if not connection_id:
msg = "Cannot run sql query, could not establish connection with the server." msg = "Cannot run sql query, could not establish connection with the server."
self.parent.sys_log(msg) self.sys_log.warning(msg)
return False return False
uuid = str(uuid4()) uuid = str(uuid4())
@@ -265,5 +262,5 @@ class DatabaseClient(Application):
status_code = payload.get("status_code") status_code = payload.get("status_code")
self._query_success_tracker[query_id] = status_code == 200 self._query_success_tracker[query_id] = status_code == 200
if self._query_success_tracker[query_id]: if self._query_success_tracker[query_id]:
_LOGGER.debug(f"Received payload {payload}") self.sys_log.debug(f"Received {payload=}")
return True return True

16
src/primaite/simulator/system/applications/red_applications/data_manipulation_bot.py
View File

@@ -71,7 +71,7 @@ class DataManipulationBot(Application):
"""Return the database client that is installed on the same machine as the DataManipulationBot.""" """Return the database client that is installed on the same machine as the DataManipulationBot."""
db_client = self.software_manager.software.get("DatabaseClient") db_client = self.software_manager.software.get("DatabaseClient")
if db_client is None: if db_client is None:
_LOGGER.info(f"{self.__class__.__name__} cannot find a database client on its host.") self.sys_log.warning(f"{self.__class__.__name__} cannot find a database client on its host.")
return db_client return db_client
def _init_request_manager(self) -> RequestManager: def _init_request_manager(self) -> RequestManager:
@@ -127,7 +127,7 @@ class DataManipulationBot(Application):
""" """
if self.attack_stage == DataManipulationAttackStage.NOT_STARTED: if self.attack_stage == DataManipulationAttackStage.NOT_STARTED:
# Bypass this stage as we're not dealing with logon for now # Bypass this stage as we're not dealing with logon for now
self.sys_log.info(f"{self.name}: ") self.sys_log.debug(f"{self.name}: ")
self.attack_stage = DataManipulationAttackStage.LOGON self.attack_stage = DataManipulationAttackStage.LOGON
def _perform_port_scan(self, p_of_success: Optional[float] = 0.1): def _perform_port_scan(self, p_of_success: Optional[float] = 0.1):
@@ -145,7 +145,7 @@ class DataManipulationBot(Application):
# perform the port scan # perform the port scan
port_is_open = True # Temporary; later we can implement NMAP port scan. port_is_open = True # Temporary; later we can implement NMAP port scan.
if port_is_open: if port_is_open:
self.sys_log.info(f"{self.name}: ") self.sys_log.debug(f"{self.name}: ")
self.attack_stage = DataManipulationAttackStage.PORT_SCAN self.attack_stage = DataManipulationAttackStage.PORT_SCAN
def _perform_data_manipulation(self, p_of_success: Optional[float] = 0.1): def _perform_data_manipulation(self, p_of_success: Optional[float] = 0.1):
@@ -177,7 +177,7 @@ class DataManipulationBot(Application):
self.sys_log.info(f"{self.name}: Data manipulation successful") self.sys_log.info(f"{self.name}: Data manipulation successful")
self.attack_stage = DataManipulationAttackStage.SUCCEEDED self.attack_stage = DataManipulationAttackStage.SUCCEEDED
else: else:
self.sys_log.info(f"{self.name}: Data manipulation failed") self.sys_log.error(f"{self.name}: Data manipulation failed")
self.attack_stage = DataManipulationAttackStage.FAILED self.attack_stage = DataManipulationAttackStage.FAILED
def run(self): def run(self):
@@ -191,7 +191,9 @@ class DataManipulationBot(Application):
def attack(self) -> bool: def attack(self) -> bool:
"""Perform the attack steps after opening the application.""" """Perform the attack steps after opening the application."""
if not self._can_perform_action(): if not self._can_perform_action():
_LOGGER.debug("Data manipulation application attempted to execute but it cannot perform actions right now.") self.sys_log.warning(
"Data manipulation application attempted to execute but it cannot perform actions right now."
)
self.run() self.run()
self.num_executions += 1 self.num_executions += 1
@@ -206,7 +208,7 @@ class DataManipulationBot(Application):
if not self._can_perform_action(): if not self._can_perform_action():
return False return False
if self.server_ip_address and self.payload: if self.server_ip_address and self.payload:
self.sys_log.info(f"{self.name}: Running") self.sys_log.debug(f"{self.name}: Running")
self._logon() self._logon()
self._perform_port_scan(p_of_success=self.port_scan_p_of_success) self._perform_port_scan(p_of_success=self.port_scan_p_of_success)
self._perform_data_manipulation(p_of_success=self.data_manipulation_p_of_success) self._perform_data_manipulation(p_of_success=self.data_manipulation_p_of_success)
@@ -220,7 +222,7 @@ class DataManipulationBot(Application):
return True return True
else: else:
self.sys_log.error(f"{self.name}: Failed to start as it requires both a target_ip_address and payload.") self.sys_log.warning(f"{self.name}: Failed to start as it requires both a target_ip_address and payload.")
return False return False
def apply_timestep(self, timestep: int) -> None: def apply_timestep(self, timestep: int) -> None:

4
src/primaite/simulator/system/applications/red_applications/dos_bot.py
View File

@@ -122,7 +122,7 @@ class DoSBot(DatabaseClient):
# DoS bot cannot do anything without a target # DoS bot cannot do anything without a target
if not self.target_ip_address or not self.target_port: if not self.target_ip_address or not self.target_port:
self.sys_log.error( self.sys_log.warning(
f"{self.name} is not properly configured. {self.target_ip_address=}, {self.target_port=}" f"{self.name} is not properly configured. {self.target_ip_address=}, {self.target_port=}"
) )
return True return True
@@ -152,7 +152,7 @@ class DoSBot(DatabaseClient):
# perform the port scan # perform the port scan
port_is_open = True # Temporary; later we can implement NMAP port scan. port_is_open = True # Temporary; later we can implement NMAP port scan.
if port_is_open: if port_is_open:
self.sys_log.info(f"{self.name}: ") self.sys_log.debug(f"{self.name}: ")
self.attack_stage = DoSAttackStage.PORT_SCAN self.attack_stage = DoSAttackStage.PORT_SCAN
def _perform_dos(self): def _perform_dos(self):

11
src/primaite/simulator/system/applications/red_applications/ransomware_script.py
View File

@@ -2,7 +2,6 @@ from enum import IntEnum
from ipaddress import IPv4Address from ipaddress import IPv4Address
from typing import Dict, Optional from typing import Dict, Optional
from primaite import getLogger
from primaite.game.science import simulate_trial from primaite.game.science import simulate_trial
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import RequestManager, RequestType from primaite.simulator.core import RequestManager, RequestType
@@ -11,8 +10,6 @@ from primaite.simulator.network.transmission.transport_layer import Port
from primaite.simulator.system.applications.application import Application from primaite.simulator.system.applications.application import Application
from primaite.simulator.system.applications.database_client import DatabaseClient from primaite.simulator.system.applications.database_client import DatabaseClient
_LOGGER = getLogger(__name__)
class RansomwareAttackStage(IntEnum): class RansomwareAttackStage(IntEnum):
""" """
@@ -94,7 +91,7 @@ class RansomwareScript(Application):
"""Return the database client that is installed on the same machine as the Ransomware Script.""" """Return the database client that is installed on the same machine as the Ransomware Script."""
db_client = self.software_manager.software.get("DatabaseClient") db_client = self.software_manager.software.get("DatabaseClient")
if db_client is None: if db_client is None:
_LOGGER.info(f"{self.__class__.__name__} cannot find a database client on its host.") self.sys_log.warning(f"{self.__class__.__name__} cannot find a database client on its host.")
return db_client return db_client
def _init_request_manager(self) -> RequestManager: def _init_request_manager(self) -> RequestManager:
@@ -158,7 +155,7 @@ class RansomwareScript(Application):
self.attack_stage = RansomwareAttackStage.NOT_STARTED self.attack_stage = RansomwareAttackStage.NOT_STARTED
return True return True
else: else:
self.sys_log.error(f"{self.name}: Failed to start as it requires both a target_ip_address and payload.") self.sys_log.warning(f"{self.name}: Failed to start as it requires both a target_ip_address and payload.")
return False return False
def configure( def configure(
@@ -254,7 +251,7 @@ class RansomwareScript(Application):
def attack(self) -> bool: def attack(self) -> bool:
"""Perform the attack steps after opening the application.""" """Perform the attack steps after opening the application."""
if not self._can_perform_action(): if not self._can_perform_action():
_LOGGER.debug("Ransomware application is unable to perform it's actions.") self.sys_log.warning("Ransomware application is unable to perform it's actions.")
self.run() self.run()
self.num_executions += 1 self.num_executions += 1
return self._application_loop() return self._application_loop()
@@ -289,7 +286,7 @@ class RansomwareScript(Application):
self.sys_log.info(f"{self.name}: Payload failed") self.sys_log.info(f"{self.name}: Payload failed")
self.attack_stage = RansomwareAttackStage.FAILED self.attack_stage = RansomwareAttackStage.FAILED
else: else:
self.sys_log.error("Attack Attempted to launch too quickly") self.sys_log.warning("Attack Attempted to launch too quickly")
self.attack_stage = RansomwareAttackStage.FAILED self.attack_stage = RansomwareAttackStage.FAILED
def _local_download(self): def _local_download(self):

10
src/primaite/simulator/system/applications/web_browser.py
View File

@@ -97,7 +97,7 @@ class WebBrowser(Application):
try: try:
parsed_url = urlparse(url) parsed_url = urlparse(url)
except Exception: except Exception:
self.sys_log.error(f"{url} is not a valid URL") self.sys_log.warning(f"{url} is not a valid URL")
return False return False
# get the IP address of the domain name via DNS # get the IP address of the domain name via DNS
@@ -114,7 +114,7 @@ class WebBrowser(Application):
self.domain_name_ip_address = IPv4Address(parsed_url.hostname) self.domain_name_ip_address = IPv4Address(parsed_url.hostname)
except Exception: except Exception:
# unable to deal with this request # unable to deal with this request
self.sys_log.error(f"{self.name}: Unable to resolve URL {url}") self.sys_log.warning(f"{self.name}: Unable to resolve URL {url}")
return False return False
# create HTTPRequest payload # create HTTPRequest payload
@@ -140,7 +140,8 @@ class WebBrowser(Application):
) )
return self.latest_response.status_code is HttpStatusCode.OK return self.latest_response.status_code is HttpStatusCode.OK
else: else:
self.sys_log.error(f"Error sending Http Packet {str(payload)}") self.sys_log.warning(f"{self.name}: Error sending Http Packet")
self.sys_log.debug(f"{self.name}: {payload=}")
self.history.append( self.history.append(
WebBrowser.BrowserHistoryItem( WebBrowser.BrowserHistoryItem(
url=url, status=self.BrowserHistoryItem._HistoryItemStatus.SERVER_UNREACHABLE url=url, status=self.BrowserHistoryItem._HistoryItemStatus.SERVER_UNREACHABLE
@@ -181,7 +182,8 @@ class WebBrowser(Application):
:return: True if successful, False otherwise. :return: True if successful, False otherwise.
""" """
if not isinstance(payload, HttpResponsePacket): if not isinstance(payload, HttpResponsePacket):
self.sys_log.error(f"{self.name} received a packet that is not an HttpResponsePacket") self.sys_log.warning(f"{self.name} received a packet that is not an HttpResponsePacket")
self.sys_log.debug(f"{self.name}: {payload=}")
return False return False
self.sys_log.info(f"{self.name}: Received HTTP {payload.status_code.value}") self.sys_log.info(f"{self.name}: Received HTTP {payload.status_code.value}")
self.latest_response = payload self.latest_response = payload

6
src/primaite/simulator/system/core/software_manager.py
View File

@@ -87,7 +87,7 @@ class SoftwareManager:
# TODO: Software manager and node itself both have an install method. Need to refactor to have more logical # TODO: Software manager and node itself both have an install method. Need to refactor to have more logical
# separation of concerns. # separation of concerns.
if software_class in self._software_class_to_name_map: if software_class in self._software_class_to_name_map:
self.sys_log.info(f"Cannot install {software_class} as it is already installed") self.sys_log.warning(f"Cannot install {software_class} as it is already installed")
return return
software = software_class( software = software_class(
software_manager=self, sys_log=self.sys_log, file_system=self.file_system, dns_server=self.dns_server software_manager=self, sys_log=self.sys_log, file_system=self.file_system, dns_server=self.dns_server
@@ -144,7 +144,7 @@ class SoftwareManager:
if receiver: if receiver:
receiver.receive_payload(payload) receiver.receive_payload(payload)
else: else:
self.sys_log.error(f"No Service of Application found with the name {target_software}") self.sys_log.warning(f"No Service of Application found with the name {target_software}")
def send_payload_to_session_manager( def send_payload_to_session_manager(
self, self,
@@ -196,7 +196,7 @@ class SoftwareManager:
payload=payload, session_id=session_id, from_network_interface=from_network_interface, frame=frame payload=payload, session_id=session_id, from_network_interface=from_network_interface, frame=frame
) )
else: else:
self.sys_log.error(f"No service or application found for port {port} and protocol {protocol}") self.sys_log.warning(f"No service or application found for port {port} and protocol {protocol}")
pass pass
def show(self, markdown: bool = False): def show(self, markdown: bool = False):

4
src/primaite/simulator/system/services/arp/arp.py
View File

@@ -147,7 +147,7 @@ class ARP(Service):
payload=arp_packet, dst_ip_address=target_ip_address, dst_port=self.port, ip_protocol=self.protocol payload=arp_packet, dst_ip_address=target_ip_address, dst_port=self.port, ip_protocol=self.protocol
) )
else: else:
self.sys_log.error( self.sys_log.warning(
"Cannot send ARP request as there is no outbound Network Interface to use. Try configuring the default " "Cannot send ARP request as there is no outbound Network Interface to use. Try configuring the default "
"gateway." "gateway."
) )
@@ -173,7 +173,7 @@ class ARP(Service):
ip_protocol=self.protocol, ip_protocol=self.protocol,
) )
else: else:
self.sys_log.error( self.sys_log.warning(
"Cannot send ARP reply as there is no outbound Network Interface to use. Try configuring the default " "Cannot send ARP reply as there is no outbound Network Interface to use. Try configuring the default "
"gateway." "gateway."
) )

12
src/primaite/simulator/system/services/database/database_service.py
View File

@@ -57,7 +57,7 @@ class DatabaseService(Service):
# check if the backup server was configured # check if the backup server was configured
if self.backup_server_ip is None: if self.backup_server_ip is None:
self.sys_log.error(f"{self.name} - {self.sys_log.hostname}: not configured.") self.sys_log.warning(f"{self.name} - {self.sys_log.hostname}: not configured.")
return False return False
software_manager: SoftwareManager = self.software_manager software_manager: SoftwareManager = self.software_manager
@@ -110,7 +110,7 @@ class DatabaseService(Service):
db_file = self.file_system.get_file(folder_name="database", file_name="database.db", include_deleted=True) db_file = self.file_system.get_file(folder_name="database", file_name="database.db", include_deleted=True)
if db_file is None: if db_file is None:
self.sys_log.error("Database file not initialised.") self.sys_log.warning("Database file not initialised.")
return False return False
# if the file was deleted, get the old visible health state # if the file was deleted, get the old visible health state
@@ -170,12 +170,12 @@ class DatabaseService(Service):
# try to create connection # try to create connection
if not self.add_connection(connection_id=connection_id): if not self.add_connection(connection_id=connection_id):
status_code = 500 status_code = 500
self.sys_log.info(f"{self.name}: Connect request for {connection_id=} declined") self.sys_log.warning(f"{self.name}: Connect request for {connection_id=} declined")
else: else:
self.sys_log.info(f"{self.name}: Connect request for {connection_id=} authorised") self.sys_log.info(f"{self.name}: Connect request for {connection_id=} authorised")
else: else:
status_code = 401 # Unauthorised status_code = 401 # Unauthorised
self.sys_log.info(f"{self.name}: Connect request for {connection_id=} declined") self.sys_log.warning(f"{self.name}: Connect request for {connection_id=} declined")
else: else:
status_code = 404 # service not found status_code = 404 # service not found
return { return {
@@ -206,7 +206,7 @@ class DatabaseService(Service):
self.sys_log.info(f"{self.name}: Running {query}") self.sys_log.info(f"{self.name}: Running {query}")
if not self.db_file: if not self.db_file:
self.sys_log.info(f"{self.name}: Failed to run {query} because the database file is missing.") self.sys_log.error(f"{self.name}: Failed to run {query} because the database file is missing.")
return {"status_code": 404, "type": "sql", "data": False} return {"status_code": 404, "type": "sql", "data": False}
if query == "SELECT": if query == "SELECT":
@@ -276,7 +276,7 @@ class DatabaseService(Service):
return {"status_code": 401, "data": False} return {"status_code": 401, "data": False}
else: else:
# Invalid query # Invalid query
self.sys_log.info(f"{self.name}: Invalid {query}") self.sys_log.warning(f"{self.name}: Invalid {query}")
return {"status_code": 500, "data": False} return {"status_code": 500, "data": False}
def describe_state(self) -> Dict: def describe_state(self) -> Dict:

9
src/primaite/simulator/system/services/dns/dns_client.py
View File

@@ -72,7 +72,7 @@ class DNSClient(Service):
# check if DNS server is configured # check if DNS server is configured
if self.dns_server is None: if self.dns_server is None:
self.sys_log.error(f"{self.name}: DNS Server is not configured") self.sys_log.warning(f"{self.name}: DNS Server is not configured")
return False return False
# check if the target domain is in the client's DNS cache # check if the target domain is in the client's DNS cache
@@ -88,7 +88,7 @@ class DNSClient(Service):
else: else:
# return False if already reattempted # return False if already reattempted
if is_reattempt: if is_reattempt:
self.sys_log.info(f"{self.name}: Domain lookup for {target_domain} failed") self.sys_log.warning(f"{self.name}: Domain lookup for {target_domain} failed")
return False return False
else: else:
# send a request to check if domain name exists in the DNS Server # send a request to check if domain name exists in the DNS Server
@@ -143,7 +143,8 @@ class DNSClient(Service):
""" """
# The payload should be a DNS packet # The payload should be a DNS packet
if not isinstance(payload, DNSPacket): if not isinstance(payload, DNSPacket):
_LOGGER.debug(f"{payload} is not a DNSPacket") self.sys_log.warning(f"{self.name}: Payload is not a DNSPacket")
self.sys_log.debug(f"{self.name}: {payload}")
return False return False
if payload.dns_reply is not None: if payload.dns_reply is not None:
@@ -156,5 +157,5 @@ class DNSClient(Service):
self.dns_cache[payload.dns_request.domain_name_request] = payload.dns_reply.domain_name_ip_address self.dns_cache[payload.dns_request.domain_name_request] = payload.dns_reply.domain_name_ip_address
return True return True
self.sys_log.error(f"Failed to resolve domain name {payload.dns_request.domain_name_request}") self.sys_log.warning(f"Failed to resolve domain name {payload.dns_request.domain_name_request}")
return False return False

3
src/primaite/simulator/system/services/dns/dns_server.py
View File

@@ -90,7 +90,8 @@ class DNSServer(Service):
# The payload should be a DNS packet # The payload should be a DNS packet
if not isinstance(payload, DNSPacket): if not isinstance(payload, DNSPacket):
_LOGGER.debug(f"{payload} is not a DNSPacket") self.sys_log.warning(f"{payload} is not a DNSPacket")
self.sys_log.debug(f"{payload} is not a DNSPacket")
return False return False
# cast payload into a DNS packet # cast payload into a DNS packet

9
src/primaite/simulator/system/services/ftp/ftp_client.py
View File

@@ -82,7 +82,7 @@ class FTPClient(FTPServiceABC):
else: else:
if is_reattempt: if is_reattempt:
# reattempt failed # reattempt failed
self.sys_log.info( self.sys_log.warning(
f"{self.name}: Unable to connect to FTP Server " f"{self.name}: Unable to connect to FTP Server "
f"{dest_ip_address} via port {payload.ftp_command_args.value}" f"{dest_ip_address} via port {payload.ftp_command_args.value}"
) )
@@ -93,7 +93,7 @@ class FTPClient(FTPServiceABC):
dest_ip_address=dest_ip_address, dest_port=dest_port, session_id=session_id, is_reattempt=True dest_ip_address=dest_ip_address, dest_port=dest_port, session_id=session_id, is_reattempt=True
) )
else: else:
self.sys_log.error(f"{self.name}: Unable to send FTPPacket") self.sys_log.warning(f"{self.name}: Unable to send FTPPacket")
return False return False
def _disconnect_from_server( def _disconnect_from_server(
@@ -158,7 +158,7 @@ class FTPClient(FTPServiceABC):
# check if the file to transfer exists on the client # check if the file to transfer exists on the client
file_to_transfer: File = self.file_system.get_file(folder_name=src_folder_name, file_name=src_file_name) file_to_transfer: File = self.file_system.get_file(folder_name=src_folder_name, file_name=src_file_name)
if not file_to_transfer: if not file_to_transfer:
self.sys_log.error(f"Unable to send file that does not exist: {src_folder_name}/{src_file_name}") self.sys_log.warning(f"Unable to send file that does not exist: {src_folder_name}/{src_file_name}")
return False return False
# check if FTP is currently connected to IP # check if FTP is currently connected to IP
@@ -253,7 +253,8 @@ class FTPClient(FTPServiceABC):
:type: session_id: Optional[str] :type: session_id: Optional[str]
""" """
if not isinstance(payload, FTPPacket): if not isinstance(payload, FTPPacket):
self.sys_log.error(f"{payload} is not an FTP packet") self.sys_log.warning(f"{self.name}: Payload is not an FTP packet")
self.sys_log.debug(f"{self.name}: {payload}")
return False return False
""" """

3
src/primaite/simulator/system/services/ftp/ftp_server.py
View File

@@ -70,7 +70,8 @@ class FTPServer(FTPServiceABC):
def receive(self, payload: Any, session_id: Optional[str] = None, **kwargs) -> bool: def receive(self, payload: Any, session_id: Optional[str] = None, **kwargs) -> bool:
"""Receives a payload from the SessionManager.""" """Receives a payload from the SessionManager."""
if not isinstance(payload, FTPPacket): if not isinstance(payload, FTPPacket):
self.sys_log.error(f"{payload} is not an FTP packet") self.sys_log.warning(f"{self.name}: Payload is not an FTP packet")
self.sys_log.debug(f"{self.name}: {payload}")
return False return False
if not super().receive(payload=payload, session_id=session_id, **kwargs): if not super().receive(payload=payload, session_id=session_id, **kwargs):

4
src/primaite/simulator/system/services/icmp/icmp.py
View File

@@ -95,7 +95,7 @@ class ICMP(Service):
network_interface = self.software_manager.session_manager.resolve_outbound_network_interface(target_ip_address) network_interface = self.software_manager.session_manager.resolve_outbound_network_interface(target_ip_address)
if not network_interface: if not network_interface:
self.sys_log.error( self.sys_log.warning(
"Cannot send ICMP echo request as there is no outbound Network Interface to use. Try configuring the " "Cannot send ICMP echo request as there is no outbound Network Interface to use. Try configuring the "
"default gateway." "default gateway."
) )
@@ -130,7 +130,7 @@ class ICMP(Service):
) )
if not network_interface: if not network_interface:
self.sys_log.error( self.sys_log.warning(
"Cannot send ICMP echo reply as there is no outbound Network Interface to use. Try configuring the " "Cannot send ICMP echo reply as there is no outbound Network Interface to use. Try configuring the "
"default gateway." "default gateway."
) )

3
src/primaite/simulator/system/services/ntp/ntp_client.py
View File

@@ -87,7 +87,7 @@ class NTPClient(Service):
:return: True if successful, False otherwise. :return: True if successful, False otherwise.
""" """
if not isinstance(payload, NTPPacket): if not isinstance(payload, NTPPacket):
_LOGGER.debug(f"{self.name}: Failed to parse NTP update") self.sys_log.warning(f"{self.name}: Failed to parse NTP update")
return False return False
if payload.ntp_reply.ntp_datetime: if payload.ntp_reply.ntp_datetime:
self.time = payload.ntp_reply.ntp_datetime self.time = payload.ntp_reply.ntp_datetime
@@ -115,7 +115,6 @@ class NTPClient(Service):
:param timestep: The current timestep number. (Amount of time since simulation episode began) :param timestep: The current timestep number. (Amount of time since simulation episode began)
:type timestep: int :type timestep: int
""" """
self.sys_log.info(f"{self.name} apply_timestep")
super().apply_timestep(timestep) super().apply_timestep(timestep)
if self.operating_state == ServiceOperatingState.RUNNING: if self.operating_state == ServiceOperatingState.RUNNING:
# request time from server # request time from server

3
src/primaite/simulator/system/services/ntp/ntp_server.py
View File

@@ -51,7 +51,8 @@ class NTPServer(Service):
:return: True if valid NTP request else False. :return: True if valid NTP request else False.
""" """
if not (isinstance(payload, NTPPacket)): if not (isinstance(payload, NTPPacket)):
_LOGGER.debug(f"{payload} is not a NTPPacket") self.sys_log.warning(f"{self.name}: Payload is not a NTPPacket")
self.sys_log.debug(f"{self.name}: {payload}")
return False return False
payload: NTPPacket = payload payload: NTPPacket = payload

4
src/primaite/simulator/system/services/service.py
View File

@@ -59,7 +59,7 @@ class Service(IOSoftware):
if self.operating_state is not ServiceOperatingState.RUNNING: if self.operating_state is not ServiceOperatingState.RUNNING:
# service is not running # service is not running
_LOGGER.debug(f"Cannot perform action: {self.name} is {self.operating_state.name}") self.sys_log.debug(f"Cannot perform action: {self.name} is {self.operating_state.name}")
return False return False
return True return True
@@ -187,6 +187,6 @@ class Service(IOSoftware):
super().apply_timestep(timestep) super().apply_timestep(timestep)
if self.operating_state == ServiceOperatingState.RESTARTING: if self.operating_state == ServiceOperatingState.RESTARTING:
if self.restart_countdown <= 0: if self.restart_countdown <= 0:
_LOGGER.debug(f"Restarting finished for service {self.name}") self.sys_log.debug(f"Restarting finished for service {self.name}")
self.operating_state = ServiceOperatingState.RUNNING self.operating_state = ServiceOperatingState.RUNNING
self.restart_countdown -= 1 self.restart_countdown -= 1

3
src/primaite/simulator/system/services/web_server/web_server.py
View File

@@ -167,7 +167,8 @@ class WebServer(Service):
# check if the payload is an HTTPPacket # check if the payload is an HTTPPacket
if not isinstance(payload, HttpRequestPacket): if not isinstance(payload, HttpRequestPacket):
self.sys_log.error("Payload is not an HTTPPacket") self.sys_log.warning(f"{self.name}: Payload is not an HTTPPacket")
self.sys_log.debug(f"{self.name}: {payload}")
return False return False
return self._process_http_request(payload=payload, session_id=session_id) return self._process_http_request(payload=payload, session_id=session_id)

10
src/primaite/simulator/system/software.py
View File

@@ -6,7 +6,7 @@ from ipaddress import IPv4Address, IPv4Network
from typing import Any, Dict, Optional, TYPE_CHECKING, Union from typing import Any, Dict, Optional, TYPE_CHECKING, Union
from primaite.interface.request import RequestResponse from primaite.interface.request import RequestResponse
from primaite.simulator.core import _LOGGER, RequestManager, RequestType, SimComponent from primaite.simulator.core import RequestManager, RequestType, SimComponent
from primaite.simulator.file_system.file_system import FileSystem, Folder from primaite.simulator.file_system.file_system import FileSystem, Folder
from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState from primaite.simulator.network.hardware.node_operating_state import NodeOperatingState
from primaite.simulator.network.transmission.network_layer import IPProtocol from primaite.simulator.network.transmission.network_layer import IPProtocol
@@ -287,7 +287,9 @@ class IOSoftware(Software):
Returns true if the software can perform actions. Returns true if the software can perform actions.
""" """
if self.software_manager and self.software_manager.node.operating_state != NodeOperatingState.ON: if self.software_manager and self.software_manager.node.operating_state != NodeOperatingState.ON:
_LOGGER.debug(f"{self.name} Error: {self.software_manager.node.hostname} is not online.") self.software_manager.node.sys_log.error(
f"{self.name} Error: {self.software_manager.node.hostname} is not online."
)
return False return False
return True return True
@@ -308,7 +310,7 @@ class IOSoftware(Software):
# if over or at capacity, set to overwhelmed # if over or at capacity, set to overwhelmed
if len(self._connections) >= self.max_sessions: if len(self._connections) >= self.max_sessions:
self.set_health_state(SoftwareHealthState.OVERWHELMED) self.set_health_state(SoftwareHealthState.OVERWHELMED)
self.sys_log.error(f"{self.name}: Connect request for {connection_id=} declined. Service is at capacity.") self.sys_log.warning(f"{self.name}: Connect request for {connection_id=} declined. Service is at capacity.")
return False return False
else: else:
# if service was previously overwhelmed, set to good because there is enough space for connections # if service was previously overwhelmed, set to good because there is enough space for connections
@@ -327,7 +329,7 @@ class IOSoftware(Software):
self.sys_log.info(f"{self.name}: Connect request for {connection_id=} authorised") self.sys_log.info(f"{self.name}: Connect request for {connection_id=} authorised")
return True return True
# connection with given id already exists # connection with given id already exists
self.sys_log.error( self.sys_log.warning(
f"{self.name}: Connect request for {connection_id=} declined. Connection already exists." f"{self.name}: Connect request for {connection_id=} declined. Connection already exists."
) )
return False return False