ruby-macho 1.2.0 → 1.3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd8e36f6bd2e8cd96c08b2c032ce8dd4b8a97249ae5363419e7930a7997cc03c
-  data.tar.gz: 4ab73d409143e72912e1de7fa050b6debd02cc58bebfcfe92deb0c269cad9702
+  metadata.gz: 73711cb2c95bea44060fc6ab6ebd99a66b06ee1a6187b512ae68527e8dc4e8f7
+  data.tar.gz: fefdf5b471bbf158af6d8a1bf766f5b327ad737e09badc60d8adae723ef3d3b9
 SHA512:
-  metadata.gz: f030168651f8882b7dc44f4ab8392e21222e4c9a3ecf3e78e08612e85a07da0bbd07bb46b93bd3e37509e9d8e296ad21f2f0bf196abb0fbfbe006c10c3bb38cf
-  data.tar.gz: 4f4c53e171932244957261a7f28fdc129993decffcfc2c212d0b1b6d3c4c67290a609fe3fae91442553456ea38a99660d68eae79bb32e0c4b1fca9287c7b71c7
+  metadata.gz: ed466ba6c6c0c62f1cb7fa365401faef73a322c636f9a1e97f3e655457f1787b83ef134360168618849f0d3253f1d6b8ed41aa0f085a9a40b3ca966ef1d437e4
+  data.tar.gz: 61781f5efc71e38eff94704c09de7338e53918030189abe0f0bb2e1b442e5685a58076c431f112d27518e921fe5177666ccea7e6015fea65a5d8460da7632d13

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015, 2016 William Woodruff <william @ tuffbizz.com>
+Copyright (c) 2015, 2016, 2017, 2018 William Woodruff <william @ yossarian.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -9,7 +9,7 @@ A Ruby library for examining and modifying Mach-O files.
 
 ### What is a Mach-O file?
 
