Files
volatility3/volatility/framework/symbols/windows/extensions/__init__.py
T

514 lines
19 KiB
Python

import collections.abc
import datetime
import logging
import typing
from volatility.framework import constants, exceptions, interfaces, objects, renderers
from volatility.framework.symbols import generic
vollog = logging.getLogger(__name__)
# Keep these in a basic module, to prevent import cycles when symbol providers require them
class _MMVAD_SHORT(objects.Struct):
def traverse(self, visited = None, depth = 0):
"""Traverse the VAD tree, determining each underlying VAD node type by looking
up the tag in memory behind the structure (essentially the pool tag)."""
if depth > 100:
vollog.log(constants.LOGLEVEL_VVV, "Vad tree is too deep, something went wrong!")
raise RuntimeError("Vad tree is too deep")
if visited == None:
visited = set()
vad_address = self.vol.offset
if vad_address in visited:
vollog.log(constants.LOGLEVEL_VVV, "VAD node already seen!")
return
visited.add(vad_address)
memory = self._context.memory[self.vol.layer_name]
# the offset is different on 32 and 64 bits
symbol_table_name = self.vol.type_name.split(constants.BANG)[0]
if self._context.symbol_space.get_type(symbol_table_name + constants.BANG + "pointer").size == 4:
vad_address -= 4
else:
vad_address -= 12
try:
tag = memory.read(vad_address, 4, pad = False).decode()
if tag in ["VadS", "VadF"]:
target = "_MMVAD_SHORT"
elif tag.startswith("Vad"):
target = "_MMVAD"
elif depth == 0:
# the root node at depth 0 is allowed to not have a tag
# but we still want to continue and access its right & left child
target = None
else:
# any node other than the root that doesn't have a recognized tag
# is just garbage and we skip the node entirely
return
if target:
vad_object = self.cast(target)
setattr(vad_object, "Tag", tag)
yield vad_object
except exceptions.InvalidAddressException:
return
except UnicodeDecodeError:
pass
for vad_node in self.get_left_child().dereference().traverse(visited, depth + 1):
yield vad_node
for vad_node in self.get_right_child().dereference().traverse(visited, depth + 1):
yield vad_node
def get_right_child(self):
"""Get the right child member"""
if hasattr(self, "RightChild"):
return self.RightChild
elif hasattr(self, "Right"):
return self.Right
raise AttributeError("Unable to find the right child member")
def get_left_child(self):
"""Get the left child member"""
if hasattr(self, "LeftChild"):
return self.LeftChild
elif hasattr(self, "Left"):
return self.Left
raise AttributeError("Unable to find the left child member")
def get_parent(self):
"""Get the VAD's parent member"""
# this is for xp and 2003
if hasattr(self, "Parent"):
return self.Parent
# this is for vista through windows 7
elif hasattr(self, "u1") and hasattr(self.u1, "Parent"):
return self.u1.Parent & ~0x3
# this is for windows 8 and 10
elif hasattr(self, "VadNode"):
if hasattr(self.VadNode, "u1"):
return self.VadNode.u1.Parent & ~0x3
elif hasattr(self.VadNode, "ParentValue"):
return self.VadNode.ParentValue & ~0x3
# also for windows 8 and 10
elif hasattr(self, "Core"):
if hasattr(self.Core.VadNode, "u1"):
return self.Core.VadNode.u1.Parent & ~0x3
elif hasattr(self.Core.VadNode, "ParentValue"):
return self.Core.VadNode.ParentValue & ~0x3
raise AttributeError("Unable to find the parent member")
def get_start(self):
"""Get the VAD's starting virtual address"""
if hasattr(self, "StartingVpn"):
if hasattr(self, "StartingVpnHigh"):
return (self.StartingVpn << 12) | (self.StartingVpnHigh << 44)
else:
return self.StartingVpn << 12
elif hasattr(self, "Core"):
if hasattr(self.Core, "StartingVpnHigh"):
return (self.Core.StartingVpn << 12) | (self.Core.StartingVpnHigh << 44)
else:
return self.Core.StartingVpn << 12
raise AttributeError("Unable to find the starting VPN member")
def get_end(self):
"""Get the VAD's ending virtual address"""
if hasattr(self, "EndingVpn"):
if hasattr(self, "EndingVpnHigh"):
return (self.EndingVpn << 12) | (self.EndingVpnHigh << 44)
else:
return ((self.EndingVpn + 1) << 12) - 1
elif hasattr(self, "Core"):
if hasattr(self.Core, "EndingVpnHigh"):
return (self.Core.EndingVpn << 12) | (self.Core.EndingVpnHigh << 44)
else:
return ((self.Core.EndingVpn + 1) << 12) - 1
raise AttributeError("Unable to find the ending VPN member")
def get_commit_charge(self):
"""Get the VAD's commit charge (number of committed pages)"""
if hasattr(self, "u1") and hasattr(self.u1, "VadFlags1"):
return self.u1.VadFlags1.CommitCharge
if hasattr(self, "u") and hasattr(self.u, "VadFlags"):
return self.u.VadFlags.CommitCharge
elif hasattr(self, "Core"):
return self.Core.u1.VadFlags1.CommitCharge
raise AttributeError("Unable to find the commit charge member")
def get_private_memory(self):
"""Get the VAD's private memory setting"""
if hasattr(self, "u1") and hasattr(self.u1, "VadFlags1"):
return self.u1.VadFlags1.PrivateMemory
if hasattr(self, "u") and hasattr(self.u, "VadFlags"):
return self.u.VadFlags.PrivateMemory
elif hasattr(self, "Core"):
return self.Core.u1.VadFlags1.PrivateMemory
raise AttributeError("Unable to find the private memory member")
def get_protection(self, protect_values, winnt_protections):
"""Get the VAD's protection constants as a string"""
protect = None
if hasattr(self, "u"):
protect = self.u.VadFlags.Protection
elif hasattr(self, "Core"):
protect = self.Core.u.VadFlags.Protection
value = protect_values[protect]
names = []
for name, mask in winnt_protections.items():
if value & mask != 0:
names.append(name)
return "|".join(names)
def get_file_name(self):
"""Only long(er) vads have mapped files"""
return "" # TODO: followup after decision around returning None
class _MMVAD(_MMVAD_SHORT):
def get_file_name(self):
"""Get the name of the file mapped into the memory range (if any)"""
file_name = "" # TODO: followup after decision around returning None
try:
# this is for xp and 2003
if hasattr(self, "ControlArea"):
file_name = self.ControlArea.FilePointer.FileName.get_string()
# this is for vista through windows 7
else:
file_name = self.Subsection.ControlArea.FilePointer.dereference().cast("_FILE_OBJECT").FileName.get_string()
except exceptions.PagedInvalidAddressException:
pass
return file_name
class _EX_FAST_REF(objects.Struct):
"""This is a standard Windows structure that stores a pointer to an
object but also leverages the least significant bits to encode additional
details. When dereferencing the pointer, we need to strip off the extra bits."""
def dereference(self) -> interfaces.objects.ObjectInterface:
if constants.BANG not in self.vol.type_name:
raise ValueError("Invalid symbol table name syntax (no {} found)".format(constants.BANG))
# the mask value is different on 32 and 64 bits
symbol_table_name = self.vol.type_name.split(constants.BANG)[0]
if self._context.symbol_space.get_type(symbol_table_name + constants.BANG + "pointer").size == 4:
max_fast_ref = 7
else:
max_fast_ref = 15
return self._context.object(symbol_table_name + constants.BANG + "pointer", layer_name = self.vol.layer_name,
offset = self.Object & ~max_fast_ref)
class ExecutiveObject(interfaces.objects.ObjectInterface):
"""This is used as a "mixin" that provides all kernel executive
objects with a means of finding their own object header."""
def object_header(self) -> '_OBJECT_HEADER':
if constants.BANG not in self.vol.type_name:
raise ValueError("Invalid symbol table name syntax (no {} found)".format(constants.BANG))
symbol_table_name = self.vol.type_name.split(constants.BANG)[0]
body_offset = self._context.symbol_space.get_type(
symbol_table_name + constants.BANG + "_OBJECT_HEADER").relative_child_offset("Body")
return self._context.object(symbol_table_name + constants.BANG + "_OBJECT_HEADER",
layer_name = self.vol.layer_name, offset = self.vol.offset - body_offset)
class _CM_KEY_BODY(objects.Struct):
"""This represents an open handle to a registry key and
is not tied to the registry hive file format on disk."""
def get_full_key_name(self) -> str:
output = []
kcb = self.KeyControlBlock
while kcb.ParentKcb:
if kcb.NameBlock.Name == None:
break
output.append(kcb.NameBlock.Name.cast("string",
encoding = "utf8",
max_length = kcb.NameBlock.NameLength,
errors = "replace"))
kcb = kcb.ParentKcb
return "\\".join(reversed(output))
class _DEVICE_OBJECT(objects.Struct, ExecutiveObject):
def get_device_name(self) -> str:
header = self.object_header()
return header.NameInfo.Name.String # type: ignore
class _FILE_OBJECT(objects.Struct, ExecutiveObject):
def file_name_with_device(self) -> str:
name = "" # TODO: followup after decision around returning None
if self._context.memory[self.vol.layer_name].is_valid(self.DeviceObject):
name = "\\Device\\{}".format(self.DeviceObject.get_device_name())
try:
name += self.FileName.String
except exceptions.PagedInvalidAddressException:
pass
return name
class _OBJECT_HEADER(objects.Struct):
@property
def NameInfo(self) -> interfaces.objects.ObjectInterface:
if constants.BANG not in self.vol.type_name:
raise ValueError("Invalid symbol table name syntax (no {} found)".format(constants.BANG))
symbol_table_name = self.vol.type_name.split(constants.BANG)[0]
try:
header_offset = ord(self.NameInfoOffset)
except AttributeError:
# http://codemachine.com/article_objectheader.html (Windows 7 and later)
name_info_bit = 0x2
layer = self._context.memory[self.vol.layer_name]
kvo = layer.config.get("kernel_virtual_offset", None)
if kvo == None:
raise AttributeError("Could not find kernel_virtual_offset for layer: {}".format(self.vol.layer_name))
ntkrnlmp = self._context.module(symbol_table_name, layer_name = self.vol.layer_name, offset = kvo)
address = ntkrnlmp.get_symbol("ObpInfoMaskToOffset").address
calculated_index = ord(self.InfoMask) & (name_info_bit | (name_info_bit - 1))
header_offset = ord(self._context.object(symbol_table_name + constants.BANG + "unsigned char",
layer_name = self.vol.layer_name,
offset = kvo + address + calculated_index))
header = self._context.object(symbol_table_name + constants.BANG + "_OBJECT_HEADER_NAME_INFO",
layer_name = self.vol.layer_name,
offset = self.vol.offset - header_offset)
return header
class _ETHREAD(objects.Struct):
def owning_process(self, kernel_layer: str = None) -> interfaces.objects.ObjectInterface:
"""Return the EPROCESS that owns this thread"""
return self.ThreadsProcess.dereference(kernel_layer)
class _UNICODE_STRING(objects.Struct):
def get_string(self) -> interfaces.objects.ObjectInterface:
# We explicitly do *not* catch errors here, we allow an exception to be thrown
# (otherwise there's no way to determine anything went wrong)
# It's up to the user of this method to catch exceptions
return self.Buffer.dereference().cast("string", max_length = self.Length, errors = "replace",
encoding = "utf16")
String = property(get_string)
class _EPROCESS(generic.GenericIntelProcess):
def add_process_layer(self,
context: interfaces.context.ContextInterface,
config_prefix: str = None,
preferred_name: str = None):
"""Constructs a new layer based on the process's DirectoryTableBase"""
parent_layer = context.memory[self.vol.layer_name]
# Presumably for 64-bit systems, the DTB is defined as an array, rather than an unsigned long long
if isinstance(self.Pcb.DirectoryTableBase, objects.Array):
dtb = self.Pcb.DirectoryTableBase.cast("unsigned long long")
else:
dtb = self.Pcb.DirectoryTableBase
dtb = dtb & ((1 << parent_layer.bits_per_register) - 1)
# Add the constructed layer and return the name
return self._add_process_layer(context, dtb, config_prefix, preferred_name)
def load_order_modules(self) -> typing.Iterable[int]:
"""Generator for DLLs in the order that they were loaded"""
if constants.BANG not in self.vol.type_name:
raise ValueError("Invalid symbol table name syntax (no {} found)".format(constants.BANG))
proc_layer_name = self.add_process_layer(self._context)
proc_layer = self._context.memory[proc_layer_name]
if not proc_layer.is_valid(self.Peb):
raise StopIteration
sym_table = self.vol.type_name.split(constants.BANG)[0]
peb = self._context.object("{}{}_PEB".format(sym_table, constants.BANG), layer_name = proc_layer_name,
offset = self.Peb)
for entry in peb.Ldr.InLoadOrderModuleList.to_list(
"{}{}_LDR_DATA_TABLE_ENTRY".format(sym_table, constants.BANG), "InLoadOrderLinks"):
yield entry
def get_handle_count(self):
try:
if hasattr(self, "ObjectTable"):
if hasattr(self.ObjectTable, "HandleCount"):
return self.ObjectTable.HandleCount
except exceptions.PagedInvalidAddressException:
vollog.log(constants.LOGLEVEL_VVV,
"Cannot access _EPROCESS.ObjectTable.HandleCount at {0:#x}".format(self.vol.offset))
return renderers.UnreadableValue()
def get_session_id(self):
try:
if hasattr(self, "Session"):
if self.Session == 0:
return renderers.NotApplicableValue()
layer_name = self.vol.layer_name
symbol_table_name = self.get_symbol_table().name
kvo = self._context.memory[layer_name].config['kernel_virtual_offset']
ntkrnlmp = self._context.module(symbol_table_name, layer_name = layer_name, offset = kvo)
session = ntkrnlmp.object(type_name = "_MM_SESSION_SPACE", offset = self.Session)
if hasattr(session, "SessionId"):
return session.SessionId
except exceptions.PagedInvalidAddressException:
vollog.log(constants.LOGLEVEL_VVV,
"Cannot access _EPROCESS.Session.SessionId at {0:#x}".format(self.vol.offset))
return renderers.UnreadableValue()
def get_create_time(self):
unix_time = self.CreateTime.QuadPart // 10000000
if unix_time == 0:
return renderers.NotApplicableValue()
unix_time = unix_time - 11644473600
return str(datetime.datetime.utcfromtimestamp(unix_time))
def get_exit_time(self):
unix_time = self.ExitTime.QuadPart // 10000000
if unix_time == 0:
return renderers.NotApplicableValue()
unix_time = unix_time - 11644473600
return str(datetime.datetime.utcfromtimestamp(unix_time))
def get_wow_64_process(self):
if hasattr(self, "Wow64Process"):
return self.Wow64Process
elif hasattr(self, "WoW64Process"):
return self.WoW64Process
raise AttributeError("Unable to find Wow64Process")
def get_is_wow64(self):
try:
value = self.get_wow_64_process()
except AttributeError:
return False
return value != 0 and value != None
def get_vad_root(self):
# windows 8 and 2012 (_MM_AVL_TABLE)
if hasattr(self.VadRoot, "BalancedRoot"):
return self.VadRoot.BalancedRoot
# windows 8.1 and windows 10 (_RTL_AVL_TREE)
elif hasattr(self.VadRoot, "Root"):
return self.VadRoot.Root.dereference() # .cast("_MMVAD")
else:
# windows xp and 2003
return self.VadRoot.dereference().cast("_MMVAD")
class _LIST_ENTRY(objects.Struct, collections.abc.Iterable):
def to_list(self,
symbol_type: str,
member: str,
forward: bool = True,
sentinel: bool = True,
layer: typing.Optional[str] = None) -> typing.Iterator[interfaces.objects.ObjectInterface]:
"""Returns an iterator of the entries in the list"""
if layer is None:
layer = self.vol.layer_name
relative_offset = self._context.symbol_space.get_type(symbol_type).relative_child_offset(member)
direction = 'Blink'
if forward:
direction = 'Flink'
link = getattr(self, direction).dereference()
if not sentinel:
yield self._context.object(symbol_type, layer, offset = self.vol.offset - relative_offset)
seen = {self.vol.offset}
while link.vol.offset not in seen:
obj = self._context.object(symbol_type, layer, offset = link.vol.offset - relative_offset)
yield obj
seen.add(link.vol.offset)
link = getattr(link, direction).dereference()
def __iter__(self) -> typing.Iterator[interfaces.objects.ObjectInterface]:
return self.to_list(self.vol.parent.vol.type_name, self.vol.member_name)