apk_unpack 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTY1MGUxMzg3NWEwMjFhMTNkMzM2MmM5MTlhMDdhZGVlYTQ0YjczNw==
+  data.tar.gz: !binary |-
+    YjNlNmE0MmYyMTU3ZGIxNzhmNDRlODU0YmU0YmU3MDliODRkZTA1ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZDMzZmM0MzI1OGEyOWFjMzRhYjE2NzNhNWMwMTliOWIwYzYzZjYxNjA2YzRh
+    OTM4OGE1N2RmZjgwYzgwYWYxMTQ1MGQwMzZhZTVhMTJjNDI4MDE1MDUyZWY2
+    YjI5MzllYTRjOThmMmY4YWQ1MGI5YzRhZjI4NGJiMWM1ZjUzYTA=
+  data.tar.gz: !binary |-
+    MjY4ZTZlZWMzZGZiNGMyNTMxZWYyMDgyNWY2Y2VjMjJhZTdkZGFiM2YzMGFm
+    ODZkNTY3MzMyNDU5ZmIwMjQzM2ExZDQ1OGVlMDNlYWQ1OTM1Mjc3Y2NmMWJj
+    ZGMyOWUzMzI5Y2E2NjkxZTJjNGNmOWU2ZDQ2ZTVjYzE0MjYwZmU=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 nVisium
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# ApkUnpack
+
+Ruby Gem to Unpack APK(s)

data/bin/apk_unpack

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'lib/apk_unpack'
+
+
+ApkUnpack.run

data/lib/apk_unpack.rb

@@ -0,0 +1,27 @@
+require 'utilities/string'
+require 'utilities/parsing'
+require 'decompiler/decompiler'
+require 'optparse'
+
+class ApkUnpack
+	def self.run 
+		options = {}
+		OptionParser.new do |opts|
+  			opts.banner = "Usage: example.rb [options]"
+  			
+  			opts.on("-c", "--config [Config File]", "Configuration file in YAML format") do |c|
+    			options[:config_file] = c
+  			end
+
+			opts.on("-h", "--help", "Displays help information") do
+    			puts opts 
+    			exit
+  			end
+		end.parse!
+		if !options.empty?
+			 Parsing.parse(options[:config_file])
+		else
+  			Decompiler.run
+		end
+	end
+end

data/lib/decompiler/decompiler.rb

@@ -0,0 +1,74 @@
+
+class Decompiler
+  def self.my_hash
+   {
+  "apk" => "file",
+  "apktool" => "file",
+  "output directory" => "dir",
+  "d2j-dex2jar .sh or .bat" => "file"
+  }
+  end
+  
+  def self.run
+ 	 my_hash.each do |k,v|
+  		puts "Please specify the absolute location of the #{k}"
+  		instance_variable_set("@#{k}".underscore, gets.chomp)
+		unless self.exists(v,k)
+			redo
+		end
+ 	 end
+ 	 execute
+ 	 rescue ::Interrupt
+ 	 	puts "\nGoodbye"
+  end
+    
+  def self.exists(data_type, entity)  
+  	val = instance_variable_get ("@#{entity}".underscore)
+  	case data_type
+  	when "dir"
+  		Dir.exists?(val)
+  	when "file"
+  		File.exists?(val)
+  	end 
+  end
+  
+  def self.set_static_vars(opts={})
+    raise "NoOptionsProvidedFromConfigFile" if opts.empty?
+    @apktool = opts[:apktool]
+    @output_directory = opts[:output_directory]
+    @d2j_dex2jar_sh_or_bat = opts[:d2j]
+  end  
+  
+  # This method defines the instance variable @apk as the location            
+  # of the APK file that the user has provided.
+  def self.set_apk_var(apk_loc = "")
+     raise "NotAValidApkLocationValue" if !(apk_loc.kind_of?(String))
+     raise "NoAPKProvidedFromConfigFile" if apk_loc.empty?
+     @apk = apk_loc
+   end
+  
+  def self.execute
+	run_apktool
+	run_dex2jar
+  end
+  
+  def self.convert_apkname_to_underscore
+  	file_name = File.basename(@apk).underscore.tr(".", "_")
+  end
+  
+  def self.convert_apk_to_jar
+  	file_name = File.basename(@apk).sub(/.apk/, ".jar")
+  end
+  
+  def self.run_apktool
+   	system "java", "-jar", @apktool, "d", "-f", @apk, "#{@output_directory}/apktool_output/#{self.convert_apkname_to_underscore}" 
+  end
+  
+  def self.run_dex2jar
+     	path = "#{@output_directory}/dex2jar_output"
+     	Dir.mkdir path if not Dir.exist? path	
+     	system @d2j_dex2jar_sh_or_bat, @apk, "-f", "-o", "#{path}/#{convert_apk_to_jar}" 
+  end
+
+end
+

data/lib/utilities/parsing.rb

@@ -0,0 +1,48 @@
+require 'yaml'
+
+class Parsing
+  
+  def self.parse(file_location=nil, test=false)
+    raise "NoFileProvidedForParsing" if !(file_location)
+    yaml_c = test ? modify_yaml_attrs : parse_config_file(file_location) 
+    opts = generate_options_from_yaml(yaml_c)   
+    variable_set(opts)
+  end
+  
+  def self.parse_config_file(file_location)
+    yaml_c = YAML.load_file(file_location)
+  end
+  
+  def self.modify_yaml_attrs
+   yaml_c = {
+   "apk" => ENV["APK"],
+   "apktool" => ENV["APKTOOL"],
+   "output_directory" => ENV["OUTPUT_DIR"],
+   "d2j" => ENV["DEX2JAR"]
+    }
+  end
+  
+  def self.generate_options_from_yaml(yaml_c) 
+     options = {}
+     options[:apk] = yaml_c["apk"]
+     options[:apktool] = yaml_c["apktool"]
+     options[:output_directory] = yaml_c["output_directory"]
+     options[:d2j] = yaml_c["d2j"]
+    return options  
+  end
+  
+  def self.variable_set(options={})
+    Decompiler.set_static_vars(options)
+    apk_loc = options[:apk]
+    if apk_loc.kind_of?(String)
+      Decompiler.set_apk_var(apk_loc)
+      Decompiler.execute
+    elsif apk_loc.kind_of?(Array)
+      apk_loc.each do |apkl|
+        Decompiler.set_apk_var(apkl)
+        Decompiler.execute
+      end
+    end
+  end
+   
+end

data/lib/utilities/string.rb

@@ -0,0 +1,12 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    tr(" ", "_").
+    tr(".", "_").
+    tr("__", "_")
+    downcase
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: apk_unpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abdullah Munawar
+- Marcus Richardson
+- Riandi Wiguna
+- Ken Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n                        The APKUnpack tool is used to quickly decompile
+  one or more APK applications essentially automating a     simple but time consuming
+  task. This tool requires that you have the APKTool and Dex2Jar applications on your
+  machine.\n                        "
+email:
+- abdullah.munawar@nvisiumsecurity.com
+executables:
+- apk_unpack
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/apk_unpack
+- lib/apk_unpack.rb
+- lib/decompiler/decompiler.rb
+- lib/utilities/parsing.rb
+- lib/utilities/string.rb
+homepage: http://nvisium.github.io/ruby_apk_unpack/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby gem intended to simplify decompiling APK files.
+test_files: []