android_parser 2.4.1 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a338a6e092fc1dc50e3c1688f165109dbb900397e51b968b0397877aa4f6a030
-  data.tar.gz: 5fbbb6f2630a3a4d2a7b090106c53dd45ac9b8ec6b4be9cb37477d1c5615c594
+  metadata.gz: 8360af54a4093e8cc95844b8b7419e3190aed92f5aa6c832f0fd4f7e8ccd2f53
+  data.tar.gz: 1b8a9172fdf2b4f18c43cb0a342aa5244f7ad109cbfc8b8995d74d6de9fc34a9
 SHA512:
-  metadata.gz: 7c270a031fc08369c7afa11e274da90c3aa732b86cade0b10066a227de49bafb30b0dd8b14ce7b77a3a347fda85bfefcf5796c55f8b2a5c645309d625030f01c
-  data.tar.gz: e850a3d98e71801a57686f8b890d45fa1d65d3459805b6855f9451990a960ba6f608ed147c88ea9ded54fb40ab8c49b4d89d19e014172aa24b8a36ba329dc7d9
+  metadata.gz: 393956811a1cfcb6bd043cdc8c6494a1760a0558d6d12ce157ee9e08b67035499f702e15cf8d6baa7971572eb616c0de28ebc92003a4e9a32c18541eb82b7f7b
+  data.tar.gz: a7998f5d5e71b889c083f6b1d73f4d277bd7aecd6c412a5d4b14dc10bccf1104472dffde03c2a2280071f88c846906f15c80991d73689f2dd957a46270ac3fbf

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ ruby-2.5, ruby-2.6, ruby-2.7, ruby-3.0, ruby-3.1, ruby-3.2 ]
+        os: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: bundle exec rspec
+        run: bundle exec rspec --format progress --force-colour

data/.gitignore

@@ -10,6 +10,7 @@ doc
 
 # bundler
 .bundle
+Gemfile.lock
 
 # rvm
 .ruby-version
@@ -17,7 +18,7 @@ doc
 # jeweler generated
 #pkg # upload gem file to server
 
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
 #
 # * Create a file at ~/.gitignore
 # * Include files you want ignored

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/CHANGELOG.md

@@ -1,45 +1,65 @@
 # ChangeLog
+
+## 2.5.1
+
+* Bugfix: Handle string resources referencing other resources.
+
+## 2.5.0
+
+> New begins!
+
 ## 0.7.0
+
 * implement Apk#signs, Apk#certificates and Manifest#version_name (#14, #15)
 * bugfix
 
 ## 0.6.0
