apk_unpack 0.0.1 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTY1MGUxMzg3NWEwMjFhMTNkMzM2MmM5MTlhMDdhZGVlYTQ0YjczNw==
+    MDYzOWEzNTM2YmZmMWE3NzMxMmU1ZmVkNjc5YzNjN2NlMTJmNzNmNw==
   data.tar.gz: !binary |-
-    YjNlNmE0MmYyMTU3ZGIxNzhmNDRlODU0YmU0YmU3MDliODRkZTA1ZQ==
+    MzY3MTM5NzJhYTU2NGVjMTUwY2JjZWVkYjNiMjE1NGI5YTZmMWNlYg==
 SHA512:
   metadata.gz: !binary |-
-    ZDMzZmM0MzI1OGEyOWFjMzRhYjE2NzNhNWMwMTliOWIwYzYzZjYxNjA2YzRh
-    OTM4OGE1N2RmZjgwYzgwYWYxMTQ1MGQwMzZhZTVhMTJjNDI4MDE1MDUyZWY2
-    YjI5MzllYTRjOThmMmY4YWQ1MGI5YzRhZjI4NGJiMWM1ZjUzYTA=
+    MzM0MDBlMzVjOGEyMzUzOTcwYTc3ZjYzZmNlNjE0ZWFiMGFhNDY5ZjRmMzVi
+    ODc0ZWNlMDYyMzM5MWMzMmU5ZDhmNzNkMDY3MGZlNmMxNDQzN2ZjYzA1MTlk
+    ODM1MThmN2RiYmFmZjkwZGQ2OWZhZjBjZGYxZDNlNGJiNTUwZjY=
   data.tar.gz: !binary |-
-    MjY4ZTZlZWMzZGZiNGMyNTMxZWYyMDgyNWY2Y2VjMjJhZTdkZGFiM2YzMGFm
-    ODZkNTY3MzMyNDU5ZmIwMjQzM2ExZDQ1OGVlMDNlYWQ1OTM1Mjc3Y2NmMWJj
-    ZGMyOWUzMzI5Y2E2NjkxZTJjNGNmOWU2ZDQ2ZTVjYzE0MjYwZmU=
+    M2ZlZGY4MGYxNDYzODI0NDEwMzE0OGE3ZWJhZWJjZWMzMmIzM2ZlMGZiMjQ4
+    ZGQ3MzlmZTMwYTUwMTk0YmU3NTc2OGNmMzk0ZTM0MjJjYWY1NjhhZWQwNmY4
+    YmY2ODVhYWRiOWM0MmE1MTEyNDhkNjk5Yzc0MjI5ZTZiMGQyODE=

data/README.md

@@ -1,3 +1,36 @@
 # ApkUnpack
 
