mirror of
https://github.com/lief-project/LIEF
synced 2026-06-08 15:30:44 +00:00
Romain Thomas
249 lines
9.2 KiB
C++
249 lines
9.2 KiB
C++
/* Copyright 2017 - 2022 R. Thomas
|
|
* Copyright 2017 - 2022 Quarkslab
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#include <algorithm>
|
|
#include <sstream>
|
|
|
|
#include "pyAbstract.hpp"
|
|
#include "pyIterators.hpp"
|
|
#include "pyErr.hpp"
|
|
#include "LIEF/Abstract/Binary.hpp"
|
|
|
|
|
|
#define PY_ENUM(x) LIEF::to_string(x), x
|
|
|
|
namespace LIEF {
|
|
|
|
template<class T>
|
|
using getter_t = T (Binary::*)(void) const;
|
|
|
|
template<class T>
|
|
using setter_t = void (Binary::*)(T);
|
|
|
|
template<class T>
|
|
using it_t = T (Binary::*)(void);
|
|
|
|
template<class T, class P>
|
|
using no_const_func = T (Binary::*)(P);
|
|
|
|
template<>
|
|
void create<Binary>(py::module& m) {
|
|
py::class_<Binary, Object> pybinary(m, "Binary",
|
|
R"delim(
|
|
File format abstract representation.
|
|
|
|
This object represents the abstraction of an executable file format.
|
|
It enables to access common features (like the :attr:`~lief.Binary.entrypoint`) regardless
|
|
of the concrete format (e.g. :attr:`lief.ELF.Binary.entrypoint`)
|
|
)delim");
|
|
|
|
py::enum_<Binary::VA_TYPES>(pybinary, "VA_TYPES")
|
|
.value(PY_ENUM(Binary::VA_TYPES::AUTO))
|
|
.value(PY_ENUM(Binary::VA_TYPES::VA))
|
|
.value(PY_ENUM(Binary::VA_TYPES::RVA));
|
|
|
|
init_ref_iterator<Binary::it_sections>(pybinary, "it_sections");
|
|
init_ref_iterator<Binary::it_symbols>(pybinary, "it_symbols");
|
|
init_ref_iterator<Binary::it_relocations>(pybinary, "it_relocations");
|
|
|
|
pybinary
|
|
.def_property_readonly("format",
|
|
&Binary::format,
|
|
"File format " RST_CLASS_REF(lief.EXE_FORMATS) " of the underlying binary.")
|
|
|
|
.def_property_readonly("is_pie",
|
|
&Binary::is_pie,
|
|
"Check if the binary is position independent")
|
|
|
|
.def_property_readonly("has_nx",
|
|
&Binary::has_nx,
|
|
"Check if the binary has ``NX`` protection (non executable stack)")
|
|
|
|
.def_property("name",
|
|
static_cast<getter_t<const std::string&>>(&Binary::name),
|
|
static_cast<setter_t<const std::string&>>(&Binary::name),
|
|
"Binary's name")
|
|
|
|
.def_property_readonly("header",
|
|
&Binary::header,
|
|
"Binary's abstract header (" RST_CLASS_REF(lief.Header) ")")
|
|
|
|
.def_property_readonly("entrypoint",
|
|
&Binary::entrypoint,
|
|
"Binary's entrypoint")
|
|
|
|
.def("remove_section",
|
|
static_cast<void (Binary::*)(const std::string&, bool)>(&Binary::remove_section),
|
|
"Remove the section with the given name",
|
|
"name"_a, "clear"_a = false)
|
|
|
|
.def_property_readonly("sections",
|
|
static_cast<it_t<Binary::it_sections>>(&Binary::sections),
|
|
"Return an iterator over the binary's abstract sections (" RST_CLASS_REF(lief.Section) ")",
|
|
py::return_value_policy::reference_internal)
|
|
|
|
.def_property_readonly("relocations",
|
|
static_cast<it_t<Binary::it_relocations>>(&Binary::relocations),
|
|
"Return an iterator over abstract " RST_CLASS_REF(lief.Relocation) "",
|
|
py::return_value_policy::reference_internal)
|
|
|
|
.def_property_readonly("exported_functions",
|
|
&Binary::exported_functions,
|
|
"Return the binary's exported " RST_CLASS_REF(lief.Function) "")
|
|
|
|
.def_property_readonly("imported_functions",
|
|
&Binary::imported_functions,
|
|
"Return the binary's imported " RST_CLASS_REF(lief.Function) " (name)")
|
|
|
|
.def_property_readonly("libraries",
|
|
[] (const Binary& binary) {
|
|
const std::vector<std::string>& imported_libraries = binary.imported_libraries();
|
|
std::vector<py::object> imported_libraries_encoded;
|
|
imported_libraries_encoded.reserve(imported_libraries.size());
|
|
|
|
std::transform(
|
|
std::begin(imported_libraries), std::end(imported_libraries),
|
|
std::back_inserter(imported_libraries_encoded),
|
|
&safe_string_converter);
|
|
return imported_libraries_encoded;
|
|
},
|
|
"Return binary's imported libraries (name)")
|
|
|
|
.def_property_readonly("symbols",
|
|
static_cast<it_t<Binary::it_symbols>>(&Binary::symbols),
|
|
"Return an iterator over the binary's abstract " RST_CLASS_REF(lief.Symbol) "",
|
|
py::return_value_policy::reference_internal)
|
|
|
|
.def("has_symbol",
|
|
&Binary::has_symbol,
|
|
"Check if a " RST_CLASS_REF(lief.Symbol) " with the given name exists",
|
|
"symbol_name"_a)
|
|
|
|
.def("get_symbol",
|
|
static_cast<no_const_func<Symbol*, const std::string&>>(&Binary::get_symbol),
|
|
R"delim(
|
|
Return the :class:`~lief.Symbol` from the given ``name``.
|
|
|
|
If the symbol can't be found, it returns None.
|
|
)delim",
|
|
"symbol_name"_a,
|
|
py::return_value_policy::reference_internal)
|
|
|
|
.def("get_function_address",
|
|
[] (const Binary& self, const std::string& name) {
|
|
return error_or(&Binary::get_function_address, self, name);
|
|
},
|
|
"Return the address of the given function name",
|
|
"function_name"_a)
|
|
|
|
.def("patch_address",
|
|
static_cast<void (Binary::*) (uint64_t, const std::vector<uint8_t>&, Binary::VA_TYPES)>(&Binary::patch_address),
|
|
R"delim(
|
|
Patch the address with the given list of bytes.
|
|
The virtual address is specified in the first argument and the content in the second (as a list of bytes).
|
|
|
|
If the underlying binary is a PE, one can specify if the virtual address is a :attr:`~lief.Binary.VA_TYPES.RVA` or
|
|
a :attr:`~lief.Binary.VA_TYPES.VA`. By default, it is set to :attr:`~lief.Binary.VA_TYPES.AUTO`.
|
|
)delim",
|
|
"address"_a, "patch_value"_a, "va_type"_a = Binary::VA_TYPES::AUTO)
|
|
|
|
.def("patch_address",
|
|
static_cast<void (Binary::*) (uint64_t, uint64_t, size_t, Binary::VA_TYPES)>(&Binary::patch_address),
|
|
R"delim(
|
|
Patch the address with the given integer value.
|
|
The virtual address is specified in the first argument, the integer in the second and the integer's size of in third one.
|
|
|
|
If the underlying binary is a PE, one can specify if the virtual address is a :attr:`~lief.Binary.VA_TYPES.RVA` or
|
|
a :attr:`~lief.Binary.VA_TYPES.VA`. By default, it is set to :attr:`~lief.Binary.VA_TYPES.AUTO`.
|
|
)delim",
|
|
"address"_a, "patch_value"_a, "size"_a = 8, "va_type"_a = Binary::VA_TYPES::AUTO)
|
|
|
|
|
|
.def("get_content_from_virtual_address",
|
|
&Binary::get_content_from_virtual_address,
|
|
R"delim(
|
|
Return the content located at the provided virtual address.
|
|
The virtual address is specified in the first argument and size to read (in bytes) in the second.
|
|
|
|
If the underlying binary is a PE, one can specify if the virtual address is a :attr:`~lief.Binary.VA_TYPES.RVA` or
|
|
a :attr:`~lief.Binary.VA_TYPES.VA`. By default, it is set to :attr:`~lief.Binary.VA_TYPES.AUTO`.
|
|
)delim",
|
|
"virtual_address"_a, "size"_a, "va_type"_a = Binary::VA_TYPES::AUTO)
|
|
|
|
.def_property_readonly("abstract",
|
|
[m] (py::object& self) {
|
|
self.attr("__class__") = m.attr("Binary");
|
|
return self;
|
|
},
|
|
R"delim(
|
|
Return the abstract representation of the current binary (:class:`lief.Binary`)
|
|
|
|
.. warning::
|
|
|
|
Getting this property modifies the ``__class__`` attribute such as
|
|
the current binary looks like a :class:`lief.Binary`.
|
|
|
|
To get back to the original binary, one needs to access :attr:`lief.Binary.concrete`
|
|
)delim",
|
|
py::return_value_policy::reference)
|
|
|
|
|
|
.def_property_readonly("concrete",
|
|
[m] (py::object& self) {
|
|
self.attr("__class__") = py::cast(self.cast<Binary*>()).attr("__class__");
|
|
return self;
|
|
},
|
|
R"delim(
|
|
The *concrete* representation of the binary. Basically, this property cast a :class:`lief.Binary`
|
|
into a :class:`lief.PE.Binary`, :class:`lief.ELF.Binary` or :class:`lief.MachO.Binary`.
|
|
|
|
See also: :attr:`lief.Binary.abstract`
|
|
)delim",
|
|
py::return_value_policy::reference)
|
|
|
|
.def_property_readonly("ctor_functions",
|
|
&Binary::ctor_functions,
|
|
"Constructor functions that are called prior to any other functions")
|
|
|
|
.def("xref",
|
|
&Binary::xref,
|
|
"Return all **virtual addresses** that *use* the ``address`` given in parameter",
|
|
"virtual_address"_a)
|
|
|
|
.def("offset_to_virtual_address",
|
|
[] (const Binary& self, uint64_t offset, uint64_t slide) {
|
|
return error_or(&Binary::offset_to_virtual_address, self, offset, slide);
|
|
},
|
|
"Convert an offset into a virtual address.",
|
|
"offset"_a, "slide"_a = 0)
|
|
|
|
.def_property_readonly("imagebase",
|
|
&Binary::imagebase,
|
|
"Default image base (i.e. if the ASLR is not enabled)")
|
|
|
|
.def("__str__",
|
|
[] (const Binary& binary)
|
|
{
|
|
std::ostringstream stream;
|
|
stream << binary;
|
|
std::string str = stream.str();
|
|
return str;
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|