diff --git a/src/primaite/simulator/__init__.py b/src/primaite/simulator/__init__.py index bbcf9af4..d2993b34 100644 --- a/src/primaite/simulator/__init__.py +++ b/src/primaite/simulator/__init__.py @@ -27,10 +27,10 @@ class LogLevel(IntEnum): class _SimOutput: def __init__(self): - date_str = datetime.now().strftime("%Y-%m-%d") - time_str = datetime.now().strftime("%H-%M-%S") + self.date_str = datetime.now().strftime("%Y-%m-%d") + self.time_str = datetime.now().strftime("%H-%M-%S") - path = PRIMAITE_PATHS.user_sessions_path / date_str / time_str + path = PRIMAITE_PATHS.user_sessions_path / self.date_str / self.time_str self._path = path self._save_pcap_logs: bool = False @@ -41,17 +41,15 @@ class _SimOutput: @property def path(self) -> Path: if is_dev_mode(): - date_str = datetime.now().strftime("%Y-%m-%d") - time_str = datetime.now().strftime("%H-%M-%S") # if dev mode is enabled, if output dir is not set, print to primaite repo root - path: Path = _PRIMAITE_ROOT.parent.parent / "sessions" / date_str / time_str / "simulation_output" + path: Path = _PRIMAITE_ROOT.parent.parent / "sessions" / self.date_str / self.time_str / "simulation_output" # otherwise print to output dir if PRIMAITE_CONFIG["developer_mode"]["output_dir"]: path: Path = ( Path(PRIMAITE_CONFIG["developer_mode"]["output_dir"]) / "sessions" - / date_str - / time_str + / self.date_str + / self.time_str / "simulation_output" ) self._path = path diff --git a/src/primaite/simulator/_package_data/network_simulator_demo.ipynb b/src/primaite/simulator/_package_data/network_simulator_demo.ipynb index 8898ab35..22fdf7ce 100644 --- a/src/primaite/simulator/_package_data/network_simulator_demo.ipynb +++ b/src/primaite/simulator/_package_data/network_simulator_demo.ipynb @@ -7,7 +7,7 @@ "source": [ "# PrimAITE Router Simulation Demo\n", "\n", - "This demo uses the ARCD Use Case 2 Network (seen below) to demonstrate the capabilities of the Network simulator in PrimAITE." + "This demo uses a modified version of the ARCD Use Case 2 Network (seen below) to demonstrate the capabilities of the Network simulator in PrimAITE." ] }, { @@ -56,7 +56,7 @@ "## The Network\n", "First let's create our network. The network comes 'pre-packaged' with PrimAITE in the `primaite.simulator.network.networks` module.\n", "\n", - "> ℹ️ You'll see a bunch of logs associated with parts of the Network that aern't an 'electronic' device on the Network and thus don't have a stsrem to log to. Soon these logs are going to be pushed to a Network Logger so we're not clogging up the PrimAITE application logs." + "> ℹ️ You'll see a bunch of logs associated with parts of the Network that aren't an 'electronic' device on the Network and thus don't have a stream to log to. Soon these logs are going to be pushed to a Network Logger so we're not clogging up the PrimAITE application logs." ] }, { @@ -68,7 +68,7 @@ }, "outputs": [], "source": [ - "from primaite.simulator.network.networks import arcd_uc2_network" + "from primaite.simulator.network.networks import network_simulator_demo_example" ] }, { @@ -80,7 +80,7 @@ }, "outputs": [], "source": [ - "network = arcd_uc2_network()" + "network = network_simulator_demo_example()" ] }, { @@ -190,7 +190,7 @@ "id": "15", "metadata": {}, "source": [ - "Calling `router.router_table.show()` displays the static routes the Router provides." + "Calling `router.router_table.show()` displays the static routes the Router provides. " ] }, { @@ -210,7 +210,9 @@ "id": "17", "metadata": {}, "source": [ - "Calling `router.sys_log.show()` displays the Router system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=`." + "Calling `router.sys_log.show()` displays the Router system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=`.\n", + "\n", + "NB: For `sys_log.show()` to work correctly log files need to be created with a sys_log level of INFO or below." ] }, { @@ -222,7 +224,7 @@ }, "outputs": [], "source": [ - "network.get_node_by_hostname(\"router_1\").sys_log.show(last_n=10)" + "network.get_node_by_hostname(\"router_1\").sys_log.show()" ] }, { @@ -232,7 +234,7 @@ "source": [ "### Switch Nodes\n", "\n", - "Next we'll inspect the Switch node and some of it's core services." + "Next we'll inspect the Switch node and some of its core services." ] }, { @@ -332,7 +334,7 @@ "id": "29", "metadata": {}, "source": [ - "Calling `computer.sys_log.show()` displays the Computer/Server system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=`." + "Calling `computer.sys_log.show()` displays the Computer/Server system log. By default, only the last 10 log entries are displayed; this can be changed by passing `last_n=`." ] }, { @@ -344,7 +346,7 @@ }, "outputs": [], "source": [ - "network.get_node_by_hostname(\"security_suite\").sys_log.show()" + "network.get_node_by_hostname(\"security_suite\").sys_log.show(last_n=25)" ] }, { @@ -398,7 +400,7 @@ }, "outputs": [], "source": [ - "network.get_node_by_hostname(\"client_1\").sys_log.show(15)" + "network.get_node_by_hostname(\"client_1\").sys_log.show(last_n=15)" ] }, { @@ -476,7 +478,7 @@ "id": "43", "metadata": {}, "source": [ - "Let's attempt to prevent client_2 from being able to ping the web server. First, we'll confirm that it can ping the server first..." + "Let's attempt to prevent client_2 from being able to ping the web server. First, we'll confirm that it can ping the server..." ] }, { @@ -496,7 +498,7 @@ "id": "45", "metadata": {}, "source": [ - "If we look at the client_2 sys log we can see that the four ICMP echo requests were sent and four ICMP each replies were received:" + "If we look at the client_2 sys log we can see that the four ICMP echo requests were sent and four ICMP each replies were received." ] }, { @@ -516,7 +518,7 @@ "id": "47", "metadata": {}, "source": [ - "Now we'll add an ACL to block ICMP from 192.168.10.22" + "Now we'll add an ACL to block ICMP from 192.168.10.22." ] }, { @@ -556,7 +558,7 @@ "id": "50", "metadata": {}, "source": [ - "Now we attempt (and fail) to ping the web server" + "Now we attempt (and fail) to ping the web server." ] }, { @@ -576,7 +578,7 @@ "id": "52", "metadata": {}, "source": [ - "We can check that the ping was actually sent by client_2 by viewing the sys log" + "We can check that the ping was actually sent by client_2 by viewing the sys log." ] }, { @@ -596,7 +598,7 @@ "id": "54", "metadata": {}, "source": [ - "We can check the router sys log to see why the traffic was blocked" + "We can check the router sys log to see why the traffic was blocked." ] }, { diff --git a/src/primaite/simulator/network/networks.py b/src/primaite/simulator/network/networks.py index bd06e615..f3d43e5b 100644 --- a/src/primaite/simulator/network/networks.py +++ b/src/primaite/simulator/network/networks.py @@ -4,6 +4,7 @@ import yaml from primaite import getLogger, PRIMAITE_PATHS from primaite.game.game import PrimaiteGame +from primaite.simulator import LogLevel, SIM_OUTPUT from primaite.simulator.network.container import Network from primaite.simulator.network.hardware.nodes.host.computer import Computer from primaite.simulator.network.hardware.nodes.host.host_node import NIC @@ -287,6 +288,20 @@ def arcd_uc2_network() -> Network: return network +def network_simulator_demo_example() -> Network: + """Returns a lightly modified version of the ARCD UC2 Network.""" + # Ensure that sys_log will be viewable for demo + SIM_OUTPUT.sys_log_level = LogLevel.DEBUG + SIM_OUTPUT.save_sys_logs = True + + network = arcd_uc2_network() + network.get_node_by_hostname("router_1").route_table.add_route( + address="192.168.10.0", subnet_mask="255.255.255.0", next_hop_ip_address="192.168.1.2" + ) + + return network + + def _get_example_network(path: str) -> Network: try: with open(path, "r") as file: @@ -308,7 +323,7 @@ def client_server_p2p_network_example() -> Network: def basic_lan_network_example() -> Network: """Get the basic LAN example network.""" - path = PRIMAITE_PATHS.user_config_path / "example_config" / "basic_network_network_example.yaml" + path = PRIMAITE_PATHS.user_config_path / "example_config" / "basic_lan_network_example.yaml" return _get_example_network(path) diff --git a/src/primaite/simulator/system/core/sys_log.py b/src/primaite/simulator/system/core/sys_log.py index d3afce94..cf68b674 100644 --- a/src/primaite/simulator/system/core/sys_log.py +++ b/src/primaite/simulator/system/core/sys_log.py @@ -52,7 +52,8 @@ class SysLog: file_handler.setFormatter(logging.Formatter(log_format)) self.logger = logging.getLogger(f"{self.hostname}_sys_log") - self.logger.handlers.clear() # clear handlers + for handler in self.logger.handlers: + self.logger.removeHandler(handler) self.logger.setLevel(logging.DEBUG) self.logger.addHandler(file_handler)