-The [Mach-O file format](https://en.wikipedia.org/wiki/Mach-O) is used by OS X
+The [Mach-O file format](https://en.wikipedia.org/wiki/Mach-O) is used by macOS
 and iOS (among others) as a general purpose binary format for object files,
 executables, dynamic libraries, and so forth.
 

data/lib/macho.rb

@@ -12,7 +12,7 @@ require "#{File.dirname(__FILE__)}/macho/tools"
 # The primary namespace for ruby-macho.
 module MachO
   # release version
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0.pre.1".freeze
 
   # Opens the given filename as a MachOFile or FatFile, depending on its magic.
   # @param filename [String] the file being opened

data/lib/macho/fat_file.rb

@@ -265,6 +265,15 @@ module MachO
       File.open(@filename, "wb") { |f| f.write(@raw_data) }
     end
 
+    # @return [Hash] a hash representation of this {FatFile}
+    def to_h
+      {
+        "header" => header.to_h,
+        "fat_archs" => fat_archs.map(&:to_h),
+        "machos" => machos.map(&:to_h),
+      }
+    end
+
     private
 
     # Obtain the fat header from raw file data.

data/lib/macho/headers.rb

@@ -475,6 +475,15 @@ module MachO
       def serialize
         [magic, nfat_arch].pack(FORMAT)
       end
+
+      # @return [Hash] a hash representation of this {FatHeader}
+      def to_h
+        {
+          "magic" => magic,
+          "magic_sym" => MH_MAGICS[magic],
+          "nfat_arch" => nfat_arch,
+        }.merge super
+      end
     end
 
     # Fat binary header architecture structure. A Fat binary has one or more of
@@ -508,7 +517,7 @@ module MachO
       # @api private
       def initialize(cputype, cpusubtype, offset, size, align)
         @cputype = cputype
-        @cpusubtype = cpusubtype
+        @cpusubtype = cpusubtype & ~CPU_SUBTYPE_MASK
         @offset = offset
         @size = size
         @align = align
@@ -518,6 +527,19 @@ module MachO
       def serialize
         [cputype, cpusubtype, offset, size, align].pack(FORMAT)
       end
+
+      # @return [Hash] a hash representation of this {FatArch}
+      def to_h
+        {
+          "cputype" => cputype,
+          "cputype_sym" => CPU_TYPES[cputype],
+          "cpusubtype" => cpusubtype,
+          "cpusubtype_sym" => CPU_SUBTYPES[cputype][cpusubtype],
+          "offset" => offset,
+          "size" => size,
+          "align" => align,
+        }.merge super
+      end
     end
 
     # 32-bit Mach-O file header structure
@@ -639,6 +661,24 @@ module MachO
       def alignment
         magic32? ? 4 : 8
       end
+
+      # @return [Hash] a hash representation of this {MachHeader}
+      def to_h
+        {
+          "magic" => magic,
+          "magic_sym" => MH_MAGICS[magic],
+          "cputype" => cputype,
+          "cputype_sym" => CPU_TYPES[cputype],
+          "cpusubtype" => cpusubtype,
+          "cpusubtype_sym" => CPU_SUBTYPES[cputype][cpusubtype],
+          "filetype" => filetype,
+          "filetype_sym" => MH_FILETYPES[filetype],
+          "ncmds" => ncmds,
+          "sizeofcmds" => sizeofcmds,
+          "flags" => flags,
+          "alignment" => alignment,
+        }.merge super
+      end
     end
 
     # 64-bit Mach-O file header structure
@@ -660,6 +700,13 @@ module MachO
         super(magic, cputype, cpusubtype, filetype, ncmds, sizeofcmds, flags)
         @reserved = reserved
       end
+
+      # @return [Hash] a hash representation of this {MachHeader64}
+      def to_h
+        {
+          "reserved" => reserved,
+        }.merge super
+      end
     end
   end
 end

data/lib/macho/load_commands.rb

@@ -143,7 +143,7 @@ module MachO
       :LC_LINKER_OPTIMIZATION_HINT => "LinkeditDataCommand",
       :LC_VERSION_MIN_TVOS => "VersionMinCommand",
       :LC_VERSION_MIN_WATCHOS => "VersionMinCommand",
-      :LC_NOTE => "LoadCommand",
+      :LC_NOTE => "NoteCommand",
       :LC_BUILD_VERSION => "BuildVersionCommand",
     }.freeze
 
@@ -169,15 +169,16 @@ module MachO
       :SG_PROTECTED_VERSION_1 => 0x8,
     }.freeze
 
-    # Mach-O load command structure
-    # This is the most generic load command - only cmd ID and size are
-    # represented, and no actual data. Used when a more specific class
-    # isn't available/implemented.
+    # The top-level Mach-O load command structure.
+    #
+    # This is the most generic load command -- only the type ID and size are
+    # represented. Used when a more specific class isn't available or isn't implemented.
     class LoadCommand < MachOStructure
-      # @return [MachO::MachOView] the raw view associated with the load command
+      # @return [MachO::MachOView, nil] the raw view associated with the load command,
+      #  or nil if the load command was created via {create}.
       attr_reader :view
 
-      # @return [Integer] the load command's identifying number
+      # @return [Integer] the load command's type ID
       attr_reader :cmd
 
       # @return [Integer] the size of the load command, in bytes
@@ -251,8 +252,8 @@ module MachO
         view.offset
       end
 
-      # @return [Symbol] a symbol representation of the load command's
-      #  identifying number
+      # @return [Symbol, nil] a symbol representation of the load command's
+      #  type ID, or nil if the ID doesn't correspond to a known load command class
       def type
         LOAD_COMMANDS[cmd]
       end
@@ -265,6 +266,17 @@ module MachO
         type.to_s
       end
 
