Files
volatilityfoundation-volati…/volatility/plugins/volshell.py
T
2012-03-08 20:58:06 +00:00

380 lines
15 KiB
Python

# Volatility
# Copyright (C) 2008 Volatile Systems
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
@author: AAron Walters and Brendan Dolan-Gavitt
@license: GNU General Public License 2.0 or later
@contact: awalters@volatilesystems.com,bdolangavitt@wesleyan.edu
@organization: Volatile Systems
"""
import struct
import sys
import volatility.commands as commands
import volatility.win32 as win32
import volatility.utils as utils
import volatility.obj as obj
try:
import distorm3 #pylint: disable-msg=F0401
except ImportError:
pass
class volshell(commands.Command):
"""Shell in the memory image"""
# Declare meta information associated with this plugin
meta_info = {}
meta_info['author'] = 'Brendan Dolan-Gavitt'
meta_info['copyright'] = 'Copyright (c) 2007,2008 Brendan Dolan-Gavitt'
meta_info['contact'] = 'bdolangavitt@wesleyan.edu'
meta_info['license'] = 'GNU General Public License 2.0 or later'
meta_info['url'] = 'http://moyix.blogspot.com/'
meta_info['os'] = 'WIN_32_XP_SP2'
meta_info['version'] = '1.3'
def __init__(self, config, *args, **kwargs):
commands.Command.__init__(self, config, *args, **kwargs)
config.add_option('OFFSET', short_option = 'o', default = None,
help = 'EPROCESS Offset (in hex) in kernel address space',
action = 'store', type = 'int')
config.add_option('IMNAME', short_option = 'n', default = None,
help = 'Operate on these Process IDs (comma-separated)',
action = 'store', type = 'str')
config.add_option('PID', short_option = 'p', default = None,
help = 'Operate on these Process IDs (comma-separated)',
action = 'store', type = 'str')
self.addrspace = None
self.eproc = None
def getpidlist(self):
return win32.tasks.pslist(self.addrspace)
def context_display(self):
print "Current context: process {0}, pid={1}, ppid={2} DTB={3:#x}".format(self.eproc.ImageFileName,
self.eproc.UniqueProcessId.v(),
self.eproc.InheritedFromUniqueProcessId.v(),
self.eproc.Pcb.DirectoryTableBase.v())
def ps(self, procs = None):
print "{0:16} {1:6} {2:6} {3:8}".format("Name", "PID", "PPID", "Offset")
for eproc in procs or self.getpidlist():
print "{0:16} {1:<6} {2:<6} {3:#08x}".format(eproc.ImageFileName,
eproc.UniqueProcessId.v(),
eproc.InheritedFromUniqueProcessId.v(),
eproc.obj_offset)
def set_context(self, offset = None, pid = None, name = None):
if pid is not None:
offsets = []
for p in self.getpidlist():
if p.UniqueProcessId.v() == pid:
offsets.append(p)
if not offsets:
print "Unable to find process matching pid {0}".format(pid)
return
elif len(offsets) > 1:
print "Multiple processes match {0}, please specify by offset".format(pid)
print "Matching processes:"
self.ps(offsets)
return
else:
offset = offsets[0].v()
elif name is not None:
offsets = []
for p in self.getpidlist():
if p.ImageFileName.find(name) >= 0:
offsets.append(p)
if not offsets:
print "Unable to find process matching name {0}".format(name)
return
elif len(offsets) > 1:
print "Multiple processes match name {0}, please specify by PID or offset".format(name)
print "Matching processes:"
self.ps(offsets)
return
else:
offset = offsets[0].v()
elif offset is None:
print "Must provide one of: offset, name, or pid as a argument."
return
self.eproc = obj.Object("_EPROCESS", offset = offset, vm = self.addrspace)
self.context_display()
def render_text(self, _outfd, _data):
self.addrspace = utils.load_as(self._config)
if not self._config.OFFSET is None:
self.set_context(offset = self._config.OFFSET)
self.context_display()
elif self._config.PID is not None:
self.set_context(pid = self._config.PID)
elif self._config.IMNAME is not None:
self.set_context(name = self._config.IMNAME)
else:
# Just use the first process, whatever it is
for p in self.getpidlist():
self.set_context(offset = p.v())
break
# Functions inside the shell
def cc(offset = None, pid = None, name = None):
"""Change current shell context.
This function changes the current shell context to to the process
specified. The process specification can be given as a virtual address
(option: offset), PID (option: pid), or process name (option: name).
If multiple processes match the given PID or name, you will be shown a
list of matching processes, and will have to specify by offset.
"""
self.set_context(offset = offset, pid = pid, name = name)
def db(address, length = 0x80, width = 16, space = None):
"""Print bytes as canonical hexdump.
This function prints bytes at the given virtual address as a canonical
hexdump. The address will be translated in the current process context
(see help on cc for information on how to change contexts).
The length parameter (default: 0x80) specifies how many bytes to print,
the width parameter (default: 16) allows you to change how many bytes per
line should be displayed, and the space parameter allows you to
optionally specify the address space to read the data from.
"""
if not space:
space = self.eproc.get_process_address_space()
#if length % 4 != 0:
# length = (length+4) - (length%4)
data = space.read(address, length)
if not data:
print "Memory unreadable at {0:08x}".format(address)
return
for offset, hex, chars in utils.Hexdump(data):
print "{0:#010x} {1:<48} {2}".format(address + offset, hex, ''.join(chars))
def dd(address, length = 0x80, space = None):
"""Print dwords at address.
This function prints the data at the given address, interpreted as
a series of dwords (unsigned four-byte integers) in hexadecimal.
The address will be translated in the current process context
(see help on cc for information on how to change contexts).
The optional length parameter (default: 0x80) controls how many bytes
to display, and space allows you to optionally specify the address space
to read the data from.
"""
if not space:
space = self.eproc.get_process_address_space()
# round up to multiple of 4
if length % 4 != 0:
length = (length + 4) - (length % 4)
data = space.read(address, length)
if not data:
print "Memory unreadable at {0:08x}".format(address)
return
dwords = []
for i in range(0, length, 4):
(dw,) = struct.unpack("<L", data[i:i + 4])
dwords.append(dw)
if len(dwords) % 4 == 0: lines = len(dwords) / 4
else: lines = len(dwords) / 4 + 1
for i in range(lines):
ad = address + i * 0x10
lwords = dwords[i * 4:i * 4 + 4]
print ("{0:08x} ".format(ad)) + " ".join("{0:08x}".format(l) for l in lwords)
def ps():
"""Print a process listing.
Prints a process listing with PID, PPID, image name, and offset.
"""
self.ps()
def list_entry(head, objname, offset = -1, fieldname = None, forward = True):
"""Traverse a _LIST_ENTRY.
Traverses a _LIST_ENTRY starting at virtual address head made up of
objects of type objname. The value of offset should be set to the
offset of the _LIST_ENTRY within the desired object."""
vm = self.eproc.get_process_address_space()
seen = set()
if fieldname:
offset = vm.profile.get_obj_offset(objname, fieldname)
#if typ != "_LIST_ENTRY":
# print ("WARN: given field is not a LIST_ENTRY, attempting to "
# "continue anyway.")
lst = obj.Object("_LIST_ENTRY", head, vm)
seen.add(lst)
if not lst.is_valid():
return
while True:
if forward:
lst = lst.Flink
else:
lst = lst.Blink
if not lst.is_valid():
return
if lst in seen:
break
else:
seen.add(lst)
nobj = obj.Object(objname, lst.obj_offset - offset, vm)
yield nobj
def dt(objct, address = None, address_space = None):
"""Describe an object or show type info.
Show the names and values of a complex object (struct). If the name of a
structure is passed, show the struct's members and their types.
You can also pass a type name and an address in order to on-the-fly
interpret a given address as an instance of a particular structure.
Examples:
# Dump the current process object
dt(self.eproc)
# Show the _EPROCESS structure
dt('_EPROCESS')
# Overlay an _EPROCESS structure at 0x81234567
dt('_EPROCESS', 0x81234567)
"""
profile = (address_space or self.eproc.obj_vm).profile
if address is not None:
objct = obj.Object(objct, address, address_space or self.eproc.get_process_address_space())
if isinstance(objct, str):
size = profile.get_obj_size(objct)
membs = [ (profile.get_obj_offset(objct, m), m, profile.vtypes[objct][1][m][1]) for m in profile.vtypes[objct][1] ]
print repr(objct), "({0} bytes)".format(size)
for o, m, t in sorted(membs):
print "{0:6}: {1:30} {2}".format(hex(o), m, t)
elif isinstance(objct, obj.BaseObject):
membs = [ (o, m) for m, (o, _c) in objct.members.items() ]
print repr(objct)
offsets = []
for o, m in sorted(membs):
val = getattr(objct, m)
if isinstance(val, list):
val = [ str(v) for v in val ]
# Handle a potentially callable offset
if callable(o):
o = o(objct) - objct.obj_offset
offsets.append((o, m, val))
# Deal with potentially out of order offsets
offsets.sort(key = lambda x: x[0])
for o, m, val in offsets:
print "{0:6}: {1:30} {2}".format(hex(o), m, val)
else:
print "ERROR: first argument not an object or known type"
print
print "Usage:"
print
hh(dt)
def dis(address, length = 128, space = None):
"""Disassemble code at a given address.
Disassembles code starting at address for a number of bytes
given by the length parameter (default: 128).
Note: This feature requires distorm, available at
http://www.ragestorm.net/distorm/
"""
if not sys.modules.has_key("distorm3"):
print "ERROR: Disassembly unavailable, distorm not found"
return
if not space:
space = self.eproc.get_process_address_space()
data = space.read(address, length)
iterable = distorm3.DecodeGenerator(address, data, distorm3.Decode32Bits)
for (offset, size, instruction, hexdump) in iterable:
print "{0:<#8x} {1:<32} {2}".format(offset, hexdump, instruction)
shell_funcs = { 'cc': cc, 'dd': dd, 'db': db, 'ps': ps, 'dt': dt, 'list_entry': list_entry, 'dis': dis}
def hh(cmd = None):
"""Get help on a command."""
shell_funcs['hh'] = hh
import pydoc
from inspect import getargspec, formatargspec
if not cmd:
for f in shell_funcs:
doc = pydoc.getdoc(shell_funcs[f])
synop, _full = pydoc.splitdoc(doc)
print "{0:40} : {1}".format(f + formatargspec(*getargspec(shell_funcs[f])), synop)
print
print "For help on a specific command, type 'hh(<command>)'"
elif type(cmd) == str:
try:
doc = pydoc.getdoc(shell_funcs[cmd])
except KeyError:
print "No such command: {0}".format(cmd)
return
print doc
else:
doc = pydoc.getdoc(cmd)
print doc
# Break into shell
banner = "Welcome to volshell! Current memory image is:\n{0}\n".format(self._config.LOCATION)
banner += "To get help, type 'hh()'"
try:
from IPython.Shell import IPShellEmbed #pylint: disable-msg=W0611,F0401
shell = IPShellEmbed([], banner = banner)
shell()
except ImportError:
import code, inspect
frame = inspect.currentframe()
# Try to enable tab completion
try:
import rlcompleter, readline #pylint: disable-msg=W0612
readline.parse_and_bind("tab: complete")
except ImportError:
pass
# evaluate commands in current namespace
namespace = frame.f_globals.copy()
namespace.update(frame.f_locals)
code.interact(banner = banner, local = namespace)