MachO/Binary.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2025 R. Thomas
 * Copyright 2017 - 2025 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.
 */
#ifndef LIEF_MACHO_BINARY_H
#define LIEF_MACHO_BINARY_H
 
#include <vector>
#include <map>
#include <set>
#include <memory>
 
#include "LIEF/MachO/LoadCommand.hpp"
#include "LIEF/MachO/Header.hpp"
#include "LIEF/MachO/BindingInfoIterator.hpp"
#include "LIEF/MachO/BuildVersion.hpp"
#include "LIEF/MachO/Stub.hpp"
#include "LIEF/MachO/Builder.hpp"
 
#include "LIEF/visibility.h"
#include "LIEF/utils.hpp"
 
#include "LIEF/Abstract/Binary.hpp"
 
#include "LIEF/iterators.hpp"
#include "LIEF/errors.hpp"
 
namespace LIEF {
 
namespace objc {
class Metadata;
}

namespace MachO {
 
class AtomInfo;
class BinaryParser;
class Builder;
class CodeSignature;
class CodeSignatureDir;
class DataInCode;
class DyldChainedFixups;
class DyldEnvironment;
class DyldExportsTrie;
class DyldInfo;
class DylibCommand;
class DylinkerCommand;
class DynamicSymbolCommand;
class EncryptionInfo;
class ExportInfo;
class FunctionStarts;
class FunctionVariants;
class FunctionVariantFixups;
class Header;
class IndirectBindingInfo;
class LinkerOptHint;
class MainCommand;
class Parser;
class RPathCommand;
class Relocation;
class Routine;
class Section;
class SegmentCommand;
class SegmentSplitInfo;
class SourceVersion;
class SubClient;
class SubFramework;
class Symbol;
class SymbolCommand;
class ThreadCommand;
class TwoLevelHints;
class UUIDCommand;
class VersionMin;

class LIEF_API Binary : public LIEF::Binary  {
 
  friend class Parser;
  friend class BinaryParser;
  friend class Builder;
  friend class DyldInfo;
  friend class BindingInfoIterator;
 
  public:
  struct range_t {
    uint64_t start = 0;
    uint64_t end   = 0;
 
    uint64_t size() const {
      return end - start;
    }
 
    bool empty() const {
      return start == end;
    }
  };

  using commands_t = std::vector<std::unique_ptr<LoadCommand>>;

  using it_commands = ref_iterator<commands_t&, LoadCommand*>;

  using it_const_commands = const_ref_iterator<const commands_t&, LoadCommand*>;

  using symbols_t = std::vector<std::unique_ptr<Symbol>>;

  using it_symbols = ref_iterator<symbols_t&, Symbol*>;

  using it_const_symbols = const_ref_iterator<const symbols_t&, const Symbol*>;

  using it_exported_symbols = filter_iterator<symbols_t&, Symbol*>;

  using it_const_exported_symbols = const_filter_iterator<const symbols_t&, const Symbol*>;

  using it_imported_symbols = filter_iterator<symbols_t&, Symbol*>;

  using it_const_imported_symbols = const_filter_iterator<const symbols_t&, const Symbol*>;

  using sections_cache_t = std::vector<Section*>;

  using it_sections = ref_iterator<sections_cache_t&>;

  using it_const_sections = const_ref_iterator<const sections_cache_t&>;

  using segments_cache_t = std::vector<SegmentCommand*>;

  using it_segments = ref_iterator<segments_cache_t&>;

  using it_const_segments = const_ref_iterator<const segments_cache_t&>;

  using libraries_cache_t = std::vector<DylibCommand*>;

  using it_libraries = ref_iterator<libraries_cache_t&>;

  using it_const_libraries = const_ref_iterator<const libraries_cache_t&>;

  using fileset_binaries_t = std::vector<std::unique_ptr<Binary>>;

  using it_fileset_binaries = ref_iterator<fileset_binaries_t&, Binary*>;

  using it_const_fileset_binaries = const_ref_iterator<const fileset_binaries_t&, Binary*>;
 