+      # @return [Hash] a hash representation of this load command
+      # @note Children should override this to include additional information.
+      def to_h
+        {
+          "view" => view.to_h,
+          "cmd" => cmd,
+          "cmdsize" => cmdsize,
+          "type" => type,
+        }.merge super
+      end
+
       # Represents a Load Command string. A rough analogue to the lc_str
       # struct used internally by OS X. This class allows ruby-macho to
       # pretend that strings stored in LCs are immediately available without
@@ -304,6 +316,14 @@ module MachO
         def to_i
           @string_offset
         end
+
+        # @return [Hash] a hash representation of this {LCStr}.
+        def to_h
+          {
+            "string" => to_s,
+            "offset" => to_i,
+          }
+        end
       end
 
       # Represents the contextual information needed by a load command to
@@ -364,6 +384,14 @@ module MachO
 
         segs.join("-")
       end
+
+      # @return [Hash] returns a hash representation of this {UUIDCommand}
+      def to_h
+        {
+          "uuid" => uuid,
+          "uuid_string" => uuid_string,
+        }.merge super
+      end
     end
 
     # A load command indicating that part of this file is to be mapped into
@@ -398,7 +426,7 @@ module MachO
 
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2a16L=4l=2L=2".freeze
+      FORMAT = "L=2Z16L=4l=2L=2".freeze
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -408,7 +436,7 @@ module MachO
       def initialize(view, cmd, cmdsize, segname, vmaddr, vmsize, fileoff,
                      filesize, maxprot, initprot, nsects, flags)
         super(view, cmd, cmdsize)
-        @segname = segname.delete("\x00")
+        @segname = segname
         @vmaddr = vmaddr
         @vmsize = vmsize
         @fileoff = fileoff
@@ -448,6 +476,22 @@ module MachO
         return false if flag.nil?
         flags & flag == flag
       end
+
+      # @return [Hash] a hash representation of this {SegmentCommand}
+      def to_h
+        {
+          "segname" => segname,
+          "vmaddr" => vmaddr,
+          "vmsize" => vmsize,
+          "fileoff" => fileoff,
+          "filesize" => filesize,
+          "maxprot" => maxprot,
+          "initprot" => initprot,
+          "nsects" => nsects,
+          "flags" => flags,
+          "sections" => sections.map(&:to_h),
+        }.merge super
+      end
     end
 
     # A load command indicating that part of this file is to be mapped into
@@ -455,7 +499,7 @@ module MachO
     class SegmentCommand64 < SegmentCommand
       # @see MachOStructure::FORMAT
       # @api private
-      FORMAT = "L=2a16Q=4l=2L=2".freeze
+      FORMAT = "L=2Z16Q=4l=2L=2".freeze
 
       # @see MachOStructure::SIZEOF
       # @api private
@@ -510,6 +554,16 @@ module MachO
         [cmd, cmdsize, string_offsets[:name], timestamp, current_version,
          compatibility_version].pack(format) + string_payload
       end
+
+      # @return [Hash] a hash representation of this {DylibCommand}
+      def to_h
+        {
+          "name" => name.to_h,
+          "timestamp" => timestamp,
+          "current_version" => current_version,
+          "compatibility_version" => compatibility_version,
+        }.merge super
+      end
     end
 
     # A load command representing some aspect of the dynamic linker, depending
@@ -546,6 +600,13 @@ module MachO
         cmdsize = SIZEOF + string_payload.bytesize
         [cmd, cmdsize, string_offsets[:name]].pack(format) + string_payload
       end
+
+      # @return [Hash] a hash representation of this {DylinkerCommand}
+      def to_h
+        {
+          "name" => name.to_h,
+        }.merge super
+      end
     end
 
     # A load command used to indicate dynamic libraries used in prebinding.
@@ -576,6 +637,15 @@ module MachO
         @nmodules = nmodules
         @linked_modules = linked_modules
       end
+
+      # @return [Hash] a hash representation of this {PreboundDylibCommand}
+      def to_h
+        {
+          "name" => name.to_h,
+          "nmodules" => nmodules,
+          "linked_modules" => linked_modules,
+        }.merge super
+      end
     end
 
     # A load command used to represent threads.
