app-info 2.8.2 → 3.0.0

data/lib/app_info/apple.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'macho'
+require 'fileutils'
+require 'forwardable'
+require 'cfpropertylist'
+
+module AppInfo
+  # Apple base parser for ipa and macos file
+  class Apple < File
+    extend Forwardable
+    include Helper::HumanFileSize
+    include Helper::Archive
+
+    # Export types
+    module ExportType
+      # debug configuration
+      DEBUG = :debug
+      # adhoc configuration (iOS only)
+      ADHOC = :adhoc
+      # enterprise configuration (iOS only)
+      ENTERPRISE = :enterprise
+      # release configuration
+      RELEASE = :release
+      # release configuration but download from App Store
+      APPSTORE = :appstore
+    end
+
+    # @return [Symbol] {Manufacturer}
+    def manufacturer
+      Manufacturer::APPLE
+    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
+
+    # @!method device
+    #   @see InfoPlist#device
+    # @!method platform
+    #   @see InfoPlist#platform
+    # @!method iphone?
+    #   @see InfoPlist#iphone?
+    # @!method ipad?
+    #   @see InfoPlist#ipad?
+    # @!method universal?
+    #   @see InfoPlist#universal?
+    # @!method build_version
+    #   @see InfoPlist#build_version
+    # @!method name
+    #   @see InfoPlist#name
+    # @!method release_version
+    #   @see InfoPlist#release_version
+    # @!method identifier
+    #   @see InfoPlist#identifier
+    # @!method bundle_id
+    #   @see InfoPlist#bundle_id
+    # @!method display_name
+    #   @see InfoPlist#display_name
+    # @!method bundle_name
+    #   @see InfoPlist#bundle_name
+    # @!method min_sdk_version
+    #   @see InfoPlist#min_sdk_version
+    # @!method min_os_version
+    #   @see InfoPlist#min_os_version
+    def_delegators :info, :device, :platform, :iphone?, :ipad?, :universal?, :macos?,
+                   :build_version, :name, :release_version, :identifier, :bundle_id,
+                   :display_name, :bundle_name, :min_sdk_version, :min_os_version
+
+    # @!method devices
+    #   @see MobileProvision#devices
+    # @!method team_name
+    #   @see MobileProvision#team_name
+    # @!method team_identifier
+    #   @see MobileProvision#team_identifier
+    # @!method profile_name
+    #   @see MobileProvision#profile_name
+    # @!method expired_date
+    #   @see MobileProvision#expired_date
+    def_delegators :mobileprovision, :devices, :team_name, :team_identifier,
+                   :profile_name, :expired_date
+
+    # @return [String, nil]
+    def distribution_name
+      "#{profile_name} - #{team_name}" if profile_name && team_name
+    end
+
+    # @return [String]
+    def release_type
+      if stored?
+        ExportType::APPSTORE
+      else
+        build_type
+      end
+    end
+
+    # return iOS build configuration, not correct in macOS app.
+    # @return [String]
+    def build_type
+      if mobileprovision?
+        return ExportType::RELEASE if macos?
+
+        devices ? ExportType::ADHOC : ExportType::ENTERPRISE
+      else
+        ExportType::DEBUG
+      end
+    end
+
+    # @return [Array<MachO>, nil]
+    def archs
+      return unless ::File.exist?(binary_path)
+
+      file = MachO.open(binary_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
+
+    # @abstract Subclass and override {#icons} to implement.
+    def icons(_uncrush: true)
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#stored?} to implement.
+    def stored?
+      not_implemented_error!(__method__)
+    end
+
+    # force remove developer certificate data from {#mobileprovision} method
+    # @return [nil]
+    def hide_developer_certificates
+      mobileprovision.delete('DeveloperCertificates') if mobileprovision?
+    end
+
+    # @return [MobileProvision]
+    def mobileprovision
+      return unless mobileprovision?
+
+      @mobileprovision ||= MobileProvision.new(mobileprovision_path)
+    end
+
+    # @return [Boolean]
+    def mobileprovision?
+      ::File.exist?(mobileprovision_path)
+    end
+
+    # @abstract Subclass and override {#mobileprovision_path} to implement.
+    def mobileprovision_path
+      not_implemented_error!(__method__)
+    end
+
+    # @return [InfoPlist]
+    def info
+      @info ||= InfoPlist.new(info_path)
+    end
+
+    # @abstract Subclass and override {#info_path} to implement.
+    def info_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#app_path} to implement.
+    def app_path
+      not_implemented_error!(__method__)
+    end
+
+    # @abstract Subclass and override {#clear!} to implement.
+    def clear!
+      not_implemented_error!(__method__)
+    end
+
+    # @return [String] contents path of contents
+    def contents
+      @contents ||= unarchive(@file, prefix: format.to_s)
+    end
+  end
+end

data/lib/app_info/certificate.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module AppInfo
+  # Certificate wrapper for
+  # {https://docs.ruby-lang.org/en/3.0/OpenSSL/X509/Certificate.html OpenSSL::X509::Certifiate}.
+  class Certificate
+    # Parse Raw data into X509 cerificate wrapper
+    # @param [String] certificate raw data
+    # @return [AppInfo::Certificate]
+    def self.parse(data)
+      cert = OpenSSL::X509::Certificate.new(data)
+      new(cert)
+    end
+
+    # @param [OpenSSL::X509::Certificate] certificate
+    def initialize(cert)
+      @cert = cert
+    end
+
+    # return version of certificate
+    # @param [String] prefix
+    # @param [Integer] base
+    # @return [String] version
+    def version(prefix: 'v', base: 1)
+      "#{prefix}#{raw.version + base}"
+    end
+
+    # return serial of certificate
+    # @param [Integer] base
+    # @param [Symbol] transform avaiables in :lower, :upper
+    # @param [String] prefix
+    # @return [String] serial
+    def serial(base = 10, transform: :lower, prefix: nil)
+      serial = raw.serial.to_s(base)
+      serial = transform == :lower ? serial.downcase : serial.upcase
+      return serial unless prefix
+
+      "#{prefix}#{serial}"
+    end
+
+    # return issuer from DN, similar to {#subject}.
+    #
+    # Example:
+    #
+    # @param [Symbol] format avaiables in `:to_a`, `:to_s` and `:raw`
+    # @return [Array, String, OpenSSL::X509::Name] the object converted into the expected format.
+    def issuer(format: :raw)
+      convert_cert_name(raw.issuer, format: format)
+    end
+
+    # return subject from DN, similar to {#issuer}.
+    # @param [Symbol] format avaiables in `:to_a`, `:to_s` and `:raw`
+    # @return [Array, String, OpenSSL::X509::Name] the object converted into the expected format.
+    def subject(format: :raw)
+      convert_cert_name(raw.subject, format: format)
+    end
+
+    # @return [Time]
+    def created_at
+      raw.not_before
+    end
+
+    # @return [Time]
+    def expired_at
+      raw.not_after
+    end
+
+    # @return [Boolean]
+    def expired?
+      expired_at < Time.now.utc
+    end
+
+    # @return [String] format always be :x509.
+    def format
+      :x509
+    end
+
+    # return algorithm digest
+    #
+    # OpenSSL supported digests:
+    #
+    # -blake2b512                -blake2s256                -md4
+    # -md5                       -md5-sha1                  -mdc2
+    # -ripemd                    -ripemd160                 -rmd160
+    # -sha1                      -sha224                    -sha256
+    # -sha3-224                  -sha3-256                  -sha3-384
+    # -sha3-512                  -sha384                    -sha512
+    # -sha512-224                -sha512-256                -shake128
+    # -shake256                  -sm3                       -ssl3-md5
+    # -ssl3-sha1                 -whirlpool
+    def digest
+      signature_algorithm = raw.signature_algorithm
+
+      case signature_algorithm
+      when /md5/
+        :md5
+      when /sha1/
+        :sha1
+      when /sha224/
+        :sha224
+      when /sha256/
+        :sha256
+      when /sha512/
+        :sha512
+      else
+        # Android signature no need the others
+        signature_algorithm.to_sym
+      end
+    end
+
+    # return algorithm name of public key
+    def algorithm
+      case public_key
+      when OpenSSL::PKey::RSA then :rsa
+      when OpenSSL::PKey::DSA then :dsa
+      when OpenSSL::PKey::DH  then :dh
+      when OpenSSL::PKey::EC  then :ec
+      end
+    end
+
+    # return length of public key
+    # @return [Integer]
+    # @raise NotImplementedError
+    def length
+      case public_key
+      when OpenSSL::PKey::RSA
+        public_key.n.num_bits
+      when OpenSSL::PKey::DSA, OpenSSL::PKey::DH
+        public_key.p.num_bits
+      when OpenSSL::PKey::EC
+        raise NotImplementedError, "key length for #{public_key.inspect} not implemented"
+      end
+    end
+    alias size length
+
+    # return fingerprint of certificate
+    # @return [String]
+    def fingerprint(name = :sha256, transform: :lower, delimiter: nil)
+      digest = OpenSSL::Digest.new(name.to_s.upcase)
+      digest.update(raw.to_der)
+      fingerprint = digest.to_s
+      fingerprint = fingerprint.upcase if transform.to_sym == :upper
+      return fingerprint unless delimiter
+
+      fingerprint.scan(/../).join(delimiter)
+    end
+
+    # Orginal OpenSSL X509 certificate
+    # @return [OpenSSL::X509::Certificate]
+    def raw
+      @cert
+    end
+
+    private
+
+    def convert_cert_name(name, format:)
+      data = name.to_a
+      case format
+      when :to_a
+        data.map { |k, v, _| [k, v] }
+      when :to_s
+        data.map { |k, v, _| "#{k}=#{v}" }.join(' ')
+      else
+        name
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      @cert.send(method.to_sym, *args, &block) || super
+    end
+
+    def respond_to_missing?(method, *args)
+      @cert.respond_to?(method.to_sym) || super
+    end
+  end
+end

data/lib/app_info/const.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module AppInfo
+  # Full Format
+  module Format
+    # Apple
+
+    INFOPLIST = :infoplist
+    MOBILEPROVISION = :mobileprovision
+    DSYM = :dsym
+
+    # macOS
+
+    MACOS = :macos
+
+    # iOS
+
+    IPA = :ipa
+
+    # Android
+
+    APK = :apk
+    AAB = :aab
+    PROGUARD = :proguard
+
+    # Windows
+
+    PE = :pe
+
+    UNKNOWN = :unknown
+  end
+
+  # Manufacturer
+  module Manufacturer
+    APPLE = :apple
+    GOOGLE = :google
+    MICROSOFT = :microsoft
+  end
+
+  # Platform
+  module Platform
+    MACOS = :macos
+    IOS = :ios
+    ANDROID = :android
+    WINDOWS = :windows
+  end
+
+  # Apple Device Type
+  module Device
+    # macOS
+    MACOS = :macos
+
+    # Apple iPhone
+    IPHONE = :iphone
+    # Apple iPad
+    IPAD = :ipad
+    # Apple Watch
+    IWATCH = :iwatch # not implemented yet
+    # Apple Universal (iPhone and iPad)
+    UNIVERSAL = :universal
+
+    # Android Phone
+    PHONE = :phone
+    # Android Tablet (not implemented yet)
+    TABLET = :tablet
+    # Android Watch
+    WATCH = :watch
+    # Android TV
+    TELEVISION = :television
+    # Android Car Automotive
+    AUTOMOTIVE = :automotive
+
+    # Windows
+    WINDOWS = :windows
+  end
+end

data/lib/app_info/core_ext/object/try.rb

@@ -4,7 +4,8 @@
 # Copy from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb
 
 module AppInfo
-  module Tryable # :nodoc:
+  # @!visibility private
+  module Tryable
     ##
     # :method: try
     #
@@ -107,6 +108,7 @@ module AppInfo
   end
 end
 
+# @!visibility private
 class Object
   include AppInfo::Tryable
 end

data/lib/app_info/core_ext/string/inflector.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module AppInfo
+  # @!visibility private
   module Inflector
     def ai_snakecase
       gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
@@ -30,6 +31,7 @@ module AppInfo
   end
 end
 
+# @!visibility private
 class String
   include AppInfo::Inflector
 end

data/lib/app_info/dsym/debug_info.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'app_info/dsym/macho'
+
+module AppInfo
+  class DSYM < File
+    # DSYM Debug Information Format Struct
+    class DebugInfo
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      # @return [String]
+      def object
+        @object ||= ::File.basename(bin_path)
+      end
+
+      # @return [::MachO::MachOFile, ::MachO::FatFile]
+      def macho_type
+        @macho_type ||= ::MachO.open(bin_path)
+      end
+
+      # @return [Array<AppInfo::DSYM::MachO>]
+      def machos
+        @machos ||= case macho_type
+                    when ::MachO::MachOFile
+                      [MachO.new(macho_type, ::File.size(bin_path))]
+                    else
+                      size = macho_type.fat_archs.each_with_object([]) do |arch, obj|
+                        obj << arch.size
+                      end
+
+                      machos = []
+                      macho_type.machos.each_with_index do |file, i|
+                        machos << MachO.new(file, size[i])
+                      end
+                      machos
+                    end
+      end
+
+      # @return [String, nil]
+      def release_version
+        info.try(:[], 'CFBundleShortVersionString')
+      end
+
+      # @return [String, nil]
+      def build_version
+        info.try(:[], 'CFBundleVersion')
+      end
+
+      # @return [String, nil]
+      def identifier
+        info.try(:[], 'CFBundleIdentifier').sub('com.apple.xcode.dsym.', '')
+      end
+      alias bundle_id identifier
+
+      # @return [CFPropertyList]
+      def info
+        return nil unless ::File.exist?(info_path)
+
+        @info ||= CFPropertyList.native_types(CFPropertyList::List.new(file: info_path).value)
+      end
+
+      # @return [String]
+      def info_path
+        @info_path ||= ::File.join(path, 'Contents', 'Info.plist')
+      end
+
+      # @return [String]
+      def bin_path
+        @bin_path ||= lambda {
+          dwarf_path = ::File.join(path, 'Contents', 'Resources', 'DWARF')
+          name = Dir.children(dwarf_path)[0]
+          ::File.join(dwarf_path, name)
+        }.call
+      end
+    end
+  end
+end

data/lib/app_info/dsym/macho.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'macho'
+
+module AppInfo
+  class DSYM < File
+    # Mach-O Struct
+    class MachO
+      include Helper::HumanFileSize
+
+      def initialize(file, size = 0)
+        @file = file
+        @size = size
+      end
+
+      # @return [String]
+      def cpu_name
+        @file.cpusubtype
+      end
+
+      # @return [String]
+      def cpu_type
+        @file.cputype
+      end
+
+      # @return [String]
+      def type
+        @file.filetype
+      end
+
+      # @return [String, Integer]
+      def size(human_size: false)
+        return number_to_human_size(@size) if human_size
+
+        @size
+      end
+
+      # @return [String]
+      def uuid
+        @file[:LC_UUID][0].uuid_string
+      end
+      alias debug_id uuid
+
+      # @return [::MachO::Headers]
+      def header
+        @header ||= @file.header
+      end
+
+      # @return [Hash{Symbol => String, Integer}]
+      def to_h
+        {
+          uuid: uuid,
+          type: type,
+          cpu_name: cpu_name,
+          cpu_type: cpu_type,
+          size: size,
+          human_size: size(human_size: true)
+        }
+      end
+    end
+  end
+end