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

Merge remote-tracking branch 'origin/dev' into feature/2470-refactor-syslog-to-be-able-to-leverage-a-configured-log-level

Browse Source
This commit is contained in:
Czar Echavez
2024-04-23 16:54:03 +01:00
parent 90343bd5ec a60e8b2203
commit 16fc6f4fd0
14 changed files with 234 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## 3.0.0b9 ## 3.0.0b9
- Removed deprecated `PrimaiteSession` class. - Removed deprecated `PrimaiteSession` class.
- Added ability to set log levels via configuration. - Added ability to set log levels via configuration.
- Upgraded pydantic to version 2.7.0
- Upgraded Ray to version >= 2.9
- Added ipywidgets to the dependencies
## [Unreleased] ## [Unreleased]
- Made requests fail to reach their target if the node is off - Made requests fail to reach their target if the node is off

5
pyproject.toml
View File

@@ -38,8 +38,9 @@ dependencies = [
"stable-baselines3[extra]==2.1.0", "stable-baselines3[extra]==2.1.0",
"tensorflow==2.12.0", "tensorflow==2.12.0",
"typer[all]==0.9.0", "typer[all]==0.9.0",
"pydantic==2.1.1", "pydantic==2.7.0",
"ray[rllib] == 2.8.0, < 3" "ray[rllib] >= 2.9, < 3",
"ipywidgets"
] ]
[tool.setuptools.dynamic] [tool.setuptools.dynamic]

12
src/primaite/config/_package_data/data_manipulation_marl.yaml
View File

@@ -1061,6 +1061,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 1 protocol_id: 1
source_wildcard_id: 0
dest_wildcard_id: 0
47: # old action num: 23 # "ACL: ADDRULE - Block outgoing traffic from client 2" 47: # old action num: 23 # "ACL: ADDRULE - Block outgoing traffic from client 2"
action: "ROUTER_ACL_ADDRULE" action: "ROUTER_ACL_ADDRULE"
options: options:
@@ -1072,6 +1074,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 1 protocol_id: 1
source_wildcard_id: 0
dest_wildcard_id: 0
48: # old action num: 24 # block tcp traffic from client 1 to web app 48: # old action num: 24 # block tcp traffic from client 1 to web app
action: "ROUTER_ACL_ADDRULE" action: "ROUTER_ACL_ADDRULE"
options: options:
@@ -1083,6 +1087,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 3 protocol_id: 3
source_wildcard_id: 0
dest_wildcard_id: 0
49: # old action num: 25 # block tcp traffic from client 2 to web app 49: # old action num: 25 # block tcp traffic from client 2 to web app
action: "ROUTER_ACL_ADDRULE" action: "ROUTER_ACL_ADDRULE"
options: options:
@@ -1094,6 +1100,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 3 protocol_id: 3
source_wildcard_id: 0
dest_wildcard_id: 0
50: # old action num: 26 50: # old action num: 26
action: "ROUTER_ACL_ADDRULE" action: "ROUTER_ACL_ADDRULE"
options: options:
@@ -1105,6 +1113,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 3 protocol_id: 3
source_wildcard_id: 0
dest_wildcard_id: 0
51: # old action num: 27 51: # old action num: 27
action: "ROUTER_ACL_ADDRULE" action: "ROUTER_ACL_ADDRULE"
options: options:
@@ -1116,6 +1126,8 @@ agents:
source_port_id: 1 source_port_id: 1
dest_port_id: 1 dest_port_id: 1
protocol_id: 3 protocol_id: 3
source_wildcard_id: 0
dest_wildcard_id: 0
52: # old action num: 28 52: # old action num: 28
action: "ROUTER_ACL_REMOVERULE" action: "ROUTER_ACL_REMOVERULE"
options: options:

7
src/primaite/game/agent/observations/host_observations.py
View File

