Enhance Mach-O support

Author: romainthomas

api/python/lief/MachO/__init__.pyi

@@ -681,6 +681,15 @@ class Binary(lief.Binary):
 
         def __next__(self) -> SubClient: ...
 
+    class it_notes:
+        def __getitem__(self, arg: int, /) -> NoteCommand: ...
+
+        def __len__(self) -> int: ...
+
+        def __iter__(self) -> Binary.it_notes: ...
+
+        def __next__(self) -> NoteCommand: ...
+
     class range_t:
         start: int
 
@@ -1043,6 +1052,12 @@ class Binary(lief.Binary):
     @property
     def objc_metadata(self) -> Optional[lief.objc.Metadata]: ...
 
+    @property
+    def notes(self) -> Binary.it_notes: ...
+
+    @property
+    def has_notes(self) -> bool: ...
+
     def __getitem__(self, arg: LoadCommand.TYPE, /) -> LoadCommand: ...
 
     def __contains__(self, arg: LoadCommand.TYPE, /) -> bool: ...
@@ -1138,6 +1153,12 @@ class Header(lief.Object):
 
         KEXT_BUNDLE = 11
 
+        FILESET = 12
+
+        GPU_EXECUTE = 13
+
+        GPU_DYLIB = 14
+
     class FLAGS(enum.Flag):
         @staticmethod
         def from_value(arg: int, /) -> Header.FLAGS: ...
@@ -1200,6 +1221,14 @@ class Header(lief.Object):
 
         APP_EXTENSION_SAFE = 33554432
 
+        NLIST_OUTOFSYNC_WITH_DYLDINFO = 67108864
+
+        SIM_SUPPORT = 134217728
+
+        IMPLICIT_PAGEZERO = 268435456
+
+        DYLIB_IN_CACHE = 2147483648
+
     magic: MACHO_TYPES
 
     cpu_type: Header.CPU_TYPE
@@ -1364,6 +1393,12 @@ class LoadCommand(lief.Object):
 
         ATOM_INFO = 54
 
+        FUNCTION_VARIANTS = 55
+
+        FUNCTION_VARIANT_FIXUPS = 56
+
+        TARGET_TRIPLE = 57
+
         LIEF_UNKNOWN = 4293787649
 
     command: LoadCommand.TYPE
@@ -1658,6 +1693,18 @@ class MainCommand(LoadCommand):
 
     def __str__(self) -> str: ...
 
+class NoteCommand(LoadCommand):
+    note_offset: int
+
+    note_size: int
+
+    @property
+    def owner_str(self) -> str: ...
+
+    owner: memoryview
+
+    def __str__(self) -> str: ...
+
 class DynamicSymbolCommand(LoadCommand):
     class it_indirect_symbols:
         def __getitem__(self, arg: int, /) -> Symbol: ...
@@ -2580,6 +2627,14 @@ class BuildVersion(LoadCommand):
 
         TVOS_EXCLAVE_KIT = 20
 
+        WATCHOS_EXCLAVE_CORE = 21
+
+        WATCHOS_EXCLAVE_KIT = 22
+
+        VISIONOS_EXCLAVE_CORE = 23
+
+        VISIONOS_EXCLAVE_KIT = 24
+
         ANY = 4294967295
 
     platform: BuildVersion.PLATFORMS
@@ -2622,6 +2677,20 @@ class BuildToolVersion(lief.Object):
 
         LLD = 4
 
+        METAL = 1024
+
+        AIRLLD = 1025
+
+        AIRNT = 1026
+
+        AIRNT_PLUGIN = 1027
+
+        AIRPACK = 1028
+
+        GPUARCHIVER = 1031
+
+        METAL_FRAMEWORK = 1032
+
 class FilesetCommand(LoadCommand):
     name: str
 

api/python/src/MachO/init.cpp

@@ -45,6 +45,7 @@
 #include <LIEF/MachO/LinkerOptHint.hpp>
 #include <LIEF/MachO/LoadCommand.hpp>
 #include <LIEF/MachO/MainCommand.hpp>
+#include <LIEF/MachO/NoteCommand.hpp>
 #include <LIEF/MachO/Parser.hpp>
 #include <LIEF/MachO/ParserConfig.hpp>
 #include <LIEF/MachO/RPathCommand.hpp>
