apple-data 1.0.629 → 1.0.648

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ccec50a6440b05805fb2139a50c19abcfa15433b0f33c93a0564b934446fb9c
-  data.tar.gz: 062551007e74d609abe1c4858040a25f63656345256ddf2eefce434fee62fafa
+  metadata.gz: 19a3c341473409d4f8e885c8427472fcb6e72a77f292809452bbf57d85af8474
+  data.tar.gz: 841dc17dc91072db9a0125c443a17863d792d797bb1a12051032dea41f0f50d4
 SHA512:
-  metadata.gz: e52bb4d0d08328bb56a946cffa4f597f765610e20b7adad4f8f1db8721f843c7a528c724da39abadba7634cb6f97af2d0ae2543aadf42db403e2b410f48b4f2f
-  data.tar.gz: ff8cd17c5f061a4c5078a3db242b5871873e89c88f6c02428c5940e3616e94c09ecf765a98a4bd47cd16b8752eab4f0e7a50b1832cb828edf9d0b55b63b27e5f
+  metadata.gz: b183b04256fb399f0d562610208f2580aebb1213289e9e6fc179a690571e8e3755bd4d41100ba56429fea8eaca9746485e628dddd8dbd9d739b73367b9fc674f
+  data.tar.gz: 90795551ee0e7af5a609b3dc39dcbf59c015030445d95e92ec8543f2ce68b76612ca9425fed563275bb9a3304829b673370c109328a560bcd800953f92de80a7

data/lib/apple_data/data_file.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
+require 'active_support/all'
+require 'jsonpath'
+
 module AppleData
   # Base class for all data files
   class DataFile
-    extend T::Sig
     attr_reader :data
 
-    sig { params(parts: String).void }
     def initialize(*parts)
       @parts = parts
       @collections = {}
-      T.unsafe(self).load_file(*parts)
+      load_file(*parts)
       ensure_metadata
     end
 
-    sig { params(path: String).returns(DataFile) }
     def self.from_path(path)
       instance = DataFile.allocate
       instance.instance_eval do
@@ -26,50 +26,98 @@ module AppleData
       instance
     end
 
-    sig { params(parts: String).returns(T::Hash[T.untyped, T.untyped]) }
     def load_file(*parts)
       parts[-1] = "#{parts[-1]}.yaml" unless T.must(parts[-1]).end_with? '.yaml'
       @filename = File.join(AppleData.data_location, T.unsafe(File).join(*parts))
       @data = {}
       @data = YAML.load_file @filename if File.exist? @filename
-      @data
+      @data.with_indifferent_access
     end
 
     def save!
       save_data data
     end
 
-    def save
-      save!
-    end
-
     def collection(name)
       @collections[name.to_s] ||= DataFileCollection.new(self, name)
     end
 
+    def collections
+      collection_list = @data['metadata']['collections'] ||= []
+      collection_list.map { |name| collection(name) }
+    end
+
     def sort!
-      @collections.each_value(&:sort)
+      collections.each(&:sort!)
+      return unless sort_paths
+
+      sort_paths.each do |path|
+        JsonPath.for(@data).gsub!(path) do |item|
+          case item
+          when Array
+            item.sort
+          when Hash
+            item.sort_by { |key, _value| key }.to_h
+          else
+            item
+          end
+        end
+      end
     end
 
     def auto_sort?
-      if @data['metadata']['auto_sort'].nil?
-        true
-      else
-        @data['metadata']['auto_sort']
-      end
+      value = metadata['auto_sort']
+      value = true if value.nil?
+      value
+    end
+
+    def metadata
+      @data['metadata'] ||= {}
+    end
+
+    def sort_paths
+      metadata['sort_paths']
     end
 
     private
 
     def save_data(data)
