Merge remote-tracking branch 'origin/dev' into feature/2646_Update-pre-commit-to-check-for-valid-copyright

tests/integration_tests/system/red_applications/test_ransomware_script.py

@@ -10,12 +10,8 @@ from primaite.simulator.network.hardware.nodes.host.computer import Computer
 from primaite.simulator.network.hardware.nodes.host.server import Server
 from primaite.simulator.network.hardware.nodes.network.router import ACLAction, Router
 from primaite.simulator.network.transmission.transport_layer import Port
-from primaite.simulator.system.applications.application import ApplicationOperatingState
 from primaite.simulator.system.applications.database_client import DatabaseClient, DatabaseClientConnection
-from primaite.simulator.system.applications.red_applications.ransomware_script import (
-    RansomwareAttackStage,
-    RansomwareScript,
-)
+from primaite.simulator.system.applications.red_applications.ransomware_script import RansomwareScript
 from primaite.simulator.system.services.database.database_service import DatabaseService
 from primaite.simulator.system.software import SoftwareHealthState
 
@@ -86,54 +82,24 @@ def ransomware_script_db_server_green_client(example_network) -> Network:
     return network
 
 
-def test_repeating_ransomware_script_attack(ransomware_script_and_db_server):
+def test_ransomware_script_attack(ransomware_script_and_db_server):
     """Test a repeating data manipulation attack."""
     RansomwareScript, computer, db_server_service, server = ransomware_script_and_db_server
 
+    computer.apply_timestep(timestep=0)
+    server.apply_timestep(timestep=0)
     assert db_server_service.health_state_actual is SoftwareHealthState.GOOD
-    assert computer.file_system.num_file_creations == 0
+    assert server.file_system.num_file_creations == 1
 
-    RansomwareScript.target_scan_p_of_success = 1
-    RansomwareScript.c2_beacon_p_of_success = 1
-    RansomwareScript.ransomware_encrypt_p_of_success = 1
-    RansomwareScript.repeat = True
     RansomwareScript.attack()
 
-    assert RansomwareScript.attack_stage == RansomwareAttackStage.NOT_STARTED
-    assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.COMPROMISED
-    assert computer.file_system.num_file_creations == 1
+    assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.CORRUPT
+    assert server.file_system.num_file_creations == 2
 
     computer.apply_timestep(timestep=1)
     server.apply_timestep(timestep=1)
 
-    assert RansomwareScript.attack_stage == RansomwareAttackStage.NOT_STARTED
-    assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.COMPROMISED
-
-
-def test_repeating_ransomware_script_attack(ransomware_script_and_db_server):
-    """Test a repeating ransowmare script attack."""
-    RansomwareScript, computer, db_server_service, server = ransomware_script_and_db_server
-
-    assert db_server_service.health_state_actual is SoftwareHealthState.GOOD
-
-    RansomwareScript.target_scan_p_of_success = 1
-    RansomwareScript.c2_beacon_p_of_success = 1
-    RansomwareScript.ransomware_encrypt_p_of_success = 1
-    RansomwareScript.repeat = False
-    RansomwareScript.attack()
-
-    assert RansomwareScript.attack_stage == RansomwareAttackStage.SUCCEEDED
     assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.CORRUPT
-    assert computer.file_system.num_file_creations == 1
-
-    computer.apply_timestep(timestep=1)
-    computer.pre_timestep(timestep=1)
-    server.apply_timestep(timestep=1)
-    server.pre_timestep(timestep=1)
-
-    assert RansomwareScript.attack_stage == RansomwareAttackStage.SUCCEEDED
-    assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.CORRUPT
-    assert computer.file_system.num_file_creations == 0
 
 
 def test_ransomware_disrupts_green_agent_connection(ransomware_script_db_server_green_client):
