From 01c508e248c624a1ab1d9459b01b72d7c0c28ab7 Mon Sep 17 00:00:00 2001 From: Kekoa Kaaikala Date: Mon, 29 Aug 2022 15:27:39 +0000 Subject: [PATCH] Agent: Replace NetworkInterface with IPv4Interface --- .../master/automated_master.py | 4 +- monkey/infection_monkey/master/propagator.py | 5 +- monkey/infection_monkey/monkey.py | 6 +- monkey/infection_monkey/network/__init__.py | 2 +- monkey/infection_monkey/network/info.py | 3 +- .../network_scanning/scan_target_generator.py | 11 ++-- .../master/test_propagator.py | 5 +- .../test_scan_target_generator.py | 63 ++++++++++--------- 8 files changed, 51 insertions(+), 48 deletions(-) diff --git a/monkey/infection_monkey/master/automated_master.py b/monkey/infection_monkey/master/automated_master.py index 55afad11a..e491e4537 100644 --- a/monkey/infection_monkey/master/automated_master.py +++ b/monkey/infection_monkey/master/automated_master.py @@ -1,6 +1,7 @@ import logging import threading import time +from ipaddress import IPv4Interface from typing import Any, Callable, Iterable, List, Optional from common.agent_configuration import CustomPBAConfiguration, PluginConfiguration @@ -10,7 +11,6 @@ from infection_monkey.i_control_channel import IControlChannel, IslandCommunicat from infection_monkey.i_master import IMaster from infection_monkey.i_puppet import IPuppet from infection_monkey.model import VictimHostFactory -from infection_monkey.network import NetworkInterface from infection_monkey.telemetry.credentials_telem import CredentialsTelem from infection_monkey.telemetry.messengers.i_telemetry_messenger import ITelemetryMessenger from infection_monkey.telemetry.post_breach_telem import PostBreachTelem @@ -39,7 +39,7 @@ class AutomatedMaster(IMaster): telemetry_messenger: ITelemetryMessenger, victim_host_factory: VictimHostFactory, control_channel: IControlChannel, - local_network_interfaces: List[NetworkInterface], + local_network_interfaces: List[IPv4Interface], credentials_store: IPropagationCredentialsRepository, ): self._current_depth = current_depth diff --git a/monkey/infection_monkey/master/propagator.py b/monkey/infection_monkey/master/propagator.py index 187ff645a..62f489657 100644 --- a/monkey/infection_monkey/master/propagator.py +++ b/monkey/infection_monkey/master/propagator.py @@ -1,5 +1,6 @@ import logging from dataclasses import replace +from ipaddress import IPv4Interface from queue import Queue from threading import Event from typing import List, Sequence @@ -18,7 +19,7 @@ from infection_monkey.i_puppet import ( PortStatus, ) from infection_monkey.model import VictimHost, VictimHostFactory -from infection_monkey.network import NetworkAddress, NetworkInterface +from infection_monkey.network import NetworkAddress from infection_monkey.network_scanning.scan_target_generator import compile_scan_target_list from infection_monkey.telemetry.exploit_telem import ExploitTelem from infection_monkey.telemetry.messengers.i_telemetry_messenger import ITelemetryMessenger @@ -37,7 +38,7 @@ class Propagator: ip_scanner: IPScanner, exploiter: Exploiter, victim_host_factory: VictimHostFactory, - local_network_interfaces: List[NetworkInterface], + local_network_interfaces: List[IPv4Interface], ): self._telemetry_messenger = telemetry_messenger self._ip_scanner = ip_scanner diff --git a/monkey/infection_monkey/monkey.py b/monkey/infection_monkey/monkey.py index 2a28d78f9..ff36ebb88 100644 --- a/monkey/infection_monkey/monkey.py +++ b/monkey/infection_monkey/monkey.py @@ -3,6 +3,7 @@ import logging import os import subprocess import sys +from ipaddress import IPv4Interface from pathlib import Path, WindowsPath from typing import List @@ -39,7 +40,6 @@ from infection_monkey.i_puppet import IPuppet, PluginType from infection_monkey.master import AutomatedMaster from infection_monkey.master.control_channel import ControlChannel from infection_monkey.model import VictimHostFactory -from infection_monkey.network import NetworkInterface from infection_monkey.network.firewall import app as firewall from infection_monkey.network.info import get_local_network_interfaces from infection_monkey.network_scanning.elasticsearch_fingerprinter import ElasticSearchFingerprinter @@ -364,7 +364,7 @@ class InfectionMonkey: return puppet def _build_victim_host_factory( - self, local_network_interfaces: List[NetworkInterface] + self, local_network_interfaces: List[IPv4Interface] ) -> VictimHostFactory: on_island = self._running_on_island(local_network_interfaces) logger.debug(f"This agent is running on the island: {on_island}") @@ -373,7 +373,7 @@ class InfectionMonkey: self._monkey_inbound_tunnel, self._cmd_island_ip, self._cmd_island_port, on_island ) - def _running_on_island(self, local_network_interfaces: List[NetworkInterface]) -> bool: + def _running_on_island(self, local_network_interfaces: List[IPv4Interface]) -> bool: server_ip, _ = address_to_ip_port(self._control_client.server_address) return server_ip in {interface.ip.compressed for interface in local_network_interfaces} diff --git a/monkey/infection_monkey/network/__init__.py b/monkey/infection_monkey/network/__init__.py index ba42da1ba..36117cbbe 100644 --- a/monkey/infection_monkey/network/__init__.py +++ b/monkey/infection_monkey/network/__init__.py @@ -1 +1 @@ -from .info import NetworkAddress, NetworkInterface +from .info import NetworkAddress diff --git a/monkey/infection_monkey/network/info.py b/monkey/infection_monkey/network/info.py index 99545d232..eee01040a 100644 --- a/monkey/infection_monkey/network/info.py +++ b/monkey/infection_monkey/network/info.py @@ -20,11 +20,10 @@ RTF_REJECT = 0x0200 # TODO: We can probably replace both of these namedtuples with classes in Python's ipaddress # library: https://docs.python.org/3/library/ipaddress.html -NetworkInterface = IPv4Interface NetworkAddress = namedtuple("NetworkAddress", ("ip", "domain")) -def get_local_network_interfaces() -> List[NetworkInterface]: +def get_local_network_interfaces() -> List[IPv4Interface]: return [IPv4Interface(f"{i['addr']}/{i['netmask']}") for i in get_host_subnets()] diff --git a/monkey/infection_monkey/network_scanning/scan_target_generator.py b/monkey/infection_monkey/network_scanning/scan_target_generator.py index a799bcce9..b4f5e4238 100644 --- a/monkey/infection_monkey/network_scanning/scan_target_generator.py +++ b/monkey/infection_monkey/network_scanning/scan_target_generator.py @@ -1,10 +1,11 @@ import itertools import logging import socket +from ipaddress import IPv4Interface from typing import Any, Dict, List from common.network.network_range import InvalidNetworkRangeError, NetworkRange -from infection_monkey.network import NetworkAddress, NetworkInterface +from infection_monkey.network import NetworkAddress logger = logging.getLogger(__name__) @@ -13,7 +14,7 @@ logger = logging.getLogger(__name__) def compile_scan_target_list( - local_network_interfaces: List[NetworkInterface], + local_network_interfaces: List[IPv4Interface], ranges_to_scan: List[str], inaccessible_subnets: List[str], blocklisted_ips: List[str], @@ -76,7 +77,7 @@ def _get_ips_from_ranges_to_scan(network_ranges: List[NetworkRange]) -> List[Net def _get_ips_to_scan_from_local_interface( - interfaces: List[NetworkInterface], + interfaces: List[IPv4Interface], ) -> List[NetworkAddress]: ranges = [ f"{interface.ip.compressed}/{interface.network.prefixlen}" for interface in interfaces @@ -89,7 +90,7 @@ def _get_ips_to_scan_from_local_interface( def _remove_interface_ips( - scan_targets: List[NetworkAddress], interfaces: List[NetworkInterface] + scan_targets: List[NetworkAddress], interfaces: List[IPv4Interface] ) -> List[NetworkAddress]: interface_ips = [interface.ip.compressed for interface in interfaces] return _remove_ips_from_scan_targets(scan_targets, interface_ips) @@ -114,7 +115,7 @@ def _remove_ips_from_scan_targets( def _get_segmentation_check_targets( - inaccessible_subnets: List[str], local_interfaces: List[NetworkInterface] + inaccessible_subnets: List[str], local_interfaces: List[IPv4Interface] ) -> List[NetworkAddress]: ips_to_scan = [] local_ips = [interface.ip.compressed for interface in local_interfaces] diff --git a/monkey/tests/unit_tests/infection_monkey/master/test_propagator.py b/monkey/tests/unit_tests/infection_monkey/master/test_propagator.py index 0ebb6db76..b8ceec5dd 100644 --- a/monkey/tests/unit_tests/infection_monkey/master/test_propagator.py +++ b/monkey/tests/unit_tests/infection_monkey/master/test_propagator.py @@ -1,3 +1,4 @@ +from ipaddress import IPv4Interface from threading import Event from unittest.mock import MagicMock @@ -17,7 +18,7 @@ from infection_monkey.i_puppet import ( ) from infection_monkey.master import IPScanResults, Propagator from infection_monkey.model import VictimHost, VictimHostFactory -from infection_monkey.network import NetworkAddress, NetworkInterface +from infection_monkey.network import NetworkAddress from infection_monkey.telemetry.exploit_telem import ExploitTelem @@ -294,7 +295,7 @@ def test_exploiter_result_processing( def test_scan_target_generation( telemetry_messenger_spy, mock_ip_scanner, mock_victim_host_factory, default_agent_configuration ): - local_network_interfaces = [NetworkInterface("10.0.0.9/29")] + local_network_interfaces = [IPv4Interface("10.0.0.9/29")] p = Propagator( telemetry_messenger_spy, mock_ip_scanner, diff --git a/monkey/tests/unit_tests/infection_monkey/network_scanning/test_scan_target_generator.py b/monkey/tests/unit_tests/infection_monkey/network_scanning/test_scan_target_generator.py index 2feff418b..25e5f9ed3 100644 --- a/monkey/tests/unit_tests/infection_monkey/network_scanning/test_scan_target_generator.py +++ b/monkey/tests/unit_tests/infection_monkey/network_scanning/test_scan_target_generator.py @@ -1,9 +1,10 @@ +from ipaddress import IPv4Interface from itertools import chain import pytest from common.network.network_range import InvalidNetworkRangeError -from infection_monkey.network import NetworkAddress, NetworkInterface +from infection_monkey.network import NetworkAddress from infection_monkey.network_scanning.scan_target_generator import compile_scan_target_list @@ -112,10 +113,10 @@ def test_only_ip_blocklisted(ranges_to_scan): def test_local_network_interface_ips_removed_from_targets(): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), - NetworkInterface("10.0.0.32/24"), - NetworkInterface("10.0.0.119/24"), - NetworkInterface("192.168.1.33/24"), + IPv4Interface("10.0.0.5/24"), + IPv4Interface("10.0.0.32/24"), + IPv4Interface("10.0.0.119/24"), + IPv4Interface("192.168.1.33/24"), ] scan_targets = compile_scan_target_list( @@ -133,7 +134,7 @@ def test_local_network_interface_ips_removed_from_targets(): def test_no_redundant_targets(): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), + IPv4Interface("10.0.0.5/24"), ] scan_targets = compile_scan_target_list( @@ -152,10 +153,10 @@ def test_no_redundant_targets(): @pytest.mark.parametrize("ranges_to_scan", [["10.0.0.5"], []]) def test_only_scan_ip_is_local(ranges_to_scan): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), - NetworkInterface("10.0.0.32/24"), - NetworkInterface("10.0.0.119/24"), - NetworkInterface("192.168.1.33/24"), + IPv4Interface("10.0.0.5/24"), + IPv4Interface("10.0.0.32/24"), + IPv4Interface("10.0.0.119/24"), + IPv4Interface("192.168.1.33/24"), ] scan_targets = compile_scan_target_list( @@ -171,10 +172,10 @@ def test_only_scan_ip_is_local(ranges_to_scan): def test_local_network_interface_ips_and_blocked_ips_removed_from_targets(): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), - NetworkInterface("10.0.0.32/24"), - NetworkInterface("10.0.0.119/24"), - NetworkInterface("192.168.1.33/24"), + IPv4Interface("10.0.0.5/24"), + IPv4Interface("10.0.0.32/24"), + IPv4Interface("10.0.0.119/24"), + IPv4Interface("192.168.1.33/24"), ] blocked_ips = ["10.0.0.63", "192.168.1.77", "0.0.0.0"] @@ -198,7 +199,7 @@ def test_local_network_interface_ips_and_blocked_ips_removed_from_targets(): def test_local_subnet_added(): - local_network_interfaces = [NetworkInterface("10.0.0.5/24")] + local_network_interfaces = [IPv4Interface("10.0.0.5/24")] scan_targets = compile_scan_target_list( local_network_interfaces=local_network_interfaces, @@ -216,8 +217,8 @@ def test_local_subnet_added(): def test_multiple_local_subnets_added(): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), - NetworkInterface("172.33.66.99/24"), + IPv4Interface("10.0.0.5/24"), + IPv4Interface("172.33.66.99/24"), ] scan_targets = compile_scan_target_list( @@ -239,8 +240,8 @@ def test_multiple_local_subnets_added(): def test_blocklisted_ips_missing_from_local_subnets(): local_network_interfaces = [ - NetworkInterface("10.0.0.5/24"), - NetworkInterface("172.33.66.99/24"), + IPv4Interface("10.0.0.5/24"), + IPv4Interface("172.33.66.99/24"), ] blocklisted_ips = ["10.0.0.12", "10.0.0.13", "172.33.66.25"] @@ -259,7 +260,7 @@ def test_blocklisted_ips_missing_from_local_subnets(): def test_local_subnets_and_ranges_added(): - local_network_interfaces = [NetworkInterface("10.0.0.5/24")] + local_network_interfaces = [IPv4Interface("10.0.0.5/24")] scan_targets = compile_scan_target_list( local_network_interfaces=local_network_interfaces, @@ -281,7 +282,7 @@ def test_local_subnets_and_ranges_added(): def test_local_network_interfaces_specified_but_disabled(): - local_network_interfaces = [NetworkInterface("10.0.0.5/24")] + local_network_interfaces = [IPv4Interface("10.0.0.5/24")] scan_targets = compile_scan_target_list( local_network_interfaces=local_network_interfaces, @@ -299,8 +300,8 @@ def test_local_network_interfaces_specified_but_disabled(): def test_local_network_interfaces_subnet_masks(): local_network_interfaces = [ - NetworkInterface("172.60.145.109/30"), - NetworkInterface("172.60.145.144/30"), + IPv4Interface("172.60.145.109/30"), + IPv4Interface("172.60.145.144/30"), ] scan_targets = compile_scan_target_list( @@ -318,7 +319,7 @@ def test_local_network_interfaces_subnet_masks(): def test_segmentation_targets(): - local_network_interfaces = [NetworkInterface("172.60.145.109/24")] + local_network_interfaces = [IPv4Interface("172.60.145.109/24")] inaccessible_subnets = ["172.60.145.108/30", "172.60.145.144/30"] @@ -338,7 +339,7 @@ def test_segmentation_targets(): def test_segmentation_clash_with_blocked(): local_network_interfaces = [ - NetworkInterface("172.60.145.109/30"), + IPv4Interface("172.60.145.109/30"), ] inaccessible_subnets = ["172.60.145.108/30", "172.60.145.149/30"] @@ -358,7 +359,7 @@ def test_segmentation_clash_with_blocked(): def test_segmentation_clash_with_targets(): local_network_interfaces = [ - NetworkInterface("172.60.145.109/30"), + IPv4Interface("172.60.145.109/30"), ] inaccessible_subnets = ["172.60.145.108/30", "172.60.145.149/30"] @@ -381,7 +382,7 @@ def test_segmentation_clash_with_targets(): def test_segmentation_one_network(): local_network_interfaces = [ - NetworkInterface("172.60.145.109/30"), + IPv4Interface("172.60.145.109/30"), ] inaccessible_subnets = ["172.60.145.1/24"] @@ -401,8 +402,8 @@ def test_segmentation_one_network(): def test_segmentation_inaccessible_networks(): local_network_interfaces = [ - NetworkInterface("172.60.1.1/24"), - NetworkInterface("172.60.2.1/24"), + IPv4Interface("172.60.1.1/24"), + IPv4Interface("172.60.2.1/24"), ] inaccessible_subnets = ["172.60.144.1/24", "172.60.146.1/24"] @@ -420,7 +421,7 @@ def test_segmentation_inaccessible_networks(): def test_invalid_inputs(): local_network_interfaces = [ - NetworkInterface("172.60.145.109/30"), + IPv4Interface("172.60.145.109/30"), ] inaccessible_subnets = [ @@ -446,7 +447,7 @@ def test_invalid_inputs(): def test_invalid_blocklisted_ip(): - local_network_interfaces = [NetworkInterface("172.60.145.109/30")] + local_network_interfaces = [IPv4Interface("172.60.145.109/30")] inaccessible_subnets = ["172.60.147.8/30", "172.60.147.148/30"]