@@ -641,6 +711,20 @@ module MachO
         @reserved5 = reserved5
         @reserved6 = reserved6
       end
+
+      # @return [Hash] a hash representation of this {RoutinesCommand}
+      def to_h
+        {
+          "init_address" => init_address,
+          "init_module" => init_module,
+          "reserved1" => reserved1,
+          "reserved2" => reserved2,
+          "reserved3" => reserved3,
+          "reserved4" => reserved4,
+          "reserved5" => reserved5,
+          "reserved6" => reserved6,
+        }.merge super
+      end
     end
 
     # A load command containing the address of the dynamic shared library
@@ -675,6 +759,13 @@ module MachO
         super(view, cmd, cmdsize)
         @umbrella = LCStr.new(self, umbrella)
       end
+
+      # @return [Hash] a hash representation of this {SubFrameworkCommand}
+      def to_h
+        {
+          "umbrella" => umbrella.to_h,
+        }.merge super
+      end
     end
 
     # A load command signifying membership of a subumbrella containing the name
@@ -696,6 +787,13 @@ module MachO
         super(view, cmd, cmdsize)
         @sub_umbrella = LCStr.new(self, sub_umbrella)
       end
+
+      # @return [Hash] a hash representation of this {SubUmbrellaCommand}
+      def to_h
+        {
+          "sub_umbrella" => sub_umbrella.to_h,
+        }.merge super
+      end
     end
 
     # A load command signifying a sublibrary of a shared library. Corresponds
@@ -717,6 +815,13 @@ module MachO
         super(view, cmd, cmdsize)
         @sub_library = LCStr.new(self, sub_library)
       end
+
+      # @return [Hash] a hash representation of this {SubLibraryCommand}
+      def to_h
+        {
+          "sub_library" => sub_library.to_h,
+        }.merge super
+      end
     end
 
     # A load command signifying a shared library that is a subframework of
@@ -738,6 +843,13 @@ module MachO
         super(view, cmd, cmdsize)
         @sub_client = LCStr.new(self, sub_client)
       end
+
+      # @return [Hash] a hash representation of this {SubClientCommand}
+      def to_h
+        {
+          "sub_client" => sub_client.to_h,
+        }.merge super
+      end
     end
 
     # A load command containing the offsets and sizes of the link-edit 4.3BSD
@@ -749,10 +861,10 @@ module MachO
       # @return [Integer] the number of symbol table entries
       attr_reader :nsyms
 
-      # @return the string table's offset
+      # @return [Integer] the string table's offset
       attr_reader :stroff
 
-      # @return the string table size in bytes
+      # @return [Integer] the string table size in bytes
       attr_reader :strsize
 
       # @see MachOStructure::FORMAT
@@ -771,6 +883,16 @@ module MachO
         @stroff = stroff
         @strsize = strsize
       end
+
+      # @return [Hash] a hash representation of this {SymtabCommand}
+      def to_h
+        {
+          "symoff" => symoff,
+          "nsyms" => nsyms,
+          "stroff" => stroff,
+          "strsize" => strsize,
+        }.merge super
+      end
     end
 
     # A load command containing symbolic information needed to support data
@@ -864,6 +986,30 @@ module MachO
         @locreloff = locreloff
         @nlocrel = nlocrel
       end
+
+      # @return [Hash] a hash representation of this {DysymtabCommand}
+      def to_h
+        {
+          "ilocalsym" => ilocalsym,
+          "nlocalsym" => nlocalsym,
+          "iextdefsym" => iextdefsym,
+          "nextdefsym" => nextdefsym,
+          "iundefsym" => iundefsym,
+          "nundefsym" => nundefsym,
+          "tocoff" => tocoff,
+          "ntoc" => ntoc,
+          "modtaboff" => modtaboff,
+          "nmodtab" => nmodtab,
+          "extrefsymoff" => extrefsymoff,
+          "nextrefsyms" => nextrefsyms,
+          "indirectsymoff" => indirectsymoff,
+          "nindirectsyms" => nindirectsyms,
+          "extreloff" => extreloff,
+          "nextrel" => nextrel,
+          "locreloff" => locreloff,
+          "nlocrel" => nlocrel,
+        }.merge super
+      end
     end
 
     # A load command containing the offset and number of hints in the two-level