+      @collections.each do |name, collection|
+        @data[name] = collection.data
+      end
+
       File.write(@filename, data.to_yaml)
     end
 
     def ensure_metadata
       @data['metadata'] ||= {}
       @data['metadata'].reverse_merge!({ 'description' => nil, 'credits' => [] })
-      (@data['metadata']['collections'] || []).each do |name|
-        collection(name)
+      collections = @data['metadata']['collections'] ||= []
+      collections.each do |name|
+        collection name
+      end
+    end
+
+    # A specific "collection" inside a data file.  Collections are enumerable groups of one type of item.
+    # The schema of each item is the same within a collection.
+    class DataFileCollection
+      def initialize(data_file, collection_name)
+        @data_file = data_file
+        @collection_name = collection_name
+        @collection_data = @data_file.data[@collection_name]
+      end
+
+      def data
+        @collection_data
+      end
+
+      def sort!
+        case @collection_data
+        when Array
+          @collection_data.sort
+        when Hash
+          @collection_data = @collection_data.sort_by { |key, _value| key }.to_h
+        end
       end
     end
   end

data/lib/apple_data/factory_data_reset.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+module AppleData
+  # Factory Device Restore
+  class FactoryDataReset < AppleData::DataFile
+    def initialize
+      super('fdr.yaml')
+
+      @data ||= {} # : data
+
+      @data['properties'] = [] # : [property]
+    end
+
+    def ensure_property(prop)
+      prop_instance = @data['properties'].find { |p| p['name'] == prop }
+      unless prop_instance
+        prop_instance = {} # : property
+        prop_instance['name'] = prop
+        prop_instance['description'] = nil
+        @data['properties'] << prop_instance
+      end
+      prop_instance
+    end
+
+    def data
+      @data['properties'].sort_by! { |prop| prop['name'] }
+
+      @data
+    end
+  end
+end

data/lib/apple_data/io_reg.rb

@@ -0,0 +1,60 @@
+# typed: true
+# frozen_string_literal: true
+
+module AppleData
+  # Data file for the IOReg data
+  class IOReg < AppleData::DataFile
+    def initialize
+      super('ioreg.yaml')
+
+      @classes = [] # : [IORegClass]
+      @instances ||= {} # : {string => IORegClass}
+
+      @data['classes'].each do |single_class|
+        @classes << IORegClass.load_one(single_class)
+      end
+    end
+
+    def data
+      @data = {}
+      @data['classes'] = @classes.map(&:to_h)
+    end
+
+    # A single IOKit class
+    class IORegClass
+      attr_accessor :description, :name, :parents, :known_names
+
+      def initialize(klass_name)
+        @name = klass_name
+        @parents = [] # : [string]
+      end
+
+      def self.for_name(name)
+        @instances[name] = IORegClass.new name unless @instances.key? name
+
+        @instances[name]
+      end
+
+      def self.values
+        @instances.values.sort_by(&:name)
+      end
+
+      def self.load_one(hash)
+        instance = IORegClass.for_name hash['name']
+        instance.description = hash['description']
+        instance.parents = hash['parents'] || []
+        instance.known_names = hash['known_names'] || []
+        instance.known_names.sort!
+        instance
+      end
+
+      def to_h
+        { 'name' => @name, 'description' => @description, 'parents' => @parents, 'known_names' => @known_names }
+      end
+
+      def user_client?
+        @parents.include? 'IOUserClient'
+      end
+    end
+  end
+end

data/lib/apple_data/ipsw.rb

@@ -3,23 +3,25 @@
 require 'zip'
 require 'cfpropertylist'
 
-# Represents an IPSW on disk and provides helper access
-class IPSW
-  def initialize(path)
-    @path = path
-    @zip = Zip::File.open(@path)
-    @manifest = CFPropertyList.guess(@zip.get_entry('BuildManifest.plist').get_input_stream.read)
-  end
+module AppleData
+  # Represents an IPSW on disk and provides helper access
+  class IPSW
+    def initialize(path)
+      @path = path
+      @zip = Zip::File.open(@path)
+      @manifest = CFPropertyList.guess(@zip.get_entry('BuildManifest.plist').get_input_stream.read)
+    end
 