  struct KeyCmp {
    bool operator() (const Relocation* lhs, const Relocation* rhs) const;
  };

  using relocations_t = std::set<Relocation*, KeyCmp>;

  using it_relocations = ref_iterator<relocations_t&, Relocation*>;

  using it_const_relocations = const_ref_iterator<const relocations_t&, const Relocation*>;

  using it_rpaths = filter_iterator<commands_t&, RPathCommand*>;

  using it_const_rpaths = const_filter_iterator<const commands_t&, const RPathCommand*>;

  using it_sub_clients = filter_iterator<commands_t&, SubClient*>;

  using it_const_sub_clients = const_filter_iterator<const commands_t&, const SubClient*>;
 
  using it_bindings = iterator_range<BindingInfoIterator>;

  using stub_iterator = iterator_range<Stub::Iterator>;

  using it_notes = filter_iterator<commands_t&, NoteCommand*>;

  using it_const_notes = const_filter_iterator<const commands_t&, const NoteCommand*>;
 
  public:
  Binary(const Binary&) = delete;
  Binary& operator=(const Binary&) = delete;

  Header& header() {
    return header_;
  }
 
  const Header& header() const {
    return header_;
  }

  it_commands commands() {
    return commands_;
  }
 
  it_const_commands commands() const {
    return commands_;
  }

  it_fileset_binaries filesets() {
    return filesets_;
  }
 
  it_const_fileset_binaries filesets() const {
    return filesets_;
  }

  it_symbols symbols() {
    return symbols_;
  }
  it_const_symbols symbols() const {
    return symbols_;
  }

  bool has_symbol(const std::string& name) const {
    return get_symbol(name) != nullptr;
  }

  const Symbol* get_symbol(const std::string& name) const;
  Symbol* get_symbol(const std::string& name) {
    return const_cast<Symbol*>(static_cast<const Binary*>(this)->get_symbol(name));
  }

  static bool is_exported(const Symbol& symbol);

  it_exported_symbols exported_symbols() {
    return {symbols_, [] (const std::unique_ptr<Symbol>& symbol) {
      return is_exported(*symbol); }
    };
  }
  it_const_exported_symbols exported_symbols() const {
    return {symbols_, [] (const std::unique_ptr<Symbol>& symbol) {
      return is_exported(*symbol);
    }};
  }

  static bool is_imported(const Symbol& symbol);

  it_imported_symbols imported_symbols() {
    return {symbols_, [] (const std::unique_ptr<Symbol>& symbol) {
      return is_imported(*symbol);
    }};
  }
 
  it_const_imported_symbols imported_symbols() const {
    return {symbols_, [] (const std::unique_ptr<Symbol>& symbol) {
      return is_imported(*symbol);
    }};
  }

  it_libraries libraries() {
    return libraries_;
  }
 
  it_const_libraries libraries() const {
    return libraries_;
  }

  it_segments segments() {
    return segments_;
  }
  it_const_segments segments() const {
    return segments_;
  }

  it_sections sections() {
    return sections_;
  }
  it_const_sections sections() const {
    return sections_;
  }

  it_relocations       relocations();
  it_const_relocations relocations() const;

  void write(const std::string& filename);

  void write(const std::string& filename, Builder::config_t config);

  void write(std::ostream& os);

  void write(std::ostream& os, Builder::config_t config);

  std::vector<uint8_t> raw();

  bool has(LoadCommand::TYPE type) const;

  const LoadCommand* get(LoadCommand::TYPE type) const;
  LoadCommand* get(LoadCommand::TYPE type) {
    return const_cast<LoadCommand*>(static_cast<const Binary*>(this)->get(type));
  }
 
  LoadCommand* add(std::unique_ptr<LoadCommand> command);

  LoadCommand* add(const LoadCommand& command) {
    return add(command.clone());
  }

  LoadCommand* add(const LoadCommand& command, size_t index);

  LoadCommand* add(const DylibCommand& library);

  LoadCommand* add(const SegmentCommand& segment);

  LoadCommand* add_library(const std::string& name);