@@ -87,6 +88,7 @@ void init_objects(nb::module_& m) {
   CREATE(SegmentCommand, m);
   CREATE(Section, m);
   CREATE(MainCommand, m);
+  CREATE(NoteCommand, m);
   CREATE(DynamicSymbolCommand, m);
   CREATE(DylinkerCommand, m);
   CREATE(DyldInfo, m);

api/python/src/MachO/objects/CMakeLists.txt

@@ -28,6 +28,7 @@ target_sources(pyLIEF PRIVATE
   pyLinkerOptHint.cpp
   pyLoadCommand.cpp
   pyMainCommand.cpp
+  pyNoteCommand.cpp
   pyParser.cpp
   pyParserConfig.cpp
   pyRPathCommand.cpp

api/python/src/MachO/objects/pyBinary.cpp

@@ -45,6 +45,7 @@
 #include "LIEF/MachO/LinkerOptHint.hpp"
 #include "LIEF/MachO/AtomInfo.hpp"
 #include "LIEF/MachO/MainCommand.hpp"
+#include "LIEF/MachO/NoteCommand.hpp"
 #include "LIEF/MachO/Routine.hpp"
 #include "LIEF/MachO/RPathCommand.hpp"
 #include "LIEF/MachO/Relocation.hpp"
@@ -88,6 +89,7 @@ void create<Binary>(nb::module_& m) {
   init_ref_iterator<Binary::it_relocations>(bin, "it_relocations");
   init_ref_iterator<Binary::it_rpaths>(bin, "it_rpaths");
   init_ref_iterator<Binary::it_sub_clients>(bin, "it_sub_clients");
+  init_ref_iterator<Binary::it_notes>(bin, "it_notes");
 
   nb::class_<Binary::range_t>(bin, "range_t")
     .def_rw("start", &Binary::range_t::start)
@@ -778,6 +780,14 @@ void create<Binary>(nb::module_& m) {
       )doc"_doc
     )
 
+    .def_prop_ro("notes",
+        nb::overload_cast<>(&Binary::notes),
+        "Iterator over the different ``LC_NOTE`` commands"_doc,
+        nb::keep_alive<0, 1>())
+
+    .def_prop_ro("has_notes", &Binary::has_notes,
+      "True if the binary contains ``LC_NOTE`` command(s)")
+
     .def("__getitem__",
         nb::overload_cast<LoadCommand::TYPE>(&Binary::operator[]),
         nb::rv_policy::reference_internal)

api/python/src/MachO/objects/pyBuildVersion.cpp

@@ -60,6 +60,14 @@ void create<BuildVersion>(nb::module_& m) {
     .value(PY_ENUM(BuildToolVersion::TOOLS::SWIFT))
     .value(PY_ENUM(BuildToolVersion::TOOLS::LD))
     .value(PY_ENUM(BuildToolVersion::TOOLS::LLD))
+
+    .value(PY_ENUM(BuildToolVersion::TOOLS::METAL))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::AIRLLD))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::AIRNT))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::AIRNT_PLUGIN))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::AIRPACK))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::GPUARCHIVER))
+    .value(PY_ENUM(BuildToolVersion::TOOLS::METAL_FRAMEWORK))
   ;
 
 