-  def baseband_files
-    result = []
-    @manifest['BuildIdentities'].each do |identity|
-      identity['Manifest'].each do |key, value|
-        result << value if key == 'BasebandFirmware'
+    def baseband_files
+      result = []
+      @manifest['BuildIdentities'].each do |identity|
+        identity['Manifest'].each do |key, value|
+          result << value if key == 'BasebandFirmware'
+        end
       end
+      result
     end
-    result
-  end
 
-  def img4_files; end
+    def img4_files; end
+  end
 end

data/lib/apple_data/keybag.rb

@@ -2,27 +2,22 @@
 
 module AppleData
   # Represents a GID grouping of encrypted and decrypted keybags
-  class GIDKeyBag < DataFile
+  class Keybag < DataFile
     @keybags = {}
-    cattr_reader :keybags
 
-    class << self
-      def new(chip_id)
-        self.[](chip_id)
-      end
+    attr_reader :keybags
 
-      def save_all
-        @keybags.each_value(&:save)
-      end
+    def self.save_all
+      @keybags.each_value(&:save)
+    end
 
-      def [](chip_id)
-        chip_id = chip_id.to_i
-        return @keybags[chip_id] if @keybags.key? chip_id
+    def self.[](chip_id)
+      chip_id = chip_id.to_i
+      return @keybags[chip_id] if @keybags.key? chip_id
 
-        instance = allocate
-        instance.send(:initialize, chip_id)
-        @keybags[chip_id] = instance
-      end
+      instance = allocate
+      instance.send(:initialize, chip_id)
+      @keybags[chip_id] = instance
     end
 
     def initialize(chip_id)
@@ -31,7 +26,8 @@ module AppleData
 
     def get_board(board_id)
       board_id = board_id.to_i
-      BoardKeyBag.new self, board_id, collection(:keybag_boards).ensure_key(board_id, description: false)
+      boards = collection(:keybag_boards)
+      BoardKeyBag.new self, board_id, boards.ensure_key(board_id, description: false)
     end
 
     # A keybag of builds for a particular build
@@ -45,7 +41,7 @@ module AppleData
       def merge_keydb_build(build_id, build)
         return unless build['keybags']
 
-        @board[build_id] ||= {}
+        @board[build_id] ||= {} # : build
         @board[build_id]['components'] ||= {}
         @board[build_id]['components'].reverse_merge! build['keybags']
       end

data/lib/apple_data/lockdown.rb

@@ -3,10 +3,11 @@
 
 module AppleData
   # Schema file for the `lockdownd.yaml` file
-  class LockdownData < AppleData::DataFile
+  class Lockdown < AppleData::DataFile
     def initialize
       super('lockdownd.yaml')
-      @data ||= {}
+      @data ||= {} # : data
+
       @data['clients'] ||= []
       @data['domains'] ||= []
     end
@@ -15,19 +16,10 @@ module AppleData
       @data['clients'] << client unless @data['clients'].include? client
     end
 
-    def ensure_domain_has_property(domain, property, _type = nil)
-      domain_instance = get_domain domain
-
-      return unless property
-
-      domain_instance['properties'] << property unless domain_instance['properties'].include? property
-    end
-
     def get_domain(domain)
       result = @data['domains'].find { |d| d['name'] == domain }
       unless result
-        result = {}
-        result['name'] = domain
+        result = { 'name' => domain } # : domain
         @data['domains'] << result
       end
       result['description'] ||= nil
@@ -35,6 +27,14 @@ module AppleData
       result
     end
 
+    def ensure_domain_has_property(domain, property, _type = nil)
+      domain_instance = get_domain domain
+
+      return unless property
+
+      domain_instance['properties'] << property unless domain_instance['properties'].include? property
+    end
+
     def data
       @data['clients'].sort!
 