  Section* add_section(const Section& section);

  const DylibCommand* find_library(const std::string& name) const;
 
  DylibCommand* find_library(const std::string& name) {
    return const_cast<DylibCommand*>(static_cast<const Binary*>(this)->find_library(name));
  }

  Section* add_section(const SegmentCommand& segment, const Section& section);

  void remove_section(const std::string& name, bool clear = false) override;

  void remove_section(const std::string& segname, const std::string& secname, bool clear = false);

  bool remove(const LoadCommand& command);

  bool remove(LoadCommand::TYPE type);

  bool remove_command(size_t index);

  bool remove_signature();

  bool extend(const LoadCommand& command, uint64_t size);

  bool extend_segment(const SegmentCommand& segment, size_t size);

  bool extend_section(Section& section, size_t size);

  bool disable_pie();

  uint64_t imagebase() const override;

  uint64_t virtual_size() const {
    return align(va_ranges().size(), (uint64_t)page_size());
  }

  std::string loader() const;

  bool has_section(const std::string& name) const {
    return get_section(name) != nullptr;
  }

  Section* get_section(const std::string& name) {
    return const_cast<Section*>(static_cast<const Binary*>(this)->get_section(name));
  }

  const Section* get_section(const std::string& name) const;

  Section* get_section(const std::string& segname, const std::string& secname) {
    return const_cast<Section*>(static_cast<const Binary*>(this)->get_section(segname, secname));
  }
 
  const Section* get_section(const std::string& segname, const std::string& secname) const;

  bool has_segment(const std::string& name) const {
    return get_segment(name) != nullptr;
  }

  const SegmentCommand* get_segment(const std::string& name) const;

  SegmentCommand* get_segment(const std::string& name) {
    return const_cast<SegmentCommand*>(static_cast<const Binary*>(this)->get_segment(name));
  }

  bool remove_symbol(const std::string& name);

  bool remove(const Symbol& sym);

  bool can_remove(const Symbol& sym) const;

  bool can_remove_symbol(const std::string& name) const;

  bool unexport(const std::string& name);

  bool unexport(const Symbol& sym);

  Section* section_from_offset(uint64_t offset) {
    return const_cast<Section*>(static_cast<const Binary*>(this)->section_from_offset(offset));
  }
  const Section* section_from_offset(uint64_t offset) const;

  Section* section_from_virtual_address(uint64_t virtual_address) {
    return const_cast<Section*>(static_cast<const Binary*>(this)->section_from_virtual_address(virtual_address));
  }
  const Section* section_from_virtual_address(uint64_t virtual_address) const;

  result<uint64_t> virtual_address_to_offset(uint64_t virtual_address) const;

  result<uint64_t> offset_to_virtual_address(uint64_t offset, uint64_t slide = 0) const override;

  SegmentCommand* segment_from_offset(uint64_t offset) {
    return const_cast<SegmentCommand*>(static_cast<const Binary*>(this)->segment_from_offset(offset));
  }
  const SegmentCommand* segment_from_offset(uint64_t offset) const;

  size_t segment_index(const SegmentCommand& segment) const;

  uint64_t fat_offset() const {
    return fat_offset_;
  }

  SegmentCommand* segment_from_virtual_address(uint64_t virtual_address) {
    return const_cast<SegmentCommand*>(static_cast<const Binary*>(this)->segment_from_virtual_address(virtual_address));
  }
  const SegmentCommand* segment_from_virtual_address(uint64_t virtual_address) const;

  range_t va_ranges() const;

  range_t off_ranges() const;

  bool is_valid_addr(uint64_t address) const {
    const range_t& r = va_ranges();
    return r.start <= address && address < r.end;
  }

  void accept(LIEF::Visitor& visitor) const override;
 
  std::ostream& print(std::ostream& os) const override;

  void patch_address(uint64_t address, const std::vector<uint8_t>& patch_value,
                     LIEF::Binary::VA_TYPES addr_type = LIEF::Binary::VA_TYPES::AUTO) override;

