app-info 2.8.5 → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9406b7552e0bea00883446b85250398c7818120de74d0d6d3545d7b9b0d7ef6
-  data.tar.gz: a99bb2c55b4214ad72f8e6cf2e720199902fb37ad174b71bb5f9f4d529ba81a3
+  metadata.gz: 91afee9fd86b49fa4f788f4316df7c689178c6fdfbc0cf3f4743ae5cb7713dde
+  data.tar.gz: 056f2a2416a1a68ca2f2dcbbc404e9f6c768a5e8a742d942f04177c7044f5ff9
 SHA512:
-  metadata.gz: '018d93bb67f489d4908f0701285ee6c177a627f3b5c602e90c24629da25f91fc2f5cb9b091675d471741361211289b71ed7c1ab51402f30cea843126c9c6271c'
-  data.tar.gz: 5eecd5818b12032898d33a14f74c43592d120ab751b2e4393591b0fd81e4df5cebb94342111478392fd84c5963f762de0383873c547176f74d546f7bfb7b8013
+  metadata.gz: 2294ae1a6e8d220c46bd21e4c1062783f2ce7b94ad5b5dffdfe8c62edd6e519a57b326913339f090f62bf955d3103a6bf665227865bceb9f45bb7c78478b04f0
+  data.tar.gz: ec84bbc24190227bedd91818bdefad90cb1472e1b7ca1db312aca651843315ab037e7b70f2322085eca70bf3ab0319af3af20270da2a006437f76cf4a4ca3f11

data/.github/dependabot.yml

@@ -1,9 +1,14 @@
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "21:00"
-    timezone: Asia/Shanghai
-  open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "21:00"
+      timezone: Asia/Shanghai
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -1,8 +1,10 @@
 name: CI
 on:
   push:
+    paths-ignore:
+      - '*.md'
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:

data/.rubocop.yml

@@ -27,6 +27,24 @@ AllCops:
     - 'lib/app_info/protobuf/models/*_pb.rb'
     - 'main.rb'
 
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'lib/app_info/helper/signatures.rb'
+    - 'lib/app_info/android/signatures/info.rb'
+    - 'lib/app_info/apk.rb'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/app_info/file.rb'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/app_info/android/signatures/v3.rb'
+
 Metrics/AbcSize:
   Max: 100
 
@@ -36,13 +54,15 @@ Metrics/BlockLength:
     - 'lib/app_info/mobile_provision.rb'
 
 Metrics/MethodLength:
-  Max: 20
+  Max: 30
   Exclude:
-    - 'lib/app_info/png_uncrush.rb'
     - 'lib/app_info/mobile_provision.rb'
+    - 'lib/app_info/android/signatures/v2.rb'
+    - 'lib/app_info/android/signatures/v3.rb'
 
-Layout/LineLength:
-  Max: 100
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/app_info/helper/signatures.rb'
 
 Metrics/ClassLength:
   CountComments: false
@@ -54,12 +74,16 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Max: 18
 
-Lint/AssignmentInCondition:
-  Enabled: false
+Metrics/BlockNesting:
+  Exclude:
+    - 'lib/app_info/dsym.rb'
 
 Style/Documentation:
   Enabled: false
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/PerlBackrefs:
   Exclude:
     - 'lib/app_info/core_ext/string/inflector.rb'
@@ -67,10 +91,8 @@ Style/PerlBackrefs:
 Style/DocumentDynamicEvalDefinition:
   Enabled: false
 
-Metrics/BlockNesting:
-  Exclude:
-    - 'lib/app_info/dsym.rb'
-
-
 Style/SlicingWithRange:
   Enabled: false
+
+Style/ClassVars:
+  Enabled: false

data/CHANGELOG.md

@@ -9,6 +9,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 > List all changes before release a new version.
 