+
 * implement Android::Apk#layouts(#10), Android::Apk#icon(#11), Android::Apk#label(#12),
 * fix bug (#13)
 
 ## 0.5.1
+
 * [#8] add Android::Manifest#label
 * [#7] fix wrong boolean value in manifest parser
 * [#6] add accessor Android::Manifest#doc
 
 ## 0.5.0
+
 * [issue #1] implement Android::Resource#find, #res_readable_id, #res_hex_id methods
 
 ## 0.4.2
+
 * fix bugs(#2, #3)
 * divide change log from readme
 
 ## 0.4.1
+
 * fix typo
 * add document
 
 ## 0.4.0
+
 * add resource parser
 * enhance dex parser
 
 ## 0.3.0
+
 * add and change name space
 * add Android::Utils module and some util methods
 * add Apk#entry, Apk#each_entry, and Apk#time methods,
 
 ## 0.2.0
+
 * update documents
 * add Apk::Dex#each_strings, Apk::Dex#each_class_names
 
 ## 0.1.2
+
 * fix bug(improve android binary xml parser)
 
 ## 0.1.1
+
 * fix bug(failed to initialize Apk::Manifest::Meta class)
 * replace iconv to String#encode(for ruby1.9)
 

data/Gemfile

@@ -1,18 +1,10 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "rubyzip", ">=1.0.0"
+source 'http://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec-its", ">= 1.2.0"
-  gem "rspec-collection_matchers", ">= 1.1.0"
-  gem "rspec-mocks", ">= 3.6.0"
-  gem "bundler", ">= 1.1.5"
-  gem "jeweler"
-  gem "yard", require: false
-  gem "redcarpet"
-  gem "simplecov", require: false
-end
+# Specify your gem's dependencies in android_parser.gemspec
+gemspec
+
+# group :development do
+#   gem 'awesome_print'
+#   gem 'debase'
+#   gem 'ruby-debug-ide'
+# end

data/README.md

@@ -1,25 +1,35 @@
-# ruby_apk
-Android Apk static analysis library for Ruby.
+# android_parser
 
-[![Gem Version](https://badge.fury.io/rb/ruby_apk.png)](http://badge.fury.io/rb/ruby_apk)
-[![Build Status](https://travis-ci.org/playtestcloud/ruby_apk.svg?branch=master)](https://travis-ci.org/playtestcloud/ruby_apk)
-[![Dependency Status](https://gemnasium.com/badges/github.com/playtestcloud/ruby_apk.png)](https://gemnasium.com/github.com/playtestcloud/ruby_apk)
+[![Language](https://img.shields.io/badge/ruby-2.5+-701516.svg)](.github/workflows/ci.yml)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/icyleaf/android_parser/ci.yml)](https://github.com/icyleaf/android_parser/actions/workflows/ci.yml)
+[![Gem version](https://img.shields.io/gem/v/android_parser.svg?style=flat)](https://rubygems.org/gems/android_parser)
+[![License](https://img.shields.io/badge/license-MIT-red.svg?style=flat)](LICENSE.txt)
+
+Android Apk static analysis parser library for Ruby, forked from [playtestcloud/ruby_apk](https://github.com/playtestcloud/ruby_apk).
 
 ## Requirements
-- ruby(>=2.2.2)
+
+- ruby (>= 2.5)
 
 ## Install
-    $ gem install ruby_apk
+
+```bash
+gem install android_parser
+```
 
 ## Usage
+
 ### Initialize
+
 ```ruby
-  require 'ruby_apk'
-  apk = Android::Apk.new('sample.apk') # set apk file path
+require 'android_parser'
+
+apk = Android::Apk.new('sample.apk') # set apk file path
 ```
 
 ### Apk
 #### Listing files in Apk
+
 ```ruby
 # listing files in apk
 apk = Android::Apk.new('sample.apk')
@@ -29,126 +39,139 @@ end
 ```
 
 #### Find files in Apk
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  elf_files = apk.find{|name, data| data[0..3] == [0x7f, 0x45, 0x4c, 0x46] } # ELF magic number
+apk = Android::Apk.new('sample.apk')
+elf_files = apk.find{|name, data| data[0..3] == [0x7f, 0x45, 0x4c, 0x46] } # ELF magic number
 ```
 
 #### Extract icon data in Apk (since 0.6.0)
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  icons = apk.icon # { "res/drawable-hdpi/ic_launcher.png" => "\x89PNG\x0D\x0A...", ... }
-  icons.each do |name, data|
-    File.open(File.basename(name), 'wb') {|f| f.write data } # save to file.
-  end
+apk = Android::Apk.new('sample.apk')
+icons = apk.icon # { "res/drawable-hdpi/ic_launcher.png" => "\x89PNG\x0D\x0A...", ... }
+icons.each do |name, data|
+  File.open(File.basename(name), 'wb') {|f| f.write data } # save to file.
+end
 ```
 
 #### Extract signature and certificate information from Apk (since v0.7.0)
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  signs = apk.signs # retrun Hash(key: signature file path, value: OpenSSL::PKCS7)
-  signs.each do |path, sign|
-    puts path # => "MATA-INF/CERT.RSA" or ...
-    puts sign # => "-----BEGIN PKCS7-----\n..." PKCS7 object
-  end
+apk = Android::Apk.new('sample.apk')
+signs = apk.signs # retrun Hash(key: signature file path, value: OpenSSL::PKCS7)
+signs.each do |path, sign|
+  puts path # => "MATA-INF/CERT.RSA" or ...
+  puts sign # => "-----BEGIN PKCS7-----\n..." PKCS7 object
+end
 
-  certs = apk.certificates # retrun Hash(key: signature file path, value: OpenSSL::X509::Certificate)
-  certs.each do |path, cert|
-    puts path # => "MATA-INF/CERT.RSA" or ...
-    puts cert # => "-----BEGIN CERTIFICATE-----\n..." # X509::Certificate object
-  end
+certs = apk.certificates # retrun Hash(key: signature file path, value: OpenSSL::X509::Certificate)
+certs.each do |path, cert|
+  puts path # => "MATA-INF/CERT.RSA" or ...
+  puts cert # => "-----BEGIN CERTIFICATE-----\n..." # X509::Certificate object
+end
 ```
 Note: Most apks have only one signature and cerficate.
 
 ### Manifest
+
 #### Get readable xml
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  manifest = apk.manifest
-  puts manifest.to_xml
+apk = Android::Apk.new('sample.apk')
+manifest = apk.manifest
+puts manifest.to_xml
 ```
 
 #### Listing components and permissions
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  manifest = apk.manifest
-  # listing components
-  manifest.components.each do |c| # 'c' is Android::Manifest::Component object
-    puts "#{c.type}: #{c.name}" 
-    c.intent_filters.each do |filter|
-      puts "\t#{filter.type}"
-    end
+apk = Android::Apk.new('sample.apk')
+manifest = apk.manifest
+# listing components
+manifest.components.each do |c| # 'c' is Android::Manifest::Component object
+  puts "#{c.type}: #{c.name}"
+  c.intent_filters.each do |filter|
+    puts "\t#{filter.type}"
   end
+end
 
-  # listing use-permission tag
-  manifest.use_permissions.each do |permission|
-    puts permission
-  end
+# listing use-permission tag
+manifest.use_permissions.each do |permission|
+  puts permission
+end
 ```
 
 #### Extract application label string
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  puts apk.manifest.label
+apk = Android::Apk.new('sample.apk')
+puts apk.manifest.label
 ```
 
 ### Resource
+
 #### Extract resource strings from apk
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  rsc = apk.resource
-  rsc.strings.each do |str|
-    puts str
-  end
+apk = Android::Apk.new('sample.apk')
+rsc = apk.resource
+rsc.strings.each do |str|
+  puts str
+end
 ```
 
 #### Parse resource file directly
+
 ```ruby
-  rsc_data = File.open('resources.arsc', 'rb').read{|f| f.read }
-  rsc = Android::Resource.new(rsc_data)
+rsc_data = File.open('resources.arsc', 'rb').read{|f| f.read }
+rsc = Android::Resource.new(rsc_data)
 ```
 
 ### Resolve resource id
+
 This feature supports only srting resources for now.
 
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  rsc = apk.resource
-  
-  # assigns readable resource id
-  puts rsc.find('@string/app_name') # => 'application name'
+apk = Android::Apk.new('sample.apk')
+rsc = apk.resource
 
-  # assigns hex resource id
-  puts rsc.find('@0x7f040000') # => 'application name'
+# assigns readable resource id
+puts rsc.find('@string/app_name') # => 'application name'
 
-  # you can set lang attribute.
-  puts rsc.find('@0x7f040000', :lang => 'ja')
-```
+# assigns hex resource id
+puts rsc.find('@0x7f040000') # => 'application name'
 
+# you can set lang attribute.
+puts rsc.find('@0x7f040000', :lang => 'ja')
+```
 
 ### Dex
+
 #### Extract dex information
+
 ```ruby
-  apk = Android::Apk.new('sample.apk')
-  dex = apk.dex
-  # listing string table in dex
-  dex.strings.each do |str|
-    puts str
-  end
+apk = Android::Apk.new('sample.apk')
+dex = apk.dex
+# listing string table in dex
+dex.strings.each do |str|
+  puts str
+end
 
-  # listing all class names
-  dex.classes.each do |cls| # cls is Android::Dex::ClassInfo
-    puts "class: #{cls.name}"
-    cls.virtual_methods.each do |m| # Android::Dex::MethodInfo
-      puts "\t#{m.definition}" # puts method definition
-    end
+# listing all class names
+dex.classes.each do |cls| # cls is Android::Dex::ClassInfo
+  puts "class: #{cls.name}"
+  cls.virtual_methods.each do |m| # Android::Dex::MethodInfo
+    puts "\t#{m.definition}" # puts method definition
   end
+end
 ```
 
 #### Parse dex file directly
+
 ```ruby
-  dex_data = File.open('classes.dex','rb').read{|f| f.read }
-  dex = Android::Dex.new(dex_data)
+dex_data = File.open('classes.dex','rb').read{|f| f.read }
+dex = Android::Dex.new(dex_data)
 ```
 
 

data/Rakefile

@@ -1,44 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'android_parser'
 require 'bundler/gem_tasks'
-
-# require 'jeweler'
-# Jeweler::Tasks.new do |gem|
-#   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-#   gem.name = "android_parser"
-#   gem.homepage = "https://github.com/icyleaf/ruby_apk"
-#   gem.license = "MIT"
-#   gem.summary = %Q{static analysis tool for android apk}
-#   gem.description = %Q{static analysis tool for android apk}
-#   gem.email = "info@securebrain.co.jp"
-#   gem.authors = ["SecureBrain"]
-#   # dependencies defined in Gemfile
-# end
-# Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
 
-# require 'yard'
-# require 'yard/rake/yardoc_task'
-# YARD::Rake::YardocTask.new do |t|
-#   t.files = ['lib/**/*.rb']
-#   t.options = []
-#   t.options << '--debug' << '--verbose' if $trace
-# end
+task default: :spec

data/android_parser.gemspec

@@ -1,64 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: ruby_apk 2.3.0 ruby lib
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "android_parser".freeze
-  s.version = "2.4.1"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["SecureBrain".freeze]
-  s.date = "2021-08-04"
-  s.description = "static analysis tool for android apk".freeze
-  s.email = "info@securebrain.co.jp".freeze
-  s.extra_rdoc_files = [
-    "CHANGELOG.md",
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.homepage = "https://github.com/icyleaf/ruby_apk".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.3".freeze
-  s.summary = "static analysis tool for android apk".freeze
+Gem::Specification.new do |spec|
+  spec.name          = 'android_parser'
+  spec.version       = '2.5.1'
+  spec.authors       = ['SecureBrain', 'icyleaf']
+  spec.email         = ['info@securebrain.co.jp', 'icyleaf.cn@gmail.com']
+  spec.platform      = Gem::Platform::RUBY
+  spec.summary       = 'Static analysis tool for android apk since 2021'
+  spec.description   = 'Static analysis tool for android apk since 2021'
+  spec.homepage      = 'https://github.com/icyleaf/android_parser'
+  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'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.add_dependency 'rubyzip', '>= 1.0', '< 3.0'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rubyzip>.freeze, [">= 1.0.0"])
-      s.add_development_dependency(%q<rspec-its>.freeze, [">= 1.2.0"])
-      s.add_development_dependency(%q<rspec-collection_matchers>.freeze, [">= 1.1.0"])
-      s.add_development_dependency(%q<rspec-mocks>.freeze, [">= 3.6.0"])
-      s.add_development_dependency(%q<bundler>.freeze, [">= 1.1.5"])
-      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
-      s.add_development_dependency(%q<yard>.freeze, [">= 0"])
-      s.add_development_dependency(%q<redcarpet>.freeze, [">= 0"])
-      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<rubyzip>.freeze, [">= 1.0.0"])
-      s.add_dependency(%q<rspec-its>.freeze, [">= 1.2.0"])
-      s.add_dependency(%q<rspec-collection_matchers>.freeze, [">= 1.1.0"])
-      s.add_dependency(%q<rspec-mocks>.freeze, [">= 3.6.0"])
-      s.add_dependency(%q<bundler>.freeze, [">= 1.1.5"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
-      s.add_dependency(%q<yard>.freeze, [">= 0"])
-      s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
-      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rubyzip>.freeze, [">= 1.0.0"])
-    s.add_dependency(%q<rspec-its>.freeze, [">= 1.2.0"])
-    s.add_dependency(%q<rspec-collection_matchers>.freeze, [">= 1.1.0"])
-    s.add_dependency(%q<rspec-mocks>.freeze, [">= 3.6.0"])
-    s.add_dependency(%q<bundler>.freeze, [">= 1.1.5"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
-    s.add_dependency(%q<yard>.freeze, [">= 0"])
-    s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0') then
+    spec.add_dependency 'rexml', '> 3.0'
   end
-end
 
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '>= 1.2.0'
+  spec.add_development_dependency 'rspec-collection_matchers', '>= 1.1.0'
+  spec.add_development_dependency 'rspec-mocks', '>= 3.6.0'
+  spec.add_development_dependency 'bundler', '>= 1.12'
+  spec.add_development_dependency 'rake', '>= 10.0'
+end

data/lib/android/apk.rb

@@ -1,8 +1,10 @@
-require 'zip' # need rubyzip gem -> doc: http://rubyzip.sourceforge.net/
+# frozen_string_literal: true
+
 require 'digest/md5'
 require 'digest/sha1'
 require 'digest/sha2'
 require 'openssl'
+require 'zip'
 
 module Android
   class NotApkFileError < StandardError; end
@@ -37,12 +39,14 @@ module Android
     # @raise [Android::NotFoundError] path file does'nt exist
     # @raise [Android::NotApkFileError] path file is not Apk file.
     def initialize(filepath)
+      Zip.warn_invalid_date = false
+
       @path = filepath
       raise NotFoundError, "'#{filepath}'" unless File.exist? @path
       begin
         @zip = Zip::File.open(@path)
       rescue Zip::Error => e
-        raise NotApkFileError, e.message 
+        raise NotApkFileError, e.message
       end
 
       @bindata = File.open(@path, 'rb') {|f| f.read }
@@ -51,7 +55,7 @@ module Android
       begin
         @resource = Android::Resource.new(self.file(RESOURCE))
       rescue => e
-        $stderr.puts "failed to parse resource:#{e}"
+        $stderr.puts "failed to parse resource: #{e}"
         #$stderr.puts e.backtrace
       end
       begin

data/lib/android/axml_parser.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'rexml/document'
 require 'stringio'
 
-
 module Android
   # binary AXML parser
   # @see https://android.googlesource.com/platform/frameworks/base.git Android OS frameworks source
@@ -12,8 +13,10 @@ module Android
   #
   #   /frameworks/base/libs/androidfw/ResourceTypes.cpp
   class AXMLParser
+    HEADER = "\x03\x00\x08\x00"
+
     def self.axml?(data)
-      (data[0..3] == "\x03\x00\x08\x00")
+      (data[0..3] == HEADER)
     end
 
     # axml parse error

data/lib/android/axml_writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rexml/document'
 require 'stringio'
 

data/lib/android/dex/access_flag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Android
   class Dex
@@ -39,7 +40,7 @@ module Android
         ACCESSORS.select{|e| ((e[:value] & @flag) != 0) }.map{|e| e[:name] }.join(' ')
       end
     end
-   
+
     # access flag object for method in dex
     class MethodAccessFlag < AccessFlag
       ACCESSORS = [