  void patch_address(uint64_t address, uint64_t patch_value,
                     size_t size = sizeof(uint64_t),
                     LIEF::Binary::VA_TYPES addr_type = LIEF::Binary::VA_TYPES::AUTO) override;

  span<const uint8_t> get_content_from_virtual_address(
      uint64_t virtual_address, uint64_t size,
      Binary::VA_TYPES addr_type = Binary::VA_TYPES::AUTO) const override;

  uint64_t entrypoint() const override;

  bool is_pie() const override {
    return header().has(Header::FLAGS::PIE);
  }

  bool has_nx() const override {
    return has_nx_stack();
  }

  bool has_nx_stack() const {
    return !header().has(Header::FLAGS::ALLOW_STACK_EXECUTION);
  }

  bool has_nx_heap() const {
    return !header().has(Header::FLAGS::NO_HEAP_EXECUTION);
  }

  bool has_entrypoint() const {
    return has_main_command() || has_thread_command();
  }

  bool has_uuid() const {
    return uuid() != nullptr;
  }

  UUIDCommand* uuid();
  const UUIDCommand* uuid() const;

  bool has_main_command() const {
    return main_command() != nullptr;
  }

  MainCommand* main_command();
  const MainCommand* main_command() const;

  bool has_dylinker() const {
    return dylinker() != nullptr;
  }

  DylinkerCommand* dylinker();
  const DylinkerCommand* dylinker() const;

  bool has_dyld_info() const {
    return dyld_info() != nullptr;
  }

  DyldInfo* dyld_info();
  const DyldInfo* dyld_info() const;

  bool has_function_starts() const {
    return function_starts() != nullptr;
  }

  FunctionStarts* function_starts();
  const FunctionStarts* function_starts() const;

  bool has_source_version() const {
    return source_version() != nullptr;
  }

  SourceVersion* source_version();
  const SourceVersion* source_version() const;

  bool has_version_min() const {
    return version_min() != nullptr;
  }

  VersionMin* version_min();
  const VersionMin* version_min() const;

  bool has_thread_command() const {
    return thread_command() != nullptr;
  }

  ThreadCommand* thread_command();
  const ThreadCommand* thread_command() const;

  bool has_routine_command() const {
    return routine_command() != nullptr;
  }

  Routine* routine_command();
  const Routine* routine_command() const;

  bool has_rpath() const {
    return rpath() != nullptr;
  }

  RPathCommand* rpath();
  const RPathCommand* rpath() const;

  it_rpaths rpaths();
  it_const_rpaths rpaths() const;

  bool has_symbol_command() const {
    return symbol_command() != nullptr;
  }

  SymbolCommand* symbol_command();
  const SymbolCommand* symbol_command() const;

  bool has_dynamic_symbol_command() const {
    return dynamic_symbol_command() != nullptr;
  }

  DynamicSymbolCommand* dynamic_symbol_command();
  const DynamicSymbolCommand* dynamic_symbol_command() const;

  bool has_code_signature() const {
    return code_signature() != nullptr;
  }

  CodeSignature* code_signature() {
    return const_cast<CodeSignature*>(static_cast<const Binary*>(this)->code_signature());
  }
  const CodeSignature* code_signature() const;

  bool has_code_signature_dir() const {
    return code_signature_dir() != nullptr;
  }

  CodeSignatureDir* code_signature_dir() {
    return const_cast<CodeSignatureDir*>(static_cast<const Binary*>(this)->code_signature_dir());
  }
  const CodeSignatureDir* code_signature_dir() const;

  bool has_data_in_code() const {
    return data_in_code() != nullptr;
  }

  DataInCode* data_in_code();
  const DataInCode* data_in_code() const;

  bool has_segment_split_info() const {
    return segment_split_info() != nullptr;
  }

  SegmentSplitInfo* segment_split_info();
  const SegmentSplitInfo* segment_split_info() const;

  bool has_sub_framework() const {
    return sub_framework() != nullptr;
  }

  bool has_encryption_info() const {
    return encryption_info() != nullptr;
  }

