android_parser 2.6.0 → 2.7.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a455cf668b1e1fbae27b208a872c304ac7ff60987034c529aa93c676b3e4348
-  data.tar.gz: 5089aec3a63dec1766ae3c981442c2a6fa9500f1351d0e989552e84047309443
+  metadata.gz: fe3ead9fd9c4393e0cf3fb39fae3f4ab4a99e68e30cbceae79a8861d451f3266
+  data.tar.gz: 2d80687dc01a1541d4f0b049d499e448eeee4f7413834fd603b5c7560b40048b
 SHA512:
-  metadata.gz: b4e6104d2a29750902a79871b5a3e2750ea3ea3a8fdcde709870950ca93ddeaa2299f481c393be9556e21378a88c843afe8b9123b338c7a7e7c204a2800c6b99
-  data.tar.gz: 9474805fe13212f5193817cf0bc22b33163211232ec01cf4ad60b65eb4713992d701f3883f87241eb2d8b532d00397d6c641c167b19db4b8d71fc314bf87d352
+  metadata.gz: 98d6c6286ec3c02a7939e94bdeff0d0316db3997df828af79bb5b585e4f698ac36cb63c419d66da0da97ba48595e33e3d405e8296de95161cb3a9d8003931233
+  data.tar.gz: bd31cc2455cf30dcb001cc838fa48608910a20aaaa7b9e74f020c4c6fb3ea07f19cc6d0e598813bccfcfec30765f1775968cf4cba0e436a58bc6ddb2548eba00

data/.github/workflows/ci.yml

@@ -10,12 +10,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ ruby-2.5, ruby-2.6, ruby-2.7, ruby-3.0, ruby-3.1, ruby-3.2 ]
+        ruby: [ ruby-3.1, ruby-3.2, ruby-3.3 ]
         os: [ ubuntu-latest, macos-latest ]
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/create_release.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Create Release
-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@v2
       if: startsWith(github.ref, 'refs/tags/')
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # ChangeLog
 
