ruby_apk 0.4.0

data/spec/dex_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Android::Dex do
+  let(:dex_path){ File.expand_path(File.dirname(__FILE__) + '/data/sample_classes.dex') }
+  let(:dex_bin){ File.open(dex_path, 'rb') {|f| f.read } }
+  let(:dex){ Android::Dex.new(dex_bin) }
+
+
+  describe '#initialize' do
+    subject { dex }
+    context 'with valid dex data' do
+      it { should be_instance_of(Android::Dex) }
+    end
+    context 'with nil data' do
+      let(:dex_bin) { nil }
+      specify { expect{ subject }.to raise_error  }
+    end
+  end
+
+  describe '#data' do
+    subject { dex.data }
+    it { should be_instance_of String }
+    specify { subject.encoding.should eq Encoding::ASCII_8BIT }
+  end
+
+  describe '#strings' do
+    let(:num_str) { dex.header[:string_ids_size] }
+    subject { dex.strings }
+    it { should be_instance_of Array }
+    it 'should have string_ids_size items' do
+      should have(num_str).items
+    end
+    it "should be the particular string(depends on sample_classes.dex)" do
+      subject[0].should eq "%d"
+    end
+    it "should be the particular string(depends on sample_classes.dex)" do
+      subject[1].should eq "<init>"
+    end
+    it "should be the particular string(depends on sample_classes.dex)" do
+      subject[2].should eq "BuildConfig.java"
+    end
+  end
+    describe '#inspect' do
+      subject { dex.inspect }
+      it { should match(/\A<Android::Dex.*>\Z/m) }
+    end
+
+  describe '#classes' do
+    subject { dex.classes }
+    let(:num_classes) { dex.header[:class_defs_size] }
+    it{ should be_instance_of Array }
+    it{ should have(num_classes).items }
+    describe 'first item' do
+      subject { dex.classes.first }
+      it{ should be_instance_of Android::Dex::ClassInfo }
+    end
+  end
+end
+

data/spec/manifest_spec.rb