  EncryptionInfo* encryption_info();
  const EncryptionInfo* encryption_info() const;

  SubFramework* sub_framework();
  const SubFramework* sub_framework() const;

  it_sub_clients subclients();
  it_const_sub_clients subclients() const;
 
  bool has_subclients() const;

  bool has_dyld_environment() const {
    return dyld_environment() != nullptr;
  }

  DyldEnvironment* dyld_environment();
  const DyldEnvironment* dyld_environment() const;

  bool has_build_version() const {
    return build_version() != nullptr;
  }

  BuildVersion* build_version();
  const BuildVersion* build_version() const;

  BuildVersion::PLATFORMS platform() const {
    if (const BuildVersion* version = build_version()) {
      return version->platform();
    }
    return BuildVersion::PLATFORMS::UNKNOWN;
  }

  bool is_ios() const {
    return platform() == BuildVersion::PLATFORMS::IOS ||
           has(LoadCommand::TYPE::VERSION_MIN_IPHONEOS);
  }

  bool is_macos() const {
    return platform() == BuildVersion::PLATFORMS::MACOS ||
           has(LoadCommand::TYPE::VERSION_MIN_MACOSX);
  }
 

  bool has_dyld_chained_fixups() const {
    return dyld_chained_fixups() != nullptr;
  }

  DyldChainedFixups* dyld_chained_fixups();
  const DyldChainedFixups* dyld_chained_fixups() const;

  bool has_dyld_exports_trie() const {
    return dyld_exports_trie() != nullptr;
  }

  DyldExportsTrie* dyld_exports_trie();
  const DyldExportsTrie* dyld_exports_trie() const;

  bool has_two_level_hints() const {
    return two_level_hints() != nullptr;
  }

  TwoLevelHints* two_level_hints() {
    return const_cast<TwoLevelHints*>(static_cast<const Binary*>(this)->two_level_hints());
  }
  const TwoLevelHints* two_level_hints() const;

  bool has_linker_opt_hint() const {
    return linker_opt_hint() != nullptr;
  }

  LinkerOptHint* linker_opt_hint() {
    return const_cast<LinkerOptHint*>(static_cast<const Binary*>(this)->linker_opt_hint());
  }
  const LinkerOptHint* linker_opt_hint() const;

  ExportInfo* add_exported_function(uint64_t address, const std::string& name);

  Symbol* add_local_symbol(uint64_t address, const std::string& name);

  std::unique_ptr<objc::Metadata> objc_metadata() const;

  stub_iterator symbol_stubs() const;

  bool has_atom_info() const {
    return atom_info() != nullptr;
  }

  AtomInfo* atom_info() {
    return const_cast<AtomInfo*>(static_cast<const Binary*>(this)->atom_info());
  }
  const AtomInfo* atom_info() const;

  it_notes notes();
 
  it_const_notes notes() const;

  bool has_notes() const {
    return get(LoadCommand::TYPE::NOTE) != nullptr;
  }

  bool has_function_variants() const {
    return function_variants() != nullptr;
  }

  FunctionVariants* function_variants() {
    return const_cast<FunctionVariants*>(static_cast<const Binary*>(this)->function_variants());
  }
 
  const FunctionVariants* function_variants() const;

  bool has_function_variant_fixups() const {
    return function_variant_fixups() != nullptr;
  }

  FunctionVariantFixups* function_variant_fixups() {
    return const_cast<FunctionVariantFixups*>(static_cast<const Binary*>(this)->function_variant_fixups());
  }
 
  const FunctionVariantFixups* function_variant_fixups() const;
 
  template<class T>
  LIEF_LOCAL bool has_command() const;
 
  template<class T>
  LIEF_LOCAL T* command();
 
  template<class T>
  LIEF_LOCAL const T* command() const;
 
  template<class T>
  LIEF_LOCAL size_t count_commands() const;
 
  template<class CMD, class Func>
  LIEF_LOCAL Binary& for_commands(Func f);
 
