app-info 2.2.0

data/lib/app_info/ipa.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'macho'
+require 'pngdefry'
+require 'fileutils'
+require 'forwardable'
+require 'cfpropertylist'
+require 'app_info/util'
+
+module AppInfo
+  # IPA parser
+  class IPA
+    extend Forwardable
+
+    attr_reader :file
+
+    # iOS Export types
+    module ExportType
+      DEBUG   = 'Debug'
+      ADHOC   = 'AdHoc'
+      INHOUSE = 'inHouse'
+      RELEASE = 'Release'
+      UNKOWN  = nil
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def size(humanable = false)
+      AppInfo::Util.file_size(@file, humanable)
+    end
+
+    def os
+      AppInfo::Platform::IOS
+    end
+    alias file_type os
+
+    def_delegators :info, :iphone?, :ipad?, :universal?, :build_version, :name,
+                   :release_version, :identifier, :bundle_id, :display_name,
+                   :bundle_name, :icons, :min_sdk_version, :device_type
+
+    def_delegators :mobileprovision, :devices, :team_name, :team_identifier,
+                   :profile_name, :expired_date
+
+    def distribution_name
+      "#{profile_name} - #{team_name}" if profile_name && team_name
+    end
+
+    def release_type
+      if stored?
+        ExportType::RELEASE
+      else
+        build_type
+      end
+    end
+
+    def build_type
+      if mobileprovision?
+        if devices
+          ExportType::ADHOC
+        else
+          ExportType::INHOUSE
+        end
+      else
+        ExportType::DEBUG
+      end
+    end
+
+    def archs
+      return unless File.exist?(bundle_path)
+
+      file = MachO.open(bundle_path)
+      case file
+      when MachO::MachOFile
+        [file.cpusubtype]
+      else
+        file.machos.each_with_object([]) do |arch, obj|
+          obj << arch.cpusubtype
+        end
+      end
+    end
+    alias architectures archs
+
+    def stored?
+      metadata? ? true : false
+    end
+
+    def hide_developer_certificates
+      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
+    end
+
+    def mobileprovision
+      return unless mobileprovision?
+      return @mobileprovision if @mobileprovision
+
+      @mobileprovision = MobileProvision.new(mobileprovision_path)
+    end
+
+    def mobileprovision?
+      File.exist?mobileprovision_path
+    end
+
+    def mobileprovision_path
+      filename = 'embedded.mobileprovision'
+      @mobileprovision_path ||= File.join(@file, filename)
+      unless File.exist?(@mobileprovision_path)
+        @mobileprovision_path = File.join(app_path, filename)
+      end
+
+      @mobileprovision_path
+    end
+
+    def metadata
+      return unless metadata?
+
+      @metadata ||= CFPropertyList.native_types(CFPropertyList::List.new(file: metadata_path).value)
+    end
+
+    def metadata?
+      File.exist?(metadata_path)
+    end
+
+    def metadata_path
+      @metadata_path ||= File.join(contents, 'iTunesMetadata.plist')
+    end
+
+    def bundle_path
+      @bundle_path ||= File.join(app_path, info.bundle_name)
+    end
+
+    def info
+      @info ||= InfoPlist.new(app_path)
+    end
+
+    def app_path
+      @app_path ||= Dir.glob(File.join(contents, 'Payload', '*.app')).first
+    end
+
+    def cleanup!
+      return unless @contents
+
+      FileUtils.rm_rf(@contents)
+
+      @contents = nil
+      @icons = nil
+      @app_path = nil
+      @metadata = nil
+      @metadata_path = nil
+      @info = nil
+    end
+
+    private
+
+    def contents
+      @contents ||= Util.unarchive(@file, path: 'ios')
+    end
+
+    def icons_root_path
+      iphone = 'CFBundleIcons'
+      ipad = 'CFBundleIcons~ipad'
+
+      case device_type
+      when 'iPhone'
+        [iphone]
+      when 'iPad'
+        [ipad]
+      when 'Universal'
+        [iphone, ipad]
+      end
+    end
+  end
+end

