app-info 2.8.5 → 3.0.0.beta2

data/lib/app_info/mobile_provision.rb

@@ -4,20 +4,37 @@ require 'openssl'
 require 'cfpropertylist'
 
 module AppInfo
-  # .mobileprovision file parser
-  class MobileProvision
-    def initialize(path)
-      @path = path
+  # Apple code signing: provisioning profile parser
+  # @see https://developer.apple.com/documentation/technotes/tn3125-inside-code-signing-provisioning-profiles
+  class MobileProvision < File
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::APPLE
+    end
+
+    # @return [Symbol] {OperaSystem}
+    def opera_system
+      case opera_systems[0]
+      when :macos
+        OperaSystem::MACOS
+      when :ios
+        OperaSystem::IOS
+      else
+        raise NotImplementedError, "Unkonwn opera_system: #{opera_systems[0]}"
+      end
     end
 
+    # @return [String, nil]
     def name
       mobileprovision.try(:[], 'Name')
     end
 
+    # @return [String, nil]
     def app_name
       mobileprovision.try(:[], 'AppIDName')
     end
 
+    # @return [Symbol, nil]
     def type
       return :development if development?
       return :adhoc if adhoc?
@@ -25,7 +42,8 @@ module AppInfo
       return :enterprise if enterprise?
     end
 
-    def platforms
+    # @return [Array<Symbol>]
+    def opera_systems
       return unless platforms = mobileprovision.try(:[], 'Platform')
 
       platforms.map do |v|
@@ -34,83 +52,100 @@ module AppInfo
       end
     end
 
-    def platform
-      platforms[0]
-    end
-
+    # @return [Array<String>, nil]
     def devices
       mobileprovision.try(:[], 'ProvisionedDevices')
     end
 
+    # @return [String, nil]
     def team_identifier
       mobileprovision.try(:[], 'TeamIdentifier')
     end
 
+    # @return [String, nil]
     def team_name
       mobileprovision.try(:[], 'TeamName')
     end
 
+    # @return [String, nil]
     def profile_name
       mobileprovision.try(:[], 'Name')
     end
 
+    # @return [String, nil]
     def created_date
       mobileprovision.try(:[], 'CreationDate')
     end
 
+    # @return [String, nil]
     def expired_date
       mobileprovision.try(:[], 'ExpirationDate')
     end
 
+    # @return [Array<String>, nil]
     def entitlements
       mobileprovision.try(:[], 'Entitlements')
     end
 
+    # return developer certificates.
+    #
+    # @deprecated Use {#certificates} instead of this method.
     def developer_certs
+      certificates
+    end
+
+    # return developer certificates.
+    #
+    # @return [Array<Certificate>]
+    def certificates
       certs = mobileprovision.try(:[], 'DeveloperCertificates')
       return if certs.empty?
 
-      certs.each_with_object([]) do |cert, obj|
-        obj << DeveloperCertificate.new(cert)
+      certs.each_with_object([]) do |cert_data, obj|
+        obj << Certificate.parse(cert_data)
       end
     end
 
     # Detect is development type of mobileprovision
     #
-    # related link: https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    # @see https://stackoverflow.com/questions/1003066/what-does-get-task-allow-do-in-xcode
+    # @return [Boolea]
     def development?
-      case platform.downcase.to_sym
-      when :ios
+      case opera_system
+      when OperaSystem::IOS
         entitlements['get-task-allow'] == true
-      when :macos
+      when OperaSystem::MACOS
         !devices.nil?
       else
-        raise Error, "Not implement with platform: #{platform}"
+        raise NotImplementedError, "Unknown opera_system: #{opera_system}"
       end
     end
 
     # Detect app store type
     #
-    # related link: https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    # @see https://developer.apple.com/library/archive/qa/qa1830/_index.html
+    # @return [Boolea]
     def appstore?
-      case platform.downcase.to_sym
-      when :ios
+      case opera_system
+      when OperaSystem::IOS
         !development? && entitlements.key?('beta-reports-active')
-      when :macos
+      when OperaSystem::MACOS
         !development?
       else
-        raise Error, "Not implement with platform: #{platform}"
+        raise NotImplementedError, "Unknown opera_system: #{opera_system}"
       end
     end
 
+    # @return [Boolea]
     def adhoc?
-      return false if platform == :macos # macOS no need adhoc
+      return false if opera_system == OperaSystem::MACOS # macOS no need adhoc
 
       !development? && !devices.nil?
     end
 
+    # @return [Boolea]
     def enterprise?
-      return false if platform == :macos # macOS no need adhoc
+      return false if opera_system == OperaSystem::MACOS # macOS no need adhoc
 
       !development? && !adhoc? && !appstore?
     end
@@ -118,7 +153,8 @@ module AppInfo
 
     # Enabled Capabilites
     #