@@ -85,6 +93,10 @@ void create<BuildVersion>(nb::module_& m) {
     .value(PY_ENUM(BuildVersion::PLATFORMS::IOS_EXCLAVE_KIT))
     .value(PY_ENUM(BuildVersion::PLATFORMS::TVOS_EXCLAVE_CORE))
     .value(PY_ENUM(BuildVersion::PLATFORMS::TVOS_EXCLAVE_KIT))
+    .value(PY_ENUM(BuildVersion::PLATFORMS::WATCHOS_EXCLAVE_CORE))
+    .value(PY_ENUM(BuildVersion::PLATFORMS::WATCHOS_EXCLAVE_KIT))
+    .value(PY_ENUM(BuildVersion::PLATFORMS::VISIONOS_EXCLAVE_CORE))
+    .value(PY_ENUM(BuildVersion::PLATFORMS::VISIONOS_EXCLAVE_KIT))
     .value(PY_ENUM(BuildVersion::PLATFORMS::ANY))
   ;
 

api/python/src/MachO/objects/pyHeader.cpp

@@ -71,6 +71,9 @@ void create<Header>(nb::module_& m) {
     .value(PY_ENUM(Header::FILE_TYPE::DYLIB_STUB))
     .value(PY_ENUM(Header::FILE_TYPE::DSYM))
     .value(PY_ENUM(Header::FILE_TYPE::KEXT_BUNDLE))
+    .value(PY_ENUM(Header::FILE_TYPE::FILESET))
+    .value(PY_ENUM(Header::FILE_TYPE::GPU_EXECUTE))
+    .value(PY_ENUM(Header::FILE_TYPE::GPU_DYLIB))
   #undef PY_ENUM
   ;
 
@@ -102,6 +105,10 @@ void create<Header>(nb::module_& m) {
     .value(PY_ENUM(Header::FLAGS::HAS_TLV_DESCRIPTORS))
     .value(PY_ENUM(Header::FLAGS::NO_HEAP_EXECUTION))
     .value(PY_ENUM(Header::FLAGS::APP_EXTENSION_SAFE))
+    .value(PY_ENUM(Header::FLAGS::NLIST_OUTOFSYNC_WITH_DYLDINFO))
+    .value(PY_ENUM(Header::FLAGS::SIM_SUPPORT))
+    .value(PY_ENUM(Header::FLAGS::IMPLICIT_PAGEZERO))
+    .value(PY_ENUM(Header::FLAGS::DYLIB_IN_CACHE))
   #undef PY_ENUM
   ;
 

api/python/src/MachO/objects/pyLoadCommand.cpp

@@ -94,6 +94,9 @@ void create<LoadCommand>(nb::module_& m) {
     .value(PY_ENUM(LoadCommand::TYPE::DYLD_CHAINED_FIXUPS))
     .value(PY_ENUM(LoadCommand::TYPE::FILESET_ENTRY))
     .value(PY_ENUM(LoadCommand::TYPE::ATOM_INFO))
+    .value(PY_ENUM(LoadCommand::TYPE::FUNCTION_VARIANTS))
+    .value(PY_ENUM(LoadCommand::TYPE::FUNCTION_VARIANT_FIXUPS))
+    .value(PY_ENUM(LoadCommand::TYPE::TARGET_TRIPLE))
     .value(PY_ENUM(LoadCommand::TYPE::LIEF_UNKNOWN))
   #undef PY_ENUM
   ;

api/python/src/MachO/objects/pyNoteCommand.cpp

@@ -0,0 +1,64 @@
+/* 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.
+ */
+#include <string>
+#include <sstream>
+#include <nanobind/stl/string.h>
+#include "nanobind/extra/stl/lief_span.h"
+#include "nanobind/utils.hpp"
+
+#include "LIEF/MachO/NoteCommand.hpp"
+
+#include "MachO/pyMachO.hpp"
+
+namespace LIEF::MachO::py {
+
+template<>
+void create<NoteCommand>(nb::module_& m) {
+
+  nb::class_<NoteCommand, LoadCommand>(m, "NoteCommand",
+      R"delim(
+      Class that represent the ``LC_NOTE`` command.
+
+      This command is used to include arbitrary notes or metadata within a binary.
+      )delim"_doc)
+
+    .def_prop_rw("note_offset",
+        nb::overload_cast<>(&NoteCommand::note_offset, nb::const_),
+        nb::overload_cast<uint64_t>(&NoteCommand::note_offset),
+        "Offset of the data associated with this note"_doc)
+
+    .def_prop_rw("note_size",
+        nb::overload_cast<>(&NoteCommand::note_size, nb::const_),
+        nb::overload_cast<uint64_t>(&NoteCommand::note_size),
+        "Size of the data referenced by the :attr:`~.note_offset`"_doc)
+
+    .def_prop_ro("owner_str", &NoteCommand::owner_str,
+      "Owner as a zero-terminated string"_doc)
+
+    .def_prop_rw("owner",
+        nb::overload_cast<>(&NoteCommand::owner, nb::const_),
+        [] (NoteCommand& self, nb::bytes owner_bytes) {
+          std::vector<uint8_t> owner = to_vector(owner_bytes);
+          span<char> note_owner = self.owner();
+          owner.resize(note_owner.size());
+          std::copy(owner.begin(), owner.end(), note_owner.begin());
+        },
+        "Owner of the note (e.g. ``AIR_METALLIB``)"_doc)
+
+    LIEF_DEFAULT_STR(NoteCommand);
+
+}
+}

api/python/src/nanobind/extra/stl/lief_span.h

@@ -10,7 +10,8 @@ NAMESPACE_BEGIN(detail)
 
 template<class T>
 struct type_caster<LIEF::span<T>> {
-  static_assert(std::is_same_v<uint8_t, std::remove_const_t<T>>,
+  static_assert(std::is_same_v<uint8_t, std::remove_const_t<T>> ||
+                std::is_same_v<char, std::remove_const_t<T>>,
                 "Need uint8_t type");
 
   static constexpr auto IsRO = std::is_const_v<T>;

api/rust/autocxx_ffi.rs

@@ -541,6 +541,8 @@ include_cpp! {
     block_constructors!("MachO_Binary_it_libraries")
     generate!("MachO_Binary_it_sub_clients")
     block_constructors!("MachO_Binary_it_sub_clients")
+    generate!("MachO_Binary_it_notes")
+    block_constructors!("MachO_Binary_it_notes")
     generate!("MachO_Binary_it_bindings_info")
     block_constructors!("MachO_Binary_it_bindings_info")
     generate!("MachO_BindingInfo")
@@ -613,6 +615,8 @@ include_cpp! {
     block_constructors!("MachO_LinkerOptHint")
     generate!("MachO_Main")
     block_constructors!("MachO_Main")
+    generate!("MachO_NoteCommand")
+    block_constructors!("MachO_NoteCommand")
     generate!("MachO_Routine")
     block_constructors!("MachO_Routine")
     generate!("MachO_RPathCommand")