mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-22 14:32:21 +02:00
This highlights that the FileHandler class can also be seen as a method similar to open, and it removes unnecessary context managers, allowing plugins to close files as they wish (they must, however, remember to close the file for it to be committed).
218 lines
11 KiB
Python
218 lines
11 KiB
Python
# This file is Copyright 2019 Volatility Foundation and licensed under the Volatility Software License 1.0
|
|
# which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
|
|
#
|
|
|
|
import datetime
|
|
import logging
|
|
from typing import Callable, Iterable, List, Type
|
|
|
|
from volatility.framework import renderers, interfaces, layers, constants
|
|
from volatility.framework.configuration import requirements
|
|
from volatility.framework.objects import utility
|
|
from volatility.framework.renderers import format_hints
|
|
from volatility.framework.symbols import intermed
|
|
from volatility.framework.symbols.windows.extensions import pe
|
|
from volatility.plugins import timeliner
|
|
|
|
vollog = logging.getLogger(__name__)
|
|
|
|
|
|
class PsList(interfaces.plugins.PluginInterface, timeliner.TimeLinerInterface):
|
|
"""Lists the processes present in a particular windows memory image."""
|
|
|
|
_required_framework_version = (2, 0, 0)
|
|
_version = (2, 0, 0)
|
|
PHYSICAL_DEFAULT = False
|
|
|
|
@classmethod
|
|
def get_requirements(cls):
|
|
return [
|
|
requirements.TranslationLayerRequirement(name = 'primary',
|
|
description = 'Memory layer for the kernel',
|
|
architectures = ["Intel32", "Intel64"]),
|
|
requirements.SymbolTableRequirement(name = "nt_symbols", description = "Windows kernel symbols"),
|
|
requirements.BooleanRequirement(name = 'physical',
|
|
description = 'Display physical offsets instead of virtual',
|
|
default = cls.PHYSICAL_DEFAULT,
|
|
optional = True),
|
|
requirements.ListRequirement(name = 'pid',
|
|
element_type = int,
|
|
description = "Process ID to include (all other processes are excluded)",
|
|
optional = True),
|
|
requirements.BooleanRequirement(name = 'dump',
|
|
description = "Extract listed processes",
|
|
default = False,
|
|
optional = True)
|
|
]
|
|
|
|
@classmethod
|
|
def process_dump(
|
|
cls, context: interfaces.context.ContextInterface, kernel_table_name: str, pe_table_name: str,
|
|
proc: interfaces.objects.ObjectInterface,
|
|
open_method: Type[interfaces.plugins.FileHandlerInterface]) -> interfaces.plugins.FileHandlerInterface:
|
|
"""Extracts the complete data for a process as a FileHandlerInterface
|
|
|
|
Args:
|
|
context: the context to operate upon
|
|
kernel_table_name: the name for the symbol table containing the kernel's symbols
|
|
pe_table_name: the name for the symbol table containing the PE format symbols
|
|
proc: the process object whose memory should be output
|
|
open_method: class to provide context manager for opening the file
|
|
|
|
Returns:
|
|
An open FileHandlerInterface object containing the complete data for the process or None in the case of failure
|
|
"""
|
|
|
|
file_handle = None
|
|
try:
|
|
proc_layer_name = proc.add_process_layer()
|
|
peb = context.object(kernel_table_name + constants.BANG + "_PEB",
|
|
layer_name = proc_layer_name,
|
|
offset = proc.Peb)
|
|
|
|
dos_header = context.object(pe_table_name + constants.BANG + "_IMAGE_DOS_HEADER",
|
|
offset = peb.ImageBaseAddress,
|
|
layer_name = proc_layer_name)
|
|
file_handle = open_method("pid.{0}.{1:#x}.dmp".format(proc.UniqueProcessId, peb.ImageBaseAddress))
|
|
for offset, data in dos_header.reconstruct():
|
|
file_handle.seek(offset)
|
|
file_handle.write(data)
|
|
except Exception as excp:
|
|
vollog.debug("Unable to dump PE with pid {}: {}".format(proc.UniqueProcessId, excp))
|
|
|
|
return file_handle
|
|
|
|
@classmethod
|
|
def create_pid_filter(cls, pid_list: List[int] = None) -> Callable[[interfaces.objects.ObjectInterface], bool]:
|
|
"""A factory for producing filter functions that filter based on a list
|
|
of process IDs.
|
|
|
|
Args:
|
|
pid_list: A list of process IDs that are acceptable, all other processes will be filtered out
|
|
|
|
Returns:
|
|
Filter function for passing to the `list_processes` method
|
|
"""
|
|
filter_func = lambda _: False
|
|
# FIXME: mypy #4973 or #2608
|
|
pid_list = pid_list or []
|
|
filter_list = [x for x in pid_list if x is not None]
|
|
if filter_list:
|
|
filter_func = lambda x: x.UniqueProcessId not in filter_list
|
|
return filter_func
|
|
|
|
@classmethod
|
|
def create_name_filter(cls, name_list: List[str] = None) -> Callable[[interfaces.objects.ObjectInterface], bool]:
|
|
"""A factory for producing filter functions that filter based on a list
|
|
of process names.
|
|
|
|
Args:
|
|
name_list: A list of process names that are acceptable, all other processes will be filtered out
|
|
|
|
Returns:
|
|
Filter function for passing to the `list_processes` method
|
|
"""
|
|
filter_func = lambda _: False
|
|
# FIXME: mypy #4973 or #2608
|
|
name_list = name_list or []
|
|
filter_list = [x for x in name_list if x is not None]
|
|
if filter_list:
|
|
filter_func = lambda x: utility.array_to_string(x.ImageFileName) not in filter_list
|
|
return filter_func
|
|
|
|
@classmethod
|
|
def list_processes(cls,
|
|
context: interfaces.context.ContextInterface,
|
|
layer_name: str,
|
|
symbol_table: str,
|
|
filter_func: Callable[[interfaces.objects.ObjectInterface], bool] = lambda _: False) -> \
|
|
Iterable[interfaces.objects.ObjectInterface]:
|
|
"""Lists all the processes in the primary layer that are in the pid
|
|
config option.
|
|
|
|
Args:
|
|
context: The context to retrieve required elements (layers, symbol tables) from
|
|
layer_name: The name of the layer on which to operate
|
|
symbol_table: The name of the table containing the kernel symbols
|
|
filter_func: A function which takes an EPROCESS object and returns True if the process should be ignored/filtered
|
|
|
|
Returns:
|
|
The list of EPROCESS objects from the `layer_name` layer's PsActiveProcessHead list after filtering
|
|
"""
|
|
|
|
# We only use the object factory to demonstrate how to use one
|
|
kvo = context.layers[layer_name].config['kernel_virtual_offset']
|
|
ntkrnlmp = context.module(symbol_table, layer_name = layer_name, offset = kvo)
|
|
|
|
ps_aph_offset = ntkrnlmp.get_symbol("PsActiveProcessHead").address
|
|
list_entry = ntkrnlmp.object(object_type = "_LIST_ENTRY", offset = ps_aph_offset)
|
|
|
|
# This is example code to demonstrate how to use symbol_space directly, rather than through a module:
|
|
#
|
|
# ```
|
|
# reloff = self.context.symbol_space.get_type(
|
|
# self.config['nt_symbols'] + constants.BANG + "_EPROCESS").relative_child_offset(
|
|
# "ActiveProcessLinks")
|
|
# ```
|
|
#
|
|
# Note: "nt_symbols!_EPROCESS" could have been used, but would rely on the "nt_symbols" symbol table not already
|
|
# having been present. Strictly, the value of the requirement should be joined with the BANG character
|
|
# defined in the constants file
|
|
reloff = ntkrnlmp.get_type("_EPROCESS").relative_child_offset("ActiveProcessLinks")
|
|
eproc = ntkrnlmp.object(object_type = "_EPROCESS", offset = list_entry.vol.offset - reloff, absolute = True)
|
|
|
|
for proc in eproc.ActiveProcessLinks:
|
|
if not filter_func(proc):
|
|
yield proc
|
|
|
|
def _generator(self):
|
|
pe_table_name = intermed.IntermediateSymbolTable.create(self.context,
|
|
self.config_path,
|
|
"windows",
|
|
"pe",
|
|
class_types = pe.class_types)
|
|
|
|
memory = self.context.layers[self.config['primary']]
|
|
if not isinstance(memory, layers.intel.Intel):
|
|
raise TypeError("Primary layer is not an intel layer")
|
|
|
|
for proc in self.list_processes(self.context,
|
|
self.config['primary'],
|
|
self.config['nt_symbols'],
|
|
filter_func = self.create_pid_filter(self.config.get('pid', None))):
|
|
|
|
if not self.config.get('physical', self.PHYSICAL_DEFAULT):
|
|
offset = proc.vol.offset
|
|
else:
|
|
(_, _, offset, _, _) = list(memory.mapping(offset = proc.vol.offset, length = 0))[0]
|
|
|
|
file_output = "Disabled"
|
|
if self.config['dump']:
|
|
file_handle = self.process_dump(self.context, self.config['nt_symbols'], pe_table_name, proc,
|
|
self.open)
|
|
file_output = "Error outputting file"
|
|
if file_handle:
|
|
file_handle.close()
|
|
file_output = str(file_handle.preferred_filename)
|
|
|
|
yield (0, (proc.UniqueProcessId, proc.InheritedFromUniqueProcessId,
|
|
proc.ImageFileName.cast("string", max_length = proc.ImageFileName.vol.count, errors = 'replace'),
|
|
format_hints.Hex(offset), proc.ActiveThreads, proc.get_handle_count(), proc.get_session_id(),
|
|
proc.get_is_wow64(), proc.get_create_time(), proc.get_exit_time(), file_output))
|
|
|
|
def generate_timeline(self):
|
|
for row in self._generator():
|
|
_depth, row_data = row
|
|
description = "Process: {} {} ({})".format(row_data[0], row_data[2], row_data[3])
|
|
yield (description, timeliner.TimeLinerType.CREATED, row_data[8])
|
|
yield (description, timeliner.TimeLinerType.MODIFIED, row_data[9])
|
|
|
|
def run(self):
|
|
offsettype = "(V)" if not self.config.get('physical', self.PHYSICAL_DEFAULT) else "(P)"
|
|
|
|
return renderers.TreeGrid([("PID", int), ("PPID", int), ("ImageFileName", str),
|
|
("Offset{0}".format(offsettype), format_hints.Hex), ("Threads", int),
|
|
("Handles", int), ("SessionId", int), ("Wow64", bool),
|
|
("CreateTime", datetime.datetime), ("ExitTime", datetime.datetime),
|
|
("File output", str)], self._generator())
|