-    # Related link: https://developer.apple.com/support/app-capabilities/
+    # @see https://developer.apple.com/support/app-capabilities/
+    # @return [Array<String>]
     def enabled_capabilities
       capabilities = []
       capabilities << 'In-App Purchase' << 'GameKit' if adhoc? || appstore?
@@ -142,10 +178,10 @@ module AppInfo
         when 'com.apple.developer.networking.vpn.api'
           capabilities << 'Personal VPN'
         when 'com.apple.developer.healthkit',
-             'com.apple.developer.healthkit.access'
+            'com.apple.developer.healthkit.access'
           capabilities << 'HealthKit' unless capabilities.include?('HealthKit')
         when 'com.apple.developer.icloud-services',
-             'com.apple.developer.icloud-container-identifiers'
+            'com.apple.developer.icloud-container-identifiers'
           capabilities << 'iCloud' unless capabilities.include?('iCloud')
         when 'com.apple.developer.in-app-payments'
           capabilities << 'Apple Pay'
@@ -192,18 +228,21 @@ module AppInfo
       capabilities
     end
 
+    # @return [String, nil]
     def [](key)
       mobileprovision.try(:[], key.to_s)
     end
 
+    # @return [Boolea]
     def empty?
       mobileprovision.nil?
     end
 
+    # @return [CFPropertyList]
     def mobileprovision
-      return @mobileprovision = nil unless File.exist?(@path)
+      return @mobileprovision = nil unless ::File.exist?(@file)
 
-      data = File.read(@path)
+      data = ::File.read(@file)
       data = strip_plist_wrapper(data) unless bplist?(data)
       list = CFPropertyList::List.new(data: data).value
       @mobileprovision = CFPropertyList.native_types(list)
@@ -235,26 +274,5 @@ module AppInfo
       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].force_encoding('UTF-8')
-      end
-
-      def created_date
-        @raw.not_after
-      end
-
-      def expired_date
-        @raw.not_before
-      end
-    end
   end
 end