@@ -0,0 +1,179 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Android::Manifest do
+  describe Android::Manifest::Component do
+    describe "self.valid?" do
+      let(:elem) { REXML::Element.new('service') }
+      subject { Android::Manifest::Component.valid?(elem) }
+      context "with valid component element" do
+        it { should be_true }
+      end
+      context "with invalid component element" do
+        let(:elem) { REXML::Element.new('invalid-name') }
+        it { should be_false }
+      end
+      context "when some exception occurs in REXML::Element object" do
+        let(:elem) {
+          elem = stub(REXML::Element)
+          elem.stub(:name).and_raise(StandardError)
+          elem
+        }
+        it { should be_false }
+      end
+    end
+    describe '#metas' do
+      subject { Android::Manifest::Component.new(elem).metas }
+      context 'with valid component element has 2 meta elements' do
+        let(:elem) { 
+          elem = REXML::Element.new('service') 
+          elem << REXML::Element.new('meta-data')
+          elem << REXML::Element.new('meta-data')
+          elem
+        }
+        it { should have(2).item }
+      end
+    end
+
+    describe Android::Manifest::Meta do
+      let(:elem) do
+        attrs = { 'name' => 'meta name', 'resource' => 'res', 'value' => 'val' }
+        elem = stub(REXML::Element, :attributes => attrs)
+        elem
+      end
+      subject { Android::Manifest::Meta.new(elem) }
+      its(:name) { should eq 'meta name' }
+      its(:resource) { should eq 'res' }
+      its(:value) { should eq 'val' }
+    end
+  end
+
+  describe Android::Manifest::IntentFilter do
+    describe '.parse' do
+      subject { Android::Manifest::IntentFilter.parse(elem) }
+      context 'assings "action" element' do
+        let(:elem) { REXML::Element.new('action') }
+        it { should be_instance_of Android::Manifest::IntentFilter::Action }
+      end
+      context 'assings "category" element' do
+        let(:elem) { REXML::Element.new('category') }
+        it { should be_instance_of Android::Manifest::IntentFilter::Category }
+      end
+      context 'assings "data" element' do
+        let(:elem) { REXML::Element.new('data') }
+        it { should be_instance_of Android::Manifest::IntentFilter::Data }
+      end
+      context 'assings unknown element' do
+        let(:elem) { REXML::Element.new('unknown') }
+        it { should be_nil }
+      end
+    end
+  end
+
+  context "with stub AXMLParser" do
+    let(:dummy_xml) {
+      xml = REXML::Document.new
+      xml << REXML::Element.new('manifest')
+    }
+    let(:manifest) { Android::Manifest.new('mock data') }
+
+    before do
+      parser = stub(Android::AXMLParser, :parse => dummy_xml) 
+      Android::AXMLParser.stub(:new).and_return(parser)
+    end
+
+    describe "#use_parmissions" do
+      subject { manifest.use_permissions }
+      context "with valid 3 parmission elements" do
+        before do
+          3.times do |i|
+            elem = REXML::Element.new("uses-permission")
+            elem.add_attribute 'name', "permission#{i}"
+            dummy_xml.root << elem
+          end
+        end
+        it { subject.should have(3).items }
+        it "should have permissions" do
+          subject.should include("permission0")
+          subject.should include("permission1")
+          subject.should include("permission2")
+        end
+      end
+      context "with no parmissions" do
+        it { should be_empty }
+      end
+    end
+
+    describe "#components" do
+      subject { manifest.components }
+      context "with valid parmission element" do
+        before do
+          app = REXML::Element.new('application')
+          activity = REXML::Element.new('activity')
+          app << activity
+          dummy_xml.root << app
+        end
+        it "should have components" do
+          subject.should have(1).items
+        end
+        it "should returns Component object" do
+          subject[0].should be_kind_of Android::Manifest::Component
+        end
+      end
+      context "with no components" do
+        it { should be_empty }
+      end
+    end
+  end
+
+  context "with real sample_AndroidManifest.xml data" do
+    let(:bin_xml_path){ File.expand_path(File.dirname(__FILE__) + '/data/sample_AndroidManifest.xml') }
+    let(:bin_xml){ File.open(bin_xml_path, 'rb') {|f| f.read } }
+    let(:manifest){ Android::Manifest.new(bin_xml) }
+
+    describe "#components" do
+      subject { manifest.components }
+      it { should be_kind_of Array }
+      it { subject[0].should be_kind_of Android::Manifest::Component }
+    end
+    describe "#package_name" do
+      subject { manifest.package_name }
+      it { should == "example.app.sample" }
+    end
+    describe "#version_code" do
+      subject { manifest.version_code}
+      it { should == 101 }
+    end
+    describe "#version_name" do
+      subject { manifest.version_name}
+      it { should == "1.0.1-malware2" }
+    end
+    describe "#min_sdk_ver" do
+      subject { manifest.min_sdk_ver}
+      it { should == 10 }
+    end
+    describe "#to_xml" do
+      let(:raw_xml){ str = <<EOS
+<manifest xmlns:android='http://schemas.android.com/apk/res/android' android:versionCode='101' android:versionName='1.0.1-malware2' package='example.app.sample'>
+    <uses-sdk android:minSdkVersion='10'/>
+    <uses-permission android:name='android.permission.INTERNET'/>
+    <uses-permission android:name='android.permission.WRITE_EXTERNAL_STORAGE'/>
+    <application android:label='@0x7f040001' android:icon='@0x7f020000' android:debuggable='true'>
+        <activity android:label='@0x7f040001' android:name='example.app.sample.SampleActivity'>
+            <intent-filter>
+                <action android:name='android.intent.action.MAIN'/>
+                <category android:name='android.intent.category.LAUNCHER'/>
+            </intent-filter>
+        </activity>
+    </application>
+</manifest>
+EOS
+        str.strip
+      }
+
+      subject { manifest.to_xml }
+      it "should return correct xml string" do
+        subject.should == raw_xml
+      end
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Android::Resource do
+  let(:res_data) { File.read(res_path) }
+  let(:resource) { Android::Resource.new(res_data) }
+
+  shared_examples_for 'a valid Android::Resource' do
+    subject { resource }
+    describe '#initialize' do
+      context 'assigns resources.arsc data' do
+        it { should be_instance_of Android::Resource }
+      end
+    end
+    its(:package_count) {should eq 1 }
+    describe '#strings' do
+      subject { resource.strings }
+      it { should have(7).items } # depends on sample_resources.arsc
+      it { should include 'Sample' }
+      it { should include 'Hello World, SampleActivity!' }
+      it { should include '日本語リソース' }
+    end
+  end
+  context 'with sample_resources.arsc data' do
+    let(:res_path) { File.expand_path(File.dirname(__FILE__) + '/data/sample_resources.arsc') }
+    it_behaves_like 'a valid Android::Resource'
+
+  end
+  context 'with sample_resources_utf16.arsc data' do
+    let(:res_path) { File.expand_path(File.dirname(__FILE__) + '/data/sample_resources_utf16.arsc') }
+    it_behaves_like 'a valid Android::Resource'
+  end
+
+  describe Android::Resource::ChunkHeader do
+    shared_examples_for 'a chunk header' do
+      its(:type) { should eq 20 }
+      its(:header_size) { should eq 244 }
+      its(:size) { should eq 1000 }
+    end
+    subject { Android::Resource::ChunkHeader.new(data, offset) }
+    context 'with no offset' do
+      let(:data) { "\x14\x00\xF4\x00\xE8\x03\x00\x00" } # [20, 244, 1000].pack('vvV')
+      let(:offset) { 0 }
+      it_behaves_like 'a chunk header'
+    end
+    context 'with 10byte offset' do
+      let(:data) { "\x00"*10 + "\x14\x00\xF4\x00\xE8\x03\x00\x00" } # [20, 244, 1000].pack('vvV')
+      let(:offset) { 10 }
+      it_behaves_like 'a chunk header'
+    end
+  end
+
+  describe Android::Resource::ResStringPool do
+    describe '.utf8_len' do
+      subject { Android::Resource::ResStringPool.utf8_len(data) }
+      context 'assigns 0x7F' do
+        let(:data) { "\x7f" }
+        it { should eq [0x7f, 1] }
+      end
+      context 'assigns x81x01' do
+        let(:data) { "\x81\x01" }
+        it { should eq [0x0101, 2] }
+      end
+      context 'assigns xffxff' do
+        let(:data) { "\xff\xff" }
+        it { should eq [0x7fff, 2] }
+      end
+    end
+    describe '#utf16_len' do
+      subject { Android::Resource::ResStringPool.utf16_len(data) }
+      context 'assigns x7fff' do
+        let(:data) { "\xff\x7f" }
+        it { should eq [0x7fff, 2] }
+      end
+      context 'assigns x8001,x0001' do
+        let(:data) { "\x01\x80\x01\x00" }
+        it { should eq [0x10001, 4] }
+      end
+      context 'assigns xffff,xffff' do
+        let(:data) { "\xff\xff\xff\xff" }
+        it 'should eq 0x7fff 0xffff' do
+          should eq [0x7fffffff, 4] 
+        end
+      end
+    end
+  end
+end