@@ -154,10 +120,6 @@ def test_ransomware_disrupts_green_agent_connection(ransomware_script_db_server_
     assert green_db_client_connection.query("SELECT")
     assert green_db_client.last_query_response.get("status_code") == 200
 
-    ransomware_script_application.target_scan_p_of_success = 1
-    ransomware_script_application.ransomware_encrypt_p_of_success = 1
-    ransomware_script_application.c2_beacon_p_of_success = 1
-    ransomware_script_application.repeat = False
     ransomware_script_application.attack()
 
     assert db_server_service.db_file.health_status is FileSystemItemHealthStatus.CORRUPT

tests/integration_tests/system/test_nmap.py

@@ -0,0 +1,186 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+from enum import Enum
+from ipaddress import IPv4Address, IPv4Network
+
+import yaml
+
+from primaite.game.game import PrimaiteGame
+from primaite.simulator.network.transmission.network_layer import IPProtocol
+from primaite.simulator.network.transmission.transport_layer import Port
+from primaite.simulator.system.applications.nmap import NMAP
+from tests import TEST_ASSETS_ROOT
+
+
+def test_ping_scan_all_on(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    expected_result = [IPv4Address("192.168.1.10"), IPv4Address("192.168.1.14")]
+    actual_result = client_1_nmap.ping_scan(target_ip_address=["192.168.1.10", "192.168.1.14"])
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_ping_scan_all_on_full_network(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    expected_result = [IPv4Address("192.168.1.1"), IPv4Address("192.168.1.10"), IPv4Address("192.168.1.14")]
+    actual_result = client_1_nmap.ping_scan(target_ip_address=IPv4Network("192.168.1.0/24"))
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_ping_scan_some_on(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    network.get_node_by_hostname("server_2").power_off()
+
+    expected_result = [IPv4Address("192.168.1.1"), IPv4Address("192.168.1.10")]
+    actual_result = client_1_nmap.ping_scan(target_ip_address=IPv4Network("192.168.1.0/24"))
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_ping_scan_all_off(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    network.get_node_by_hostname("server_1").power_off()
+    network.get_node_by_hostname("server_2").power_off()
+
+    expected_result = []
+    actual_result = client_1_nmap.ping_scan(target_ip_address=["192.168.1.10", "192.168.1.14"])
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_port_scan_one_node_one_port(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    client_2 = network.get_node_by_hostname("client_2")
+
+    actual_result = client_1_nmap.port_scan(
+        target_ip_address=client_2.network_interface[1].ip_address, target_port=Port.DNS, target_protocol=IPProtocol.TCP
+    )
+
+    expected_result = {IPv4Address("192.168.10.22"): {IPProtocol.TCP: [Port.DNS]}}
+
+    assert actual_result == expected_result
+
+
+def sort_dict(d):
+    """Recursively sorts a dictionary."""
+    if isinstance(d, dict):
+        return {k: sort_dict(v) for k, v in sorted(d.items(), key=lambda item: str(item[0]))}
+    elif isinstance(d, list):
+        return sorted(d, key=lambda item: str(item) if isinstance(item, Enum) else item)
+    elif isinstance(d, Enum):
+        return str(d)
+    else:
+        return d
+
+
+def test_port_scan_full_subnet_all_ports_and_protocols(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    actual_result = client_1_nmap.port_scan(
+        target_ip_address=IPv4Network("192.168.10.0/24"),
+    )
+
+    expected_result = {
+        IPv4Address("192.168.10.1"): {IPProtocol.UDP: [Port.ARP]},
+        IPv4Address("192.168.10.22"): {
+            IPProtocol.TCP: [Port.HTTP, Port.FTP, Port.DNS],
+            IPProtocol.UDP: [Port.ARP, Port.NTP],
+        },
+    }
+
+    assert sort_dict(actual_result) == sort_dict(expected_result)
+
+
+def test_network_service_recon_all_ports_and_protocols(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1_nmap: NMAP = client_1.software_manager.software["NMAP"]  # noqa
+
+    actual_result = client_1_nmap.network_service_recon(
+        target_ip_address=IPv4Network("192.168.10.0/24"), target_port=Port.HTTP, target_protocol=IPProtocol.TCP
+    )
+
+    expected_result = {IPv4Address("192.168.10.22"): {IPProtocol.TCP: [Port.HTTP]}}
+
+    assert sort_dict(actual_result) == sort_dict(expected_result)
+
+
+def test_ping_scan_red_agent():
+    with open(TEST_ASSETS_ROOT / "configs/nmap_ping_scan_red_agent_config.yaml", "r") as file:
+        cfg = yaml.safe_load(file)
+
+    game = PrimaiteGame.from_config(cfg)
+
+    game.step()
+
+    expected_result = ["192.168.1.1", "192.168.1.10", "192.168.1.14"]
+
+    action_history = game.agents["client_1_red_nmap"].history
+    assert len(action_history) == 1
+    actual_result = action_history[0].response.data["live_hosts"]
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_port_scan_red_agent():
+    with open(TEST_ASSETS_ROOT / "configs/nmap_port_scan_red_agent_config.yaml", "r") as file:
+        cfg = yaml.safe_load(file)
+
+    game = PrimaiteGame.from_config(cfg)
+
+    game.step()
+
+    expected_result = {
+        "192.168.10.1": {"udp": [219]},
+        "192.168.10.22": {
+            "tcp": [80, 21, 53],
+            "udp": [219, 123],
+        },
+    }
+
+    action_history = game.agents["client_1_red_nmap"].history
+    assert len(action_history) == 1
+    actual_result = action_history[0].response.data
+
+    assert sorted(actual_result) == sorted(expected_result)
+
+
+def test_network_service_recon_red_agent():
+    with open(TEST_ASSETS_ROOT / "configs/nmap_network_service_recon_red_agent_config.yaml", "r") as file:
+        cfg = yaml.safe_load(file)
+
+    game = PrimaiteGame.from_config(cfg)
+
+    game.step()
+
+    expected_result = {"192.168.10.22": {"tcp": [80]}}
+
+    action_history = game.agents["client_1_red_nmap"].history
+    assert len(action_history) == 1
+    actual_result = action_history[0].response.data
+
+    assert sorted(actual_result) == sorted(expected_result)