From a928a15b8bfe41780c0cd1e1d6f025f9fa913a32 Mon Sep 17 00:00:00 2001 From: Wesley Shields Date: Wed, 27 Nov 2013 15:52:24 -0500 Subject: [PATCH] Initial commit of pepy (pronounced p-pie). This is a set of python bindings to pe-parse. It is nowhere near feature complete yet but I'll keep working on it. --- python/pepy.cpp | 265 ++++++++++++++++++++++++++++++++++++++++++++++++ python/setup.py | 51 ++++++++++ 2 files changed, 316 insertions(+) create mode 100644 python/pepy.cpp create mode 100644 python/setup.py diff --git a/python/pepy.cpp b/python/pepy.cpp new file mode 100644 index 0000000..eccfbca --- /dev/null +++ b/python/pepy.cpp @@ -0,0 +1,265 @@ +/* + * Copyright (c) 2013, Wesley Shields . All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include +#include +#include "parse.h" + +#define PEPY_VERSION "0.1" + +static PyObject *pepy_error; + +typedef struct { + PyObject_HEAD +} pepy; + +typedef struct { + PyObject_HEAD + parsed_pe *pe; +} pepy_parsed; + +static PyObject *pepy_parsed_new(PyTypeObject *type, PyObject *args, PyObject *kwds) { + pepy_parsed *self; + + self = (pepy_parsed *) type->tp_alloc(type, 0); + + return (PyObject *) self; +} + +static int pepy_parsed_init(pepy_parsed *self, PyObject *args, PyObject *kwds) { + PyObject *py_str; + char *pe_path = NULL; + + if (!PyArg_ParseTuple(args, "S:pepy_parse", &py_str)) { + return -1; + } + + pe_path = PyString_AsString(py_str); + if (!pe_path) + return -1; + + self->pe = ParsePEFromFile(pe_path); + if (!self->pe) { + return -2; + } + + return 0; +} + +static void pepy_parsed_dealloc(pepy_parsed *self) { + DestructParsedPE(self->pe); + self->ob_type->tp_free((PyObject *) self); +} + +static PyObject *pepy_parsed_get_entry_point(PyObject *self, PyObject *args) { + VA entrypoint; + PyObject *ret; + + if (!GetEntryPoint(((pepy_parsed *) self)->pe, entrypoint)) + Py_RETURN_NONE; + + ret = PyLong_FromLongLong(entrypoint); + if (!ret) { + PyErr_SetString(pepy_error, "Unable to create return object."); + return NULL; + } + + return ret; +} + +static PyObject *pepy_parsed_get_bytes(PyObject *self, PyObject *args) { + uint64_t start, idx; + uint8_t b; + Py_ssize_t len; + PyObject *byte, *ret; + + if (!PyArg_ParseTuple(args, "KK:pepy_parsed_get_bytes", &start, &len)) + return NULL; + + ret = PyList_New(len); + if (!ret) { + PyErr_SetString(pepy_error, "Unable to create new list."); + return NULL; + } + + for (idx = 0; idx < len; idx++) { + if (!ReadByteAtVA(((pepy_parsed *) self)->pe, start + idx, b)) + return ret; + + byte = PyInt_FromLong(b); + PyList_SET_ITEM(ret, idx, byte); + } + + return ret; +} + +int section_callback(void *cbd, VA base, std::string &name, image_section_header s, bounded_buffer *data) { + PyObject *vals; + PyObject *list = (PyObject *) cbd; + PyObject *sect = PyDict_New(); + Py_ssize_t i = 0; + + /* This order must match the order of the tuple (vals). */ + char *keys[] = { "name", "base", "size", "virtaddr", "virtsize", "relocs", + "linenums", "characteristics" }; + + if (!sect) + return 0; + + vals = Py_BuildValue("sKKIIHHI", name.c_str(), base, data->bufLen, + s.VirtualAddress, s.Misc.VirtualSize, + s.NumberOfRelocations, s.NumberOfLinenumbers, + s.Characteristics); + if (!vals) + Py_DECREF(sect); + + for (i = 0; i <= 7; i++) { + if (PyDict_SetItemString(sect, keys[i], PyTuple_GetItem(vals, i)) == -1) { + Py_DECREF(vals); + Py_DECREF(sect); + return 0; + } + } + + if (PyList_Append(list, sect) == -1) { + Py_DECREF(vals); + Py_DECREF(sect); + } + + return 0; +} + +static PyObject *pepy_parsed_get_sections(PyObject *self, PyObject *args) { + PyObject *ret = PyList_New(0); + if (!ret) { + PyErr_SetString(pepy_error, "Unable to create new list."); + return NULL; + } + + IterSec(((pepy_parsed *)self)->pe, section_callback, ret); + + return ret; +} + +static PyMethodDef pepy_parsed_methods[] = { + { "get_entry_point", pepy_parsed_get_entry_point, METH_NOARGS, + "Return the entry point address." }, + { "get_bytes", pepy_parsed_get_bytes, METH_VARARGS, + "Return the first N bytes at a given address." }, + { "get_sections", pepy_parsed_get_sections, METH_NOARGS, + "Return a list of dictionaries describing the sections." }, + { NULL } +}; + +static PyTypeObject pepy_parsed_type = { + PyObject_HEAD_INIT(NULL) + 0, /* ob_size */ + "pepy.parsed", /* tp_name */ + sizeof(pepy_parsed), /* tp_basicsize */ + 0, /* tp_itemsize */ + (destructor) pepy_parsed_dealloc, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_compare */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT, /* tp_flags */ + "parsed object", /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + 0, /* tp_iter */ + 0, /* tp_iternext */ + pepy_parsed_methods, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + 0, /* tp_base */ + 0, /* tp_dict */ + 0, /* tp_descr_get */ + 0, /* tp_descr_set */ + 0, /* tp_dictoffset */ + (initproc) pepy_parsed_init, /* tp_init */ + 0, /* tp_alloc */ + pepy_parsed_new, /* tp_new */ +}; + +static PyObject *pepy_parse(PyObject *self, PyObject *args) { + PyObject *parsed; + int ret; + + parsed = pepy_parsed_new(&pepy_parsed_type, NULL, NULL); + if (!parsed) { + PyErr_SetString(pepy_error, "Unable to make new parsed object."); + return NULL; + } + + ret = pepy_parsed_init((pepy_parsed *) parsed, args, NULL); + if (ret < 0) { + if (ret == -2) + PyErr_SetString(pepy_error, "Unable to parse PE file."); + else + PyErr_SetString(pepy_error, "Unable to init new parsed object."); + return NULL; + } + + return parsed; +} + +static PyMethodDef pepy_methods[] = { + { "parse", pepy_parse, METH_VARARGS, "Parse PE from file." }, + { NULL } +}; + +PyMODINIT_FUNC initpepy(void) { + PyObject *m; + + if (PyType_Ready(&pepy_parsed_type) < 0) + return; + + m = Py_InitModule3("pepy", pepy_methods, "Python interface to pe-parse."); + if (!m) + return; + + pepy_error = PyErr_NewException((char *) "pepy.error", NULL, NULL); + Py_INCREF(pepy_error); + PyModule_AddObject(m, "error", pepy_error); + + Py_INCREF(&pepy_parsed_type); + PyModule_AddObject(m, "pepy_parsed", (PyObject *) &pepy_parsed_type); + + PyModule_AddStringMacro(m, PEPY_VERSION); +} diff --git a/python/setup.py b/python/setup.py new file mode 100644 index 0000000..63c93fb --- /dev/null +++ b/python/setup.py @@ -0,0 +1,51 @@ +# Copyright (c) 2013, Wesley Shields . All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. + +from distutils.core import setup, Extension + +INCLUDE_DIRS = ['/usr/local/include', + '/opt/local/include', + '/usr/include', + '../parser-library'] +LIBRARY_DIRS = ['/usr/lib', + '/usr/local/lib'] + +extension_mod = Extension('pepy', + sources = ['pepy.cpp', + '../parser-library/parse.cpp', + '../parser-library/buffer.cpp'], + extra_compile_args = ["-g", "-O0"], # Debug only + include_dirs = INCLUDE_DIRS, + library_dirs = LIBRARY_DIRS) + + +setup (name = 'pepy', + version = '0.1', + description = 'python bindings for pe-parse', + author = 'Wesley Shields', + author_email = 'wxs@atarininja.org', + license = 'BSD', + long_description = 'Python bindings for pe-parse', + ext_modules = [extension_mod])