data/spec/ruby_apk_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RubyApk" do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec"
+end
+require 'rspec'
+require 'ruby_apk'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/utils_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Android::Utils do
+  let(:sample_apk_path) { File.expand_path(File.dirname(__FILE__) + '/data/sample.apk') }
+  let(:sample_dex_path) { File.expand_path(File.dirname(__FILE__) + '/data/sample_classes.dex') }
+  describe '.apk?' do
+    subject { Android::Utils.apk?(apk_path) }
+
+    context 'assigns apk file path' do
+      let(:apk_path) { sample_apk_path }
+      it { should be_true }
+    end
+    context 'assigns nil' do
+      let(:apk_path) { nil }
+      it { should be_false }
+    end
+    context 'assigns not exist path' do
+      let(:apk_path) { 'hogehoge' }
+      it { should be_false }
+    end
+    context 'assigns not apk file path' do
+      let(:apk_path) { __FILE__ }
+      it { should be_false }
+    end
+  end
+
+  describe '.elf?' do
+    subject { Android::Utils.elf?(data) }
+    context 'assigns data start with elf magic' do
+      let(:data) { "\x7fELF\xff\xff\xff" }
+      it { should be_true }
+    end
+    context 'assigns nil' do
+      let(:data) { nil }
+      it { should be_false }
+    end
+    context 'assigns not elf data' do
+      let(:data) { "\xff\xff\xff\xff\xff\xff" }
+      it { should be_false }
+    end
+  end
+
+  describe '.cert?' do
+    subject { Android::Utils.cert?(data) }
+    context 'assigns data start with x509 magic' do
+      let(:data) { "\x30\x82\xff\xff\xff" }
+      it { should be_true }
+    end
+    context 'assigns nil' do
+      let(:data) { nil }
+      it { should be_false }
+    end
+    context 'assigns not valid data' do
+      let(:data) { "\xff\xff\xff\xff\xff\xff" }
+      it { should be_false }
+    end
+  end
+
+  describe '.dex?' do
+    subject { Android::Utils.dex?(data) }
+    context 'assigns dex file data' do
+      let(:data) { File.read(sample_dex_path) }
+      it { should be_true }
+    end
+    context 'assigns nil' do
+      let(:data) { nil }
+      it { should be_false }
+    end
+    context 'assings not dex data' do
+      let(:data) { 'hogehoge' }
+      it { should be_false }
+    end
+  end
+  describe '.valid_dex?' do
+    subject { Android::Utils.valid_dex?(data) }
+    context 'assigns dex file data' do
+      let(:data) { File.read(sample_dex_path) }
+      it { should be_true }
+    end
+    context 'assigns nil' do
+      let(:data) { nil }
+      it { should be_false }
+    end
+    context 'assings not dex data' do
+      let(:data) { 'hogehoge' }
+      it { should be_false }
+    end
+  end
+end
+

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: ruby_apk
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- SecureBrain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: static analysis tool for android apk
+email: info@securebrain.co.jp
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/android/apk.rb
+- lib/android/axml_parser.rb
+- lib/android/dex.rb
+- lib/android/dex/access_flag.rb
+- lib/android/dex/dex_object.rb
+- lib/android/dex/info.rb
+- lib/android/dex/utils.rb
+- lib/android/manifest.rb
+- lib/android/resource.rb
+- lib/android/utils.rb
+- lib/ruby_apk.rb
+- ruby_apk.gemspec
+- spec/apk_spec.rb
+- spec/axml_parser_spec.rb
+- spec/data/sample.apk
+- spec/data/sample_AndroidManifest.xml
+- spec/data/sample_classes.dex
+- spec/data/sample_resources.arsc
+- spec/data/sample_resources_utf16.arsc
+- spec/dex/access_flag_spec.rb
+- spec/dex/dex_object_spec.rb
+- spec/dex/info_spec.rb
+- spec/dex/utils_spec.rb
+- spec/dex_spec.rb
+- spec/manifest_spec.rb
+- spec/resource_spec.rb
+- spec/ruby_apk_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
+homepage: http://www.securebrain.co.jp/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 405895141232042325
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: static analysis tool for android apk
+test_files: []