@@ -895,6 +1041,15 @@ module MachO
         @table = TwolevelHintsTable.new(view, htoffset, nhints)
       end
 
+      # @return [Hash] a hash representation of this {TwolevelHintsCommand}
+      def to_h
+        {
+          "htoffset" => htoffset,
+          "nhints" => nhints,
+          "table" => table.hints.map(&:to_h),
+        }.merge super
+      end
+
       # A representation of the two-level namespace lookup hints table exposed
       # by a {TwolevelHintsCommand} (`LC_TWOLEVEL_HINTS`).
       class TwolevelHintsTable
@@ -927,6 +1082,14 @@ module MachO
             @isub_image = blob >> 24
             @itoc = blob & 0x00FFFFFF
           end
+
+          # @return [Hash] a hash representation of this {TwolevelHint}
+          def to_h
+            {
+              "isub_image" => isub_image,
+              "itoc" => itoc,
+            }
+          end
         end
       end
     end
@@ -950,6 +1113,13 @@ module MachO
         super(view, cmd, cmdsize)
         @cksum = cksum
       end
+
+      # @return [Hash] a hash representation of this {PrebindCksumCommand}
+      def to_h
+        {
+          "cksum" => cksum,
+        }.merge super
+      end
     end
 
     # A load command representing an rpath, which specifies a path that should
@@ -984,6 +1154,13 @@ module MachO
         cmdsize = SIZEOF + string_payload.bytesize
         [cmd, cmdsize, string_offsets[:path]].pack(format) + string_payload
       end
+
+      # @return [Hash] a hash representation of this {RpathCommand}
+      def to_h
+        {
+          "path" => path.to_h,
+        }.merge super
+      end
     end
 
     # A load command representing the offsets and sizes of a blob of data in
@@ -1011,6 +1188,14 @@ module MachO
         @dataoff = dataoff
         @datasize = datasize
       end
+
+      # @return [Hash] a hash representation of this {LinkeditDataCommand}
+      def to_h
+        {
+          "dataoff" => dataoff,
+          "datasize" => datasize,
+        }.merge super
+      end
     end
 
     # A load command representing the offset to and size of an encrypted
@@ -1040,20 +1225,20 @@ module MachO
         @cryptsize = cryptsize
         @cryptid = cryptid
       end
+
+      # @return [Hash] a hash representation of this {EncryptionInfoCommand}
+      def to_h
+        {
+          "cryptoff" => cryptoff,
+          "cryptsize" => cryptsize,
+          "cryptid" => cryptid,
+        }.merge super
+      end
     end
 
     # A load command representing the offset to and size of an encrypted
     # segment. Corresponds to LC_ENCRYPTION_INFO_64.
-    class EncryptionInfoCommand64 < LoadCommand
-      # @return [Integer] the offset to the encrypted segment
-      attr_reader :cryptoff
-
-      # @return [Integer] the size of the encrypted segment
-      attr_reader :cryptsize
-
-      # @return [Integer] the encryption system, or 0 if not encrypted yet
-      attr_reader :cryptid
-
+    class EncryptionInfoCommand64 < EncryptionInfoCommand
       # @return [Integer] 64-bit padding value
       attr_reader :pad
 
@@ -1067,12 +1252,16 @@ module MachO
 
       # @api private
       def initialize(view, cmd, cmdsize, cryptoff, cryptsize, cryptid, pad)