  LoadCommand* operator[](LoadCommand::TYPE type) {
    return get(type);
  }
  const LoadCommand* operator[](LoadCommand::TYPE type) const {
    return get(type);
  }

  LIEF::Binary::functions_t ctor_functions() const override;

  LIEF::Binary::functions_t functions() const;

  LIEF::Binary::functions_t unwind_functions() const;

  bool has_filesets() const {
    return filesets_.empty();
  }

  const std::string& fileset_name() const {
    return fileset_name_;
  }

  Symbol& add(const Symbol& symbol);
 
  ~Binary() override;

  ok_error_t shift(size_t value);

  ok_error_t shift_linkedit(size_t width);

  uint64_t memory_base_address() const {
    return in_memory_base_addr_;
  }

  bool support_arm64_ptr_auth() const {
    return header().cpu_type() == Header::CPU_TYPE::ARM64 &&
           (header().cpu_subtype() & ~Header::SUBTYPE_MASK) == Header::CPU_SUBTYPE_ARM64_ARM64E;
  }

  it_bindings bindings() const;
 
  static bool classof(const LIEF::Binary* bin) {
    return bin->format() == Binary::FORMATS::MACHO;
  }
 
  span<const uint8_t> overlay() const {
    return overlay_;
  }
 
  void sort_segments();
  void refresh_seg_offset();

  static LIEF_LOCAL bool can_cache_segment(const SegmentCommand& segment);

  LIEF_LOCAL size_t available_command_space() const {
    return available_command_space_;
  }
 
  private:
  LIEF_LOCAL Binary();
 
  LIEF_LOCAL void shift_command(size_t width, uint64_t from_offset);

  LIEF_LOCAL size_t add_cached_segment(SegmentCommand& segment);
 
  template<class T>
  LIEF_LOCAL ok_error_t patch_relocation(Relocation& relocation, uint64_t from,
                                         uint64_t shift);
 
  LIEF::Header get_abstract_header() const override {
    return LIEF::Header::from(*this);
  }
 
  LIEF_LOCAL LIEF::Binary::sections_t get_abstract_sections() override;
  LIEF_LOCAL LIEF::Binary::symbols_t get_abstract_symbols() override;
  LIEF_LOCAL LIEF::Binary::relocations_t get_abstract_relocations() override;
  LIEF_LOCAL LIEF::Binary::functions_t get_abstract_exported_functions() const override;
  LIEF_LOCAL LIEF::Binary::functions_t get_abstract_imported_functions() const override;
  LIEF_LOCAL std::vector<std::string> get_abstract_imported_libraries() const override;

  ok_error_t ensure_command_space(size_t size) {
    return available_command_space_ < size ? shift(size) : ok();
  }
 
  relocations_t& relocations_list() {
    return this->relocations_;
  }
 
  const relocations_t& relocations_list() const {
    return this->relocations_;
  }
 
  size_t pointer_size() const {
    return this->is64_ ? sizeof(uint64_t) : sizeof(uint32_t);
  }
 
  bool        is64_ = true;
  Header      header_;
  commands_t  commands_;
  symbols_t   symbols_;
 
  // Same purpose as sections_cache_t
  libraries_cache_t libraries_;
 
  // The sections are owned by the SegmentCommand object.
  // This attribute is a cache to speed-up the iteration
  sections_cache_t sections_;
 
  // Same purpose as sections_cache_t
  segments_cache_t segments_;
 
  fileset_binaries_t filesets_;
 
  // Cached relocations from segment / sections
  mutable relocations_t relocations_;
  size_t available_command_space_ = 0;
 
  // This is used to improve performances of
  // offset_to_virtual_address
  std::map<uint64_t, SegmentCommand*> offset_seg_;
 
  protected:
  uint64_t fat_offset_ = 0;
  uint64_t fileset_offset_ = 0;
  uint64_t in_memory_base_addr_ = 0;
  std::string fileset_name_;
  std::vector<uint8_t> overlay_;
  std::vector<std::unique_ptr<IndirectBindingInfo>> indirect_bindings_;
};
 
} // namespace MachO
} // namespace LIEF
#endif