Skip to content

Repository files navigation

Libvmi Python bindings

Join the chat at https://gitter.im/libvmi/pythonCI

If you'd rather perform introspection using Python instead of C, then these bindings will help get you going.

The bindings are Python 2 compatible.

Requirements

  • python3-pkgconfig
  • python3-cffi (> 1.6.0)
  • python3-future
  • libvmi

Setup

python setup.py build
python setup.py install

API

Constructor

The main class that you need to import is Libvmi.

The default parameters uses VMI_CONFIG_GLOBAL_FILE_ENTRY and calls vmi_init_complete:

fromlibvmiimportLibvmiwithLibvmi("Windows_7") asvmi:
os=vmi.get_ostype()

You can specify a string (VMI_CONFIG_STRING):

fromlibvmiimportLibvmi, VMIConfigconfig_str='{ostype = "Windows";win_pdbase=0x28;win_pid=0x180;win_tasks=0x188;win_pname=0x2e0;}'withLibvmi("Windows_7", mode=VMIConfig.STRING, config=config_str) asvmi:
os=vmi.get_ostype()

Or a dict (VMI_CONFIG_GHASHTABLE):

fromlibvmiimportLibvmi, VMIConfighash= {
"ostype": "Windows",
"win_pdbase": 0x28,
"win_tasks": 0x188,
"win_pid": 0x180,
"win_pname": 0x2e0,
}
withLibvmi("Windows_7", mode=VMIConfig.DICT, config=hash) asvmi:
os=vmi.get_ostype()

You can also use a partial initialization, which calls vmi_init. (It doesn't require a configuration):

fromlibvmiimportLibvmiwithLibvmi("Windows_7", partial=True) asvmi:

Examples

fromlibvmiimportLibvmi, AccessContext, TranslateMechanismwithLibvmi("Windows_7") asvmi:
pshead=vmi.read_addr_ksym("PsActiveProcessHead")
name=vmi.get_name()
id=vmi.get_vmid()
buffer, bytes_read=vmi.read_va(pshead, 4, 16)
vmi.write_va(pshead, 4, buffer)
ctx=AccessContext(TranslateMechanism.KERNEL_SYMBOL, ksym="PsActiveProcessHead")
buffer, bytes_read=vmi.read(ctx, 8)

Note: The implementation already checks if the return value is VMI_FAILURE and raises a LibvmiError in such case.

Integration

Volatility

You can use the volatlity framework directly in top of the bindings.

git clone https://github.com/volatilityfoundation/volatility /tmp
cp ./volatility/vmi.py /tmp/volatility/volatility/plugins/addrspaces/

Usage

python vol.py -l vmi://domain --profile=Win7SP0x64 pslist

Rekall

The Rekall address space is already integrated upstream.

Usage

rekall -f vmi://domain pslist

Contributors

  • Bryan D. Payne
  • Mathieu Tarral

About

LibVMI Python bindings

Topics

Resources

Stars

35 stars

Watchers

8 watching

Forks

Releases

Packages

Used by

Contributors

Languages