-        super(view, cmd, cmdsize)
-        @cryptoff = cryptoff
-        @cryptsize = cryptsize
-        @cryptid = cryptid
+        super(view, cmd, cmdsize, cryptoff, cryptsize, cryptid)
         @pad = pad
       end
+
+      # @return [Hash] a hash representation of this {EncryptionInfoCommand64}
+      def to_h
+        {
+          "pad" => pad,
+        }.merge super
+      end
     end
 
     # A load command containing the minimum OS version on which the binary
@@ -1121,6 +1310,16 @@ module MachO
 
         segs.join(".")
       end
+
+      # @return [Hash] a hash representation of this {VersionMinCommand}
+      def to_h
+        {
+          "version" => version,
+          "version_string" => version_string,
+          "sdk" => sdk,
+          "sdk_string" => sdk_string,
+        }.merge super
+      end
     end
 
     # A load command containing the minimum OS version on which
@@ -1156,6 +1355,40 @@ module MachO
         @tool_entries = ToolEntries.new(view, ntools)
       end
 
+      # A string representation of the binary's minimum OS version.
+      # @return [String] a string representing the minimum OS version.
+      def minos_string
+        binary = "%032b" % minos
+        segs = [
+          binary[0..15], binary[16..23], binary[24..31]
+        ].map { |s| s.to_i(2) }
+
+        segs.join(".")
+      end
+
+      # A string representation of the binary's SDK version.
+      # @return [String] a string representing the SDK version.
+      def sdk_string
+        binary = "%032b" % sdk
+        segs = [
+          binary[0..15], binary[16..23], binary[24..31]
+        ].map { |s| s.to_i(2) }
+
+        segs.join(".")
+      end
+
+      # @return [Hash] a hash representation of this {BuildVersionCommand}
+      def to_h
+        {
+          "platform" => platform,
+          "minos" => minos,
+          "minos_string" => minos_string,
+          "sdk" => sdk,
+          "sdk_string" => sdk_string,
+          "tool_entries" => tool_entries.tools.map(&:to_h),
+        }.merge super
+      end
+
       # A representation of the tool versions exposed
       # by a {BuildVersionCommand} (`LC_BUILD_VERSION`).
       class ToolEntries
@@ -1181,36 +1414,22 @@ module MachO
           # @return [Integer] the tool's version number
           attr_reader :version
 
-          # @param tool 32-bit integer
-          # # @param version 32-bit integer
+          # @param tool [Integer] 32-bit integer
+          # @param version [Integer] 32-bit integer
           # @api private
           def initialize(tool, version)
             @tool = tool
             @version = version
           end
-        end
-      end
 
-      # A string representation of the binary's minimum OS version.
-      # @return [String] a string representing the minimum OS version.
-      def minos_string
-        binary = "%032b" % minos
-        segs = [
-          binary[0..15], binary[16..23], binary[24..31]
-        ].map { |s| s.to_i(2) }
-
-        segs.join(".")
-      end
-
-      # A string representation of the binary's SDK version.
-      # @return [String] a string representing the SDK version.
-      def sdk_string
-        binary = "%032b" % sdk
-        segs = [
-          binary[0..15], binary[16..23], binary[24..31]
-        ].map { |s| s.to_i(2) }
-
-        segs.join(".")
+          # @return [Hash] a hash representation of this {Tool}
+          def to_h
+            {
+              "tool" => tool,
+              "version" => version,
+            }
+          end
+        end
       end
     end
 
@@ -1272,6 +1491,22 @@ module MachO
         @export_off = export_off
         @export_size = export_size
       end
+
+      # @return [Hash] a hash representation of this {DyldInfoCommand}
+      def to_h
+        {
+          "rebase_off" => rebase_off,
+          "rebase_size" => rebase_size,
+          "bind_off" => bind_off,
+          "bind_size" => bind_size,
+          "weak_bind_off" => weak_bind_off,
+          "weak_bind_size" => weak_bind_size,
+          "lazy_bind_off" => lazy_bind_off,
+          "lazy_bind_size" => lazy_bind_size,
+          "export_off" => export_off,
+          "export_size" => export_size,
+        }.merge super
+      end
     end
 
     # A load command containing linker options embedded in object files.
