mootool 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3b78029772e10d48f7e6c2937c241ff0783f03be555234cd77c5b72cbf10eb
-  data.tar.gz: d1303b8e5bfdf05bb7a10c86d161fb5ffafa237586f25137e556a35f49b8ec75
+  metadata.gz: 4cfbbe3c322b64f68aa32ecfd9373b4158cabb53cec3c6ba392f6c8e1d9a7761
+  data.tar.gz: 9ec26119e06df11ccae1aa7eb28796db2d8a6b3af889ba20882ca22847274bff
 SHA512:
-  metadata.gz: ae85a488ccf2023d087ae7fc3a6f63b09f3cff51a14555f0e49742e5556b33e898dbafd377ec481a42a23801eb4987155aad924e7e461b5578fff4efc215a35d
-  data.tar.gz: bed2644636530b161772dc0fa430845fbebfcf057b1bdb47aa0b898129def0eeef0b0434bbea3922de9b88bf8b44d02cc8dd874f8329f7b976d03691c3e1bb84
+  metadata.gz: eeed0e6c5d966626700309b618f517169b14d643e76ba9af7f48d66e1c6fae173129011e81f425c9eb209d312f0007ce03be2978520df4d8ebbf1eef585d437a
+  data.tar.gz: 7501f0bd4de48f2decc42d5c62ebdcaedf3a9e1720c72a316060eb02a3943032f87120927ac3bebd3b3e068691e3ed42c27b833884141ffbb2ec6a3fdad30046

data/.github/workflows/ci.yml

@@ -16,8 +16,9 @@ on:
 jobs:
   test:
 
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby-version: [ '3.0', '3.1.2', '3.2.0-preview1' ]
 
@@ -27,7 +28,7 @@ jobs:
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):
         # uses: ruby/setup-ruby@v1
-        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/Gemfile.lock

@@ -1,8 +1,11 @@
 PATH
   remote: .
   specs:
-    mootool (0.2.2)
+    mootool (0.2.5)
+      lzfse
+      lzss
       plist (~> 3)
+      ruby-lzma
       ruby-macho (~> 3)
       rubyzip (~> 2)
       sorbet-runtime (~> 0)
@@ -17,6 +20,8 @@ GEM
     docile (1.4.0)
     iniparse (1.5.0)
     json (2.6.2)
+    lzfse (0.0.1)
+    lzss (0.1)
     method_source (1.0.0)
     netrc (0.11.0)
     overcommit (0.59.1)
@@ -68,6 +73,7 @@ GEM
       rubocop (~> 1.0)
     rubocop-rspec (2.12.1)
       rubocop (~> 1.31)
+    ruby-lzma (0.4.3)
     ruby-macho (3.0.0)
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
@@ -90,7 +96,7 @@ GEM
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    tapioca (0.9.3)
+    tapioca (0.9.4)
       bundler (>= 1.17.3)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)

data/lib/mootool/models/decompressor.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'lzfse'
+require 'lzma'
+require 'compress/lzss'
+
+module MooTool
+  # The magic Apple decompressor (as in it uses magics)
+  class Decompressor
+    COMPRESSION_LZSS = 'lzss'
+    COMPRESSION_LZVN = 'lzvn'
+    COMPRESSION_LZFSE = 'bvx2'
+    COMPRESSION_LZMA = 'lzma'
+
+    attr_reader :value
+
+    def initialize(data)
+      @value = case data[0..3]
+               when COMPRESSION_LZFSE
+                 LZFSE.lzfse_decompress(data)
+               when COMPRESSION_LZVN
+                 LZFSE.lzvn_decompress(data)
+               when COMPRESSION_LZSS
+                 Compress::LZSS.decompress(data)
+               when COMPRESSION_LZMA
+                 LZMA.decompress(data)
+               else
+                 data
+               end
+    end
+  end
+end

data/lib/mootool/models/device_tree.rb

@@ -4,82 +4,114 @@
 require 'sorbet-runtime'
 
 module MooTool
-  module Models
-    # DeviceTree is a Apple Device Tree node that has been parsed
-    class DeviceTree
-      extend T::Sig
+  # DeviceTree is a Apple Device Tree node that has been parsed
+  class DeviceTree
+    extend T::Sig
+
+    NODE_FORMAT = 'VV'
+    PROP_FORMAT = 'A32V'
 
-      NODE_FORMAT = 'VV'
-      PROP_FORMAT = 'A32V'
+    PHANDLE_PROP = 'AAPL,phandle'
+    COMPATIBLE_PROP = 'compatible'
 
-      # Represents a single node in the device tree
-      class Node
-        extend T::Sig
+    # Represents a single node in the device tree
+    class Node
+      extend T::Sig
 
-        attr_reader :children, :properties
+      attr_reader :children, :properties
 
-        sig { params(data: T.any(IO, StringIO)).void }
-        def initialize(data)
-          vals = T.must(data.read(8)).unpack(NODE_FORMAT)
-          property_count = T.cast(vals[0], Integer)
-          child_count = T.cast(vals[1], Integer)
+      sig { params(tree: DeviceTree, data: T.any(IO, StringIO)).void }
+      def initialize(tree, data)
+        @tree = tree
+        vals = T.must(data.read(8)).unpack(NODE_FORMAT)
+        property_count = T.cast(vals[0], Integer)
+        child_count = T.cast(vals[1], Integer)
 
-          @properties = T.let({}, T::Hash[String, Property])
-          @children = T.let([], T::Array[Node])
+        @properties = T.let({}, T::Hash[String, Property])
+        @children = T.let([], T::Array[Node])
 
