dsym_uuid_extractor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 414325b5c26358f6ea5948f1fd5c5e24fef16038
+  data.tar.gz: cbc44da0cda1c5acbdcd303d0da72e8c8329ac56
+SHA512:
+  metadata.gz: bbfe84993a42b3809dbb62528a83cec3b9eda1fc1ba1a11111e2aa0e9474b4b204052dfafb36233ae5b1e841b4ad822c80e0906dd332254bb9faf7bb1c210d38
+  data.tar.gz: 706cf7cfda811dd7b24ec23d7c34e7762d3e4c58181dd760d96bf68a391cee7c0baa87d1a3d99cbc87c527546ff861efb91f7d874b1daa7a71f46b02d141e075

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Marwan Tanager
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# dsym_uuid_extractor
+
+This gem provides a ruby module to extract UUID/architecture info from a dSYM
+file generated by Apple's Xcode or a similar environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dsym_uuid_extractor'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+DsymUuidExtractor.run(dsym_file_path)
+=> {'4383705b-72ab-4b89-815e-dae35cce2e52'=>'arm64','048c3790-07fb-428d-a330-91fe1d30d2c1'=>'armv7s'}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dsym_uuid_extractor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dsym_uuid_extractor.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dsym_uuid_extractor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dsym_uuid_extractor"
+  spec.version       = DsymUuidExtractor::VERSION
+  spec.authors       = ["Marwan Tanager"]
+  spec.email         = ["marwan.tanager@gmail.com"]
+
+  spec.summary       = "dSYM UUID/arch extractor"
+  spec.description   = "Extract UUIDs/architecture information from a standard dSYM file"
+  spec.homepage      = "https://github.com/Instabug/dsym_uuid_extractor"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "ffi", "~> 1.9", ">= 1.9.10"
+end

data/lib/dsym_uuid_extractor.rb

@@ -0,0 +1,21 @@
+require 'dsym_uuid_extractor/version'
+require 'dsym_uuid_extractor/macho_reader'
+
+module DsymUuidExtractor
+  def self.run(file_path)
+    results = {}
+
+    reader = if MachOBinaryReader.is_binary_file?(file_path)
+               MachOBinaryReader.new(file_path: file_path)
+             else
+               MachOFileReader.new(file_path: file_path)
+             end
+
+    reader.each_file do |file|
+      file.extract_info
+      results[file.uuid] = file.arch
+    end
+
+    results
+  end
+end

data/lib/dsym_uuid_extractor/macho_reader.rb