@@ -227,6 +227,13 @@ class HostObservation(AbstractObservation, identifier="HOST"):
applications = [ApplicationObservation.from_config(config=c, parent_where=where) for c in config.applications] applications = [ApplicationObservation.from_config(config=c, parent_where=where) for c in config.applications]
folders = [FolderObservation.from_config(config=c, parent_where=where) for c in config.folders] folders = [FolderObservation.from_config(config=c, parent_where=where) for c in config.folders]
nics = [NICObservation.from_config(config=c, parent_where=where) for c in config.network_interfaces] nics = [NICObservation.from_config(config=c, parent_where=where) for c in config.network_interfaces]
# If list of network interfaces is not defined, assume we want to
# monitor the first N interfaces. Network interface numbering starts at 1.
count = 1
while len(nics) < config.num_nics:
nic_config = NICObservation.ConfigSchema(nic_num=count, include_nmne=config.include_nmne)
nics.append(NICObservation.from_config(config=nic_config, parent_where=where))
count += 1
return cls( return cls(
where=where, where=where,

4
src/primaite/game/agent/observations/observations.py
View File

@@ -1,6 +1,6 @@
"""Manages the observation space for the agent.""" """Manages the observation space for the agent."""
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from typing import Any, Dict, Iterable, Type from typing import Any, Dict, Iterable, Optional, Type, Union
from gymnasium import spaces from gymnasium import spaces
from gymnasium.core import ObsType from gymnasium.core import ObsType
@@ -9,7 +9,7 @@ from pydantic import BaseModel, ConfigDict
from primaite import getLogger from primaite import getLogger
_LOGGER = getLogger(__name__) _LOGGER = getLogger(__name__)
WhereType = Iterable[str | int] | None WhereType = Optional[Iterable[Union[str, int]]]
class AbstractObservation(ABC): class AbstractObservation(ABC):

4
src/primaite/game/agent/rewards.py
View File

@@ -26,7 +26,7 @@ the structure:
``` ```
""" """
from abc import abstractmethod from abc import abstractmethod
from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type, TYPE_CHECKING from typing import Callable, Dict, Iterable, List, Optional, Tuple, Type, TYPE_CHECKING, Union
from typing_extensions import Never from typing_extensions import Never
@@ -37,7 +37,7 @@ if TYPE_CHECKING:
from primaite.game.agent.interface import AgentActionHistoryItem from primaite.game.agent.interface import AgentActionHistoryItem
_LOGGER = getLogger(__name__) _LOGGER = getLogger(__name__)
WhereType = Iterable[str | int] | None WhereType = Optional[Iterable[Union[str, int]]]
class AbstractReward: class AbstractReward:

4
src/primaite/notebooks/Data-Manipulation-Customising-Red-Agent.ipynb
View File

@@ -362,7 +362,7 @@
" cfg = yaml.safe_load(f)\n", " cfg = yaml.safe_load(f)\n",
" cfg['simulation']['network']\n", " cfg['simulation']['network']\n",
" for node in cfg['simulation']['network']['nodes']:\n", " for node in cfg['simulation']['network']['nodes']:\n",
" if node['ref'] in ['client_1', 'client_2']:\n", " if node['hostname'] in ['client_1', 'client_2']:\n",
" node['applications'] = change['applications']\n", " node['applications'] = change['applications']\n",
"\n", "\n",
"env = PrimaiteGymEnv(game_config = cfg)\n", "env = PrimaiteGymEnv(game_config = cfg)\n",
@@ -407,7 +407,7 @@
" cfg = yaml.safe_load(f)\n", " cfg = yaml.safe_load(f)\n",
" cfg['simulation']['network']\n", " cfg['simulation']['network']\n",
" for node in cfg['simulation']['network']['nodes']:\n", " for node in cfg['simulation']['network']['nodes']:\n",
" if node['ref'] in ['client_1', 'client_2']:\n", " if node['hostname'] in ['client_1', 'client_2']:\n",
" node['applications'] = change['applications']\n", " node['applications'] = change['applications']\n",
"\n", "\n",
"env = PrimaiteGymEnv(game_config = cfg)\n", "env = PrimaiteGymEnv(game_config = cfg)\n",

76
src/primaite/notebooks/Training-an-SB3-Agent.ipynb
View File

@@ -1,5 +1,21 @@
{ {
"cells": [ "cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Training an SB3 Agent\n",
"\n",
"This notebook will demonstrate how to use primaite to create and train a PPO agent, using a pre-defined configuration file."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### First, we import the inital packages and read in our configuration file."
]
},
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
@@ -27,7 +43,14 @@
"outputs": [], "outputs": [],
"source": [ "source": [
"with open(data_manipulation_config_path(), 'r') as f:\n", "with open(data_manipulation_config_path(), 'r') as f:\n",
" cfg = yaml.safe_load(f)\n" " cfg = yaml.safe_load(f)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Using the given configuration, we generate the environment our agent will train in."
] ]
}, },
{ {
@@ -39,6 +62,13 @@
"gym = PrimaiteGymEnv(game_config=cfg)" "gym = PrimaiteGymEnv(game_config=cfg)"
] ]
}, },
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Lets define training parameters for the agent."
]
},
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
@@ -48,9 +78,9 @@
"from stable_baselines3 import PPO\n", "from stable_baselines3 import PPO\n",
"\n", "\n",
"EPISODE_LEN = 128\n", "EPISODE_LEN = 128\n",
"NO_STEPS = EPISODE_LEN * 10\n", "NUM_EPISODES = 10\n",
"BATCH_SIZE = EPISODE_LEN * 10\n", "NO_STEPS = EPISODE_LEN * NUM_EPISODES\n",
"TOTAL_TIMESTEPS = 5e3 * EPISODE_LEN\n", "BATCH_SIZE = 32\n",
"LEARNING_RATE = 3e-4" "LEARNING_RATE = 3e-4"
] ]
}, },
@@ -60,7 +90,14 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"model = PPO('MlpPolicy', gym, learning_rate=LEARNING_RATE, n_steps=NO_STEPS, batch_size=BATCH_SIZE, verbose=0, tensorboard_log=\"./PPO_UC2/\")\n" "model = PPO('MlpPolicy', gym, learning_rate=LEARNING_RATE, n_steps=NO_STEPS, batch_size=BATCH_SIZE, verbose=0, tensorboard_log=\"./PPO_UC2/\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"With the agent configured, let's train for our defined number of episodes."
] ]
}, },
{ {
@@ -69,7 +106,14 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"model.learn(total_timesteps=TOTAL_TIMESTEPS)\n" "model.learn(total_timesteps=NO_STEPS)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Next, let's save the agent to a zip file that can be used in future evaluation."
] ]
}, },
{ {
@@ -78,7 +122,14 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"model.save(\"PrimAITE-v3.0.0b7-PPO\")" "model.save(\"PrimAITE-PPO-example-agent\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Now, we load the saved agent and run it in evaluation mode."
] ]
}, },
{ {
@@ -88,7 +139,14 @@
"outputs": [], "outputs": [],
"source": [ "source": [
"eval_model = PPO(\"MlpPolicy\", gym)\n", "eval_model = PPO(\"MlpPolicy\", gym)\n",
"eval_model = PPO.load(\"PrimAITE-v3.0.0b7-PPO\", gym)" "eval_model = PPO.load(\"PrimAITE-PPO-example-agent\", gym)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Finally, evaluate the agent."
] ]
}, },
{ {
@@ -119,7 +177,7 @@
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython3", "pygments_lexer": "ipython3",
"version": "3.9.18" "version": "3.10.11"
} }
}, },
"nbformat": 4, "nbformat": 4,

