apple-data 1.0.650 → 1.0.651

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2dc425f46f36d461a492ecf9f1a95df5c7e3a9675b88b08647e2530b9cc901a
-  data.tar.gz: 3111575be969f6d1a531a4e58ad62065131ffe4280e695192ec439682feb2fd9
+  metadata.gz: e0c08f469c75dfae827884566fe4ce755af8498b7796c3386fa480a069146ac0
+  data.tar.gz: 4a024ac00342adc29f4a51e9db9e8db1569873e619cefd72801fc712c8b5e91d
 SHA512:
-  metadata.gz: 85861d964d97dff7e43c569fbe5c4dc0b77dc04ac8ba21f0eb52fa71b17815dac627285822b25893fab0756654b51ca752c46a6aceef884c1981305d851a3648
-  data.tar.gz: bb377aea5b290a06069c533625353f0de2826cf6c387ad283f092002c8b5e728913b4ecda9d9abb35c0e3835e188da1d6b25842e68bbaed6200d6f13cb374afb
+  metadata.gz: c7b8ff4a5926f27d734326b1c824036038b74480852033d7a44de883456c87ef49e4d4833c4942bfab685e42d9aaff349ee03c46ad8961f88bc3d39d6542fed0
+  data.tar.gz: 06c32e5eb6fa6ac49a7711381bd6269e032f53f3abb82acd83c29f564c797dedb0cab57c71fc0c6a3b4a8019f543f198aa4806b5fb60b18931c6bfb0a28ab619

data/lib/apple_data/data_file.rb

@@ -1,17 +1,31 @@
 # frozen_string_literal: true
 
-require 'active_support/all'
-require 'jsonpath'
-
 module AppleData
   # Base class for all data files
   class DataFile
+    def self.define(&)
+      dsl = AppleData::DSL::DataFileDefinition.new
+      dsl.instance_eval(&)
+      dsl.build!
+    end
+
+    def self.inherited(klass)
+      super
+      @data_files ||= []
+      @data_files << klass
+    end
+
+    def self.all
+      @data_files
+    end
+
     attr_reader :data
 
     def initialize(*parts)
       @parts = parts
+      @parts = [self.class.const_get(:DEFAULT_FILENAME)] if @parts.empty?
       @collections = {}
-      load_file(*parts)
+      load_file(*@parts)
       ensure_metadata
     end
 
@@ -27,11 +41,12 @@ module AppleData
     end
 
     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))
+      parts[-1] = "#{parts[-1]}.yaml" unless parts[-1].end_with? '.yaml'
+      @filename = File.join(AppleData.data_location, File.join(*parts))
       @data = {}
       @data = YAML.load_file @filename if File.exist? @filename
-      @data.with_indifferent_access
+      @data.deep_symbolize_keys!
+      @data = @data.with_indifferent_access
     end
 
     def save!
@@ -120,5 +135,31 @@ module AppleData
         end
       end
     end
+
+    def construct_array(collection_definition, value)
+      value.data.map do |item|
+        if collection_definition.mapper
+          collection_definition.mapper.from_hash(item)
+        else
+          item
+        end
+      end
+    end
+
+    def construct_hash(collection_definition, value)
+      result = value.data.map do |key, item|
+        instance = if item
+                     if collection_definition.mapper
+                       collection_definition.mapper.from_hash(item)
+                     else
+                       item
+                     end
+                   end
+        instance.key = key if instance.respond_to? :key=
+        [key, instance]
+      end
+
+      result.to_h
+    end
   end
 end