data/lib/apple_data/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppleData
-  VERSION = '1.0.629'
+  VERSION = '1.0.648'
 end

data/lib/apple_data.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-DEFAULT_APPLE_DATA_SHARE = T.let(File.join(File.dirname(__FILE__), '../share/'), String)
-
 # Base Namespace for AppleData gem
 module AppleData
+  DEFAULT_APPLE_DATA_SHARE = File.join(File.dirname(__FILE__), '../share/')
+
   def get_data(file)
     YAML.load_file(File.join(@apple_data, file))
   end
@@ -13,14 +13,12 @@ module AppleData
   end
 
   def self.data_location
-    @apple_data || DEFAULT_APPLE_DATA_SHARE
+    @apple_data || AppleData::DEFAULT_APPLE_DATA_SHARE
   end
 end
 
 require 'apple_data/data_file'
-require 'apple_data/boot_args'
-require 'apple_data/fdr'
-require 'apple_data/ioreg'
-require 'apple_data/macho'
+require 'apple_data/factory_data_reset'
+require 'apple_data/io_reg'
 require 'apple_data/lockdown'
 require 'apple_data/keybag'

data/share/apns.yaml

@@ -2,6 +2,10 @@
 metadata:
   description:
   credits:
+  collections:
+  - apns_commands
+  - topics
+  - apns_environments
 apns_commands:
   7:
     name: connect
@@ -360,16 +364,18 @@ topics:
   com.apple.ess:
   com.apple.findmy:
   com.apple.gamed:
+  com.apple.iWork.Numbers:
+  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.garageband10:
+  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.mobilegarageband:
+  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.musicmemos.ideas:
+  com.apple.icloud-container.clouddocs.F6266T9T75.com.apple.iMovie:
   com.apple.icloud-container.clouddocs.com.apple.Automator:
   com.apple.icloud-container.clouddocs.com.apple.CloudDocs:
   com.apple.icloud-container.clouddocs.com.apple.CloudDocs.container-metadata:
   com.apple.icloud-container.clouddocs.com.apple.CloudDocs.health:
   com.apple.icloud-container.clouddocs.com.apple.CloudDocs.pp-metadata:
-  com.apple.icloud-container.clouddocs.com.apple.finder:
   com.apple.icloud-container.clouddocs.com.apple.Grab:
-  com.apple.icloud-container.clouddocs.com.apple.iBooks.cloudData:
   com.apple.icloud-container.clouddocs.com.apple.Keynote:
-  com.apple.icloud-container.clouddocs.com.apple.mail:
   com.apple.icloud-container.clouddocs.com.apple.Mica:
   com.apple.icloud-container.clouddocs.com.apple.Notes:
   com.apple.icloud-container.clouddocs.com.apple.Numbers:
@@ -377,20 +383,25 @@ topics:
   com.apple.icloud-container.clouddocs.com.apple.Preview:
   com.apple.icloud-container.clouddocs.com.apple.QuickTimePlayerX:
   com.apple.icloud-container.clouddocs.com.apple.ScriptEditor2:
-  com.apple.icloud-container.clouddocs.com.apple.shoebox:
   com.apple.icloud-container.clouddocs.com.apple.TextEdit:
   com.apple.icloud-container.clouddocs.com.apple.TextInput:
-  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.garageband10:
-  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.mobilegarageband:
-  com.apple.icloud-container.clouddocs.F3LWYJ7GM7.com.apple.musicmemos.ideas:
-  com.apple.icloud-container.clouddocs.F6266T9T75.com.apple.iMovie:
+  com.apple.icloud-container.clouddocs.com.apple.finder:
+  com.apple.icloud-container.clouddocs.com.apple.iBooks.cloudData:
+  com.apple.icloud-container.clouddocs.com.apple.mail:
+  com.apple.icloud-container.clouddocs.com.apple.shoebox:
+  com.apple.icloud-container.clouddocs.iCloud.com.apple.MobileSMS:
+  com.apple.icloud-container.clouddocs.iCloud.com.apple.Playgrounds:
   com.apple.icloud-container.clouddocs.iCloud.com.apple.configurator.ui:
   com.apple.icloud-container.clouddocs.iCloud.com.apple.iBooks:
   com.apple.icloud-container.clouddocs.iCloud.com.apple.iBooks.iTunesU:
-  com.apple.icloud-container.clouddocs.iCloud.com.apple.MobileSMS:
-  com.apple.icloud-container.clouddocs.iCloud.com.apple.Playgrounds:
   com.apple.icloud-container.clouddocs.iCloud.com.polishedplay.coreanimator:
   com.apple.icloud-container.clouddocs.iCloud.is.workflow.my.workflows:
+  com.apple.icloud-container.com.apple.Safari:
+  com.apple.icloud-container.com.apple.SafariShared.CloudTabs:
+  com.apple.icloud-container.com.apple.SafariShared.Settings:
+  com.apple.icloud-container.com.apple.SafariShared.WBSCloudBookmarksStore:
+  com.apple.icloud-container.com.apple.TrustedPeersHelper:
+  com.apple.icloud-container.com.apple.UsageTrackingAgent:
   com.apple.icloud-container.com.apple.amsengagementd:
   com.apple.icloud-container.com.apple.appleaccount.beneficiary:
   com.apple.icloud-container.com.apple.appleaccount.beneficiary.private:
@@ -405,20 +416,16 @@ topics:
   com.apple.icloud-container.com.apple.cloudpaird:
   com.apple.icloud-container.com.apple.findmy.findmylocateagent:
   com.apple.icloud-container.com.apple.gamed:
+  com.apple.icloud-container.com.apple.iWork.Numbers:
   com.apple.icloud-container.com.apple.icloud.fmfd:
   com.apple.icloud-container.com.apple.icloud.searchpartyuseragent:
   com.apple.icloud-container.com.apple.imagent:
-  com.apple.icloud-container.com.apple.iWork.Numbers:
   com.apple.icloud-container.com.apple.keyboardservicesd:
   com.apple.icloud-container.com.apple.knowledge-agent:
   com.apple.icloud-container.com.apple.passd:
   com.apple.icloud-container.com.apple.photos.cloud:
   com.apple.icloud-container.com.apple.protectedcloudstorage.protectedcloudkeysyncing:
   com.apple.icloud-container.com.apple.reminders:
-  com.apple.icloud-container.com.apple.Safari:
-  com.apple.icloud-container.com.apple.SafariShared.CloudTabs:
-  com.apple.icloud-container.com.apple.SafariShared.Settings:
-  com.apple.icloud-container.com.apple.SafariShared.WBSCloudBookmarksStore:
   com.apple.icloud-container.com.apple.security.cuttlefish:
   com.apple.icloud-container.com.apple.security.kcsharing:
   com.apple.icloud-container.com.apple.securityd:
@@ -427,9 +434,7 @@ topics:
   com.apple.icloud-container.com.apple.suggestd:
   com.apple.icloud-container.com.apple.syncdefaultsd:
   com.apple.icloud-container.com.apple.transparencyd:
-  com.apple.icloud-container.com.apple.TrustedPeersHelper:
   com.apple.icloud-container.com.apple.upload-request-proxy.com.apple.photos.cloud:
-  com.apple.icloud-container.com.apple.UsageTrackingAgent:
   com.apple.icloud-container.com.apple.willowd:
   com.apple.icloud.fmip.voiceassistantsync:
   com.apple.icloud.presence.mode.status:
@@ -437,7 +442,6 @@ topics:
   com.apple.idmsauth:
   com.apple.idmsauthagent:
   com.apple.itunesstored:
-  com.apple.iWork.Numbers:
   com.apple.jalisco:
   com.apple.madrid:
   com.apple.mobileassetd:
@@ -494,11 +498,11 @@ topics:
   com.apple.private.alloy.fmf:
   com.apple.private.alloy.gamecenter.imessage:
   com.apple.private.alloy.gelato:
-  com.apple.private.alloy.groupkit:
-  com.apple.private.alloy.groupkit.invite:
   com.apple.private.alloy.groupRemoteControl.cloud:
   com.apple.private.alloy.groupRemoteControl.messaging:
   com.apple.private.alloy.groupRemoteControl.session:
+  com.apple.private.alloy.groupkit:
+  com.apple.private.alloy.groupkit.invite:
   com.apple.private.alloy.hearing:
   com.apple.private.alloy.home:
   com.apple.private.alloy.home.invite:

data/share/backup.yaml

@@ -6,32 +6,32 @@ metadata:
   - backup_domains
 backup_domains:
   AppDomain-com.apple.Maps:
-  AppDomain-com.apple.mobilemail:
-  AppDomain-com.apple.mobilenotes:
-  AppDomain-com.apple.mobilesafari:
   AppDomain-com.apple.MobileSMS:
   AppDomain-com.apple.Music:
-  AppDomain-com.apple.news:
   AppDomain-com.apple.Passbook:
-  AppDomain-com.apple.podcasts:
   AppDomain-com.apple.ScreenshotServicesService:
   AppDomain-com.apple.SleepLockScreen:
+  AppDomain-com.apple.mobilemail:
+  AppDomain-com.apple.mobilenotes:
+  AppDomain-com.apple.mobilesafari:
+  AppDomain-com.apple.news:
+  AppDomain-com.apple.podcasts:
   AppDomain-com.apple.store.Jolly:
   AppDomainGroup-243LU875E5.groups.com.apple.podcasts:
-  AppDomainGroup-group.com.apple.mail:
   AppDomainGroup-group.com.apple.Maps:
   AppDomainGroup-group.com.apple.Music:
+  AppDomainGroup-group.com.apple.mail:
   AppDomainGroup-group.com.apple.news:
   AppDomainGroup-group.com.apple.notes:
   AppDomainGroup-group.com.apple.tips:
   AppDomainGroup-group.com.apple.weather:
-  AppDomainPlugin-com.apple.AppleMediaDiscovery.AMDEngagementExtension:
   AppDomainPlugin-com.apple.AppStore.ProductPageExtension:
+  AppDomainPlugin-com.apple.AppleMediaDiscovery.AMDEngagementExtension:
   AppDomainPlugin-com.apple.Maps.GeneralMapsWidget:
   AppDomainPlugin-com.apple.MobileSMS.MessagesNotificationExtension:
   AppDomainPlugin-com.apple.Music.Messages:
-  AppDomainPlugin-com.apple.news.widget:
   AppDomainPlugin-com.apple.TestFlight.ServiceExtension:
+  AppDomainPlugin-com.apple.news.widget:
   AppDomainPlugin-com.apple.weather.widget:
   HomeDomain:
   KeyboardDomain:

data/share/baseband/qualcomm/mav13.yaml

@@ -3,6 +3,7 @@ metadata:
   description:
   credits:
   - rickmark
+  collections: []
 bbfw_contents:
   acdb.mbn:
     description: accessory database

data/share/baseband/qualcomm/mav20.yaml

@@ -2,6 +2,7 @@
 metadata:
   description:
   credits: []
+  collections: []
 versions:
 - 1.00.03-5
 - 1.14.04

data/share/baseband/qualcomm/mav21.yaml

@@ -3,6 +3,7 @@ metadata:
   description: Data on the Qualcomm X55 (Mav21) baseband
   credits:
   - rickmark
+  collections: []
 bbfw_contents:
 - acdb.mbn
 - apdp.mbn