data/lib/app_info/ipa/info_plist.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'cfpropertylist'
+require 'app_info/util'
+
+module AppInfo
+  # iOS Info.plist parser
+  class InfoPlist
+    def initialize(app_path)
+      @app_path = app_path
+    end
+
+    def build_version
+      info.try(:[], 'CFBundleVersion')
+    end
+
+    def release_version
+      info.try(:[], 'CFBundleShortVersionString')
+    end
+
+    def identifier
+      info.try(:[], 'CFBundleIdentifier')
+    end
+    alias bundle_id identifier
+
+    def name
+      display_name || bundle_name
+    end
+
+    def display_name
+      info.try(:[], 'CFBundleDisplayName')
+    end
+
+    def bundle_name
+      info.try(:[], 'CFBundleName')
+    end
+
+    #
+    # Extract the Minimum OS Version from the Info.plist
+    #
+    def min_sdk_version
+      info.try(:[], 'MinimumOSVersion')
+    end
+
+    def icons
+      return @icons if @icons
+
+      @icons = []
+      icons_root_path.each do |name|
+        icon_array = info.try(:[], name)
+                         .try(:[], 'CFBundlePrimaryIcon')
+                         .try(:[], 'CFBundleIconFiles')
+
+        next if icon_array.nil? || icon_array.empty?
+
+        icon_array.each do |items|
+          Dir.glob(File.join(@app_path, "#{items}*")).find_all.each do |file|
+            dict = {
+              name: File.basename(file),
+              file: file,
+              dimensions: Pngdefry.dimensions(file)
+            }
+
+            @icons.push(dict)
+          end
+        end
+      end
+
+      @icons
+    end
+
+    def device_type
+      device_family = info.try(:[], 'UIDeviceFamily')
+      if device_family.length == 1
+        case device_family
+        when [1]
+          'iPhone'
+        when [2]
+          'iPad'
+        end
+      elsif device_family.length == 2 && device_family == [1, 2]
+        'Universal'
+      end
+    end
+
+    def iphone?
+      device_type == 'iPhone'
+    end
+
+    def ipad?
+      device_type == 'iPad'
+    end
+
+    def universal?
+      device_type == 'Universal'
+    end
+
+    def release_type
+      if stored?
+        'Store'
+      else
+        build_type
+      end
+    end
+
+    def [](key)
+      info.try(:[], key.to_s)
+    end
+
+    def method_missing(method_name, *args, &block)
+      info.try(:[], Util.format_key(method_name)) ||
+        info.send(method_name) ||
+        super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      info.key?(Util.format_key(method_name)) ||
+        info.respond_to?(method_name) ||
+        super
+    end
+
+    private
+
+    def info
+      @info ||= CFPropertyList.native_types(CFPropertyList::List.new(file: info_path).value)
+    end
+
+    def info_path
+      File.join(@app_path, 'Info.plist')
+    end
+
+    IPHONE_KEY = 'CFBundleIcons'
+    IPAD_KEY = 'CFBundleIcons~ipad'
+
+    def icons_root_path
+      case device_type
+      when 'iPhone'
+        [IPHONE_KEY]
+      when 'iPad'
+        [IPAD_KEY]
+      when 'Universal'
+        [IPHONE_KEY, IPAD_KEY]
+      end
+    end
+  end
+end