+## [3.0.0.beta2] (2023-04-04)
+
+### Changed
+
+- Re-organize categories `.platform`, `.opera_sytem` and `.device` for all parsers. [#58](https://github.com/icyleaf/app_info/pull/58)
+- Change ExportType values type to symbol both IPA and macOS parsers. [#58](https://github.com/icyleaf/app_info/pull/58)
+
+## [3.0.0.beta1] (2023-04-04)
+
+### Added
+
+- New Windows PE format parser. [#47](https://github.com/icyleaf/app_info/pull/47)
+- Android parser add v2, v3 scheme signature support. [#55](https://github.com/icyleaf/app_info/pull/55]
+- dSYM parer accept multi dSYM target in a zip file. [#56](https://github.com/icyleaf/app_info/pull/56)
+- Better document for yardoc.
+
+### Changed
+
+- Add `AppInfo::File` base class for all parsers.
+- Add `AppInfo::Certifiate` X509 certificate wrapped and apply in Android/MobileProvision.
+- Remove `.sign_version` method in Android parser.
+- Rename `.file_type` to `.format` method in all parers and return a `AppInfo::Format` type.
+- Remove duplice `AppInfo::AndroidDevice` class.
+- Remove `AppInfo::MobileProvision::DeveloperCertificate` class, use `AppInfo::Certifiate` instead.
+- Deprecate `.signs` and `.certifiates` methods in Android parser, use `.signatures` instead.
+- Deprecate `.developer_certs` method in MobileProvision parser, use `.certificates` instead.
+
+### Fixed
+
+- Fixed minor typo.
+
 ## [2.8.5] (2023-03-16)
 
 ### Fixed
@@ -247,7 +278,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Updated dependency of CFPropertly list be a range between 2.3.4. (thanks @[cschroed](https://github.com/cschroed))
 
-[Unreleased]: https://github.com/icyleaf/app-info/compare/v2.8.5..HEAD
+[Unreleased]: https://github.com/icyleaf/app-info/compare/v3.0.0.beta2..HEAD
+[3.0.0.beta2]: https://github.com/icyleaf/app-info/compare/v3.0.0.beta1...v3.0.0.beta2
+[3.0.0.beta1]: https://github.com/icyleaf/app-info/compare/v2.8.5...v3.0.0.beta1
 [2.8.5]: https://github.com/icyleaf/app-info/compare/v2.8.4...v2.8.5
 [2.8.4]: https://github.com/icyleaf/app-info/compare/v2.8.3...v2.8.4
 [2.8.3]: https://github.com/icyleaf/app-info/compare/v2.8.2...v2.8.3

data/Gemfile

@@ -7,5 +7,11 @@ gemspec
 
 group :development do
   gem 'awesome_print'
-  gem 'debug' # For ruby 3.0+
+  gem 'debug' # For ruby 3.0+\
+  gem 'yard'
+end
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rubocop'
 end

data/README.md

@@ -1,11 +1,12 @@
-# app_info
+# app-info
 
-[![Language](https://img.shields.io/badge/ruby-2.5+-701516.svg)](.github/workflows/ci.yml)
+[![Language](https://img.shields.io/badge/ruby-2.5+-701516)](.github/workflows/ci.yml)
+[![Gem version](https://img.shields.io/gem/v/app-info?include_prereleases)](https://rubygems.org/gems/app-info)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/icyleaf/app_info/ci.yml)](https://github.com/icyleaf/app_info/actions/workflows/ci.yml)
-[![Gem version](https://img.shields.io/gem/v/app-info.svg?style=flat)](https://rubygems.org/gems/app_info)
-[![License](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](LICENSE)
+[![License](https://img.shields.io/github/license/icyleaf/app-info)](LICENSE)
 
-Teardown tool for mobile app (ipa, apk and aab file), macOS app and dSYM.zip file, analysis metedata like version, name, icon etc.
+Teardown tool for mobile app (ipa, apk and aab file), macOS app, dSYM.zip file and Windows PE file.
+Analysis metedata like version, name, icon etc.
 
 ## Support
 
@@ -16,10 +17,13 @@ Teardown tool for mobile app (ipa, apk and aab file), macOS app and dSYM.zip fil
   - `.ipa`
   - `Info.plist` file
   - `.mobileprovision`/`.provisionprofile` file
-- Zipped macOS App file
+- macOS App file (archived by starnd pkzip format)
   - `.app.zip`
-- Zipped dSYMs file
+- dSYMs file (archived by starnd pkzip format)
   - `.dSYM.zip`
+- Windows PE file
+  - `.exe`
+  - `.zip` (binary in a zip file)
 
 <hr />
 
@@ -65,6 +69,8 @@ parser = AppInfo.parse('android.aab')
 parser = AppInfo.parse('u-u-i-d.mobileprovision')
 parser = AppInfo.parse('macOS.App.zip')
 parser = AppInfo.parse('App.dSYm.zip')
+parser = AppInfo.parse('win.exe')
+parser = AppInfo.parse('win.zip')
 
 # If detect file type failed, you can parse in other way
 parser = AppInfo::IPA.new('iphone.ipa')
@@ -74,6 +80,7 @@ parser = AppInfo::InfoPlist.new('Info.plist')
 parser = AppInfo::MobileProvision.new('uuid.mobileprovision')
 parser = AppInfo::Macos.new('App.dSYm.zip')
 parser = AppInfo::DSYM.new('App.dSYm.zip')
+parser = AppInfo::PE.new('win.exe')
 ```
 
 ### iOS
@@ -220,12 +227,8 @@ android.deep_links
 android.schemes
 # => ['appinfo']
 
-# get sign list (only v1 sign)
-android.signs
-# => [...]
-
-# get certificate list (only v1 sign)
-android.certificates
+# get v1-v3 scheme singature information (included unverified certificate and more)
+android.signatures
 # => [...]
 ```
 
@@ -313,6 +316,58 @@ dsym.machos.each do |macho|
 end
 ```
 
+### Windows
+
+Accept any PE format file, such like `.exe` or `.exe` binary fin a zip file.
+
+```ruby
+win = AppInfo.parse('win.exe')
+
+# get given file size
+win.size
+# => 3093823
+
+# get given file size in human reable.
+win.size(human_size: true)
+# => 29 MB
+
+# get given file size
+win.binary_size
+# => 20940
+
+# get given file size in human reable.
+win.size(human_size: true)
+# => 20 MB
+
+# get product name
+win.name
+# => AppInfo
+
+# get app company name
+win.company_name
+# => EWS Studio
+
+# get app product version (alias to release_version)
+win.product_version
+# => 1.0.0
+
+# get app assembly version (alias to build_version)
+win.assembly_version
+# => 1.0.0
+
+# detect architecture(s)
+win.archs
+# => x64
+
+# get all imports files
+win.imports
+# => [KERNEL32.dll, ...]
+
+# get app icons (bmp format image)
+win.icons
+# => [{:name=>"ICON.bmp", :file=>"{path}/ICON.bmp"}, :dimensions=>[64, 64]}, ...]
+```
+
 ## CLI Shell (Interactive console)
 
 It is possible to use this gem as a command line interface to parse mobile app:

data/Rakefile

@@ -2,6 +2,7 @@
 
 $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'app_info'
+require 'yard'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -9,3 +10,13 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+task :doc do
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', 'README.md', 'LICENSE']
+    # t.options = ['--any', '--extra', '--opts'] # optional
+    # t.stats_options = ['--list-undoc']         # optional
+  end
+end
+
+

data/app_info.gemspec

@@ -23,14 +23,23 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'CFPropertyList', '< 3.1.0', '>= 2.3.4'
   spec.add_dependency 'image_size', '>= 1.5', '< 3.3'
   spec.add_dependency 'ruby-macho', '>= 1.4', '< 4'
-  spec.add_dependency 'android_parser', '~> 2.5.1'
+  spec.add_dependency 'android_parser', '~> 2.6.0'
   spec.add_dependency 'rubyzip', '>= 1.2', '< 3.0'
   spec.add_dependency 'uuidtools', '>= 2.1.5', '< 2.3.0'
   spec.add_dependency 'icns', '~> 0.2.0'
+  spec.add_dependency 'pedump', '~> 0.6.2'
   spec.add_dependency 'google-protobuf', '>= 3.19.4', '< 3.23.0'
 
   spec.add_development_dependency 'bundler', '>= 1.12'
   spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.19'
+
+  spec.post_install_message = <<~ENDBANNER
+    AppInfo 3.0 is coming!
+    **********************
+    The public API of some AppInfo classes has been changed.
+
+    Please ensure that your Gemfiles and .gemspecs are suitably restrictive
+    to avoid an unexpected breakage when 3.0 is released (e.g. ~> 2.8.5).
+    See https://github.com/icyleaf/app_info for details.
+  ENDBANNER
 end

data/lib/app_info/aab.rb

@@ -1,160 +1,85 @@
 # frozen_string_literal: true
 
 require 'app_info/protobuf/manifest'
-require 'image_size'
-require 'forwardable'
 
 module AppInfo
-  # Parse APK file
-  class AAB
-    include Helper::HumanFileSize
-    extend Forwardable
-
-    attr_reader :file
-
-    # APK Devices
-    module Device
-      PHONE       = 'Phone'
-      TABLET      = 'Tablet'
-      WATCH       = 'Watch'
-      TV          = 'Television'
-      AUTOMOTIVE  = 'Automotive'
-    end
-
+  # Parse APK file parser
+  class AAB < Android
     BASE_PATH = 'base'
     BASE_MANIFEST = "#{BASE_PATH}/manifest/AndroidManifest.xml"
     BASE_RESOURCES = "#{BASE_PATH}/resources.pb"
 
-    def initialize(file)
-      @file = file
-    end
-
-    def size(human_size: false)
-      file_to_human_size(@file, human_size: human_size)
-    end
-
-    def os
-      Platform::ANDROID
-    end
-    alias file_type os
-
+    # @!method version_name
+    #   @see Protobuf::Manifest#version_name
+    #   @return [String]
+    # @!method deep_links
+    #   @see Protobuf::Manifest#deep_links
+    #   @return [String]
+    # @!method schemes
+    #   @see Protobuf::Manifest#schemes
+    #   @return [String]
     def_delegators :manifest, :version_name, :deep_links, :schemes
 
     alias release_version version_name
 
+    # @return [String]
     def package_name
       manifest.package
     end
     alias identifier package_name
     alias bundle_id package_name
 
+    # @return [String]
     def version_code
       manifest.version_code.to_s
     end
     alias build_version version_code
 
+    # @return [String]
     def name
       manifest.label
     end
 
-    def device_type
-      if wear?
-        Device::WATCH
-      elsif tv?
-        Device::TV
-      elsif automotive?
-        Device::AUTOMOTIVE
-      else
-        Device::PHONE
-      end
-    end
-
-    # TODO: find a way to detect
-    # Found answer but not works: https://stackoverflow.com/questions/9279111/determine-if-the-device-is-a-smartphone-or-tablet
-    # def tablet?
-    #   resource.first_package
-    #           .entries('bool')
-    #           .select{|e| e.name == 'isTablet' }
-    #           .size >= 1
-    # end
-
-    def wear?
-      !!use_features&.include?('android.hardware.type.watch')
-    end
-
-    def tv?
-      !!use_features&.include?('android.software.leanback')
-    end
-
-    def automotive?
-      !!use_features&.include?('android.hardware.type.automotive')
-    end
-
+    # @return [String]
     def min_sdk_version
       manifest.uses_sdk.min_sdk_version
     end
     alias min_os_version min_sdk_version
 
+    # @return [String]
     def target_sdk_version
       manifest.uses_sdk.target_sdk_version
     end
 
+    # @return [Array<String>]
     def use_features
       return [] unless manifest.respond_to?(:uses_feature)
 
       @use_features ||= manifest&.uses_feature&.map(&:name)
     end
 
+    # @return [Array<String>]
     def use_permissions
       return [] unless manifest.respond_to?(:uses_permission)
 
       @use_permissions ||= manifest&.uses_permission&.map(&:name)
     end
 
+    # @return [Protobuf::Node]
     def activities
       @activities ||= manifest.activities
     end
 
+    # @return [Protobuf::Node]
     def services
       @services ||= manifest.services
     end
 
+    # @return [Protobuf::Node]
     def components
       @components ||= manifest.components.transform_values
     end
 
-    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'
-    end
-
-    def signs
-      return @signs if @signs
-
-      @signs = []
-      each_file do |path, data|
-        # find META-INF/xxx.{RSA|DSA}
-        next unless path =~ %r{^META-INF/} && data.unpack('CC') == [0x30, 0x82]
-
-        @signs << APK::Sign.new(path, OpenSSL::PKCS7.new(data))
-      end
-
-      @signs
-    end
-
-    def certificates
-      @certificates ||= signs.each_with_object([]) do |sign, obj|
-        obj << APK::Certificate.new(sign.path, sign.sign.certificates[0])
-      end
-    end
-
     def each_file
       zip.each do |entry|
         next unless entry.file?
@@ -171,36 +96,50 @@ module AppInfo
     end
 
     def entry(name, base_path: BASE_PATH)
-      entry = @zip.find_entry(File.join(base_path, name))
+      entry = @zip.find_entry(::File.join(base_path, name))
       raise NotFoundError, "'#{name}'" if entry.nil?
 
       entry
     end
 
+    # @return [Protobuf::Manifest]
     def manifest
       io = zip.read(zip.find_entry(BASE_MANIFEST))
       @manifest ||= Protobuf::Manifest.parse(io, resource)
     end
 
+    # @return [Protobuf::Resources]
     def resource
       io = zip.read(zip.find_entry(BASE_RESOURCES))
       @resource ||= Protobuf::Resources.parse(io)
     end
 
-    def zip
-      @zip ||= Zip::File.open(@file)
-    end
-
+    # Full icons metadata
+    # @example
+    #   aab.icons
+    #   # => [
+    #   #   {
+    #   #     name: 'icon.png',
+    #   #     file: '/path/to/icon.png',
+    #   #     dimensions: [29, 29]
+    #   #   },
+    #   #   {
+    #   #     name: 'icon1.png',
+    #   #     file: '/path/to/icon1.png',
+    #   #     dimensions: [120, 120]
+    #   #   }
+    #   # ]
+    # @return [Array<Hash{Symbol => String, Array<Integer>}>] icons paths of icons
     def icons
       @icons ||= manifest.icons.each_with_object([]) do |res, obj|
         path = res.value
-        filename = File.basename(path)
-        filepath = File.join(contents, File.dirname(path))
-        file = File.join(filepath, filename)
+        filename = ::File.basename(path)
+        filepath = ::File.join(contents, ::File.dirname(path))
+        file = ::File.join(filepath, filename)
         FileUtils.mkdir_p filepath
 
         binary_data = read_file(path)
-        File.write(file, binary_data, encoding: Encoding::BINARY)
+        ::File.write(file, binary_data, encoding: Encoding::BINARY)
 
         obj << {
           name: filename,
@@ -222,14 +161,15 @@ module AppInfo
       @info = nil
     end
 
-    def contents
-      @contents ||= File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
+    # @return [Zip::File]
+    def zip
+      @zip ||= Zip::File.open(@file)
     end
 
     private
 
     def xml_file?(file)
-      File.extname(file) == '.xml'
+      ::File.extname(file) == '.xml'
     end
 
     # TODO: how to convert xml content after decode protoubufed content