data/lib/apple_data/dsl/collection_definition.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module AppleData
+  module DSL
+    # A definition of a collection of objects, with a particular schema
+    class CollectionDefinition
+      attr_reader :name
+      attr_accessor :mapper
+
+      def initialize(name, mapper)
+        @name = name
+        @mapper = mapper
+      end
+
+      # Builds the collection into the given data file class
+      def build!(klass)
+        name = @name
+        klass.instance_eval do
+          define_method(name) do
+            @mapped_collections ||= {}
+            if @mapped_collections[name].nil?
+              collection_definition = self.class.const_get(:COLLECTIONS)[name]
+
+              value = collection(name.to_s)
+              result = case value.data
+                       when Hash
+                         construct_hash(collection_definition, value)
+                       when Array
+                         construct_array(collection_definition, value)
+                       else
+                         value.data
+                       end
+
+              @mapped_collections[name] = result
+            end
+
+            @mapped_collections[name]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apple_data/dsl/data_file_definition.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AppleData
+  module DSL
+    # The DSL that is used when defining a data file
+    class DataFileDefinition
+      def initialize
+        @collections = {}
+      end
+
+      def collection(name, mapper = nil, &)
+        @collections[name] = AppleData::DSL::CollectionDefinition.new(name, mapper)
+        if block_given? && @collections[name].mapper.nil?
+          @collections[name].mapper = Class.new(AppleData::SchemaBase)
+          @collections[name].mapper.class_eval(&)
+        end
+        @collections[name]
+      end
+
+      attr_writer :default_filename
+
+      def build!
+        klass = Class.new(DataFile)
+
+        klass.const_set(:DEFAULT_FILENAME, @default_filename)
+        klass.const_set(:COLLECTIONS, @collections)
+
+        @collections.each_value do |collection_definition|
+          collection_definition.build!(klass)
+        end
+
+        klass
+      end
+    end
+  end
+end

data/lib/apple_data/models/img4/object.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module AppleData
+  module Models
+    module IMG4
+      # IMG4 "objects" are either a reference to a file, or some other structured set of properties
+      class Object < AppleData::Models::IMG4::Tag
+        attribute :encoding, :string
+        attribute :firmware_name, :string
+        attribute :recovery, :boolean
+        attribute :restore, :boolean
+        attribute :firmware, :boolean
+        attribute :subtype, :string
+        attribute :manifest, :boolean
+        attribute :nullable, :boolean
+        attribute :roots, :string, collection: true
+        attribute :metadata, :string, collection: true
+        attribute :values, :string, collection: true
+        attribute :width, :integer
+      end
+    end
+  end
+end

data/lib/apple_data/models/img4/property.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AppleData
+  module Models
+    module IMG4
+      # An IMG4 property is a name and a value
+      class Property < AppleData::Models::IMG4::Tag
+        attribute :roots, :string, collection: true
+        attribute :example, :string
+      end
+    end
+  end
+end

data/lib/apple_data/models/img4/tag.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AppleData
+  module Models
+    module IMG4
+      # Generic IMG4 DER "tag"
+      class Tag < Shale::Mapper
+        attr_accessor :key
+
+        attribute :name, :string
+        attribute :description, :string
+        attribute :title, :string
+        attribute :alias, :string, collection: true
+        attribute :example, :string
+        attribute :type, :string
+
+        def to_s
+          name || title || description || key
+        end
+
+        def to_sym
+          to_s.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/apple_data/models/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AppleData
+  module Models
+    # The metadata common to all Apple Data models
+    class Metadata < AppleData::SchemaBase
+      attribute :credits, :string, collection: true
+      attribute :description, :string
+      attribute :auto_sort, :boolean
+    end
+  end
+end

data/lib/apple_data/schema_base.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AppleData
+  class SchemaBase < Shale::Mapper
+  end
+end

data/lib/apple_data/schemas/factory_data_restore.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+AppleData::Schemas::FactoryDataRestore = AppleData::DataFile.define do
+  self.default_filename = 'fdr'
+
+  collection :fdr_modes do
+    attribute :description, :string
+  end
+
+  collection :fdr_objects, AppleData::Models::IMG4::Object
+
+  collection :fdr_properties, AppleData::Models::IMG4::Property
+end