data/lib/app_info/pe.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+require 'pedump'
+require 'fileutils'
+require 'forwardable'
+
+module AppInfo
+  # Windows PE parser
+  #
+  # @see https://learn.microsoft.com/zh-cn/windows/win32/debug/pe-format Microsoft PE Format
+  class PE < File
+    include Helper::HumanFileSize
+    include Helper::Archive
+    extend Forwardable
+
+    ARCH = {
+      0x014c => 'x86',
+      0x0200 => 'Intel Itanium',
+      0x8664 => 'x64',
+      0x1c0 => 'arm',
+      0xaa64 => 'arm64',
+      0x5032 => 'RISC-v 32',
+      0x5064 => 'RISC-v 64',
+      0x5128 => 'RISC-v 128'
+    }.freeze
+
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::WINDOWS
+    end
+
+    # @return [Symbol] {OperaSystem}
+    def opera_system
+      OperaSystem::WINDOWS
+    end
+
+    # @return [Symbol] {Device}
+    def device
+      Device::WINDOWS
+    end
+
+    # return file size
+    # @example Read file size in integer
+    #   aab.size                    # => 3618865
+    #
+    # @example Read file size in human readabale
+    #   aab.size(human_size: true)  # => '3.45 MB'
+    #
+    # @param [Boolean] human_size Convert integer value to human readable.
+    # @return [Integer, String]
+    def size(human_size: false)
+      file_to_human_size(@file, human_size: human_size)
+    end
+
+    def binary_size(human_size: false)
+      file_to_human_size(binary_file, human_size: human_size)
+    end
+
+    # @!method product_name
+    #   @see VersionInfo#product_name
+    #   @return [String]
+    # @!method product_version
+    #   @see VersionInfo#product_version
+    #   @return [String]
+    # @!method company_name
+    #   @see VersionInfo#company_name
+    #   @return [String]
+    # @!method assembly_version
+    #   @see VersionInfo#assembly_version
+    #   @return [String]
+    def_delegators :version_info, :product_name, :product_version, :company_name, :assembly_version
+
+    alias name product_name
+    alias release_version product_version
+    alias build_version assembly_version
+
+    # @return [String]
+    def archs
+      ARCH[image_file_header.Machine] || 'unknown'
+    end
+    alias architectures archs
+
+    # @return [Hash{String => String}] imports imports of libraries
+    def imports
+      @imports ||= pe.imports.each_with_object({}) do |import, obj|
+        obj[import.module_name] = import.first_thunk.map(&:name).compact
+      end
+    end
+
+    # @return [Array{String}] icons paths of bmp image icons
+    def icons
+      @icons ||= lambda {
+        # Fetch the largest size icon
+        files = []
+        pe.resources&.find_all do |res|
+          next unless res.type == 'ICON'
+
+          filename = "#{::File.basename(file, '.*')}-#{res.type}-#{res.id}.bmp"
+          icon_file = tempdir(filename, prefix: 'pe', system: true)
+          mask_icon_file = icon_file.sub('.bmp', '.mask.bmp')
+
+          begin
+            ::File.open(icon_file, 'wb') do |f|
+              f << res.restore_bitmap(io)
+            end
+
+            if res.bitmap_mask(io)
+              mask_icon_file = icon_file.sub('.bmp', '.mask.bmp')
+              ::File.open(mask_icon_file, 'wb') do |f|
+                f << res.bitmap_mask(io)
+              end
+            end
+          rescue StandardError => e
+            # ignore pedump throws any exception.
+            raise e unless e.backtrace.first.include?('pedump')
+
+            FileUtils.rm_f(icon_file)
+          ensure
+            next unless ::File.exist?(icon_file)
+
+            mask_file = ::File.exist?(mask_icon_file) ? mask_icon_file : nil
+            files << icon_metadata(icon_file, mask_file: mask_file)
+          end
+        end
+
+        files
+      }.call
+    end
+
+    # @return [PEdump]
+    def pe
+      @pe ||= lambda {
+        pe = PEdump.new(io)
+        pe.logger.level = Logger::FATAL # ignore :warn logger output
+        pe
+      }.call
+    end
+
+    # @return [VersionInfo]
+    def version_info
+      @version_info ||= VersionInfo.new(pe.version_info)
+    end
+
+    def clear!
+      @io = nil
+      @pe = nil
+      @icons = nil
+      @imports = nil
+    end
+
+    # @return [String] binary_file path
+    def binary_file
+      @binary_file ||= lambda {
+        file_io = ::File.open(@file, 'rb')
+        return @file unless file_io.read(100) =~ AppInfo::ZIP_RETGEX
+
+        zip_file = Zip::File.open(@file)
+        zip_entry = zip_file.glob('*.exe').first
+        raise NotFoundError, 'Not found .exe file in archive file' if zip_entry.nil?
+
+        exe_file = tempdir(zip_entry.name, prefix: 'pe-exe', system: true)
+        zip_entry.extract(exe_file)
+        zip_file.close
+
+        return exe_file
+      }.call
+    end
+
+    private
+
+    def image_file_header
+      @image_file_header ||= pe.pe.image_file_header
+    end
+
+    # @return [Hash{Symbol => String}]
+    def icon_metadata(file, mask_file: nil)
+      {
+        name: ::File.basename(file),
+        file: file,
+        mask: mask_file,
+        dimensions: ImageSize.path(file).size
+      }
+    end
+
+    # @return [File]
+    def io
+      @io ||= ::File.open(binary_file, 'rb')
+    end
+
+    # VersionInfo class
+    #
+    # Ref: https://learn.microsoft.com/zh-cn/windows/win32/menurc/versioninfo-resource
+    class VersionInfo
+      def initialize(raw)
+        @raw = raw
+      end
+
+      # @return [String]
+      def company_name
+        @company_name ||= value_of('CompanyName')
+      end
+
+      # @return [String]
+      def product_name
+        @product_name ||= value_of('ProductName')
+      end
+
+      # @return [String]
+      def product_version
+        @product_version ||= value_of('ProductVersion')
+      end
+
+      # @return [String]
+      def assembly_version
+        @assembly_version ||= value_of('Assembly Version')
+      end
+
+      # @return [String]
+      def file_version
+        @file_version ||= value_of('FileVersion')
+      end
+
+      # @return [String]
+      def file_description
+        @file_description ||= value_of('FileDescription')
+      end
+
+      # @return [String]
+      def copyright
+        @copyright ||= value_of('LegalCopyright')
+      end
+
+      private
+
+      def value_of(key)
+        info.each do |v|
+          return v[:Value] if v[:szKey] == key.to_s
+        end
+
+        nil
+      end
+
+      def info
+        return @info if @info
+
+        @raw.each do |item|
+          next unless item.is_a?(PEdump::VS_VERSIONINFO)
+
+          versions = item[:Children].select { |v| v.is_a?(PEdump::StringFileInfo) }
+          next if versions.empty?
+
+          @info = versions[0][:Children][0][:Children]
+          return @info
+        end
+
+        @info = []
+      end
+    end
+  end
+end

data/lib/app_info/png_uncrush.rb

@@ -7,9 +7,10 @@ require 'zlib'
 require 'stringio'
 
 module AppInfo
+  # Decompress iOS Png image file.
+  # @see https://github.com/swcai/iphone-png-normalizer swcai/iphone-png-normalizer
+  # @author Wenwei Cai
   class PngUncrush
-    class Error < StandardError; end
-
     class FormatError < Error; end
 
     class PngReader # :nodoc:
@@ -31,18 +32,24 @@ module AppInfo
         @data = String.new
       end
 
+      # @return [Integer]
       def size
         @io.size
       end
 
+      # @param [String] format
+      # @return [String]
+      # @see IO package data
       def unpack(format)
         @io.unpack(format)
       end
 
+      # @return [String]
       def header
         @header ||= self[0, 8]
       end
 
+      # @return [Boolean]
       def png?
         header.bytes == PNG_HEADER
       end
@@ -60,23 +67,36 @@ module AppInfo
       end
     end
 
+    # Decompress crushed png file.
+    # @param [String] input path of png file
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def self.decompress(input, output)
       new(input).decompress(output)
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def self.dimensions(input)
       new(input).dimensions
     end
 
     def initialize(filename)
-      @io = PngReader.new(File.open(filename))
+      @io = PngReader.new(::File.open(filename))
       raise FormatError, 'not a png file' unless @io.png?
     end
 
+    # get png dimensions
+    # @param [String] input path of png file
+    # @return [Array<Integer>] dimensions width, height value of png file
     def dimensions
       _dump_sections(dimensions: true)
     end
 
+    # Decompress crushed png file.
+    # @param [String] output path of output file
+    # @return [Boolean] result whether decompress successfully
     def decompress(output)
       content = _remap(_dump_sections)
       return false unless content
@@ -125,7 +145,7 @@ module AppInfo
     end
 
     def write_file(path, content)
-      File.write(path, content, encoding: Encoding::BINARY)
+      ::File.write(path, content, encoding: Encoding::BINARY)
       true
     end
 

data/lib/app_info/proguard.rb

@@ -5,52 +5,59 @@ require 'rexml/document'
 
 module AppInfo
   # Proguard parser
-  class Proguard
+  class Proguard < File
     include Helper::Archive
 
     NAMESPACE = UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, 'icyleaf.com')
 
-    attr_reader :file
-
-    def initialize(file)
-      @file = file
+    # @return [Symbol] {Platform}
+    def platform
+      Platform::GOOGLE
     end
 
-    def file_type
-      Platform::PROGUARD
+    # @return [Symbol] {OperaSystem}
+    def opera_system
+      OperaSystem::ANDROID
     end
 
+    # @return [String]
     def uuid
       # Similar to https://docs.sentry.io/workflow/debug-files/#proguard-uuids
-      UUIDTools::UUID.sha1_create(NAMESPACE, File.read(mapping_path)).to_s
+      UUIDTools::UUID.sha1_create(NAMESPACE, ::File.read(mapping_path)).to_s
     end
     alias debug_id uuid
 
+    # @return [Boolean]
     def mapping?
-      File.exist?(mapping_path)
+      ::File.exist?(mapping_path)
     end
 
+    # @return [Boolean]
     def manifest?
-      File.exist?(manifest_path)
+      ::File.exist?(manifest_path)
     end
 
+    # @return [Boolean]
     def symbol?
-      File.exist?(symbol_path)
+      ::File.exist?(symbol_path)
     end
     alias resource? symbol?
 
+    # @return [String, nil]
     def package_name
       return unless manifest?
 
       manifest.root.attributes['package']
     end
 
+    # @return [String, nil]
     def releasd_version
       return unless manifest?
 
       manifest.root.attributes['package']
     end
 
+    # @return [String, nil]
     def version_name
       return unless manifest?
 
@@ -58,6 +65,7 @@ module AppInfo
     end
     alias release_version version_name
 
+    # @return [String, nil]
     def version_code
       return unless manifest?
 
@@ -65,27 +73,32 @@ module AppInfo
     end
     alias build_version version_code
 
+    # @return [REXML::Document]
     def manifest
       return unless manifest?
 
-      @manifest ||= REXML::Document.new(File.new(manifest_path))
+      @manifest ||= REXML::Document.new(::File.new(manifest_path))
     end
 
+    # @return [String]
     def mapping_path
-      @mapping_path ||= Dir.glob(File.join(contents, '*mapping*.txt')).first
+      @mapping_path ||= Dir.glob(::File.join(contents, '*mapping*.txt')).first
     end
 
+    # @return [String]
     def manifest_path
-      @manifest_path ||= File.join(contents, 'AndroidManifest.xml')
+      @manifest_path ||= ::File.join(contents, 'AndroidManifest.xml')
     end
 
+    # @return [String]
     def symbol_path
-      @symbol_path ||= File.join(contents, 'R.txt')
+      @symbol_path ||= ::File.join(contents, 'R.txt')
     end
     alias resource_path symbol_path
 
+    # @return [String] contents path of contents
     def contents
-      @contents ||= unarchive(@file, path: 'proguard')
+      @contents ||= unarchive(@file, prefix: 'proguard')
     end
 
     def clear!