data/lib/app_info/ipa/mobile_provision.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'cfpropertylist'
+require 'app_info/util'
+
+module AppInfo
+  # .mobileprovision file parser
+  class MobileProvision
+    def initialize(path)
+      @path = path
+    end
+
+    def name
+      mobileprovision.try(:[], 'Name')
+    end
+
+    def app_name
+      mobileprovision.try(:[], 'AppIDName')
+    end
+
+    def type
+      return :development if development?
+      return :adhoc if adhoc?
+      return :appstore if appstore?
+      return :inhouse if inhouse?
+    end
+
+    def platforms
+      return unless platforms = mobileprovision.try(:[], 'Platform')
+
+      platforms.map { |v|
+        v = 'macOS' if v == 'OSX'
+        v.downcase.to_sym
+      }
+    end
+
+    def platform
+      platforms[0]
+    end
+
+    def devices
+      mobileprovision.try(:[], 'ProvisionedDevices')
+    end
+
+    def team_identifier
+      mobileprovision.try(:[], 'TeamIdentifier')
+    end
+
+    def team_name
+      mobileprovision.try(:[], 'TeamName')
+    end
+
+    def profile_name
+      mobileprovision.try(:[], 'Name')
+    end
+
+    def created_date
+      mobileprovision.try(:[], 'CreationDate')
+    end
+
+    def expired_date
+      mobileprovision.try(:[], 'ExpirationDate')
+    end
+
+    def entitlements
+      mobileprovision.try(:[], 'Entitlements')
+    end
+
+    def developer_certs
+      certs = mobileprovision.try(:[], 'DeveloperCertificates')
+      return if certs.empty?
+
+      certs.each_with_object([]) do |cert, obj|
+        obj << DeveloperCertificate.new(cert)
+      end
+    end
+
+    # Detect is development type of mobileprovision
+    #
+    # related link: https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    def development?
+      case platform.downcase.to_sym
+      when :ios
+        entitlements['get-task-allow'] == true
+      when :macos
+        !devices.nil?
+      else
+        raise Error, "Not implement with platform: #{platform}"
+      end
+    end
+
+    # Detect app store type
+    #
+    # related link: https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    def appstore?
+      case platform.downcase.to_sym
+      when :ios
+        !development? && entitlements.key?('beta-reports-active')
+      when :macos
+        !development?
+      else
+        raise Error, "Not implement with platform: #{platform}"
+      end
+    end
+
+    def adhoc?
+      return false if platform == :macos # macOS no need adhoc
+
+      !development? && !devices.nil?
+    end
+
+    def inhouse?
+      return false if platform == :macos # macOS no need adhoc
+
+      !development? && !adhoc? && !appstore?
+    end
+
+    # Enabled Capabilites
+    #
+    # Related link: https://developer.apple.com/support/app-capabilities/
+    def enabled_capabilities
+      capabilities = []
+      if adhoc? || appstore?
+        capabilities << 'In-App Purchase' << 'GameKit'
+      end
+
+      entitlements.each do |key, value|
+        case key
+        when 'aps-environment'
+          capabilities << 'Push Notifications'
+        when 'com.apple.developer.applesignin'
+          capabilities << 'Sign In with Apple'
+        when 'com.apple.developer.siri'
+          capabilities << 'SiriKit'
+        when 'com.apple.security.application-groups'
+          capabilities << 'App Groups'
+        when 'com.apple.developer.associated-domains'
+          capabilities << 'Associated Domains'
+        when 'com.apple.developer.default-data-protection'
+          capabilities << 'Data Protection'
+        when 'com.apple.developer.networking.networkextension'
+          capabilities << 'Network Extensions'
+        when 'com.apple.developer.networking.vpn.api'
+          capabilities << 'Personal VPN'
+        when 'com.apple.developer.healthkit', 'com.apple.developer.healthkit.access'
+          capabilities << 'HealthKit' unless capabilities.include?('HealthKit')
+        when 'com.apple.developer.icloud-services', 'com.apple.developer.icloud-container-identifiers'
+          capabilities << 'iCloud' unless capabilities.include?('iCloud')
+        when 'com.apple.developer.in-app-payments'
+          capabilities << 'Apple Pay'
+        when 'com.apple.developer.homekit'
+          capabilities << 'HomeKit'
+        when 'com.apple.developer.user-fonts'
+          capabilities << 'Fonts'
+        when 'com.apple.developer.pass-type-identifiers'
+          capabilities << 'Wallet'
+        when 'inter-app-audio'
+          capabilities << 'Inter-App Audio'
+        when 'com.apple.developer.networking.multipath'
+          capabilities << 'Multipath'
+        when 'com.apple.developer.authentication-services.autofill-credential-provider'
+          capabilities << 'AutoFill Credential Provider'
+        when 'com.apple.developer.networking.wifi-info'
+          capabilities << 'Access WiFi Information'
+        when 'com.apple.external-accessory.wireless-configuration'
+          capabilities << 'Wireless Accessory Configuration'
+        when 'com.apple.developer.kernel.extended-virtual-addressing'
+          capabilities << 'Extended Virtual Address Space'
+        when 'com.apple.developer.nfc.readersession.formats'
+          capabilities << 'NFC Tag Reading'
+        when 'com.apple.developer.ClassKit-environment'
+          capabilities << 'ClassKit'
+        when 'com.apple.developer.networking.HotspotConfiguration'
+          capabilities << 'Hotspot'
+        when 'com.apple.developer.devicecheck.appattest-environment'
+          capabilities << 'App Attest'
+        when 'com.apple.developer.coremedia.hls.low-latency'
+          capabilities << 'Low Latency HLS'
+        when 'com.apple.developer.associated-domains.mdm-managed'
+          capabilities << 'MDM Managed Associated Domains'
+        # macOS Only
+        when 'com.apple.developer.maps'
+          capabilities << 'Maps'
+        when 'com.apple.developer.system-extension.install'
+          capabilities << 'System Extension'
+        when 'com.apple.developer.networking.custom-protocol'
+          capabilities << 'Custom Network Protocol'
+        end
+      end
+
+      capabilities
+    end
+
+    def [](key)
+      mobileprovision.try(:[], key.to_s)
+    end
+
+    def empty?
+      mobileprovision.nil?
+    end
+
+    def mobileprovision
+      return @mobileprovision = nil unless File.exist?(@path)
+
+      data = File.read(@path)
+      data = strip_plist_wrapper(data) unless bplist?(data)
+      list = CFPropertyList::List.new(data: data).value
+      @mobileprovision = CFPropertyList.native_types(list)
+    rescue CFFormatError
+      @mobileprovision = nil
+    end
+
+    def method_missing(method_name, *args, &block)
+      mobileprovision.try(:[], Util.format_key(method_name)) ||
+        mobileprovision.send(method_name) ||
+        super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      mobileprovision.key?(Util.format_key(method_name)) ||
+        mobileprovision.respond_to?(method_name) ||
+        super
+    end
+
+    private
+
+    def bplist?(raw)
+      raw[0..5] == 'bplist'
+    end
+
+    def strip_plist_wrapper(raw)
+      end_tag = '</plist>'
+      start_point = raw.index('<?xml version=')
+      end_point = raw.index(end_tag) + end_tag.size - 1
+      raw[start_point..end_point]
+    end
+
+    # Developer Certificate
+    class DeveloperCertificate
+      attr_reader :raw
+
+      def initialize(data)
+        @raw = OpenSSL::X509::Certificate.new(data)
+      end
+
+      def name
+        @raw.subject.to_a.find { |name, _, _| name == 'CN' }[1]
+      end
+
+      def created_date
+        @raw.not_after
+      end
+
+      def expired_date
+        @raw.not_before
+      end
+    end
+  end
+end