ruby-macho 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2197be0a734893a06de0c2a50c78a125e1e0f7b
-  data.tar.gz: 6333cb31cc35794f81b35c1e5f5a3e5d8f63d509
+  metadata.gz: 70e9e70c2eb3e759c76828051d5bca20c19f081b
+  data.tar.gz: 7a626fcc61d6437dec0085c46843cf7a9574f9a1
 SHA512:
-  metadata.gz: 2965997a877ab4c4d675f7e51b8b8ddb7fa82dda776e6b2fe5bb10bcfbf27845809723dc072257076a87c351fe03321839d669dd517ec36e0f57453a7831bef5
-  data.tar.gz: 326050eb144d5e9c415dcf58d10fb3da1c565044fae5bb3d1482fe9f15124c64490f95b2e595748b8f567e69db1cc8e5797cf0917c855150ae034bb9094b456c
+  metadata.gz: 6a110e3986ffbe60926702252a173082cd44bbb65824cbdd55648a969a2a54fb2afe9b60c5b761f978b8c2b11948887f052de67daab6d9b261085a199be58d38
+  data.tar.gz: 5a7c81e82a7857fe6a2732605f9dc4fb3e139d2989673ad3fbe1632be85072e13432cdbaf0964024cc53cc3c63d29a7864152dea5296b170185e12132e1fafc6

data/lib/macho/fat_file.rb

@@ -98,6 +98,15 @@ module MachO
 
 		alias :change_dylib :change_install_name
 
+		# Extract a Mach-O with the given CPU type from the file.
+		# @example
+		#  file.extract("CPU_TYPE_I386") # => MachO::MachOFile
+		# @param cputype [String] the CPU type of the Mach-O being extracted
+		# @return [MachO::MachOFile, nil] the extracted Mach-O or nil if no Mach-O has the given CPU type
+		def extract(cputype)
+			machos.select { |macho| macho.cputype == cputype }.first
+		end
+
 		# Write all (fat) data to the given filename.
 		# @param filename [String] the file to write to
 		def write(filename)

data/lib/macho/load_commands.rb

@@ -338,13 +338,48 @@ module MachO
 			super(offset, cmd, cmdsize)
 			@uuid = uuid.unpack("C16") # re-unpack for the actual UUID array
 		end
+
+		# @return [String] a string representation of the UUID
+		def uuid_string
+			hexes = uuid.map { |e| "%02x" % e }
+			segs = [
+				hexes[0..3].join, hexes[4..5].join,	hexes[6..7].join,
+				hexes[8..9].join, hexes[10..15].join
+			]
+
+			segs.join("-")
+		end
 	end
 
 	# A load command indicating that part of this file is to be mapped into
 	# the task's address space. Corresponds to LC_SEGMENT.
 	class SegmentCommand < LoadCommand
-		attr_reader :segname, :vmaddr, :vmsize, :fileoff, :filesize, :maxprot
-		attr_reader :initprot, :nsects, :flags
+		# @return [String] the name of the segment, including null padding bytes
+		attr_reader :segname
+
+		# @return [Fixnum] the memory address of the segment
+		attr_reader :vmaddr
+
+		# @return [Fixnum] the memory size of the segment
+		attr_reader :vmsize
+
+		# @return [Fixnum] the file offset of the segment
+		attr_reader :fileoff
+
+		# @return [Fixnum] the amount to map from the file
+		attr_reader :filesize
+
+		# @return [Fixnum] the maximum VM protection
+		attr_reader :maxprot
+
+		# @return [Fixnum] the initial VM protection
+		attr_reader :initprot
+
+		# @return [Fixnum] the number of sections in the segment
+		attr_reader :nsects
+
+		# @return [Fixnum] any flags associated with the segment
+		attr_reader :flags
 
 		@format = "VVa16VVVVVVVV"
 		@sizeof = 56