@@ -1293,6 +1528,13 @@ module MachO
         super(view, cmd, cmdsize)
         @count = count
       end
+
+      # @return [Hash] a hash representation of this {LinkerOptionCommand}
+      def to_h
+        {
+          "count" => count,
+        }.merge super
+      end
     end
 
     # A load command specifying the offset of main(). Corresponds to LC_MAIN.
@@ -1317,6 +1559,14 @@ module MachO
         @entryoff = entryoff
         @stacksize = stacksize
       end
+
+      # @return [Hash] a hash representation of this {EntryPointCommand}
+      def to_h
+        {
+          "entryoff" => entryoff,
+          "stacksize" => stacksize,
+        }.merge super
+      end
     end
 
     # A load command specifying the version of the sources used to build the
@@ -1350,6 +1600,14 @@ module MachO
 
         segs.join(".")
       end
+
+      # @return [Hash] a hash representation of this {SourceVersionCommand}
+      def to_h
+        {
+          "version" => version,
+          "version_string" => version_string,
+        }.merge super
+      end
     end
 
     # An obsolete load command containing the offset and size of the (GNU style)
@@ -1375,6 +1633,14 @@ module MachO
         @offset = offset
         @size = size
       end
+
+      # @return [Hash] a hash representation of this {SymsegCommand}
+      def to_h
+        {
+          "offset" => offset,
+          "size" => size,
+        }.merge super
+      end
     end
 
     # An obsolete load command containing a free format string table. Each
@@ -1412,6 +1678,14 @@ module MachO
         @name = LCStr.new(self, name)
         @header_addr = header_addr
       end
+
+      # @return [Hash] a hash representation of this {FvmfileCommand}
+      def to_h
+        {
+          "name" => name.to_h,
+          "header_addr" => header_addr,
+        }.merge super
+      end
     end
 
     # An obsolete load command containing the path to a library to be loaded
@@ -1440,6 +1714,52 @@ module MachO
         @minor_version = minor_version
         @header_addr = header_addr
       end
+
+      # @return [Hash] a hash representation of this {FvmlibCommand}
+      def to_h
+        {
+          "name" => name.to_h,
+          "minor_version" => minor_version,
+          "header_addr" => header_addr,
+        }.merge super
+      end
+    end
+
+    # A load command containing an owner name and offset/size for an arbitrary data region.
+    # Corresponds to LC_NOTE.
+    class NoteCommand < LoadCommand
+      # @return [String] the name of the owner for this note
+      attr_reader :data_owner
+
+      # @return [Integer] the offset, within the file, of the note
+      attr_reader :offset
+
+      # @return [Integer] the size, in bytes, of the note
+      attr_reader :size
+
+      # @see MachOStructure::FORMAT
+      # @api private
+      FORMAT = "L=2Z16Q=2".freeze
+
+      # @see MachOStructure::SIZEOF
+      # @api private
+      SIZEOF = 48
+
+      def initialize(view, cmd, cmdsize, data_owner, offset, size)
+        super(view, cmd, cmdsize)
+        @data_owner = data_owner
+        @offset = offset
+        @size = size
+      end
+
+      # @return [Hash] a hash representation of this {NoteCommand}
+      def to_h
+        {
+          "data_owner" => data_owner,
+          "offset" => offset,
+          "size" => size,
+        }.merge super
+      end
     end
   end
 end

data/lib/macho/macho_file.rb

@@ -25,7 +25,7 @@ module MachO
     # @note load commands are provided in order of ascending offset.
     attr_reader :load_commands
 
