ruby_apk 0.5.1 → 0.6.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # ChangeLog
+## 0.6.0
+* implement Android::Apk#layouts(#10), Android::Apk#icon(#11), Android::Apk#label(#12),
+* fix bug (#13)
+
 ## 0.5.1
-* [#8] ass Android::Manifest#label
+* [#8] add Android::Manifest#label
 * [#7] fix wrong boolean value in manifest parser
 * [#6] add accessor Android::Manifest#doc
 

data/README.md

@@ -1,6 +1,8 @@
 # ruby_apk
 Android Apk static analysis library for Ruby.
 
+[![Build Status](https://travis-ci.org/SecureBrain/ruby_apk.png)](https://travis-ci.org/SecureBrain/ruby_apk)
+
 ## Requirements
 - ruby(>=1.9.x)
 
@@ -30,6 +32,20 @@ end
   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
+```
+#### Extract application label string (since 0.6.0)
+```ruby
+  apk = Android::Apk.new('sample.apk')
+  puts apk.label
+```
+
 ### Manifest
 #### Get readable xml
 ```ruby

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/android/apk.rb

@@ -150,6 +150,43 @@ module Android
       end
       found
     end
+
+    # extract icon data from AndroidManifest and resource.
+    # @return [Hash{ String => String }] hash key is icon filename. value is image data
+    # @raise [NotFoundError]
+    # @since 0.6.0
+    def icon
+      icon_id = @manifest.doc.elements['/manifest/application'].attributes['icon']
+      if /^@(\w+\/\w+)|(0x[0-9a-fA-F]{8})$/ =~ icon_id
+        drawables = @resource.find(icon_id)
+        Hash[drawables.map {|name| [name, file(name)] }]
+      else 
+        { icon_id => file(icon_id) } # ugh!: not tested!!
+      end
+    end
+
+    # get application label from AndroidManifest and resources.
+    # @param [String] lang language code like 'ja', 'cn', ...
+    # @return [String] application label string
+    # @return [nil] when label is not found
+    # @since 0.6.0
+    def label(lang=nil)
+      label_id = @manifest.label
+      if /^@(\w+\/\w+)|(0x[0-9a-fA-F]{8})$/ =~ label_id
+        opts = {}
+        opts[:lang] = lang unless lang.nil?
+        @resource.find(label_id, opts)
+      else
+        label_id # include nil
+      end
+    end
+
+    # get screen layout xml datas
+    # @return [Hash{ name => Android::Layout }]
+    # @since 0.6.0
+    def layouts
+      @layouts ||= Layout.collect_layouts(self) # lazy parse
+    end
   end
 end
 

data/lib/android/axml_parser.rb

@@ -12,6 +12,10 @@ module Android
   #   
   #   /frameworks/base/libs/androidfw/ResourceTypes.cpp
   class AXMLParser
+    def self.axml?(data)
+      (data[0..3] == "\x03\x00\x08\x00")
+    end
+
     # axml parse error
     class ReadError < StandardError; end
 
@@ -81,18 +85,10 @@ module Android
       @io.read(2).unpack("v")[0]
     end
 
-    # parse string table
+    # relace string table parser
     def parse_strings
-      sit_off = 0x24                  # string index table offset
-      st_off = sit_off + @num_str * 4 # string table offset
-      @strings = []
-      @num_str.times do |i|
-        pos = st_off + word(sit_off + (4 * i)) # get position from string index table
-        len = short(pos) # read string length(not bytes)
-        str = @io.read(len*2) # read string(UTF-16LE)
-        str.force_encoding(Encoding::UTF_16LE)
-        @strings[i] = str.encode(Encoding::UTF_8)
-      end
+      strpool = Resource::ResStringPool.new(@io.string, 8) # ugh!
+      @strings = strpool.strings
     end
 
     # parse tag

data/lib/android/layout.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'ruby_apk'
+require 'rexml/document'
+
+module Android
+  class Layout
+    # @return [Hash] { path => Layout }
+    def self.collect_layouts(apk)
+      targets = apk.find {|name, data| name =~ /^res\/layout\/*/ }
+      ret = {}
+      targets.each do |path| 
+        data = apk.file(path)
+        data.force_encoding(Encoding::ASCII_8BIT)
+        ret[path] = nil
+        begin
+          ret[path] = Layout.new(data, path) if AXMLParser.axml?(data)
+        rescue => e
+          $stderr.puts e
+        end
+      end
+      ret
+    end
+
+    # @return [String] layout file path
+    attr_reader :path
+    # @return [REXML::Document] xml document object
+    attr_reader :doc
+
+    def initialize(data, path=nil)
+      @data = data
+      @path = path
+      @doc = AXMLParser.new(data).parse
+    end
+
+    # @return [String] xml string
+    def to_xml(indent=4)
+      xml = ''
+      formatter = REXML::Formatters::Pretty.new(indent)
+      formatter.write(@doc.root, xml)
+      xml
+    end
+  end
+end
+

data/lib/android/manifest.rb

@@ -206,8 +206,16 @@ module Android
 
     # application label
     # @return [String] application label string or resource id (like @0x7f04001)
+    # @since 0.5.1
     def label
-      @doc.elements['/manifest/application'].attributes['label']
+      label = @doc.elements['/manifest/application'].attributes['label']
+      if label.nil?
+        # application element has no label attributes.
+        # so looking for activites that has label attribute.
+        activities = @doc.elements['/manifest/application'].find{|e| e.name == 'activity' && !e.attributes['label'].nil? }
+        label = activities.nil? ? nil : activities.first.attributes['label']
+      end
+      label
     end
 
     # return xml as string format

data/lib/android/resource.rb

@@ -123,7 +123,7 @@ module Android
       # @option opts [String] :contry cantry code like 'jp'...
       # @raise [ArgumentError] invalid id format
       # @note
-      #  This method only support string resource for now.
+      #  This method only support string and drawable resource for now.
       # @note
       #  Always return nil if assign not string type res id.
       #
@@ -132,13 +132,24 @@ module Android
         tid = ((hex_id&0xff0000) >>16)
         key = hex_id&0xffff
 
-        if type(tid) == 'string'
+        case type(tid) 
+        when 'string'
           return find_res_string(key, opts)
+        when 'drawable'
+          drawables = []
+          @types[tid].each do |type|
+            unless type[key].nil?
+              drawables << @global_string_pool.strings[type[key].val.data]
+            end
+          end
+          return drawables
         else
           nil
         end
       end
 
+      def res_types
+      end
       def find_res_string(key, opts={})
         unless opts[:lang].nil?
           string = @res_strings_lang[opts[:lang]]
@@ -483,10 +494,10 @@ module Android
       first_pkg.res_hex_id(readable_id)
     end
 
-    private
     def first_pkg
       @packages.first[1]
     end
+    private
     def parse
       offset = 0
 

data/lib/ruby_apk.rb

@@ -4,3 +4,4 @@ require_relative 'android/axml_parser'
 require_relative 'android/dex'
 require_relative 'android/resource'
 require_relative 'android/utils'
+require_relative 'android/layout'

data/ruby_apk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby_apk"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["SecureBrain"]
-  s.date = "2013-05-01"
+  s.date = "2013-05-05"
   s.description = "static analysis tool for android apk"
   s.email = "info@securebrain.co.jp"
   s.extra_rdoc_files = [
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".rspec",
+    ".travis.yml",
     "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "lib/android/dex/dex_object.rb",
     "lib/android/dex/info.rb",
     "lib/android/dex/utils.rb",
+    "lib/android/layout.rb",
     "lib/android/manifest.rb",
     "lib/android/resource.rb",
     "lib/android/utils.rb",
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
     "spec/dex/info_spec.rb",
     "spec/dex/utils_spec.rb",
     "spec/dex_spec.rb",
+    "spec/layout_spec.rb",
     "spec/manifest_spec.rb",
     "spec/resource_spec.rb",
     "spec/ruby_apk_spec.rb",
@@ -59,7 +61,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/SecureBrain/ruby_apk/"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.16"
   s.summary = "static analysis tool for android apk"
 
   if s.respond_to? :specification_version then

data/spec/apk_spec.rb

@@ -265,4 +265,27 @@ describe Android::Apk do
       end
     end
   end
+
+  describe "#icon" do
+    context "with real apk file" do
+      let(:tmp_path){ File.expand_path(File.dirname(__FILE__) + '/data/sample.apk') }
+      subject { apk.icon }
+      it { should be_a Hash }
+      it { should have(3).items }
+      it { subject.keys.should =~ ["res/drawable-hdpi/ic_launcher.png", "res/drawable-ldpi/ic_launcher.png", "res/drawable-mdpi/ic_launcher.png"]
+ }
+    end
+  end
+
+  describe "#label" do
+    context "with real apk file" do
+      let(:tmp_path){ File.expand_path(File.dirname(__FILE__) + '/data/sample.apk') }
+      subject { apk.label }
+      it { should eq 'Sample' }
+      context 'when assign lang code' do
+        subject { apk.label('ja') }
+        it { should eq 'Sample' }
+      end
+    end
+  end
 end

data/spec/dex/dex_object_spec.rb

@@ -3,13 +3,15 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Android::Dex do
   describe Android::Dex::DexObject::Header do
     let(:header_sample) {
-      "\x64\x65\x78\x0A\x30\x33\x35\x00\x3F\x14\x98\x2C\x25\x77\x9B\x8D" +
-      "\x7C\xF0\x0B\xFA\x4D\x7B\x03\xAD\x4C\x15\xBC\x31\x4F\xD3\x4B\x71" +
-      "\x58\x18\x00\x00\x70\x00\x00\x00\x78\x56\x34\x12\x00\x00\x00\x00" +
-      "\x00\x00\x00\x00\x88\x17\x00\x00\x7A\x00\x00\x00\x70\x00\x00\x00" +
-      "\x23\x00\x00\x00\x58\x02\x00\x00\x0E\x00\x00\x00\xE4\x02\x00\x00" +
-      "\x10\x00\x00\x00\x8C\x03\x00\x00\x2C\x00\x00\x00\x0C\x04\x00\x00" +
-      "\x0A\x00\x00\x00\x6C\x05\x00\x00\xAC\x11\x00\x00\xAC\x06\x00\x00"
+      sample = 
+        "\x64\x65\x78\x0A\x30\x33\x35\x00\x3F\x14\x98\x2C\x25\x77\x9B\x8D" +
+        "\x7C\xF0\x0B\xFA\x4D\x7B\x03\xAD\x4C\x15\xBC\x31\x4F\xD3\x4B\x71" +
+        "\x58\x18\x00\x00\x70\x00\x00\x00\x78\x56\x34\x12\x00\x00\x00\x00" +
+        "\x00\x00\x00\x00\x88\x17\x00\x00\x7A\x00\x00\x00\x70\x00\x00\x00" +
+        "\x23\x00\x00\x00\x58\x02\x00\x00\x0E\x00\x00\x00\xE4\x02\x00\x00" +
+        "\x10\x00\x00\x00\x8C\x03\x00\x00\x2C\x00\x00\x00\x0C\x04\x00\x00" +
+        "\x0A\x00\x00\x00\x6C\x05\x00\x00\xAC\x11\x00\x00\xAC\x06\x00\x00"
+      sample.force_encoding(Encoding::ASCII_8BIT)
     }
     let(:header) { Android::Dex::DexObject::Header.new(header_sample) }
     describe "#symbols" do

data/spec/layout_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Android::Layout do
+  context 'with real apk sample file' do
+    let(:apk_path){ File.expand_path(File.dirname(__FILE__) + '/data/sample.apk') }
+    let(:apk){ Android::Apk.new(apk_path) }
+    let(:layouts) { apk.layouts }
+    subject { layouts }
+    it { should be_a Hash }
+    it { should have_key "res/layout/main.xml" }
+    it { should have(1).item }
+    context 'about first item' do
+      subject { layouts['res/layout/main.xml'] }
+      it { should be_a Android::Layout }
+      describe '#path' do
+        it { subject.path.should eq 'res/layout/main.xml' }
+      end
+      describe '#doc' do
+        it { subject.doc.should be_a REXML::Document }
+      end
+      describe '#to_xml' do
+        it { subject.to_xml.should be_a String }
+      end
+    end
+  end
+end
+

data/spec/resource_spec.rb

@@ -84,6 +84,20 @@ describe Android::Resource do
       end
     end
 
+    context 'with str_resources.arsc data' do
+      let(:res_data) { File.read(File.expand_path(File.dirname(__FILE__) + '/data/str_resources.arsc')) }
+      subject { resource }
+      describe 'about drawable resource' do
+        it 'hoge' do
+          table = resource.packages.first[1]
+          p table
+          table.type_strings.each_with_index do |type, id|
+            puts "[0x#{(id+1).to_s(16)}] #{type}"
+          end
+          puts "readable id:" + table.res_readable_id('@0x7f020000')
+        end
+      end
+    end
     context 'with str_resources.arsc data' do
       let(:res_data) { File.read(File.expand_path(File.dirname(__FILE__) + '/data/str_resources.arsc')) }
       subject { resource }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_apk
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833627600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70114833627600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833625800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.11.0
+  version_requirements: *70114833625800
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833624840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,15 +43,10 @@ dependencies:
         version: 1.1.5
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.5
+  version_requirements: *70114833624840
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833622960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -69,15 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.4
+  version_requirements: *70114833622960
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833622080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70114833622080
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833637060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,15 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70114833637060
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70114833634900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -117,12 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70114833634900
 description: static analysis tool for android apk
 email: info@securebrain.co.jp
 executables: []
@@ -131,7 +96,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -146,6 +111,7 @@ files:
 - lib/android/dex/dex_object.rb
 - lib/android/dex/info.rb
 - lib/android/dex/utils.rb
+- lib/android/layout.rb
 - lib/android/manifest.rb
 - lib/android/resource.rb
 - lib/android/utils.rb
@@ -164,6 +130,7 @@ files:
 - spec/dex/info_spec.rb
 - spec/dex/utils_spec.rb
 - spec/dex_spec.rb
+- spec/layout_spec.rb
 - spec/manifest_spec.rb
 - spec/resource_spec.rb
 - spec/ruby_apk_spec.rb
@@ -184,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1470903068031812848
+      hash: -3061789134736537466
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -193,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: static analysis tool for android apk

data/.rspec

@@ -1 +0,0 @@
---color --format d