@@ -373,8 +408,32 @@ module MachO
 	# A load command indicating that part of this file is to be mapped into
 	# the task's address space. Corresponds to LC_SEGMENT_64.
 	class SegmentCommand64 < LoadCommand
-		attr_reader :segname, :vmaddr, :vmsize, :fileoff, :filesize, :maxprot
-		attr_reader :initprot, :nsects, :flags
+		# @return [String] the name of the segment, including null padding bytes
+		attr_reader :segname
+
+		# @return [Fixnum] the memory address of the segment
+		attr_reader :vmaddr
+
+		# @return [Fixnum] the memory size of the segment
+		attr_reader :vmsize
+
+		# @return [Fixnum] the file offset of the segment
+		attr_reader :fileoff
+
+		# @return [Fixnum] the amount to map from the file
+		attr_reader :filesize
+
+		# @return [Fixnum] the maximum VM protection
+		attr_reader :maxprot
+
+		# @return [Fixnum] the initial VM protection
+		attr_reader :initprot
+
+		# @return [Fixnum] the number of sections in the segment
+		attr_reader :nsects
+
+		# @return [Fixnum] any flags associated with the segment
+		attr_reader :flags
 
 		@format = "VVa16QQQQVVVV"
 		@sizeof = 72
@@ -404,7 +463,17 @@ module MachO
 	# on filetype. Corresponds to LC_ID_DYLIB, LC_LOAD_DYLIB, LC_LOAD_WEAK_DYLIB,
 	# and LC_REEXPORT_DYLIB.
 	class DylibCommand < LoadCommand
-		attr_reader :name, :timestamp, :current_version, :compatibility_version
+		# @return [Fixnum] the library's path name (lc_str)
+		attr_reader :name
+
+		# @return [Fixnum] the library's build time stamp
+		attr_reader :timestamp
+
+		# @return [Fixnum] the library's current version number
+		attr_reader :current_version
+
+		# @return [Fixnum] the library's compatibility version number
+		attr_reader :compatibility_version
 
 		@format = "VVVVVV"
 		@sizeof = 24
@@ -424,6 +493,7 @@ module MachO
 	# on filetype. Corresponds to LC_ID_DYLINKER, LC_LOAD_DYLINKER, and
 	# LC_DYLD_ENVIRONMENT.
 	class DylinkerCommand < LoadCommand
+		# @return [Fixnum] the dynamic linker's path name (lc_str)
 		attr_reader :name
 
 		@format = "VVV"
@@ -439,7 +509,14 @@ module MachO
 	# A load command used to indicate dynamic libraries used in prebinding.
 	# Corresponds to LC_PREBOUND_DYLIB.
 	class PreboundDylibCommand < LoadCommand
-		attr_reader :name, :nmodules, :linked_modules
+		# @return [Fixnum] the library's path name (lc_str)
+		attr_reader :name
+
+		# @return [Fixnum] the number of modules in the library
+		attr_reader :nmodules
+
+		# @return [Fixnum] a bit vector of linked modules
+		attr_reader :linked_modules
 
 		@format = "VVVVV"
 		@sizeof = 20
@@ -463,8 +540,29 @@ module MachO
 	# initialization routine and an index into the module table for the module
 	# that defines the routine. Corresponds to LC_ROUTINES.
 	class RoutinesCommand < LoadCommand
-		attr_reader :init_address, :init_module, :reserved1, :reserved2
-		attr_reader :reserved3, :reserved4, :reserved5, :reserved6
+		# @return [Fixnum] the address of the initialization routine
+		attr_reader :init_address
+
+		# @return [Fixnum] the index into the module table that the init routine is defined in
+		attr_reader :init_module
+
+		# @return [void]
+		attr_reader :reserved1
+
+		# @return [void]
+		attr_reader :reserved2
+
+		# @return [void]
+		attr_reader :reserved3
+
+		# @return [void]
+		attr_reader :reserved4
+
+		# @return [void]
+		attr_reader :reserved5
+
+		# @return [void]
+		attr_reader :reserved6
 
 		@format = "VVVVVVVVVV"
 		@sizeof = 40