-    # Creates a new MachOFile instance from a binary string.
+    # Creates a new instance from a binary string.
     # @param bin [String] a binary string containing raw Mach-O data
     # @return [MachOFile] a new MachOFile
     def self.new_from_bin(bin)
@@ -35,7 +35,7 @@ module MachO
       instance
     end
 
-    # Creates a new FatFile from the given filename.
+    # Creates a new instance from data read from the given filename.
     # @param filename [String] the Mach-O file to load from
     # @raise [ArgumentError] if the given file does not exist
     def initialize(filename)
@@ -408,6 +408,14 @@ module MachO
       File.open(@filename, "wb") { |f| f.write(@raw_data) }
     end
 
+    # @return [Hash] a hash representation of this {MachOFile}
+    def to_h
+      {
+        "header" => header.to_h,
+        "load_commands" => load_commands.map(&:to_h),
+      }
+    end
+
     private
 
     # The file's Mach-O header structure.

data/lib/macho/sections.rb

@@ -104,7 +104,7 @@ module MachO
       attr_reader :reserved2
 
       # @see MachOStructure::FORMAT
-      FORMAT = "a16a16L=9".freeze
+      FORMAT = "Z16Z16L=9".freeze
 
       # @see MachOStructure::SIZEOF
       SIZEOF = 68
@@ -125,16 +125,14 @@ module MachO
         @reserved2 = reserved2
       end
 
-      # @return [String] the section's name, with any trailing NULL characters
-      #  removed
+      # @return [String] the section's name
       def section_name
-        sectname.delete("\x00")
+        sectname
       end
 
-      # @return [String] the parent segment's name, with any trailing NULL
-      #  characters removed
+      # @return [String] the parent segment's name
       def segment_name
-        segname.delete("\x00")
+        segname
       end
 
       # @return [Boolean] whether the section is empty (i.e, {size} is 0)
@@ -151,6 +149,23 @@ module MachO
         return false if flag.nil?
         flags & flag == flag
       end
+
+      # @return [Hash] a hash representation of this {Section}
+      def to_h
+        {
+          "sectname" => sectname,
+          "segname" => segname,
+          "addr" => addr,
+          "size" => size,
+          "offset" => offset,
+          "align" => align,
+          "reloff" => reloff,
+          "nreloc" => nreloc,
+          "flags" => flags,
+          "reserved1" => reserved1,
+          "reserved2" => reserved2,
+        }.merge super
+      end
     end
 
     # Represents a section of a segment for 64-bit architectures.
@@ -159,7 +174,7 @@ module MachO
       attr_reader :reserved3
 
       # @see MachOStructure::FORMAT
-      FORMAT = "a16a16Q=2L=8".freeze
+      FORMAT = "Z16Z16Q=2L=8".freeze
 
       # @see MachOStructure::SIZEOF
       SIZEOF = 80
@@ -171,6 +186,13 @@ module MachO
           nreloc, flags, reserved1, reserved2)
         @reserved3 = reserved3
       end
+
+      # @return [Hash] a hash representation of this {Section64}
+      def to_h
+        {
+          "reserved3" => reserved3,
+        }.merge super
+      end
     end
   end
 end

data/lib/macho/structure.rb

@@ -26,5 +26,15 @@ module MachO
 
       new(*bin.unpack(format))
     end
+
+    # @return [Hash] a hash representation of this {MachOStructure}.
+    def to_h
+      {
+        "structure" => {
+          "format" => self.class::FORMAT,
+          "bytesize" => self.class.bytesize,
+        },
+      }
+    end
   end
 end

data/lib/macho/view.rb

@@ -19,5 +19,13 @@ module MachO
       @endianness = endianness
       @offset = offset
     end
+
+    # @return [Hash] a hash representation of this {MachOView}.
+    def to_h
+      {
+        "endianness" => endianness,
+        "offset" => offset,
+      }
+    end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.pre.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
-email: william@tuffbizz.com
+email: william@yossarian.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -42,12 +42,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6