@@ -0,0 +1,265 @@
+require 'ffi'
+
+module DsymUuidExtractor
+  # Based on the details found in https://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/MachORuntime/index.html
+
+  class MachOReader
+    # Constants
+    ## CPU Types
+    CPU_ARCH_ABI64  = 0x01000000
+    CPU_TYPE_I386   = 7
+    CPU_TYPE_X86_64 = CPU_TYPE_I386 | CPU_ARCH_ABI64
+    CPU_TYPE_ARM    = 12
+    CPU_TYPE_ARM64  = CPU_TYPE_ARM | CPU_ARCH_ABI64
+    ## CPU Subtypes
+    CPU_SUBTYPE_ARM_V7  = 9
+    CPU_SUBTYPE_ARM_V7S = 11
+
+    # Readers
+    attr_reader :file
+
+    # Methods
+    def initialize(opts = {})
+      @file = File.open(opts[:file_path], mode: 'rb')
+
+      @file.seek(opts[:seek_to_pos]) if opts[:seek_to_pos]
+    end
+
+    def read_struct(struct_class, opts = {})
+      struct_size = struct_class.size
+      buffer      = FFI::Buffer.new(:char, struct_size)
+      buffer      = buffer.order(opts[:byte_order]) if opts[:byte_order]
+
+      buffer.put_bytes(0, @file.read(struct_size))
+
+      struct_class.new(buffer)
+    end
+
+    class EmptySymbolicationFile < StandardError; end
+    class MachOReaderError < StandardError; end
+    class UnkownCpuSubtype < MachOReaderError; end
+    class UnkownCpuType < MachOReaderError; end
+    class ArchIsNil < MachOReaderError; end
+  end
+
+  class MachOBinaryReader < MachOReader
+    ## Magic Numbers
+    FAT_MAGIC = 0xcafebabe
+    FAT_CIGAM = 0xbebafeca
+    # Struct Classes
+    class FatHeader < FFI::Struct
+      layout magic:     :uint32,
+             nfat_arch: :uint32
+    end
+
+    class FatArch < FFI::Struct
+      layout cputype:    :int32,
+             cpusubtype: :int32,
+             offset:     :uint32,
+             size:       :uint32,
+             align:      :uint32
+    end
+
+    # Methods
+    def self.is_binary_file?(file_path)
+      fail EmptySymbolicationFile if File.zero?(file_path)
+
+      File.read(file_path, 4).unpack('L>')[0] == FAT_MAGIC ||
+        File.read(file_path, 4).unpack('L<')[0] == FAT_CIGAM
+      rescue EmptySymbolicationFile
+        # To be logged in CloudWatch...
+        false
+    end
+
+    def each_file
+      arch_count = fat_header[:nfat_arch]
+
+      seek_to_fat_arch
+      arch_offsets = arch_count.times.map do
+        fat_arch = read_struct(FatArch)
+
+        fat_arch[:offset]
+      end
+
+      arch_offsets.each do |arch_offset|
+        yield MachOFileReader.new(file_path: File.absolute_path(file.path), seek_to_pos: arch_offset)
+      end
+    end
+
+    def read_struct(struct_class, opts = {})
+      super(struct_class, opts.merge(byte_order: :big))
+    end
+
+    private
+
+    def fat_header
+      return @fat_header if @fat_header
+
+      seek_to_file_beginning
+      @fat_header = read_struct(FatHeader)
+    end
+
+    def seek_to_fat_arch
+      seek_to_file_beginning
+      file.seek(FatHeader.size, IO::SEEK_CUR)
+    end
+
+    def seek_to_file_beginning
+      file.seek(0)
+    end
+  end
+
+  class MachOFileReader < MachOReader
+    # Constants
+    ## Load Commands
+    LC_UUID = 0x1b
+    ## Magic Numbers
+    MH_MAGIC    = 0xfeedface
+    MH_CIGAM    = 0xcefaedfe
+    MH_MAGIC_64 = 0xfeedfacf
+    MH_CIGAM_64 = 0xcffaedfe
+    ## Byte Order
+    BYTE_ORDER         = FFI::MemoryPointer.new(:char).order
+    BYTE_ORDER_INVERSE = BYTE_ORDER == :little ? :big : :little
+
+    # Struct Classes
+    class MachHeader < FFI::Struct
+      layout magic:      :uint32,
+             cputype:    :int32,
+             cpusubtype: :int32,
+             filetype:   :uint32,
+             ncmds:      :uint32,
+             sizeofcmds: :uint32,
+             flags:      :uint32
+    end
+
+    class MachHeader64 < FFI::Struct
+      layout magic:      :uint32,
+             cputype:    :int32,
+             cpusubtype: :int32,
+             filetype:   :uint32,
+             ncmds:      :uint32,
+             sizeofcmds: :uint32,
+             flags:      :uint32,
+             reserved:   :uint32
+    end
+
+    class LoadCommand < FFI::Struct
+      layout cmd:     :uint32,
+             cmdsize: :uint32
+    end
+
+    class UuidCommand < FFI::Struct
+      layout cmd:     :uint32,
+             cmdsize: :uint32,
+             uuid:    [:uint8, 16]
+    end
+
+    # Readers
+    attr_reader :arch, :uuid, :is_64_arch
+
+    # Methods
+    def self.is_macho_file?(file_path)
+      magic_number = new(file_path: file_path).magic_number
+
+      [MH_MAGIC, MH_MAGIC_64, MH_CIGAM, MH_CIGAM_64].include?(magic_number)
+    end
+
+    def initialize(opts = {})
+      super(opts)
+
+      @file_beginning_pos = file.pos
+    end
+
+    def magic_number
+      mach_header[:magic]
+    end
+
+    def extract_info
+      extract_arch
+      extract_uuid
+    end
+
+    def each_file
+      yield self
+    end
+
+    private
+
+    def mach_header
+      return @mach_header if @mach_header
+
+      seek_to_file_beginning
+      @mach_header = read_struct(MachHeader)
+    end
+
+    def extract_arch
+      @arch = case mach_header[:cputype]
+              when CPU_TYPE_I386
+                'i386'
+              when CPU_TYPE_X86_64
+                'x86_64'
+              when CPU_TYPE_ARM64
+                'arm64'
+              when CPU_TYPE_ARM
+                case mach_header[:cpusubtype]
+                when CPU_SUBTYPE_ARM_V7
+                  'armv7'
+                when CPU_SUBTYPE_ARM_V7S
+                  'armv7s'
+                else
+                  fail MachOReader::UnkownCpuSubtype, "Extracting arch failed; unknown cpusubtype '#{mach_header[:cputype]}'"
+                end
+              else
+                fail MachOReader::UnkownCpuType, "Extracting arch failed; unknown cputype '#{mach_header[:cputype]}'"
+              end
+
+      @is_64_arch = (mach_header[:cputype] & CPU_ARCH_ABI64 != 0)
+    end
+
+    def extract_uuid
+      seek_to_load_commands
+
+      mach_header[:ncmds].times do
+        load_command = read_struct(LoadCommand, byte_order: byte_order)
+
+        file.seek(-LoadCommand.size, IO::SEEK_CUR)
+
+        if load_command[:cmd] == LC_UUID
+          uuid_command = read_struct(UuidCommand, byte_order: byte_order)
+
+          # Copied from securerandom stdlib
+          uuid_unpacked = uuid_command[:uuid].to_a.pack('C' * 16).unpack('NnnnnN')
+          @uuid         = (format('%08x-%04x-%04x-%04x-%04x%08x', *uuid_unpacked)).upcase
+
+          break
+        else
+          file.seek(load_command[:cmdsize], IO::SEEK_CUR)
+        end
+      end
+    end
+
+    def seek_to_file_beginning
+      file.seek(@file_beginning_pos)
+    end
+
+    def seek_to_load_commands
+      fail MachOReader::ArchIsNil, '@arch is nil; call #extract_arch first' if @arch.nil?
+
+      header_struct = is_64_arch ? MachHeader64 : MachHeader
+
+      seek_to_file_beginning
+      file.seek(header_struct.size, IO::SEEK_CUR)
+
+      true
+    end
+
+    def byte_order
+      @byte_order ||= if is_64_arch
+                        mach_header[:magic] == MH_MAGIC_64 ? BYTE_ORDER : BYTE_ORDER_INVERSE
+                      else
+                        mach_header[:magic] == MH_MAGIC ? BYTE_ORDER : BYTE_ORDER_INVERSE
+                      end
+    end
+  end
+end

data/lib/dsym_uuid_extractor/version.rb

@@ -0,0 +1,3 @@
+module DsymUuidExtractor
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dsym_uuid_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marwan Tanager
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.10
+description: Extract UUIDs/architecture information from a standard dSYM file
+email:
+- marwan.tanager@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dsym_uuid_extractor.gemspec
+- lib/dsym_uuid_extractor.rb
+- lib/dsym_uuid_extractor/macho_reader.rb
+- lib/dsym_uuid_extractor/version.rb
+homepage: https://github.com/Instabug/dsym_uuid_extractor
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: dSYM UUID/arch extractor
+test_files: []