@@ -489,8 +587,29 @@ module MachO
 	# initialization routine and an index into the module table for the module
 	# that defines the routine. Corresponds to LC_ROUTINES_64.
 	class RoutinesCommand64 < LoadCommand
-		attr_reader :init_address, :init_module, :reserved1, :reserved2
-		attr_reader :reserved3, :reserved4, :reserved5, :reserved6
+		# @return [Fixnum] the address of the initialization routine
+		attr_reader :init_address
+
+		# @return [Fixnum] the index into the module table that the init routine is defined in
+		attr_reader :init_module
+
+		# @return [void]
+		attr_reader :reserved1
+
+		# @return [void]
+		attr_reader :reserved2
+
+		# @return [void]
+		attr_reader :reserved3
+
+		# @return [void]
+		attr_reader :reserved4
+
+		# @return [void]
+		attr_reader :reserved5
+
+		# @return [void]
+		attr_reader :reserved6
 
 		@format = "VVQQQQQQQQ"
 		@sizeof = 72
@@ -514,6 +633,7 @@ module MachO
 	# A load command signifying membership of a subframework containing the name
 	# of an umbrella framework. Corresponds to LC_SUB_FRAMEWORK.
 	class SubFrameworkCommand < LoadCommand
+		# @return [Fixnum] the umbrella framework name (lc_str)
 		attr_reader :umbrella
 
 		@format = "VVV"
@@ -529,6 +649,7 @@ module MachO
 	# A load command signifying membership of a subumbrella containing the name
 	# of an umbrella framework. Corresponds to LC_SUB_UMBRELLA.
 	class SubUmbrellaCommand < LoadCommand
+		# @return [Fixnum] the subumbrella framework name (lc_str)
 		attr_reader :sub_umbrella
 
 		@format = "VVV"
@@ -544,6 +665,7 @@ module MachO
 	# A load command signifying a sublibrary of a shared library. Corresponds
 	# to LC_SUB_LIBRARY.
 	class SubLibraryCommand < LoadCommand
+		# @return [Fixnum] the sublibrary name (lc_str)
 		attr_reader :sub_library
 
 		@format = "VVV"
@@ -559,6 +681,7 @@ module MachO
 	# A load command signifying a shared library that is a subframework of
 	# an umbrella framework. Corresponds to LC_SUB_CLIENT.
 	class SubClientCommand < LoadCommand
+		# @return [Fixnum] the subclient name (lc_str)
 		attr_reader :sub_client
 
 		@format = "VVV"
@@ -602,40 +725,58 @@ module MachO
 	# A load command containing symbolic information needed to support data
 	# structures used by the dynamic link editor. Corresponds to LC_DYSYMTAB.
 	class DysymtabCommand < LoadCommand
+		# @return [Fixnum] the index to local symbols
 		attr_reader :ilocalsym
 
+		# @return [Fixnum] the number of local symbols
 		attr_reader :nlocalsym
 
+		# @return [Fixnum] the index to externally defined symbols
 		attr_reader :iextdefsym
 
+		# @return [Fixnum] the number of externally defined symbols
 		attr_reader :nextdefsym
 
+		# @return [Fixnum] the index to undefined symbols
 		attr_reader :iundefsym
 
+		# @return [Fixnum] the number of undefined symbols
 		attr_reader :nundefsym
 
+		# @return [Fixnum] the file offset to the table of contents
 		attr_reader :tocoff
 
+		# @return [Fixnum] the number of entries in the table of contents
 		attr_reader :ntoc
 
+		# @return [Fixnum] the file offset to the module table
 		attr_reader :modtaboff
 
+		# @return [Fixnum] the number of entries in the module table
 		attr_reader :nmodtab
 
