#2618 - Added NMAP application, documentation, and tests.

tests/integration_tests/system/test_nmap.py

@@ -0,0 +1,116 @@
+from enum import Enum
+from ipaddress import IPv4Address, IPv4Network
+
+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
+
+
+def test_ping_scan_all_on(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1.software_manager.install(NMAP)
+    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.software_manager.install(NMAP)
+    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.software_manager.install(NMAP)
+    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.10")]
+    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_off(example_network):
+    network = example_network
+
+    client_1 = network.get_node_by_hostname("client_1")
+    client_1.software_manager.install(NMAP)
+    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.software_manager.install(NMAP)
+    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.software_manager.install(NMAP)
+    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.21"): {IPProtocol.UDP: [Port.ARP]},
+        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)