-          property_count.times do
-            prop = Property.new(data)
-            @properties[prop.name] = prop
-          end
-          child_count.times { @children << Node.new(data) }
+        property_count.times do
+          prop = Property.new(data)
+          @properties[prop.name] = prop
         end
+        child_count.times { @children << Node.new(tree, data) }
+
+        @tree.add_handle(self, @properties[PHANDLE_PROP].value) if @properties.key? PHANDLE_PROP
       end
 
-      # Represents a single property and it's value
-      class Property
-        extend T::Sig
+      def to_h
+        props = @properties.transform_values(&:value)
+        if @children.any?
+          props.merge({ children: @children.map(&:to_h) })
+        else
+          props
+        end
+      end
+    end
 
-        attr_accessor :name, :value
+    # Represents a single property and it's value
+    class Property
+      extend T::Sig
 
-        sig { params(data: T.any(StringIO, IO)).void }
-        def initialize(data)
-          args = T.must(data.read(36)).unpack(PROP_FORMAT)
+      attr_accessor :name, :value
 
-          @name = T.let(T.cast(args[0], String), String)
-          @size = T.let(T.cast(args[1], Integer), Integer)
+      sig { params(data: T.any(StringIO, IO)).void }
+      def initialize(data)
+        args = T.must(data.read(36)).unpack(PROP_FORMAT)
 
-          if @size & 0x80000000 != 0
-            @template = true
-            @size &= 0x7fffffff
-          end
+        @name = T.let(T.cast(args[0], String), String)
+        @size = T.let(T.cast(args[1], Integer), Integer)
 
-          @value = data.read(@size.align(4))
-          @value = T.must(@value)[0..@size]
+        if @size & 0x80000000 != 0
+          @template = true
+          @size &= 0x7fffffff
         end
+
+        @value = T.must(data.read(@size.align(4)))[0..(@size - 1)]
+
+        normalize
       end
 
-      attr_reader :root
+      private
 
-      # @param [String] data
-      sig { params(data: T.any(IO, String, StringIO, Pathname)).void }
-      def initialize(data)
-        case data
-        when Pathname
-          data = T.assert_type!(data, Pathname)
-          @data = File.open(data.realpath, 'rb')
-        when String
-          data = T.assert_type!(data, String)
-          @data = StringIO.new(data)
-        when IO
-          @data = T.cast(data, IO)
-        end
-        @root = Node.new(@data)
+      def normalize
+        @value = @value.split("\x00").map(&:chomp) if @name == COMPATIBLE_PROP
+        @value = @value.unpack1('V') if @size == 4
+
+        @value = @value.chomp("\x00") if @value.is_a?(String) && @value.count("\x00") == 1 && @value.end_with?("\x00")
       end
+    end
 
-      sig { params(path: String).returns(DeviceTree) }
-      def self.open(path)
-        DeviceTree.new(Pathname.new(path))
+    attr_reader :root
+
+    # @param [String] data
+    sig { params(data: T.any(IO, String, StringIO, Pathname)).void }
+    def initialize(data)
+      @handles = {}
+      case data
+      when Pathname
+        data = T.assert_type!(data, Pathname)
+        @data = File.open(data.realpath, 'rb')
+      when String
+        data = T.assert_type!(data, String)
+        @data = StringIO.new(data)
+      when IO
+        @data = T.cast(data, IO)
       end
+      @root = Node.new(self, @data)
+    end
+
+    def add_handle(node, handle)
+      @handles[handle] = node
+    end
+
+    sig { params(path: String).returns(DeviceTree) }
+    def self.open(path)
+      MooTool::DeviceTree.new(Pathname.new(path))
+    end
+
+    def to_h
+      @root.to_h
     end
   end
 end

data/lib/mootool/models/img4.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openssl'
+require_relative 'decompressor'
 
 module MooTool
   # Module for Apple's IMG4 encryption and signing format
@@ -18,12 +19,14 @@ module MooTool
         when 'IM4P'
           @type = @data.value[1].value
           @build = @data.value[2].value
-          @payload = @data.value[3].value
+          @payload = MooTool::Decompressor.new(@data.value[3].value).value
         when 'IMG4', 'IM4M'
           raise 'Not implemented'
         else
           raise "Unknown IMG4 type #{@data.first.value}"
         end
+
+        @manifest = Manifest.new(@payload) if @payload.start_with?('IM4M')
       end
 
       def payload?

data/lib/mootool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MooTool
-  VERSION = '0.2.2'
+  VERSION = '0.2.5'
 end

data/mootool.gemspec

@@ -37,7 +37,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'lzfse'
+  spec.add_runtime_dependency 'lzss'
   spec.add_runtime_dependency 'plist', '~> 3'
+  spec.add_runtime_dependency 'ruby-lzma'
   spec.add_runtime_dependency 'ruby-macho', '~> 3'
   spec.add_runtime_dependency 'rubyzip', '~> 2'
   spec.add_runtime_dependency 'sorbet-runtime', '~> 0'

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mootool
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Rick Mark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lzfse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lzss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: plist
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: ruby-lzma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-macho
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +146,7 @@ files:
 - lib/mootool/controllers/kernel_collection.rb
 - lib/mootool/controllers/sections.rb
 - lib/mootool/core_extensions.rb
+- lib/mootool/models/decompressor.rb
 - lib/mootool/models/device_tree.rb
 - lib/mootool/models/img4.rb
 - lib/mootool/models/ipsw.rb