+		# @return [Fixnum] the file offset to the referenced symbol table
 		attr_reader :extrefsymoff
 
+		# @return [Fixnum] the number of entries in the referenced symbol table
 		attr_reader :nextrefsyms
 
+		# @return [Fixnum] the file offset to the indirect symbol table
 		attr_reader :indirectsymoff
 
+		# @return [Fixnum] the number of entries in the indirect symbol table
 		attr_reader :nindirectsyms
 
+		# @return [Fixnum] the file offset to the external relocation entries
 		attr_reader :extreloff
 
+		# @return [Fixnum] the number of external relocation entries
 		attr_reader :nextrel
 
+		# @return [Fixnum] the file offset to the local relocation entries
 		attr_reader :locreloff
 
+		# @return [Fixnum] the number of local relocation entries
 		attr_reader :nlocrel
 
 
@@ -710,6 +851,7 @@ module MachO
 	# be added to the current run path used to find @rpath prefixed dylibs.
 	# Corresponds to LC_RPATH.
 	class RpathCommand < LoadCommand
+		# @return [Fixnum] the oath to add to the run path (lc_str)
 		attr_reader :path
 
 		@format = "VVV"
@@ -813,15 +955,63 @@ module MachO
 			@version = version
 			@sdk = sdk
 		end
+
+		# A string representation of the binary's minimum OS version.
+		# @return [String] a string representing the minimum OS version.
+		def version_string
+			binary = "%032b" % version
+			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
 	end
 
 	# A load command containing the file offsets and sizes of the new
 	# compressed form of the information dyld needs to load the image.
 	# Corresponds to LC_DYLD_INFO and LC_DYLD_INFO_ONLY.
 	class DyldInfoCommand < LoadCommand
-		attr_reader :rebase_off, :rebase_size, :bind_off, :bind_size
-		attr_reader :weak_bind_off, :weak_bind_size, :lazy_bind_off
-		attr_reader :lazy_bind_size, :export_off, :export_size
+		# @return [Fixnum] the file offset to the rebase information
+		attr_reader :rebase_off
+
+		# @return [Fixnum] the size of the rebase information
+		attr_reader :rebase_size
+
+		# @return [Fixnum] the file offset to the binding information
+		attr_reader :bind_off
+
+		# @return [Fixnum] the size of the binding information
+		attr_reader :bind_size
+
+		# @return [Fixnum] the file offset to the weak binding information
+		attr_reader :weak_bind_off
+
+		# @return [Fixnum] the size of the weak binding information
+		attr_reader :weak_bind_size
+
+		# @return [Fixnum] the file offset to the lazy binding information
+		attr_reader :lazy_bind_off
+
+		# @return [Fixnum] the size of the lazy binding information
+		attr_reader :lazy_bind_size
+
+		# @return [Fixnum] the file offset to the export information
+		attr_reader :export_off
+
+		# @return [Fixnum] the size of the export information
+		attr_reader :export_size
 
 		@format = "VVVVVVVVVVVV"
 		@sizeof = 48
@@ -893,5 +1083,17 @@ module MachO
 			super(offset, cmd, cmdsize)
 			@version = version
 		end
+
+		# A string representation of the sources used to build the binary.
+		# @return [String] a string representation of the version
+		def version_string
+			binary = "%064b" % version
+			segs = [
+				binary[0..23], binary[24..33], binary[34..43], binary[44..53],
+				binary[54..63]
+			].map { |s| s.to_i(2) }
+
+			segs.join(".")
+		end
 	end
 end

data/lib/macho/structure.rb

@@ -1,5 +1,6 @@
 module MachO
-	# A general purpose pseudo-structure. 
+	# A general purpose pseudo-structure.
+	# @abstract
 	class MachOStructure
 		# Subclasses should fill these in manually.
 		@format = ""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-macho
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies: []
 description: A library for viewing and manipulating Mach-O files in Ruby.
 email: william@tuffbizz.com