-Ruby Gem to Unpack APK(s)
+Performing static analysis on an Android application can get a bit tedious when having to use apktool and dex2jar to de-compile APK files. I wanted to automate the process in an easy way to assist people with this simple but time consuming task, especially for those who want to de-compile multiple apps using both dex2jar and apktool.
+
+The lightweight ruby gem was built to utilize dex2jar and apktool to de-compile and output the corresponding files to a specified directory.
+
+You can download the latest gem from here:
+
+[Ruby Gem](http://rubygems.org/gems/apk_unpack)
+
+    gem install apk_unpack
+
+You can view the project page on git from here:
+
+[GitHub](https://github.com/nVisium/ruby_apk_unpack)
+
+Dex2jar and apktool are not included within the gem in this version so those two tools will have to be installed separately. The path of apktool.jar, dj2-dex2jar.sh or .bat, the .apk files, and output location is required to be set in a YAML file. The syntax and example of the YAML file is below but can also be found in the /examples directory of the gem:
+
+    apk:
+       - /Users/somebody/Desktop/com.example.apk
+       - /Users/somebody/Desktop/com.another.example.apk
+    apktool: /Users/somebody/tmp/apktool1.5.2/apktool.jar
+    output_directory: /Users/somebody/Desktop/apk_stuff
+    d2j: /Users/somebody/tmp/dex2jar-0.0.9.15/d2j-dex2jar.sh
+
+To run the gem you execute the following commands:
+
+    apk_unpack -c <path/to/YAML file>
+
+There are a few things we will be working on for future releases. Including the possibility of having the YAML file point at a directory instead of specific APK files, offloading de-compiling the APK files to a service running on Heroku. This would all be automated to download the APK, decompile it and then serve it to the user.
+
+We hope you have found this post to be helpful in performing Android assessments and as usual, we'd love to hear your thoughts.
+
+Special thanks to [Marcus](https://twitter.com/90skicks), [Riandi](https://twitter.com/rwiguna), and [Ken](https://twitter.com/cktricky) for co-authoring the gem.
+
+Abdullah Munawar is an application security consultant at nVisium who specializes in mobile application testing and ripping apart new things. He previously worked on the security teams at financial and aviation organizations, with over 7 years of experience. Abdullah attempts humor on a daily basis and succeeds most of the time, every time. You can follow Abdullah on twitter [@amanofwar](https://twitter.com/amanofwar)

data/lib/apk_unpack.rb

@@ -3,7 +3,10 @@ require 'utilities/parsing'
 require 'decompiler/decompiler'
 require 'optparse'
 
+# This class is responsible for CLI output and options
 class ApkUnpack
+	# This method defines the CLI options of the gem and takes in the
+	# YAML configuration file
 	def self.run 
 		options = {}
 		OptionParser.new do |opts|

data/lib/decompiler/decompiler.rb

@@ -1,5 +1,8 @@
-
+# This class uses apktool and dex2jar to perform the de-compilation
+# of APKs and outputs the results into their respective directories  
 class Decompiler
+  
+  # This method creates a hash of the 4 inputs for the tool
   def self.my_hash
    {
   "apk" => "file",
@@ -9,6 +12,8 @@ class Decompiler
   }
   end
   
+  # This method creates instance variable @k and fills up the array
+  # my_hash with the 4 values its expecting
   def self.run
  	 my_hash.each do |k,v|
   		puts "Please specify the absolute location of the #{k}"
@@ -21,7 +26,9 @@ class Decompiler
  	 rescue ::Interrupt
  	 	puts "\nGoodbye"
   end
-    
+  
+  # This method validates that the files and directories being
+  # referenced exist   
   def self.exists(data_type, entity)  
   	val = instance_variable_get ("@#{entity}".underscore)
   	case data_type
@@ -32,6 +39,9 @@ class Decompiler
   	end 
   end
   
+  # This method has the tool revert to having the user manually
+  # enter the 4 parameters needed to run the tool in the case
+  # the YAML config file does not exist
   def self.set_static_vars(opts={})
     raise "NoOptionsProvidedFromConfigFile" if opts.empty?
     @apktool = opts[:apktool]
@@ -47,23 +57,30 @@ class Decompiler
      @apk = apk_loc
    end
   
+  # This method executes the run_apktool and run_dex2jar methods
   def self.execute
 	run_apktool
 	run_dex2jar
   end
   
+  # This method converts periods "." within filenames to underscore
   def self.convert_apkname_to_underscore
   	file_name = File.basename(@apk).underscore.tr(".", "_")
   end
   
+  # This method takes the file name of the .apk and converts it to
+  # a .jar
   def self.convert_apk_to_jar
   	file_name = File.basename(@apk).sub(/.apk/, ".jar")
   end
   
+  # This method runs apktool and outputs the results into its 
+  # own directory
   def self.run_apktool
    	system "java", "-jar", @apktool, "d", "-f", @apk, "#{@output_directory}/apktool_output/#{self.convert_apkname_to_underscore}" 
   end
   
+  # This method executes dex2jar and outputs the file under its own dex2jar directory
   def self.run_dex2jar
      	path = "#{@output_directory}/dex2jar_output"
      	Dir.mkdir path if not Dir.exist? path	

data/lib/utilities/parsing.rb

@@ -1,7 +1,10 @@
 require 'yaml'
 
+# This class performs all of the parsing associated with the YAML
+# file or the reading in of the paths for the 4 variables
 class Parsing
   
+  # This method raises an error if a YAML file is not given
   def self.parse(file_location=nil, test=false)
     raise "NoFileProvidedForParsing" if !(file_location)
     yaml_c = test ? modify_yaml_attrs : parse_config_file(file_location) 
@@ -9,10 +12,13 @@ class Parsing
     variable_set(opts)
   end
   
+  # This method loads and parses the YAML config file
   def self.parse_config_file(file_location)
     yaml_c = YAML.load_file(file_location)
   end
   
+  # This method creates a hash called yaml_c that takes in
+  # the 4 environment variables defined
   def self.modify_yaml_attrs
    yaml_c = {
    "apk" => ENV["APK"],
@@ -22,6 +28,8 @@ class Parsing
     }
   end
   
+  # This method reads in the options from the YAML file
+  # and assigns them the hash values within the yaml_c hash
   def self.generate_options_from_yaml(yaml_c) 
      options = {}
      options[:apk] = yaml_c["apk"]
@@ -31,6 +39,9 @@ class Parsing
     return options  
   end
   
+  # This method specifies executing the gem for the 3 options of
+  # reading in the APK location manually, having a single APK within
+  # the YAML file, or having multiple APKs within the YAML file
   def self.variable_set(options={})
     Decompiler.set_static_vars(options)
     apk_loc = options[:apk]

data/lib/utilities/string.rb

@@ -1,3 +1,5 @@
+# This class normalizes the file names and paths being taken in
+# by the YAML file
 class String
   def underscore
     self.gsub(/::/, '/').

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apk_unpack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Abdullah Munawar
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,12 +41,12 @@ dependencies:
     - - ! '>='
       - !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                        "
+description: ! "\n  \t\t\t\t\t\tThe 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
+- abdullah.munawar@nvisium.com
 executables:
 - apk_unpack
 extensions: []