data/lib/apple_data/schemas/img4.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+AppleData::Schemas::IMG4 = AppleData::DataFile.define do
+  self.default_filename = 'img4'
+
+  collection :unmapped
+
+  collection :core, AppleData::Models::IMG4::Tag
+  collection :lpol_properties, AppleData::Models::IMG4::Property
+  collection :cryptex_properties, AppleData::Models::IMG4::Property
+  collection :cryptex_objects, AppleData::Models::IMG4::Object
+  collection :manifest_properties, AppleData::Models::IMG4::Property
+  collection :objects, AppleData::Models::IMG4::Object
+  collection :img4_tags, AppleData::Models::IMG4::Tag
+
+  collection :types do
+    attribute :description, :string
+  end
+end

data/lib/apple_data/schemas/local_policy.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+AppleData::Schemas::LocalPolicy = AppleData::DataFile.define do
+  self.default_filename = 'local_policy'
+end

data/lib/apple_data/schemas/pki.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+AppleData::Schemas::PKI = AppleData::DataFile.define do
+  self.default_filename = 'pki'
+
+  collection :certificate_names do
+    attribute :key, :string
+    attribute :name, :string
+    attribute :issuer, :string
+  end
+
+  collection :keys do
+    attribute :title, :string
+    attribute :certificates, :string, collection: true
+  end
+
+  collection :oids do
+    attribute :title, :string
+    attribute :type, :string
+    attribute :description, :string
+    attribute :apple_description, :string
+    attribute :found_in, :string, collection: true
+    attribute :issuers, :string, collection: true
+    attribute :ous, :string, collection: true
+  end
+end

data/lib/apple_data/version.rb

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

data/lib/apple_data.rb

@@ -1,7 +1,25 @@
 # frozen_string_literal: true
 
+require 'active_support/all'
+require 'shale'
+require 'zeitwerk'
+require 'jsonpath'
+
 # Base Namespace for AppleData gem
 module AppleData
+  LOADER = Zeitwerk::Loader.new.tap do |loader|
+    loader.push_dir(__dir__)
+    loader.tag = 'apple-data'
+    loader.inflector.tap do |inflector|
+      inflector.inflect 'dsl' => 'DSL'
+      inflector.inflect 'img4' => 'IMG4'
+      inflector.inflect 'pki' => 'PKI'
+    end
+    loader.setup
+
+    loader.eager_load_dir(File.join(__dir__, 'apple_data/schemas'))
+  end
+
   DEFAULT_APPLE_DATA_SHARE = File.join(File.dirname(__FILE__), '../share/')
 
   def get_data(file)
@@ -16,9 +34,3 @@ module AppleData
     @apple_data || AppleData::DEFAULT_APPLE_DATA_SHARE
   end
 end
-
-require 'apple_data/data_file'
-require 'apple_data/factory_data_reset'
-require 'apple_data/io_reg'
-require 'apple_data/lockdown'
-require 'apple_data/keybag'

data/share/fdr.yaml

@@ -5,7 +5,7 @@ metadata:
   collections:
   - fdr_properties
 fdr_modes:
-  '':
+  base:
     description: Objects for the device directly, indicates no factory process or
       mode in use.
   mansta:
@@ -97,7 +97,7 @@ fdr_properties:
   comb:
     description: Combined FDR object
   dCfg:
-    description: Display LCD
+    description:
     contexts:
     - base
     - mansta
@@ -152,11 +152,12 @@ fdr_properties:
     - base
     - mansta
   meid:
-    description: Mobile Equipment Identifier (CMDA)
+    title: Mobile Equipment Identifier (CMDA)
   mft2:
   mlb#:
-    description: Main Logic Board Serial Number
+    title: Main Logic Board Serial Number
   mmap:
+    title: Memory Map
     description: The memory map passed from the iBoot loader to the Kernel
   nuid:
     description:
@@ -204,7 +205,8 @@ fdr_properties:
     title: Recovery SSL
     description: Root SSL / TLS certificate
   rvok:
-    description: Trust Object Revocation
+    title: Revocation List
+    description: FDR trust object list of revoked certificates / public keys
   scrt:
     description: SEP Certificate
     contexts:
@@ -213,7 +215,9 @@ fdr_properties:
     description: Point Compressed Elliptic Curve point sering as the master Public
       Key for the SE
   seal:
-    description:
+    title: FDR Sealing Object
+    description: Used to provide a cryptographic seal of the data that is restored
+      to the device via FDR to prevent tampering with said data.
     contexts:
     - base
   secb:
@@ -231,7 +235,9 @@ fdr_properties:
     title: Trusted Public Keys
     description: Trusted Public Key
   trst:
-    description: Trust Object
+    title: Trust Object
+    description: The various data required to connect to FDR, includes the remote
+      SSL root, revocation list, and trusted public keys
   tsid:
     description:
   vcrt:

data/share/img4.yaml

@@ -1019,7 +1019,7 @@ objects:
   rdtr:
     title: Restore Device Tree
     description:
-      firmware_name: RestoreDeviceTree
+    firmware_name: RestoreDeviceTree
   recm:
     description: Recovery Mode
     firmware_name: RecoveryMode

data/share/pki.yaml

@@ -7,18 +7,27 @@ metadata:
   - keys
   - oids
 certificate_names:
-  dcrt: Device Identity Certificate
-  dcrt-oid: Device Owner Identity Certificate
-  lcrt: Lynx / Secure Storage for SEP Certificate
-  pcrt: product/production certificate?
-  rcrt: remote/recovery certificate?
-  scrt: SEP Certificate
-  sdcrt: SEP Device Certificate
-  tcrt: test certificate?
+  dcrt:
+    name: Device Identity Certificate
+  dcrt-oid:
+    name: Device Owner Identity Certificate
+  lcrt:
+    name: Lynx / Secure Storage for SEP Certificate
+  pcrt:
+    name: Protected Certificate
+  rcrt:
+    name: remote/recovery certificate?
+  scrt:
+    name: SEP Certificate
+  sdcrt:
+    name: SEP Device Certificate
+  tcrt:
+    name: test certificate?
   ucrt:
     name: User Identity Certificate
     issuer: Basic Attestation User Root CA
-  vcrt: virtual certificate?
+  vcrt:
+    name: virtual certificate?
 keys:
   oik:
     title: Owner Identity Key

metadata

@@ -1,14 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: apple-data
 version: !ruby/object:Gem::Version
-  version: 1.0.650
+  version: 1.0.651
 platform: ruby
 authors:
 - Rick Mark
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: jsonpath
+  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: pathutil
+  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: shale
+  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: zeitwerk
+  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'
 description: |2
       This package includes machine readable data about Apple platforms maintained by hack-different.
 
@@ -21,14 +91,24 @@ extra_rdoc_files:
 - README.md
 files:
 - README.md
-- lib/apple-data.rb
 - lib/apple_data.rb
 - lib/apple_data/data_file.rb
+- lib/apple_data/dsl/collection_definition.rb
+- lib/apple_data/dsl/data_file_definition.rb
 - lib/apple_data/factory_data_reset.rb
 - lib/apple_data/io_reg.rb
 - lib/apple_data/ipsw.rb
 - lib/apple_data/keybag.rb
 - lib/apple_data/lockdown.rb
+- lib/apple_data/models/img4/object.rb
+- lib/apple_data/models/img4/property.rb
+- lib/apple_data/models/img4/tag.rb
+- lib/apple_data/models/metadata.rb
+- lib/apple_data/schema_base.rb
+- lib/apple_data/schemas/factory_data_restore.rb
+- lib/apple_data/schemas/img4.rb
+- lib/apple_data/schemas/local_policy.rb
+- lib/apple_data/schemas/pki.rb
 - lib/apple_data/version.rb
 - share/apns.yaml
 - share/backup.yaml
@@ -288,7 +368,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/apple-data.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'apple_data'