Merge pull request #1624 from volatilityfoundation/feature/linux_ifconfig_plugin

Feature/linux ifconfig plugin

Author: ikelos

test/test_volatility.py

@@ -12,7 +12,6 @@
 import shutil
 import tempfile
 import hashlib
-import ntpath
 import json
 import contextlib
 
@@ -183,11 +182,7 @@ def test_windows_dumpfiles(image, volatility, python):
         known_files = json.load(json_file)
 
     failed_chksms = 0
-
-    if sys.platform == "win32":
-        file_name = ntpath.basename(image)
-    else:
-        file_name = os.path.basename(image)
+    file_name = os.path.basename(image)
 
     try:
         for addr in known_files["windows_dumpfiles"][file_name]:
@@ -842,6 +837,36 @@ def test_linux_hidden_modules(image, volatility, python):
     assert out.count(b"\n") >= 4
 
 
+def test_linux_ip_addr(image, volatility, python):
+    rc, out, err = runvol_plugin("linux.ip.Addr", image, volatility, python)
+
+    assert re.search(
+        rb"2\s+eth0\s+00:0c:29:8f:ed:ca\s+False\s+192.168.201.161\s+24\s+global\s+UP",
+        out,
+    )
+    assert re.search(
+        rb"2\s+eth0\s+00:0c:29:8f:ed:ca\s+False\s+fe80::20c:29ff:fe8f:edca\s+64\s+link\s+UP",
+        out,
+    )
+    assert out.count(b"\n") >= 8
+    assert rc == 0
+
+
+def test_linux_ip_link(image, volatility, python):
+    rc, out, err = runvol_plugin("linux.ip.Link", image, volatility, python)
+
+    assert re.search(
+        rb"-\s+lo\s+00:00:00:00:00:00\s+UNKNOWN\s+16436\s+noqueue\s+0\s+LOOPBACK,LOWER_UP,UP",
+        out,
+    )
+    assert re.search(
+        rb"-\s+eth0\s+00:0c:29:8f:ed:ca\s+UP\s+1500\s+pfifo_fast\s+1000\s+BROADCAST,LOWER_UP,MULTICAST,UP",
+        out,
+    )
+    assert out.count(b"\n") >= 6
+    assert rc == 0
+
+
 def test_linux_kallsyms(image, volatility, python):
     rc, out, _err = runvol_plugin(
         "linux.kallsyms.Kallsyms",

volatility3/framework/constants/_version.py

@@ -1,6 +1,6 @@
 # We use the SemVer 2.0.0 versioning scheme
 VERSION_MAJOR = 2  # Number of releases of the library with a breaking change
-VERSION_MINOR = 21  # Number of changes that only add to the interface
+VERSION_MINOR = 22  # Number of changes that only add to the interface
 VERSION_PATCH = 0  # Number of changes that do not change the interface
 VERSION_SUFFIX = ""
 

volatility3/framework/constants/linux/__init__.py

@@ -5,7 +5,7 @@
 
 Linux-specific values that aren't found in debug symbols
 """
-from enum import IntEnum, Flag
+import enum
 from dataclasses import dataclass
 
 KERNEL_NAME = "__kernel__"
@@ -282,8 +282,54 @@
 
 ELF_MAX_EXTRACTION_SIZE = 1024 * 1024 * 1024 * 4 - 1
 
+# For IFA_* below - Ref: include/net/ipv6.h
+IPV6_ADDR_LOOPBACK = 0x0010
+IPV6_ADDR_LINKLOCAL = 0x0020
+IPV6_ADDR_SITELOCAL = 0x0040
+# For inet6_ifaddr - Ref: include/net/if_inet6.h
+IFA_HOST = IPV6_ADDR_LOOPBACK
+IFA_LINK = IPV6_ADDR_LINKLOCAL
+IFA_SITE = IPV6_ADDR_SITELOCAL
+
+# Only for kernels < 3.15 when the net_device_flags enum didn't exist
+# ref include/uapi/linux/if.h
+NET_DEVICE_FLAGS = {
+    "IFF_UP": 0x1,
+    "IFF_BROADCAST": 0x2,
+    "IFF_DEBUG": 0x4,
+    "IFF_LOOPBACK": 0x8,
+    "IFF_POINTOPOINT": 0x10,
+    "IFF_NOTRAILERS": 0x20,
+    "IFF_RUNNING": 0x40,
+    "IFF_NOARP": 0x80,
+    "IFF_PROMISC": 0x100,
+    "IFF_ALLMULTI": 0x200,
+    "IFF_MASTER": 0x400,
+    "IFF_SLAVE": 0x800,
+    "IFF_MULTICAST": 0x1000,
+    "IFF_PORTSEL": 0x2000,
+    "IFF_AUTOMEDIA": 0x4000,
+    "IFF_DYNAMIC": 0x8000,
+    "IFF_LOWER_UP": 0x10000,
+    "IFF_DORMANT": 0x20000,
+    "IFF_ECHO": 0x40000,
+}
+
+
+# Kernels >= 2.6.17. See IF_OPER_* in include/uapi/linux/if.h
+class IF_OPER_STATES(enum.Enum):
+    """RFC 2863 - Network interface operational status"""
 
-class ELF_IDENT(IntEnum):
+    UNKNOWN = 0
+    NOTPRESENT = 1
+    DOWN = 2
+    LOWERLAYERDOWN = 3
+    TESTING = 4
+    DORMANT = 5
+    UP = 6
+
+
+class ELF_IDENT(enum.IntEnum):
     """ELF header e_ident indexes"""
 
     EI_MAG0 = 0
@@ -297,7 +343,7 @@ class ELF_IDENT(IntEnum):
     EI_PAD = 8
 
 
-class ELF_CLASS(IntEnum):
+class ELF_CLASS(enum.IntEnum):
     """ELF header class types"""
 
     ELFCLASSNONE = 0
@@ -320,8 +366,9 @@ class ELF_CLASS(IntEnum):
 PTRACE_O_SUSPEND_SECCOMP = 1 << 21
 
 
-class PT_FLAGS(Flag):
+class PT_FLAGS(enum.Flag):
     "PTrace flags"
+
     PT_PTRACED = 0x00001
     PT_SEIZED = 0x10000
 

volatility3/framework/interfaces/objects.py

@@ -133,7 +133,7 @@ def __init__(
 
     def __getattr__(self, attr: str) -> Any:
         """Method for ensuring volatility members can be returned."""
-        raise AttributeError
+        raise AttributeError()
 
     @property
     def vol(self) -> ReadOnlyMapping:

volatility3/framework/plugins/linux/ip.py

@@ -0,0 +1,159 @@
+# This file is Copyright 2023 Volatility Foundation and licensed under the Volatility Software License 1.0
+# which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
+#
+
+from typing import List
+from volatility3.framework import interfaces, renderers, constants
+from volatility3.framework.configuration import requirements
+from volatility3.framework.interfaces import plugins
+from volatility3.framework.symbols.linux import network
+from volatility3.framework.symbols.linux.extensions import network as net_extensions
+
+
+class Addr(plugins.PluginInterface):
+    """Lists network interface information for all devices"""
+
+    _required_framework_version = (2, 22, 0)
+
+    _version = (1, 0, 1)
+
+    @classmethod
+    def get_requirements(cls) -> List[interfaces.configuration.RequirementInterface]:
+        return [
+            requirements.ModuleRequirement(
+                name="kernel",
+                description="Linux kernel",
+                architectures=["Intel32", "Intel64"],
+            ),
+            requirements.VersionRequirement(
+                name="Net", component=network.NetSymbols, version=(1, 0, 0)
+            ),
+        ]
+
+    def _gather_net_dev_info(self, net_dev: net_extensions.net_device):
+        mac_addr = net_dev.get_mac_address()
+        promisc = net_dev.promisc
+        operational_state = net_dev.get_operational_state()
+        iface_name = net_dev.get_device_name()
+        iface_ifindex = net_dev.ifindex
+        try:
+            net_ns_id = net_dev.get_net_namespace_id()
+        except AttributeError:
+            net_ns_id = renderers.NotAvailableValue()
+
+        # Interface IPv4 Addresses
+        in_device = net_dev.ip_ptr.dereference().cast("in_device")
+        for in_ifaddr in in_device.get_addresses():
+            prefix_len = in_ifaddr.get_prefix_len()
+            scope_type = in_ifaddr.get_scope_type()
+            ip_addr = in_ifaddr.get_address()
+            yield net_ns_id, iface_ifindex, iface_name, mac_addr, promisc, ip_addr, prefix_len, scope_type, operational_state
+
+        # Interface IPv6 Addresses
+        inet6_dev = net_dev.ip6_ptr.dereference().cast("inet6_dev")
+        for inet6_ifaddr in inet6_dev.get_addresses():
+            prefix_len = inet6_ifaddr.get_prefix_len()
+            scope_type = inet6_ifaddr.get_scope_type()
+            ip6_addr = inet6_ifaddr.get_address()
+            yield net_ns_id, iface_ifindex, iface_name, mac_addr, promisc, ip6_addr, prefix_len, scope_type, operational_state
+
+    def _generator(self):
+        vmlinux = self.context.modules[self.config["kernel"]]
+
+        net_type_symname = vmlinux.symbol_table_name + constants.BANG + "net"
+        net_device_symname = vmlinux.symbol_table_name + constants.BANG + "net_device"
+        network.NetSymbols.apply(self.context.symbol_space[vmlinux.symbol_table_name])
+
+        # 'net_namespace_list' exists from kernels >= 2.6.24
+        net_namespace_list = vmlinux.object_from_symbol("net_namespace_list")
+        for net_ns in net_namespace_list.to_list(net_type_symname, "list"):
+            for net_dev in net_ns.dev_base_head.to_list(net_device_symname, "dev_list"):
+                for fields in self._gather_net_dev_info(net_dev):
+                    yield 0, fields
+
+    def run(self):
+        headers = [
+            ("NetNS", int),
+            ("Index", int),
+            ("Interface", str),
+            ("MAC", str),
+            ("Promiscuous", bool),
+            ("IP", str),
+            ("Prefix", int),
+            ("Scope Type", str),
+            ("State", str),
+        ]
+
+        return renderers.TreeGrid(headers, self._generator())
+
+
+class Link(plugins.PluginInterface):
+    """Lists information about network interfaces similar to `ip link show`"""
+
+    _required_framework_version = (2, 0, 0)
+    _version = (1, 0, 0)
+
+    @classmethod
+    def get_requirements(cls) -> List[interfaces.configuration.RequirementInterface]:
+        return [
+            requirements.ModuleRequirement(
+                name="kernel",
+                description="Linux kernel",
+                architectures=["Intel32", "Intel64"],
+            ),
+            requirements.VersionRequirement(
+                name="Net", component=network.NetSymbols, version=(1, 0, 0)
+            ),
+        ]
+
+    def _gather_net_dev_link_info(self, net_device):
+        mac_addr = net_device.get_mac_address()
+        operational_state = net_device.get_operational_state()
+        iface_name = net_device.get_device_name()
+        mtu = net_device.mtu
+        qdisc_name = net_device.get_qdisc_name()
+        qlen = net_device.get_queue_length()
+        try:
+            net_ns_id = net_device.get_net_namespace_id()
+        except AttributeError:
+            net_ns_id = renderers.NotAvailableValue()
+
+        # Format flags to string. Drop IFF_ to match iproute2 'ip link' output.
+        # Also, note that iproute2 removes IFF_RUNNING, see print_link_flags()
+        flags_list = [
+            flag.replace("IFF_", "")
+            for flag in net_device.get_flag_names()
+            if flag != "IFF_RUNNING"
+        ]
+        flags_str = ",".join(flags_list)
+
+        yield net_ns_id, iface_name, mac_addr, operational_state, mtu, qdisc_name, qlen, flags_str
+
+    def _generator(self):
+        vmlinux = self.context.modules[self.config["kernel"]]
+
+        network.NetSymbols.apply(self.context.symbol_space[vmlinux.symbol_table_name])
+
+        net_type_symname = vmlinux.symbol_table_name + constants.BANG + "net"
+        net_device_symname = vmlinux.symbol_table_name + constants.BANG + "net_device"
+
+        # 'net_namespace_list' exists from kernels >= 2.6.24
+        net_namespace_list = vmlinux.object_from_symbol("net_namespace_list")
+        for net_ns in net_namespace_list.to_list(net_type_symname, "list"):
+            for net_dev in net_ns.dev_base_head.to_list(net_device_symname, "dev_list"):
+                for fields in self._gather_net_dev_link_info(net_dev):
+                    yield 0, fields
+
+    def run(self):
+        headers = [
+            ("NS", int),
+            ("Interface", str),
+            ("MAC", str),
+            ("State", str),
+            ("MTU", int),
+            ("Qdisc", str),
+            ("Qlen", int),
+            ("Flags", str),
+        ]
+
+        return renderers.TreeGrid(headers, self._generator())