app-info 2.8.4 → 3.0.0.beta1

data/lib/app_info/apk.rb

@@ -5,8 +5,8 @@ require 'image_size'
 require 'forwardable'
 
 module AppInfo
-  # Parse APK file
-  class APK
+  # Parse APK file parser, wrapper for {https://github.com/icyleaf/android_parser android_parser}.
+  class APK < File
     include Helper::HumanFileSize
     extend Forwardable
 
@@ -21,18 +21,26 @@ module AppInfo
       AUTOMOTIVE  = 'Automotive'
     end
 
-    def initialize(file)
-      @file = file
-    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 os
+    def file_type
+      Format::APK
+    end
+
+    def platform
       Platform::ANDROID
     end
-    alias file_type os
 
     def_delegators :apk, :manifest, :resource, :dex
 
@@ -86,28 +94,25 @@ module AppInfo
     end
     alias min_os_version min_sdk_version
 
-    def sign_version
-      return 'v1' unless signs.empty?
-
-      # when ?
-      # https://source.android.com/security/apksigning/v2?hl=zh-cn
-      #   'v2'
-      # when ?
-      # https://source.android.com/security/apksigning/v3?hl=zh-cn
-      #   'v3'
-      'unknown'
+    # Return multi version certifiates of signatures
+    # @return [Array<Hash>]
+    # @see AppInfo::Android::Signature.verify
+    def signatures
+      @signatures ||= Android::Signature.verify(self)
     end
 
+    # Legacy v1 scheme signatures, it will remove soon.
+    # @deprecated Use {#signatures}
+    # @return [Array<OpenSSL::PKCS7, nil>]
     def signs
-      apk.signs.each_with_object([]) do |(path, sign), obj|
-        obj << Sign.new(path, sign)
-      end
+      @signs ||= v1sign&.signatures || []
     end
 
+    # Legacy v1 scheme certificates, it will remove soon.
+    # @deprecated Use {#signatures}
+    # @return [Array<OpenSSL::PKCS7, nil>]
     def certificates
-      apk.certificates.each_with_object([]) do |(path, certificate), obj|
-        obj << Certificate.new(path, certificate)
-      end
+      @certificates ||= v1sign&.certificates || []
     end
 
     def activities
@@ -118,13 +123,17 @@ module AppInfo
       @apk ||= ::Android::Apk.new(@file)
     end
 
+    def zip
+      @zip ||= apk.instance_variable_get(:@zip)
+    end
+
     def icons
       @icons ||= apk.icon.each_with_object([]) do |(path, data), obj|
-        icon_name = File.basename(path)
-        icon_path = File.join(contents, File.dirname(path))
-        icon_file = File.join(icon_path, icon_name)
+        icon_name = ::File.basename(path)
+        icon_path = ::File.join(contents, ::File.dirname(path))
+        icon_file = ::File.join(icon_path, icon_name)
         FileUtils.mkdir_p icon_path
-        File.write(icon_file, data, encoding: Encoding::BINARY)
+        ::File.write(icon_file, data, encoding: Encoding::BINARY)
 
         obj << {
           name: icon_name,
@@ -147,27 +156,15 @@ module AppInfo
     end
 
     def contents
-      @contents ||= File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
+      @contents ||= ::File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
     end
 
-    # Android Certificate
-    class Certificate
-      attr_reader :path, :certificate
+    private
 
-      def initialize(path, certificate)
-        @path = path
-        @certificate = certificate
-      end
-    end
-
-    # Android Sign
-    class Sign
-      attr_reader :path, :sign
-
-      def initialize(path, sign)
-        @path = path
-        @sign = sign
-      end
+    def v1sign
+      @v1sign ||= Android::Signature::V1.verify(self)
+    rescue Android::Signature::NotFoundError
+      nil
     end
   end
 end

data/lib/app_info/certificate.rb

@@ -0,0 +1,181 @@
+# 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
+    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
+
+    def created_at
+      raw.not_before
+    end
+
+    def expired_at
+      raw.not_after
+    end
+
+    def expired?
+      expired_at < Time.now.utc
+    end
+
+    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 size of public key
+    def size
+      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 size for #{public_key.inspect} not implemented"
+      end
+    end
+
+    # return fingerprint of certificate
+    def fingerprint(name = :sha256, transform: :lower, delimiter: nil)
+      digest = OpenSSL::Digest.new(name.to_s.upcase)
+      # digest = case name.to_sym
+      #          when :sha1
+      #            OpenSSL::Digest::SHA1.new
+      #          when :sha224
+      #            OpenSSL::Digest::SHA224.new
+      #          when :sha384
+      #            OpenSSL::Digest::SHA384.new
+      #          when :sha512
+      #            OpenSSL::Digest::SHA512.new
+      #          when :md5
+      #            OpenSSL::Digest::MD5.new
+      #          else
+      #            OpenSSL::Digest::SHA256.new
+      #          end
+
+      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
+    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.include?(method.to_sym) || super
+    end
+  end
+end

data/lib/app_info/const.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AppInfo
+  # Full Format
+  module Format
+    # iOS
+    IPA = :ipa
+    INFOPLIST = :infoplist
+    MOBILEPROVISION = :mobileprovision
+    DSYM = :dsym
+
+    # Android
+    APK = :apk
+    AAB = :aab
+    PROGUARD = :proguard
+
+    # macOS
+    MACOS = :macos
+
+    # Windows
+    PE = :pe
+
+    UNKNOWN = :unknown
+  end
+
+  # Platform
+  module Platform
+    WINDOWS = 'Windows'
+    MACOS = 'macOS'
+    IOS = 'iOS'
+    ANDROID = 'Android'
+  end
+
+  # Apple Device Type
+  module Device
+    MACOS = 'macOS'
+    IPHONE = 'iPhone'
+    IPAD = 'iPad'
+    UNIVERSAL = 'Universal'
+  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,72 @@
+# 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
+
+      def object
+        @object ||= ::File.basename(bin_path)
+      end
+
+      def macho_type
+        @macho_type ||= ::MachO.open(bin_path)
+      end
+
+      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
+
+      def release_version
+        info.try(:[], 'CFBundleShortVersionString')
+      end
+
+      def build_version
+        info.try(:[], 'CFBundleVersion')
+      end
+
+      def identifier
+        info.try(:[], 'CFBundleIdentifier').sub('com.apple.xcode.dsym.', '')
+      end
+      alias bundle_id identifier
+
+      def info
+        return nil unless ::File.exist?(info_path)
+
+        @info ||= CFPropertyList.native_types(CFPropertyList::List.new(file: info_path).value)
+      end
+
+      def info_path
+        @info_path ||= ::File.join(path, 'Contents', 'Info.plist')
+      end
+
+      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,55 @@
+# 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
+
+      def cpu_name
+        @file.cpusubtype
+      end
+
+      def cpu_type
+        @file.cputype
+      end
+
+      def type
+        @file.filetype
+      end
+
+      def size(human_size: false)
+        return number_to_human_size(@size) if human_size
+
+        @size
+      end
+
+      def uuid
+        @file[:LC_UUID][0].uuid_string
+      end
+      alias debug_id uuid
+
+      def header
+        @header ||= @file.header
+      end
+
+      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