+## 2.7.0.beta1
+
+* Dropped Ruby 2.5~3.0 support, now requires Ruby 3.1+.
+* Bugfix: [#7] parse library type to fix unknown chunk type 0x0203.
+* Bugfix: fix 3bits of lang and country in locales.
+* add fetch locales support.
+* add architectures support.
+* add detect universal apk.
+
+## 2.6.0
+
+* [#2] add queries component support.
+* [#3] add detect enable kotlin code.
+
 ## 2.5.1
 
 * Bugfix: Handle string resources referencing other resources.

data/android_parser.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'android_parser'
-  spec.version       = '2.6.0'
+  spec.version       = '2.7.0.beta1'
   spec.authors       = ['SecureBrain', 'icyleaf']
   spec.email         = ['info@securebrain.co.jp', 'icyleaf.cn@gmail.com']
   spec.platform      = Gem::Platform::RUBY
@@ -15,13 +15,10 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.add_dependency 'rubyzip', '>= 1.0', '< 3.0'
-
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0') then
-    spec.add_dependency 'rexml', '> 3.0'
-  end
+  spec.add_dependency 'rexml', '> 3.0' # requires for Ruby 3.0+
 
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '>= 1.2.0'

data/lib/android/apk.rb

@@ -12,7 +12,6 @@ module Android
 
   # apk object class
   class Apk
-
     # @return [String] apk file path
     attr_reader :path
     # @return [Android::Manifest] manifest instance
@@ -43,32 +42,30 @@ module Android
 
       @path = filepath
       raise NotFoundError, "'#{filepath}'" unless File.exist? @path
-      begin
-        @zip = Zip::File.open(@path)
-      rescue Zip::Error => e
-        raise NotApkFileError, e.message
-      end
 
       @bindata = File.open(@path, 'rb') {|f| f.read }
       @bindata.force_encoding(Encoding::ASCII_8BIT)
-      raise NotApkFileError, "manifest file is not found." if @zip.find_entry(MANIFEST).nil?
+      raise NotApkFileError, 'manifest file is not found.' if zip.find_entry(MANIFEST).nil?
+
       begin
         @resource = Android::Resource.new(self.file(RESOURCE))
       rescue => e
-        $stderr.puts "failed to parse resource: #{e}"
-        #$stderr.puts e.backtrace
+        logger.error "failed to parse resource: #{e} with backtrace"
+        logger.error e.backtrace
       end
+
       begin
         @manifest = Android::Manifest.new(self.file(MANIFEST), @resource)
       rescue => e
-        $stderr.puts "failed to parse manifest:#{e}"
-        #$stderr.puts e.backtrace
+        logger.error "failed to parse manifest:#{e} with backtrace"
+        logger.error e.backtrace
       end
+
       begin
         @dex = Android::Dex.new(self.file(DEX))
       rescue => e
-        $stderr.puts "failed to parse dex:#{e}"
-        #$stderr.puts e.backtrace
+        logger.error "failed to parse dex:#{e} with backtrace"
+        logger.error e.backtrace
       end
     end
 
@@ -105,9 +102,9 @@ module Android
     # @yieldparam [String] name file name in apk
     # @yieldparam [String] data file data in apk
     def each_file
-      @zip.each do |entry|
+      zip.each do |entry|
         next unless entry.file?
-        yield entry.name, @zip.read(entry)
+        yield entry.name, zip.read(entry)
       end
     end
 
@@ -116,13 +113,13 @@ module Android
     # @return [String] binary data
     # @raise [NotFoundError] when 'name' doesn't exist in the apk
     def file(name) # get data by entry name(path)
-      @zip.read(entry(name))
+      zip.read(entry(name))
     end
 
     # @yield [entry]
     # @yieldparam [Zip::Entry] entry zip entry
     def each_entry
-      @zip.each do |entry|
+      zip.each do |entry|
         next unless entry.file?
         yield entry
       end
@@ -133,7 +130,7 @@ module Android
     # @return [Zip::Entry] zip entry object
     # @raise [NotFoundError] when 'name' doesn't exist in the apk
     def entry(name)
-      entry = @zip.find_entry(name)
+      entry = zip.find_entry(name)
       raise NotFoundError, "'#{name}'" if entry.nil?
       return entry
     end
@@ -223,6 +220,23 @@ module Android
       @certificates ||= Hash[self.signs.map{|path, sign| [path, sign.certificates.first] }]
     end
 
+    # Return all architectures (all most for universal apk)
+    # @return [Array<String>]
+    # @since 2.7.0
+    def archs
+      @archs ||= zip.glob('lib/**/*').each_with_object([]) do |entry, obj|
+        arch = entry.name.split('/')[1]
+        obj << arch unless obj.include?(arch)
+      end
+    end
+
+    # detect if contains multi-platforms (native machine code)
+    # @return [Boolean]
+    # @since 2.7.0
+    def universal?
+      archs.size > 1
+    end
+
     # detect if use kotlin language (may be third-party sdk or not)
     # @return [Boolean]
     # @since 2.6.0
@@ -257,6 +271,15 @@ module Android
       'META-INF/services/kotlinx.coroutines.CoroutineExceptionHandler',
       'META-INF/services/kotlinx.coroutines.internal.MainDispatcherFactory'
     ].freeze
+
+    def zip
+      @zip ||= Zip::File.open(@path)
+    rescue Zip::Error => e
+      raise NotApkFileError, e.message
+    end
+
+    def logger
+      Android.logger
+    end
   end
 end
-

data/lib/android/configuration.rb

@@ -0,0 +1,13 @@
+module Android
+  module Configuration
+    attr_writer :logger
+
+    def configure
+      yield self
+    end
+
+    def logger
+      @logger ||= NullLogger.new
+    end
+  end
+end

data/lib/android/manifest.rb

@@ -17,7 +17,7 @@ module Android
       # @return [Boolean]
       def self.valid?(elem)
         TYPES.include?(elem.name.downcase)
-      rescue => e
+      rescue
         false
       end
 
@@ -83,7 +83,7 @@ module Android
       # @return [Boolean]
       def self.valid?(elem)
         ['activity', 'activity-alias'].include?(elem.name.downcase)
-      rescue => e
+      rescue
         false
       end
 
@@ -145,7 +145,7 @@ module Android
         filter&.elements&.any? do |elem|
           TYPES.include?(elem&.name&.downcase)
         end
-      rescue => e
+      rescue
         false
       end
 
@@ -418,7 +418,7 @@ module Android
     #################################
     # Manifest class definitions
     #################################
-    #
+
     # @return [REXML::Document] manifest xml
     attr_reader :doc
 

data/lib/android/null_logger.rb

@@ -0,0 +1,65 @@
+
+module Android
+  class NullLogger
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def unknown(*_args)
+      nil
+    end
+
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def fatal(*_args)
+      nil
+    end
+
+    # @return [FALSE]
+    def fatal?
+      false
+    end
+
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def error(*_args)
+      nil
+    end
+
+    # @return [FALSE]
+    def error?
+      false
+    end
+
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def warn(*_args)
+      nil
+    end
+
+    # @return [FALSE]
+    def warn?
+      false
+    end
+
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def info(*_args)
+      nil
+    end
+
+    # @return [FALSE]
+    def info?
+      false
+    end
+
+    # @param _args Anything that we want to ignore
+    # @return [nil]
+    def debug(*_args)
+      nil
+    end
+
+    # @return [FALSE]
+    def debug?
+      false
+    end
+  end
+end

data/lib/android/resource.rb

@@ -6,6 +6,8 @@ module Android
   # /frameworks/base/include/utils/ResourceTypes.h
   # @see http://justanapplication.wordpress.com/category/android/android-resources/
   class Resource
+    class UnknownChunkType < StandardError; end
+
     class Chunk
       def initialize(data, offset)
         data.force_encoding(Encoding::ASCII_8BIT)
@@ -198,7 +200,7 @@ module Android
     end
 
     class ResTablePackage < ChunkHeader
-      attr_reader :name
+      attr_reader :name, :locales
 
       def global_string_pool=(pool)
         @global_string_pool = pool
@@ -279,7 +281,7 @@ module Android
         "@#{type(tid)}/#{key(keyid)}"
       end
       def res_hex_id(readable_id, opt={})
-        dummy, typestr, keystr = readable_id.match(/^@?(\w+)\/(\w+)$/).to_a
+        _dummy, typestr, keystr = readable_id.match(/^@?(\w+)\/(\w+)$/).to_a
         tid = type_id(typestr)
         raise NotFoundError unless @types.has_key?(tid)
         keyid = @types[tid][0].keys[keystr]
@@ -324,21 +326,26 @@ module Android
 
         @types = {}
         @specs = {}
+        @libraries = []
         while offset < (@offset + @size)
           type = @data[offset, 2].unpack('v')[0]
           case type
-          when 0x0201 # RES_TABLE_TYPE_TYPE
+          when TYPE_TYPE
             type = ResTableType.new(@data, offset, self)
             offset += type.size
             @types[type.id] = [] if @types[type.id].nil?
             @types[type.id] << type
-          when 0x0202 # RES_TABLE_TYPE_SPEC_TYPE`
+          when TYPE_SPEC_TYPE
             spec = ResTableTypeSpec.new(@data, offset)
             offset += spec.size
             @specs[spec.id] = [] if @specs[spec.id].nil?
             @specs[spec.id] << spec
+          when TYPE_LIBRARY
+            library = ResTableLibraryType.new(@data, offset)
+            offset += library.size
+            @libraries.concat(library.libraries)
           else
-            raise "chunk type error: type:%#04x" % type
+            raise UnknownChunkType, "chunk type error: type:%#04x" % type
           end
         end
       end
@@ -348,7 +355,7 @@ module Android
         @res_strings_lang = {}
         @res_strings_contry = {}
         begin
-          type = type_id('string')
+          _type = type_id('string')
         rescue NotFoundError
           return
         end
@@ -367,6 +374,8 @@ module Android
             @res_strings_contry[contry] = str_hash unless contry.nil?
           end
         end
+
+        @locales = @res_strings_lang.keys
       end
       private :extract_res_strings
 
@@ -409,8 +418,8 @@ module Android
       def parse
         super
         @id = read_int8
-        res0 = read_int8   # must be 0.(maybe 4byte align)
-        res1 = read_int16  # must be 0.(maybe 4byte align)
+        _res0 = read_int8   # must be 0.(maybe 4byte align)
+        _res1 = read_int16  # must be 0.(maybe 4byte align)
         @entry_count = read_int32
         @entry_start = read_int32
         @config = ResTableConfig.new(@data, current_position)
@@ -444,10 +453,8 @@ module Android
       def parse
         @size = read_int32
         @imei = read_int32
-        la = @data_io.read(2)
-        @locale_lang = la unless la == "\x00\x00"
-        cn = @data_io.read(2)
-        @locale_contry = cn unless cn == "\x00\x00"
+        @locale_lang = unpack_locale(@data_io.read(1), @data_io.read(1), 'a')
+        @locale_contry = unpack_locale(@data_io.read(1), @data_io.read(1), '0')
         @screen_type = read_int32
         @input = read_int32
         @screen_input = read_int32
@@ -457,6 +464,27 @@ module Android
       def inspect
         "<ResTableConfig size:#{@size}, imei:#{@imei}, la:'#{@locale_lang}' cn:'#{@locale_contry}'"
       end
+
+      private
+
+      # Convert from https://github.com/LoyieKing/Apktool/blob/e0e6cfd03f10d710e666c29456659688fb5aeea2/brut.apktool/apktool-lib/src/main/java/brut/androlib/res/decoder/ARSCDecoder.java#L474
+      def unpack_locale(in0, in1, base)
+        return if in0 == "\x00" && in1 == "\x00"
+
+        in0_value = in0.ord
+        in1_value = in1.ord
+        # check high bit, if so we have a packed 3 letter code
+        return [(in0_value).chr, (in1_value).chr].join('') unless ((in0_value >> 7) & 1) == 1
+
+        first = in1_value & 0x1F
+        second = ((in1_value & 0xE0) >> 5) + ((in0_value & 0x03) << 3)
+        third = (in0_value & 0x7C) >> 2
+
+        base_value = base.ord
+        # since this function handles languages & regions, we add the value(s) to the base char
+        # which is usually 'a' or '0' depending on language or region.
+        [(first + base_value).chr, (second + base_value).chr, (third + base_value).chr].join('')
+      end
     end
 
     class ResTableTypeSpec < ChunkHeader
@@ -465,8 +493,8 @@ module Android
       def parse
         super
         @id = read_int8
-        res0 = read_int8 # must be 0.(maybe 4byte align)
-        res1 = read_int16 # must be 0.(maybe 4byte align)
+        _res0 = read_int8 # must be 0.(maybe 4byte align)
+        _res1 = read_int16 # must be 0.(maybe 4byte align)
         @entry_count = read_int32
       end
       private :parse
@@ -531,29 +559,54 @@ module Android
       end
     end
 
+    class ResTableLibraryType < ChunkHeader
+      attr_reader :libraries
+
+      def parse
+        super
+        @libraries = []
+        library_count = read_int32
+        library_count.times do
+          package_id = read_int32
+          package_name = @data_io.read(128).force_encoding(Encoding::UTF_16LE).strip
+          @libraries << ResTableLibraryValue.new(package_id, package_name)
+        end
+      end
+      private :parse
+
+      def inspect
+        "<ResTableLibraryType library_count:#{@libraries.size}>"
+      end
+
+      ResTableLibraryValue = Struct.new(:package_id, :package_name)
+    end
+
     class ResValue < Chunk
       TYPE_REFERENCE = 0x01
 
       attr_reader :size, :data_type, :data
       def parse
         @size = read_int16
-        res0 = read_int8 # Always set 0.
+        _res0 = read_int8 # Always set 0.
         @data_type = read_int8
         @data = read_int32
       end
       private :parse
     end
 
-    ######################################################################
+    #################################
+    # Resource class definitions
+    #################################
+
     # @returns [Hash] { name(String) => value(ResTablePackage) }
     attr_reader :packages
 
     def initialize(data)
       data.force_encoding(Encoding::ASCII_8BIT)
       @data = data
-      parse()
-    end
 
+      parse
+    end
 
     # @return [Array<String>] all strings defined in arsc.
     def strings
@@ -565,7 +618,7 @@ module Android
       @res_table.package_count
     end
 
-    #  This method only support string resource for now.
+    # This method only support string resource for now.
     # find resource by resource id
     # @param [String] res_id (like '@0x7f010001' or '@string/key')
     # @param [Hash] opts option
@@ -596,6 +649,13 @@ module Android
       first_pkg.res_hex_id(readable_id)
     end
 
+    # Return resources locales
+    # @return [Array<String>] all strings of locales.
+    # @since 2.7.0
+    def locales
+      first_pkg.locales
+    end
+
     def first_pkg
       @packages.first[1]
     end
@@ -607,27 +667,38 @@ module Android
 
       while offset < @data.size
         type = @data[offset, 2].unpack('v')[0]
-        #print "[%#08x] " % offset
+        logger.debug "[%#08x] " % offset
         @packages = {}
         case type
-        when 0x0001 # RES_STRING_POOL_TYPE
-          @string_pool = ResStringPool.new(@data, offset)
-          offset += @string_pool.size
-          #puts "RES_STRING_POOL_TYPE %#x, %#x" % [@string_pool.size, offset]
-        when 0x0002 # RES_TABLE_TYPE
-          #puts "RES_TABLE_TYPE"
+        when TYPE_TABLE
           @res_table = ResTableHeader.new(@data, offset)
           offset += @res_table.header_size
-        when 0x0200 # RES_TABLE_PACKAGE_TYPE
-          #puts "RES_TABLE_PACKAGE_TYPE"
+          logger.debug "RES_TABLE_TYPE"
+        when TYPE_STRING_POOL_TYPE
+          @string_pool = ResStringPool.new(@data, offset)
+          offset += @string_pool.size
+          logger.debug("RES_STRING_POOL_TYPE %#x, %#x" % [@string_pool.size, offset])
+        when TYPE_PACKAGE
           pkg = ResTablePackage.new(@data, offset)
           pkg.global_string_pool = @string_pool
           offset += pkg.size
           @packages[pkg.name] = pkg
+          logger.debug "RES_TABLE_PACKAGE_TYPE"
         else
-          raise "chunk type error: type:%#04x" % type
+          raise UnknownChunkType, "chunk type error: type:%#04x" % type
         end
       end
     end
+
+    def logger
+      Android.logger
+    end
+
+    TYPE_STRING_POOL_TYPE = 0x0001    # RES_STRING_POOL_TYPE
+    TYPE_TABLE = 0x0002               # RES_TABLE_TYPE
+    TYPE_PACKAGE = 0x0200             # RES_TABLE_PACKAGE_TYPE
+    TYPE_TYPE = 0x0201                # RES_TABLE_TYPE_TYPE
+    TYPE_SPEC_TYPE = 0x0202           # RES_TABLE_TYPE_SPEC_TYPE
+    TYPE_LIBRARY = 0x0203             # RES_TABLE_LIBRARY_TYPE
   end
 end

data/lib/android/utils.rb

@@ -8,9 +8,9 @@ module Android
     # @return [Boolean]
     def self.apk?(path)
       begin
-        apk = Apk.new(path)
+        Apk.new(path)
         return true
-      rescue => e
+      rescue
         return false
       end
     end
@@ -20,7 +20,7 @@ module Android
     # @return [Boolean]
     def self.elf?(data)
       data[0..3] == "\x7f\x45\x4c\x46"
-    rescue => e
+    rescue
       false
     end
 
@@ -29,7 +29,7 @@ module Android
     # @return [Boolean]
     def self.cert?(data)
       data[0..1] == "\x30\x82"
-    rescue => e
+    rescue
       false
     end
 
@@ -38,7 +38,7 @@ module Android
     # @return [Boolean]
     def self.dex?(data)
       data[0..7] == "\x64\x65\x78\x0a\x30\x33\x35\x00" # "dex\n035\0"
-    rescue => e
+    rescue
       false
     end
 
@@ -48,9 +48,8 @@ module Android
     def self.valid_dex?(data)
       Android::Dex.new(data)
       true
-    rescue => e
+    rescue
       false
     end
   end
 end
-

data/lib/android_parser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'android/null_logger'
+require_relative 'android/configuration'
 require_relative 'android/apk'
 require_relative 'android/manifest'
 require_relative 'android/axml_parser'
@@ -8,3 +10,7 @@ require_relative 'android/dex'
 require_relative 'android/resource'
 require_relative 'android/utils'
 require_relative 'android/layout'
+
+module Android
+  extend Configuration
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: android_parser
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0.beta1
 platform: ruby
 authors:
 - SecureBrain
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -148,9 +148,11 @@ files:
 - README.md
 - Rakefile
 - android_parser.gemspec
+- docs/resources-arsc-reference.png
 - lib/android/apk.rb
 - lib/android/axml_parser.rb
 - lib/android/axml_writer.rb
+- lib/android/configuration.rb
 - lib/android/dex.rb
 - lib/android/dex/access_flag.rb
 - lib/android/dex/dex_object.rb
@@ -158,10 +160,10 @@ files:
 - lib/android/dex/utils.rb
 - lib/android/layout.rb
 - lib/android/manifest.rb
+- lib/android/null_logger.rb
 - lib/android/resource.rb
 - lib/android/utils.rb
 - lib/android_parser.rb
-- lib/ruby_apk.rb
 homepage: https://github.com/icyleaf/android_parser
 licenses:
 - MIT
@@ -174,14 +176,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Static analysis tool for android apk since 2021

data/lib/ruby_apk.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-# Compatible with older versions
-require File.dirname(__FILE__) + '/android_parser'