34
src/primaite/simulator/_package_data/create-simulation_demo.ipynb
View File

@@ -6,7 +6,7 @@
"source": [ "source": [
"# Build a simulation using the Python API\n", "# Build a simulation using the Python API\n",
"\n", "\n",
"Currently, this notbook manipulates the simulation by directly placing objects inside of the attributes of the network and domain. It should be refactored when proper methods exist for adding these objects.\n" "Currently, this notebook manipulates the simulation by directly placing objects inside of the attributes of the network and domain. It should be refactored when proper methods exist for adding these objects.\n"
] ]
}, },
{ {
@@ -58,7 +58,8 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"from primaite.simulator.network.hardware.base import Node\n" "from primaite.simulator.network.hardware.nodes.host.computer import Computer\n",
"from primaite.simulator.network.hardware.nodes.host.server import Server"
] ]
}, },
{ {
@@ -67,9 +68,9 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"my_pc = Node(hostname=\"primaite_pc\",)\n", "my_pc = Computer(hostname=\"Computer\", ip_address=\"192.168.1.10\", subnet_mask=\"255.255.255.0\")\n",
"net.add_node(my_pc)\n", "net.add_node(my_pc)\n",
"my_server = Node(hostname=\"google_server\")\n", "my_server = Server(hostname=\"Server\", ip_address=\"192.168.1.11\", subnet_mask=\"255.255.255.0\")\n",
"net.add_node(my_server)\n" "net.add_node(my_server)\n"
] ]
}, },
@@ -86,7 +87,8 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"from primaite.simulator.network.hardware.base import NIC, Link, Switch\n" "from primaite.simulator.network.hardware.nodes.host.host_node import NIC\n",
"from primaite.simulator.network.hardware.nodes.network.switch import Switch\n"
] ]
}, },
{ {
@@ -95,19 +97,17 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"my_swtich = Switch(hostname=\"switch1\", num_ports=12)\n", "my_switch = Switch(hostname=\"switch1\", num_ports=12)\n",
"net.add_node(my_swtich)\n", "net.add_node(my_switch)\n",
"\n", "\n",
"pc_nic = NIC(ip_address=\"130.1.1.1\", gateway=\"130.1.1.255\", subnet_mask=\"255.255.255.0\")\n", "pc_nic = NIC(ip_address=\"130.1.1.1\", gateway=\"130.1.1.255\", subnet_mask=\"255.255.255.0\")\n",
"my_pc.connect_nic(pc_nic)\n", "my_pc.connect_nic(pc_nic)\n",
"\n", "\n",
"\n",
"server_nic = NIC(ip_address=\"130.1.1.2\", gateway=\"130.1.1.255\", subnet_mask=\"255.255.255.0\")\n", "server_nic = NIC(ip_address=\"130.1.1.2\", gateway=\"130.1.1.255\", subnet_mask=\"255.255.255.0\")\n",
"my_server.connect_nic(server_nic)\n", "my_server.connect_nic(server_nic)\n",
"\n", "\n",
"\n", "net.connect(pc_nic, my_switch.network_interface[1])\n",
"net.connect(pc_nic, my_swtich.switch_ports[1])\n", "net.connect(server_nic, my_switch.network_interface[2])\n"
"net.connect(server_nic, my_swtich.switch_ports[2])\n"
] ]
}, },
{ {
@@ -124,7 +124,8 @@
"outputs": [], "outputs": [],
"source": [ "source": [
"from primaite.simulator.file_system.file_type import FileType\n", "from primaite.simulator.file_system.file_type import FileType\n",
"from primaite.simulator.file_system.file_system import File" "from primaite.simulator.file_system.file_system import File\n",
"from primaite.simulator.system.core.sys_log import SysLog"
] ]
}, },
{ {
@@ -134,7 +135,7 @@
"outputs": [], "outputs": [],
"source": [ "source": [
"my_pc_downloads_folder = my_pc.file_system.create_folder(\"downloads\")\n", "my_pc_downloads_folder = my_pc.file_system.create_folder(\"downloads\")\n",
"my_pc_downloads_folder.add_file(File(name=\"firefox_installer.zip\",file_type=FileType.ZIP))" "my_pc_downloads_folder.add_file(File(name=\"firefox_installer.zip\",folder_id=\"Test\", folder_name=\"downloads\" ,file_type=FileType.ZIP, sys_log=SysLog(hostname=\"Test\")))"
] ]
}, },
{ {
@@ -160,9 +161,12 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"from pathlib import Path\n",
"from primaite.simulator.system.applications.application import Application, ApplicationOperatingState\n", "from primaite.simulator.system.applications.application import Application, ApplicationOperatingState\n",
"from primaite.simulator.system.software import SoftwareHealthState, SoftwareCriticality\n", "from primaite.simulator.system.software import SoftwareHealthState, SoftwareCriticality\n",
"from primaite.simulator.network.transmission.transport_layer import Port\n", "from primaite.simulator.network.transmission.transport_layer import Port\n",
"from primaite.simulator.network.transmission.network_layer import IPProtocol\n",
"from primaite.simulator.file_system.file_system import FileSystem\n",
"\n", "\n",
"# no applications exist yet so we will create our own.\n", "# no applications exist yet so we will create our own.\n",
"class MSPaint(Application):\n", "class MSPaint(Application):\n",
@@ -176,7 +180,7 @@
"metadata": {}, "metadata": {},
"outputs": [], "outputs": [],
"source": [ "source": [
"mspaint = MSPaint(name = \"mspaint\", health_state_actual=SoftwareHealthState.GOOD, health_state_visible=SoftwareHealthState.GOOD, criticality=SoftwareCriticality.MEDIUM, ports={Port.HTTP}, operating_state=ApplicationOperatingState.RUNNING,execution_control_status='manual')" "mspaint = MSPaint(name = \"mspaint\", health_state_actual=SoftwareHealthState.GOOD, health_state_visible=SoftwareHealthState.GOOD, criticality=SoftwareCriticality.MEDIUM, port=Port.HTTP, protocol = IPProtocol.NONE,operating_state=ApplicationOperatingState.RUNNING,execution_control_status='manual', file_system=FileSystem(sys_log=SysLog(hostname=\"Test\"), sim_root=Path(__name__).parent),)"
] ]
}, },
{ {
@@ -257,7 +261,7 @@
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython3", "pygments_lexer": "ipython3",
"version": "3.10.12" "version": "3.10.11"
} }
}, },
"nbformat": 4, "nbformat": 4,

