app-info 2.8.4 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaf82a6d1506255b1273449d8780190beb43d82000a8307a8bdb2f7d26db9b5f
-  data.tar.gz: bd2a591c4586eec718b991a7a8ee9c51b42311da1c5b7d6c8c9ff47df017d6e8
+  metadata.gz: 35509386f8425f29ea466dbcb1ce12cf54be230f9b4668d4ad2f5ac9b4a4b1b5
+  data.tar.gz: 6f3f87d116877fd058a9f479de6b0aa789d74c255f832f5db132446e6250b82e
 SHA512:
-  metadata.gz: f386060b89ea25bea1b1e41d2d8e355143f109304206e57a130d4ea93769085787c712a6f0ae8dddbc8b06cb82c63802af707b6cd04f0342b98effe557e31e22
-  data.tar.gz: 9181a83795f635f2c88f52889a9b7399cbfa62979ae7f2dabff23d2fb877287de24952d0c2fe53e41651e9c4f0ff01a5b1f7a5f6e0324b2e57684814e438d057
+  metadata.gz: b62671980b8d9e7a854523e24311af90e78b807023b65aa1d417159717c3119c34beef4e589638d3fa3708820c8732a1c82859f8b2194477a90548dfd0611b0a
+  data.tar.gz: dc22e6f681b64658bacd6206c3cb7bdceb4afac7fac9332af230563930d8df24da1b95336647c25f7f84537c7716804d5d27e7409baa08b30e5f436e3a505c16

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,22 @@ AllCops:
     - 'lib/app_info/protobuf/models/*_pb.rb'
     - 'main.rb'
 
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'lib/app_info/helper/signatures.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 +52,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 +72,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 +89,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,11 +9,38 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 > List all changes before release a new version.
 
-## [2.8.4] (2023-03-09)
+## [3.0.0.beta1] (2023-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)
+
+### Changed
+
+- Add `AppInfo::File` base class for all parsers.
+- Add `AppInfo::Certifiate` X509 certificate wrapped and apply in Android/MobileProvision.
+- Remove `AppInfo::MobileProvision::DeveloperCertificate` class, use `AppInfo::Certifiate` instead.
+- Remove `.sign_version` method in Android parser.
+- Remove duplice `AppInfo::AndroidDevice` class.
+- 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
 
 - Sync the latest appt2 proto files to parse Android SDK 31+ for aab parser. [#51](https://github.com/icyleaf/app_info/issues/51) (thanks @[UpBra](https://github.com/UpBra))
+
+## [2.8.4] (2023-03-09)
+
+### Fixed
+
 - Force android device return as boolean for aab parser.
 - Handle string resources referencing other resources for apk parser.
 
@@ -242,7 +269,8 @@ 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.4..HEAD
+[Unreleased]: https://github.com/icyleaf/app-info/compare/v2.8.5..HEAD
+[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
 [2.8.2]: https://github.com/icyleaf/app-info/compare/v2.8.1...v2.8.2

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

@@ -5,7 +5,8 @@
 [![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)
 
-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,23 @@ 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 />
+
+![Zealot Showcase](https://github.com/tryzealot/docs/blob/main/static/img/showcase-light.png#gh-light-mode-only)
+![Zealot Showcase](https://github.com/tryzealot/docs/blob/main/static/img/showcase-dark.png#gh-dark-mode-only)
+
+[Zealot](https://zealot.ews.im/docs/user-guide/) is a self-hosted Beta App Distribution for Android, iOS and macOS apps. app_info it the core inside.
+
+<hr />
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -55,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')
@@ -64,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
@@ -210,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
 # => [...]
 ```
 
@@ -303,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

@@ -5,8 +5,8 @@ require 'image_size'
 require 'forwardable'
 
 module AppInfo
-  # Parse APK file
-  class AAB
+  # Parse APK file parser
+  class AAB < File
     include Helper::HumanFileSize
     extend Forwardable
 
@@ -25,38 +25,52 @@ module AppInfo
     BASE_MANIFEST = "#{BASE_PATH}/manifest/AndroidManifest.xml"
     BASE_RESOURCES = "#{BASE_PATH}/resources.pb"
 
-    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
+    # @return [Symbol] {Format::AAB}
+    def file_type
+      Format::AAB
+    end
+
+    # @return [String] {Platform::ANDROID}
+    def platform
       Platform::ANDROID
     end
-    alias file_type os
 
     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
 
+    # @return [String] {Device}
     def device_type
       if wear?
         Device::WATCH
@@ -78,33 +92,40 @@ module AppInfo
     #           .size >= 1
     # end
 
+    # @return [Boolean]
     def wear?
       !!use_features&.include?('android.hardware.type.watch')
     end
 
+    # @return [Boolean]
     def tv?
       !!use_features&.include?('android.software.leanback')
     end
 
+    # @return [Boolean]
     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)
 
@@ -123,36 +144,25 @@ module AppInfo
       @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'
+    # Return multi version certifiates of signatures
+    # @return [Array<Hash>] signatures
+    # @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>] signatures
     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
+      @signs ||= v1sign&.signatures || []
     end
 
+    # Legacy v1 scheme certificates, it will remove soon.
+    # @deprecated Use {#signatures}
+    # @return [Array<OpenSSL::PKCS7, nil>] certificates
     def certificates
-      @certificates ||= signs.each_with_object([]) do |sign, obj|
-        obj << APK::Certificate.new(sign.path, sign.sign.certificates[0])
-      end
+      @certificates ||= v1sign&.certificates || []
     end
 
     def each_file
@@ -171,7 +181,7 @@ 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
@@ -182,25 +192,28 @@ module AppInfo
       @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
 
+    # @return [Zip::File]
     def zip
       @zip ||= Zip::File.open(@file)
     end
 
+    # @return [Array<Hash>]
     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,
@@ -223,13 +236,19 @@ module AppInfo
     end
 
     def contents
-      @contents ||= File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
+      @contents ||= ::File.join(Dir.mktmpdir, "AppInfo-android-#{SecureRandom.hex}")
     end
 
     private
 
+    def v1sign
+      @v1sign ||= Android::Signature::V1.verify(self)
+    rescue Android::Signature::NotFoundError
+      nil
+    end
+
     def xml_file?(file)
-      File.extname(file) == '.xml'
+      ::File.extname(file) == '.xml'
     end
 
     # TODO: how to convert xml content after decode protoubufed content