/* Copyright 2017 - 2021 R. Thomas * Copyright 2017 - 2021 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 #include "LIEF/Abstract/Binary.hpp" #include "LIEF/MachO/Binary.hpp" #include "LIEF/MachO/hash.hpp" #include "pyMachO.hpp" namespace LIEF { namespace MachO { template using no_const_getter = T (Binary::*)(void); template using no_const_func = T (Binary::*)(P); template<> void create(py::module& m) { py::class_(m, "Binary") .def_property_readonly("header", static_cast>(&Binary::header), "Return binary's " RST_CLASS_REF(lief.MachO.Header) "", py::return_value_policy::reference_internal) .def_property_readonly("sections", static_cast>(&Binary::sections), "Return binary's " RST_CLASS_REF(lief.MachO.Section) "", py::return_value_policy::reference_internal) .def_property_readonly("relocations", static_cast>(&Binary::relocations), "Return an iterator over binary's " RST_CLASS_REF(lief.MachO.Relocation) "", py::return_value_policy::reference_internal) .def_property_readonly("segments", static_cast>(&Binary::segments), "Return binary's " RST_CLASS_REF(lief.MachO.SegmentCommand) "", py::return_value_policy::reference_internal) .def_property_readonly("libraries", static_cast>(&Binary::libraries), "Return binary's " RST_CLASS_REF(lief.MachO.DylibCommand) "", py::return_value_policy::reference_internal) .def_property_readonly("symbols", static_cast>(&Binary::symbols), "Return binary's " RST_CLASS_REF(lief.MachO.Symbol) "", py::return_value_policy::reference_internal) .def("has_symbol", &Binary::has_symbol, "Check if a " RST_CLASS_REF(lief.MachO.Symbol) " with the given name exists", "name"_a) .def("get_symbol", static_cast>(&Binary::get_symbol), "Return the " RST_CLASS_REF(lief.MachO.Symbol) " from the given name", "name"_a, py::return_value_policy::reference) .def_property_readonly("imported_symbols", static_cast>(&Binary::imported_symbols), "Return binary's " RST_CLASS_REF(lief.MachO.Symbol) " which are imported", py::return_value_policy::reference_internal) .def_property_readonly("exported_symbols", static_cast>(&Binary::exported_symbols), "Return binary's " RST_CLASS_REF(lief.MachO.Symbol) " which are exported", py::return_value_policy::reference_internal) .def_property_readonly("commands", static_cast>(&Binary::commands), "Return binary's " RST_CLASS_REF(lief.MachO.Command) "", py::return_value_policy::reference_internal) .def_property_readonly("imagebase", &Binary::imagebase, "Return binary's ``image base`` which is the base address\ where segments are mapped (without PIE). ``0`` if not relevant.") .def_property_readonly("virtual_size", &Binary::virtual_size, "Binary's memory size when mapped") .def_property_readonly("fat_offset", &Binary::fat_offset, "Return binary's *fat offset*. ``0`` if not relevant.", py::return_value_policy::copy) .def("section_from_offset", static_cast(&Binary::section_from_offset), "Return the " RST_CLASS_REF(lief.MachO.Section) " which contains the offset", py::return_value_policy::reference) .def("section_from_virtual_address", static_cast(&Binary::section_from_virtual_address), "Return the " RST_CLASS_REF(lief.MachO.Section) " which contains the virtual address", py::return_value_policy::reference) .def("segment_from_offset", static_cast(&Binary::segment_from_offset), "Return the " RST_CLASS_REF(lief.MachO.SegmentCommand) " which contains the offset", py::return_value_policy::reference) .def("segment_from_virtual_address", static_cast(&Binary::segment_from_virtual_address), "Return the " RST_CLASS_REF(lief.MachO.SegmentCommand) " which contains the virtual address", py::return_value_policy::reference) .def_property_readonly("has_entrypoint", &Binary::has_entrypoint, "``True`` if the binary has an entrypoint.\n" "Basically for libraries it will return ``false``", py::return_value_policy::reference_internal) .def_property_readonly("has_uuid", &Binary::has_uuid, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.UUIDCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("uuid", static_cast>(&Binary::uuid), "Return binary's " RST_CLASS_REF(lief.MachO.UUIDCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_main_command", &Binary::has_main_command, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.MainCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("main_command", static_cast>(&Binary::main_command), "Return binary's " RST_CLASS_REF(lief.MachO.MainCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_dylinker", &Binary::has_dylinker, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.DylinkerCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("dylinker", static_cast>(&Binary::dylinker), "Return binary's " RST_CLASS_REF(lief.MachO.DylinkerCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_dyld_info", &Binary::has_dyld_info, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.DyldInfo) " command.", py::return_value_policy::reference_internal) .def_property_readonly("dyld_info", static_cast>(&Binary::dyld_info), "Return binary's " RST_CLASS_REF(lief.MachO.DyldInfo) " if any.", py::return_value_policy::reference) .def_property_readonly("has_function_starts", &Binary::has_function_starts, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.FunctionStarts) " command.", py::return_value_policy::reference_internal) .def_property_readonly("function_starts", static_cast>(&Binary::function_starts), "Return binary's " RST_CLASS_REF(lief.MachO.FunctionStarts) " if any.", py::return_value_policy::reference) .def_property_readonly("has_source_version", &Binary::has_source_version, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.SourceVersion) " command.", py::return_value_policy::reference_internal) .def_property_readonly("source_version", static_cast>(&Binary::source_version), "Return binary's " RST_CLASS_REF(lief.MachO.SourceVersion) " if any.", py::return_value_policy::reference) .def_property_readonly("has_version_min", &Binary::has_version_min, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.VersionMin) " command.", py::return_value_policy::reference_internal) .def_property_readonly("version_min", static_cast>(&Binary::version_min), "Return binary's " RST_CLASS_REF(lief.MachO.VersionMin) " if any.", py::return_value_policy::reference) .def_property_readonly("has_thread_command", &Binary::has_thread_command, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.ThreadCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("thread_command", static_cast>(&Binary::thread_command), "Return binary's " RST_CLASS_REF(lief.MachO.ThreadCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_rpath", &Binary::has_rpath, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.RPathCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("rpath", static_cast>(&Binary::rpath), "Return binary's " RST_CLASS_REF(lief.MachO.RPathCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_symbol_command", &Binary::has_symbol_command, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.SymbolCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("symbol_command", static_cast>(&Binary::symbol_command), "Return binary's " RST_CLASS_REF(lief.MachO.SymbolCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_dynamic_symbol_command", &Binary::has_dynamic_symbol_command, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.DynamicSymbolCommand) " command.", py::return_value_policy::reference_internal) .def_property_readonly("dynamic_symbol_command", static_cast>(&Binary::dynamic_symbol_command), "Return binary's " RST_CLASS_REF(lief.MachO.DynamicSymbolCommand) " if any.", py::return_value_policy::reference) .def_property_readonly("has_code_signature", &Binary::has_code_signature, "``True`` if the binary is signed (i.e. has a " RST_CLASS_REF(lief.MachO.CodeSignature) " command)", py::return_value_policy::reference_internal) .def_property_readonly("code_signature", static_cast>(&Binary::code_signature), "Return binary's " RST_CLASS_REF(lief.MachO.CodeSignature) " if any.", py::return_value_policy::reference) .def_property_readonly("has_code_signature_dir", &Binary::has_code_signature_dir, "``True`` if the binary is signed (i.e. has a " RST_CLASS_REF(lief.MachO.CodeSignature) " command) " "with the command LC_DYLIB_CODE_SIGN_DRS", py::return_value_policy::reference_internal) .def_property_readonly("code_signature_dir", static_cast>(&Binary::code_signature_dir), "Return binary's " RST_CLASS_REF(lief.MachO.CodeSignature) " if any.", py::return_value_policy::reference) .def_property_readonly("has_data_in_code", &Binary::has_data_in_code, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.DataInCode) " command", py::return_value_policy::reference_internal) .def_property_readonly("data_in_code", static_cast>(&Binary::data_in_code), "Return binary's " RST_CLASS_REF(lief.MachO.DataInCode) " if any.", py::return_value_policy::reference) .def_property_readonly("has_segment_split_info", &Binary::has_segment_split_info, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.SegmentSplitInfo) " command", py::return_value_policy::reference_internal) .def_property_readonly("segment_split_info", static_cast>(&Binary::segment_split_info), "Return binary's " RST_CLASS_REF(lief.MachO.SegmentSplitInfo) " if any.", py::return_value_policy::reference) .def_property_readonly("has_sub_framework", &Binary::has_sub_framework, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.SubFramework) " command", py::return_value_policy::reference_internal) .def_property_readonly("sub_framework", static_cast>(&Binary::sub_framework), "Return binary's " RST_CLASS_REF(lief.MachO.SubFramework) " if any.", py::return_value_policy::reference) .def_property_readonly("has_dyld_environment", &Binary::has_dyld_environment, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.DyldEnvironment) " command", py::return_value_policy::reference_internal) .def_property_readonly("dyld_environment", static_cast>(&Binary::dyld_environment), "Return binary's " RST_CLASS_REF(lief.MachO.DyldEnvironment) " if any.", py::return_value_policy::reference) .def_property_readonly("has_encryption_info", &Binary::has_encryption_info, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.EncryptionInfo) " command", py::return_value_policy::reference_internal) .def_property_readonly("encryption_info", static_cast>(&Binary::encryption_info), "Return binary's " RST_CLASS_REF(lief.MachO.EncryptionInfo) " if any.", py::return_value_policy::reference) .def_property_readonly("has_build_version", &Binary::has_build_version, "``True`` if the binary has a " RST_CLASS_REF(lief.MachO.BuildVersion) " command", py::return_value_policy::reference_internal) .def_property_readonly("build_version", static_cast>(&Binary::build_version), "Return binary's " RST_CLASS_REF(lief.MachO.BuildVersion) " if any.", py::return_value_policy::reference) .def("virtual_address_to_offset", &Binary::virtual_address_to_offset, "Convert the virtual address to an offset in the binary", "virtual_address"_a) .def("has_section", &Binary::has_section, "Check if a section with the given name exists", "name"_a) .def("get_section", static_cast(&Binary::get_section), "Return the section from the given name", "name"_a, py::return_value_policy::reference) .def("has_segment", &Binary::has_segment, "Check if a " RST_CLASS_REF(lief.MachO.SegmentCommand) " with the given name exists", "name"_a) .def("get_segment", static_cast(&Binary::get_segment), "Return the " RST_CLASS_REF(lief.MachO.SegmentCommand) " from the given name", "name"_a, py::return_value_policy::reference) .def_property_readonly("va_ranges", &Binary::va_ranges, "Return the range of virtual addresses as a tuple ``(va_start, va_end)``") .def_property_readonly("off_ranges", &Binary::off_ranges, "Return the range of offsets as a tuple ``(off_start, off_end)``") .def("is_valid_addr", &Binary::is_valid_addr, "Check if the given address is comprise between the lowest " "virtual address and the biggest one", "address"_a) .def("write", &Binary::write, "Rebuild the binary and write it in a file", "output"_a, py::return_value_policy::reference_internal) .def("add", static_cast(&Binary::add), "Add a new " RST_CLASS_REF(lief.MachO.DylibCommand) "", "dylib_command"_a, py::return_value_policy::reference) .def("add", static_cast(&Binary::add), "Add a new " RST_CLASS_REF(lief.MachO.SegmentCommand) "", "segment"_a, py::return_value_policy::reference) .def("add", static_cast(&Binary::add), "Add a new " RST_CLASS_REF(lief.MachO.LoadCommand) "", "load_command"_a, py::return_value_policy::reference) .def("add", static_cast(&Binary::add), "Add a new " RST_CLASS_REF(lief.MachO.LoadCommand) " at ``index``", "load_command"_a, "index"_a, py::return_value_policy::reference) .def("remove", static_cast(&Binary::remove), "Remove a " RST_CLASS_REF(lief.MachO.LoadCommand) "", "load_command"_a) .def("remove", static_cast(&Binary::remove), "Remove **all** " RST_CLASS_REF(lief.MachO.LoadCommand) " having the given " "" RST_CLASS_REF(lief.MachO.LOAD_COMMAND_TYPES) "", "type"_a) .def("remove", static_cast(&Binary::remove), "Remove the given " RST_CLASS_REF(lief.MachO.Symbol)"", "symbol"_a) .def("remove_command", static_cast(&Binary::remove_command), "Remove the " RST_CLASS_REF(lief.MachO.LoadCommand) " at ``index``", "index"_a) .def("remove_signature", static_cast(&Binary::remove_signature), "Remove the " RST_CLASS_REF(lief.MachO.CodeSignature) " (if any)") .def("remove_symbol", static_cast(&Binary::remove_symbol), "Remove all symbol(s) with the given name", "name"_a) .def("can_remove", static_cast(&Binary::can_remove), "Check if the given symbol can be safely removed.", "symbol"_a) .def("can_remove_symbol", static_cast(&Binary::can_remove_symbol), "Check if the given symbol name can be safely removed.", "symbol_name"_a) .def("unexport", static_cast(&Binary::unexport), "Remove the symbol from the export table", "name"_a) .def("unexport", static_cast(&Binary::unexport), "Remove the symbol from the export table", "symbol"_a) .def("extend", static_cast(&Binary::extend), "Extend a " RST_CLASS_REF(lief.MachO.LoadCommand) " by ``size``", "load_command"_a, "size"_a) .def("extend_segment", static_cast(&Binary::extend_segment), "Extend the **content** of the given " RST_CLASS_REF(lief.MachO.SegmentCommand) " by ``size``", "segment_command"_a, "size"_a) .def("add_section", static_cast(&Binary::add_section), "Add a new " RST_CLASS_REF(lief.MachO.Section) " in the given " RST_CLASS_REF(lief.MachO.SegmentCommand) "", "segment"_a, "section"_a, py::return_value_policy::reference) .def("add_section", static_cast(&Binary::add_section), "Add a new " RST_CLASS_REF(lief.MachO.Section) " within the ``__TEXT`` segment", "section"_a, py::return_value_policy::reference) .def("add_section", static_cast(&Binary::add_section), "Add a new " RST_CLASS_REF(lief.MachO.Section) " in the given " RST_CLASS_REF(lief.MachO.SegmentCommand) "", "section"_a, "section"_a, py::return_value_policy::reference) .def("add_library", static_cast(&Binary::add_library), "Add a new library dependency", "library_name"_a, py::return_value_policy::reference) .def("get", static_cast(&Binary::get), "Return the **first** " RST_CLASS_REF(lief.MachO.LoadCommand) " having the given " "" RST_CLASS_REF(lief.MachO.LOAD_COMMAND_TYPES) "", "type"_a, py::return_value_policy::reference) .def("has", static_cast(&Binary::has), "Check if the current binary has a " RST_CLASS_REF(lief.MachO.LoadCommand) " with the given " "" RST_CLASS_REF(lief.MachO.LOAD_COMMAND_TYPES) "", "type"_a) .def_property_readonly("unwind_functions", &Binary::unwind_functions, "Return list of " RST_CLASS_REF(lief.Function) " found in the ``__unwind_info`` section") .def_property_readonly("functions", &Binary::functions, "Return list of **all** " RST_CLASS_REF(lief.Function) " found") .def("__getitem__", static_cast(&Binary::operator[]), "", py::return_value_policy::reference) .def("__contains__", static_cast(&Binary::has)) .def("__str__", [] (const Binary& binary) { std::ostringstream stream; stream << binary; std::string str = stream.str(); return str; }); } } }