208
src/primaite/simulator/_package_data/network_simulator_demo.ipynb
View File

@@ -238,7 +238,7 @@
"id": "20", "id": "20",
"metadata": {}, "metadata": {},
"source": [ "source": [
"Calling `switch.show()` displays the Switch orts on the Switch." "Calling `switch.show()` displays the Switch ports on the Switch."
] ]
}, },
{ {
@@ -256,11 +256,9 @@
{ {
"cell_type": "markdown", "cell_type": "markdown",
"id": "22", "id": "22",
"metadata": { "metadata": {},
"tags": []
},
"source": [ "source": [
"Calling `switch.arp.show()` displays the Switch ARP Cache." "Calling `switch.sys_log.show()` displays the Switch system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
] ]
}, },
{ {
@@ -271,33 +269,13 @@
"tags": [] "tags": []
}, },
"outputs": [], "outputs": [],
"source": [
"network.get_node_by_hostname(\"switch_1\").arp.show()"
]
},
{
"cell_type": "markdown",
"id": "24",
"metadata": {},
"source": [
"Calling `switch.sys_log.show()` displays the Switch system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "25",
"metadata": {
"tags": []
},
"outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"switch_1\").sys_log.show()" "network.get_node_by_hostname(\"switch_1\").sys_log.show()"
] ]
}, },
{ {
"cell_type": "markdown", "cell_type": "markdown",
"id": "26", "id": "24",
"metadata": {}, "metadata": {},
"source": [ "source": [
"### Computer/Server Nodes\n", "### Computer/Server Nodes\n",
@@ -307,7 +285,7 @@
}, },
{ {
"cell_type": "markdown", "cell_type": "markdown",
"id": "27", "id": "25",
"metadata": { "metadata": {
"tags": [] "tags": []
}, },
@@ -315,6 +293,26 @@
"Calling `computer.show()` displays the NICs on the Computer/Server." "Calling `computer.show()` displays the NICs on the Computer/Server."
] ]
}, },
{
"cell_type": "code",
"execution_count": null,
"id": "26",
"metadata": {
"tags": []
},
"outputs": [],
"source": [
"network.get_node_by_hostname(\"security_suite\").show()"
]
},
{
"cell_type": "markdown",
"id": "27",
"metadata": {},
"source": [
"Calling `computer.arp.show()` displays the Computer/Server ARP Cache."
]
},
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
@@ -324,7 +322,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"security_suite\").show()" "network.get_node_by_hostname(\"security_suite\").arp.show()"
] ]
}, },
{ {
@@ -332,7 +330,7 @@
"id": "29", "id": "29",
"metadata": {}, "metadata": {},
"source": [ "source": [
"Calling `computer.arp.show()` displays the Computer/Server ARP Cache." "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=<number of log entries>`."
] ]
}, },
{ {
@@ -344,7 +342,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"security_suite\").arp.show()" "network.get_node_by_hostname(\"security_suite\").sys_log.show()"
] ]
}, },
{ {
@@ -352,7 +350,9 @@
"id": "31", "id": "31",
"metadata": {}, "metadata": {},
"source": [ "source": [
"Calling `switch.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=<number of log entries>`." "## Basic Network Comms Check\n",
"\n",
"We can perform a good old ping to check that Nodes are able to communicate with each other."
] ]
}, },
{ {
@@ -364,7 +364,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"security_suite\").sys_log.show()" "network.show(nodes=False, links=False)"
] ]
}, },
{ {
@@ -372,9 +372,7 @@
"id": "33", "id": "33",
"metadata": {}, "metadata": {},
"source": [ "source": [
"## Basic Network Comms Check\n", "We'll first ping client_1's default gateway."
"\n",
"We can perform a good old ping to check that Nodes are able to communicate with each other."
] ]
}, },
{ {
@@ -386,27 +384,27 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.show(nodes=False, links=False)" "network.get_node_by_hostname(\"client_1\").ping(\"192.168.10.1\")"
]
},
{
"cell_type": "markdown",
"id": "35",
"metadata": {},
"source": [
"We'll first ping client_1's default gateway."
] ]
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
"id": "36", "id": "35",
"metadata": { "metadata": {
"tags": [] "tags": []
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_1\").ping(\"192.168.10.1\")" "network.get_node_by_hostname(\"client_1\").sys_log.show(15)"
]
},
{
"cell_type": "markdown",
"id": "36",
"metadata": {},
"source": [
"Next, we'll ping the interface of the 192.168.1.0/24 Network on the Router (port 1)."
] ]
}, },
{ {
@@ -418,7 +416,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_1\").sys_log.show(15)" "network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.1\")"
] ]
}, },
{ {
@@ -426,7 +424,7 @@
"id": "38", "id": "38",
"metadata": {}, "metadata": {},
"source": [ "source": [
"Next, we'll ping the interface of the 192.168.1.0/24 Network on the Router (port 1)." "And finally, we'll ping the web server."
] ]
}, },
{ {
@@ -438,7 +436,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.1\")" "network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.12\")"
] ]
}, },
{ {
@@ -446,7 +444,7 @@
"id": "40", "id": "40",
"metadata": {}, "metadata": {},
"source": [ "source": [
"And finally, we'll ping the web server." "To confirm that the ping was received and processed by the web_server, we can view the sys log"
] ]
}, },
{ {
@@ -458,7 +456,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.12\")" "network.get_node_by_hostname(\"web_server\").sys_log.show()"
] ]
}, },
{ {
@@ -466,29 +464,29 @@
"id": "42", "id": "42",
"metadata": {}, "metadata": {},
"source": [ "source": [
"To confirm that the ping was received and processed by the web_server, we can view the sys log" "## Advanced Network Usage\n",
"\n",
"We can now use the Network to perform some more advanced things."
]
},
{
"cell_type": "markdown",
"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..."
] ]
}, },
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
"id": "43", "id": "44",
"metadata": { "metadata": {
"tags": [] "tags": []
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"web_server\").sys_log.show()" "network.get_node_by_hostname(\"client_2\").ping(\"192.168.1.12\")"
]
},
{
"cell_type": "markdown",
"id": "44",
"metadata": {},
"source": [
"## Advanced Network Usage\n",
"\n",
"We can now use the Network to perform some more advaced things."
] ]
}, },
{ {
@@ -496,7 +494,7 @@
"id": "45", "id": "45",
"metadata": {}, "metadata": {},
"source": [ "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..." "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:"
] ]
}, },
{ {
@@ -508,7 +506,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_2\").ping(\"192.168.1.12\")" "network.get_node_by_hostname(\"client_2\").sys_log.show()"
] ]
}, },
{ {
@@ -516,7 +514,7 @@
"id": "47", "id": "47",
"metadata": {}, "metadata": {},
"source": [ "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:" "Now we'll add an ACL to block ICMP from 192.168.10.22"
] ]
}, },
{ {
@@ -527,30 +525,10 @@
"tags": [] "tags": []
}, },
"outputs": [], "outputs": [],
"source": [
"network.get_node_by_hostname(\"client_2\").sys_log.show()"
]
},
{
"cell_type": "markdown",
"id": "49",
"metadata": {},
"source": [
"Now we'll add an ACL to block ICMP from 192.168.10.22"
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "50",
"metadata": {
"tags": []
},
"outputs": [],
"source": [ "source": [
"from primaite.simulator.network.transmission.network_layer import IPProtocol\n", "from primaite.simulator.network.transmission.network_layer import IPProtocol\n",
"from primaite.simulator.network.transmission.transport_layer import Port\n", "from primaite.simulator.network.transmission.transport_layer import Port\n",
"from primaite.simulator.network.hardware.nodes.router import ACLAction\n", "from primaite.simulator.network.hardware.nodes.network.router import ACLAction\n",
"network.get_node_by_hostname(\"router_1\").acl.add_rule(\n", "network.get_node_by_hostname(\"router_1\").acl.add_rule(\n",
" action=ACLAction.DENY,\n", " action=ACLAction.DENY,\n",
" protocol=IPProtocol.ICMP,\n", " protocol=IPProtocol.ICMP,\n",
@@ -562,7 +540,7 @@
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
"id": "51", "id": "49",
"metadata": { "metadata": {
"tags": [] "tags": []
}, },
@@ -573,12 +551,32 @@
}, },
{ {
"cell_type": "markdown", "cell_type": "markdown",
"id": "52", "id": "50",
"metadata": {}, "metadata": {},
"source": [ "source": [
"Now we attempt (and fail) to ping the web server" "Now we attempt (and fail) to ping the web server"
] ]
}, },
{
"cell_type": "code",
"execution_count": null,
"id": "51",
"metadata": {
"tags": []
},
"outputs": [],
"source": [
"network.get_node_by_hostname(\"client_2\").ping(\"192.168.1.12\")"
]
},
{
"cell_type": "markdown",
"id": "52",
"metadata": {},
"source": [
"We can check that the ping was actually sent by client_2 by viewing the sys log"
]
},
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
@@ -588,7 +586,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_2\").ping(\"192.168.1.12\")" "network.get_node_by_hostname(\"client_2\").sys_log.show()"
] ]
}, },
{ {
@@ -596,7 +594,7 @@
"id": "54", "id": "54",
"metadata": {}, "metadata": {},
"source": [ "source": [
"We can check that the ping was actually sent by client_2 by viewing the sys log" "We can check the router sys log to see why the traffic was blocked"
] ]
}, },
{ {
@@ -608,7 +606,7 @@
}, },
"outputs": [], "outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_2\").sys_log.show()" "network.get_node_by_hostname(\"router_1\").sys_log.show()"
] ]
}, },
{ {
@@ -616,7 +614,7 @@
"id": "56", "id": "56",
"metadata": {}, "metadata": {},
"source": [ "source": [
"We can check the router sys log to see why the traffic was blocked" "Now a final check to ensure that client_1 can still ping the web_server."
] ]
}, },
{ {
@@ -627,26 +625,6 @@
"tags": [] "tags": []
}, },
"outputs": [], "outputs": [],
"source": [
"network.get_node_by_hostname(\"router_1\").sys_log.show()"
]
},
{
"cell_type": "markdown",
"id": "58",
"metadata": {},
"source": [
"Now a final check to ensure that client_1 can still ping the web_server."
]
},
{
"cell_type": "code",
"execution_count": null,
"id": "59",
"metadata": {
"tags": []
},
"outputs": [],
"source": [ "source": [
"network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.12\")" "network.get_node_by_hostname(\"client_1\").ping(\"192.168.1.12\")"
] ]
@@ -654,7 +632,7 @@
{ {
"cell_type": "code", "cell_type": "code",
"execution_count": null, "execution_count": null,
"id": "60", "id": "58",
"metadata": { "metadata": {
"tags": [] "tags": []
}, },

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

@@ -316,6 +316,16 @@ class HostNode(Node):
super().__init__(**kwargs) super().__init__(**kwargs)
self.connect_nic(NIC(ip_address=ip_address, subnet_mask=subnet_mask)) self.connect_nic(NIC(ip_address=ip_address, subnet_mask=subnet_mask))
@property
def arp(self) -> Optional[ARP]:
"""
Return the ARP Cache of the HostNode.
:return: ARP Cache for given HostNode
:rtype: Optional[ARP]
"""
return self.software_manager.software.get("ARP")
def _install_system_software(self): def _install_system_software(self):
""" """
Installs the system software and network services typically found on an operating system. Installs the system software and network services typically found on an operating system.

12
src/primaite/simulator/network/hardware/nodes/network/network_node.py
View File

@@ -1,7 +1,9 @@
from abc import abstractmethod from abc import abstractmethod
from typing import Optional
from primaite.simulator.network.hardware.base import NetworkInterface, Node from primaite.simulator.network.hardware.base import NetworkInterface, Node
from primaite.simulator.network.transmission.data_link_layer import Frame from primaite.simulator.network.transmission.data_link_layer import Frame
from primaite.simulator.system.services.arp.arp import ARP
class NetworkNode(Node): class NetworkNode(Node):
@@ -28,3 +30,13 @@ class NetworkNode(Node):
:type from_network_interface: NetworkInterface :type from_network_interface: NetworkInterface
""" """
pass pass
@property
def arp(self) -> Optional[ARP]:
"""
Return the ARP Cache of the NetworkNode.
:return: ARP Cache for given NetworkNode
:rtype: Optional[ARP]
"""
return self.software_manager.software.get("ARP")

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

@@ -1237,8 +1237,7 @@ class Router(NetworkNode):
icmp: RouterICMP = self.software_manager.icmp # noqa icmp: RouterICMP = self.software_manager.icmp # noqa
icmp.router = self icmp.router = self
self.software_manager.install(RouterARP) self.software_manager.install(RouterARP)
arp: RouterARP = self.software_manager.arp # noqa self.arp.router = self
arp.router = self
def _set_default_acl(self): def _set_default_acl(self):
""" """

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

@@ -233,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.sys_log.warning(msg) self.parent.sys_log.warning(msg)
return False return False
uuid = str(uuid4()) uuid = str(uuid4())