headdesk 0.1.0

data/lib/headdesk/apk/class.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'headdesk/apk/field'
+require 'headdesk/apk/method'
+
+module Headdesk
+  class Apk
+    #
+    # A Smali bytecode class
+    #
+    class Class
+      # Formats:
+      #   android/content/Context
+      #   android.content.Context
+      def self.path_for(decl)
+        File.join(*decl.split(%r{[\/,\.]}))
+      end
+
+      def initialize(smali_file)
+        @smali = File.read(smali_file)
+      end
+
+      def method?(name)
+        method(name) != false
+      end
+
+      def method(name)
+        matchdata = /(^\.method .* #{name}.*$[\s\S]*?\.end method)/.match(@smali)
+        return nil unless matchdata
+
+        Method.new(matchdata)
+      end
+
+      def field?(name)
+        field(name) != false
+      end
+
+      def field(name)
+        matchdata = /^\.field .* #{name}.* = "(.*)"$/.match(@smali)
+        return nil unless matchdata
+
+        Field.new(matchdata)
+      end
+    end
+  end
+end

data/lib/headdesk/apk/field.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Headdesk
+  class Apk
+    #
+    # A Smali bytecode field
+    #
+    class Field
+      attr_reader :code, :value
+
+      def initialize(matchdata)
+        @code = matchdata[0]
+        @value = matchdata[1]
+
+        @value.extend(ExtraMethods)
+      end
+    end
+
+    #
+    # Extra methods for 'value'
+    #
+    module ExtraMethods
+      def to_version
+        /^(\d+\.)?(\d+\.)?(\*|\d+)$/.match(self).captures.map(&:to_i)
+      end
+    end
+  end
+end

data/lib/headdesk/apk/method.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Headdesk
+  class Apk
+    #
+    # A Smali bytecode method
+    #
+    class Method
+      attr_reader :code
+
+      def initialize(matchdata)
+        @code = matchdata[0]
+      end
+    end
+  end
+end

data/lib/headdesk/apk/resources.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Headdesk
+  class Apk
+    #
+    # Android Resources searching
+    #
+    class Resources
+      def initialize(path)
+        @path = path
+      end
+
+      def values(modifiers = {})
+        XmlCollection.new(@path, 'values', modifiers)
+      end
+
+      #
+      # Collection of XML values for specific locale/api/etc
+      #
+      class XmlCollection
+        # :reek:NestedIterators and :reek:TooManyStatements
+        def initialize(path, type, modifiers = {})
+          @resources = {}
+          globspec = File.join(path, 'res', "#{type}{#{XmlCollection.api_versions(modifiers).join(',')}}", '*.xml')
+          Dir.glob(globspec).each do |file_name|
+            xml = File.open(file_name) { |file| Nokogiri::XML(file) }
+
+            @resources.merge! XmlCollection.named_elements(xml)
+            @resources.merge! XmlCollection.item_elements(xml)
+          end
+        end
+
+        def respond_to_missing?(method_name, include_all)
+          @resources.include?(method_name.to_s) || super
+        end
+
+        def method_missing(method_name, *arguments, &block)
+          super unless @resources.include?(method_name.to_s)
+
+          OpenStruct.new(@resources[method_name.to_s])
+        end
+
+        private
+
+        def self.api_versions(modifiers)
+          mods = [nil]
+          if modifiers.key?(:v)
+            (1..modifiers[:v].to_i).each do |api_version|
+              mods << "-v#{api_version}"
+            end
+          end
+          mods
+        end
+
+        # :reek:TooManyStatements
+        def self.named_elements(xml)
+          named_elements = %i[string integer color bool]
+
+          resources = {}
+          xml.xpath("//#{named_elements.join('|//')}").each do |elem|
+            type = elem.name.to_s
+            name = elem.attributes['name'].to_s
+
+            resources[type] ||= {}
+            resources[type][name] = case type
+                                    when 'bool'
+                                      elem.text == true.to_s
+                                    when 'integer'
+                                      elem.text.to_i
+                                    else
+                                      elem.text
+                                    end
+          end
+          resources
+        end
+
+        # :reek:TooManyStatements
+        def self.item_elements(xml)
+          item_elements = %i[drawable]
+          resources = {}
+          xml.xpath("//item[#{item_elements.map { |elem| "contains(@type, '#{elem}')" }.join('or')}]").each do |elem|
+            type = elem.attributes['type'].to_s
+            name = elem.attributes['name'].to_s
+
+            resources[type] ||= {}
+            resources[type][name] = elem.text
+          end
+          resources
+        end
+      end
+    end
+  end
+end

data/lib/headdesk/apktool.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Headdesk
+  #
+  # Wrapper around using https://ibotpeaches.github.io/Apktool/
+  #
+  class ApkTool
+    def self.apktool_jar
+      "ext/apktool_#{APKTOOL_VERSION}.jar"
+    end
+
+    #
+    # Run apktool command
+    #
+    # :reek:TooManyStatements
+    def self.cmd(*args)
+      _stdin, stdout, stderr, wait_thr = Open3.popen3('java', '-jar', apktool_jar, *args)
+      r_stdout = stdout.gets(nil)
+      stdout.close
+      r_stderr = stderr.gets(nil)
+      stderr.close
+      r_exit_code = wait_thr.value
+
+      [r_stdout, r_stderr, r_exit_code]
+    end
+
+    #
+    # Unpacks an APK to the specified path
+    #
+    # :reek:TooManyStatements
+    def self.unpack_to(path, destination)
+      throw CliError.new("File not found: #{path}") unless File.exist?(path)
+      throw CliError.new("Path not found: #{destination}") unless Dir.exist?(destination)
+
+      args = ['d', '--force', '--output', destination]
+
+      stdout, stderr, exit_code = Headdesk::ApkTool.cmd(*args, path)
+      raise stderr unless exit_code.to_i.zero?
+
+      stdout
+    end
+  end
+end

data/lib/headdesk/check.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require 'headdesk/descriptionator'
+
+module Headdesk
+  #
+  # Check for a potential issue in an apk or ipa
+  #
+  # :reek:ModuleInitialize
+  module Check
+    attr_reader :report, :status, :apk, :ipa
+
+    def self.for_apk
+      APK.all
+    end
+
+    def self.for_ipa
+      IPA.all
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    #
+    # Class methods for Check
+    #
+    module ClassMethods
+      def describe(desc = nil)
+        @last_desc = desc if desc
+        @last_desc
+      end
+    end
+
+    def initialize(bundle)
+      @apk = bundle
+      @ipa = bundle
+      @report = {
+        description: self.class.describe,
+        steps: [],
+        export: {}
+      }
+      @status = :skip
+    end
+
+    def describe(desc = nil)
+      @last_desc = desc if desc
+      @last_desc
+    end
+
+    # :reek:ManualDispatch and :reek:TooManyStatements and :reek:FeatureEnvy
+    def check_control_flow(status_to_assign, conditions = nil)
+      pass = !conditions || conditions.empty?
+      raise ArgumentError, 'Do not specify both if: and unless:' if
+        conditions.key?(:if) && conditions.key?(:unless)
+
+      pass = Check.condition?(conditions, :if) if conditions.key? :if
+      pass = !Check.condition?(conditions, :unless) if conditions.key? :unless
+
+      skip = false
+      raise ArgumentError, 'Do not specify both skip_if: and skip_unless:' if
+        conditions.key?(:skip_if) && conditions.key?(:skip_unless)
+
+      skip = Check.condition?(conditions, :skip_if) if conditions.key? :skip_if
+      skip = !Check.condition?(conditions, :skip_unless) if conditions.key? :skip_unless
+
+      # TODO: greater_than, less_than, equals
+
+      # rubocop:disable RescueStandardError
+      # Try and get an auto-description
+      default_description = describe.to_s
+      description = begin
+                      if conditions[:unless].respond_to?(:call)
+                        descriptionator = Headdesk::Descriptionator.new(:unless)
+                        desc = descriptionator.instance_exec(&conditions[:unless])
+                        desc.is_a?(String) ? desc : default_description
+                      elsif conditions[:if].respond_to?(:call)
+                        descriptionator = Headdesk::Descriptionator.new(:if)
+                        desc = descriptionator.instance_exec(&conditions[:if])
+                        desc.is_a?(String) ? desc : default_description
+                      else
+                        default_description
+                      end
+                    rescue
+                      default_description
+                    end
+      # rubocop:enable RescueStandardError
+
+      @status = status_to_assign if pass && !skip
+      @report[:steps] << {
+        description: description,
+        status: skip ? :skip : @status
+      }
+      return unless pass
+
+      throw :halt_check
+    end
+
+    def skip_check(conditions = {})
+      check_control_flow(:skip, conditions)
+    end
+
+    def fail_check(conditions = {})
+      check_control_flow(:fail, conditions)
+    end
+
+    def export(merge = {})
+      @report[:export].merge! merge
+    end
+
+    def preconditions?
+      true
+    end
+
+    def run
+      before
+      catch(:halt_check) do
+        call
+      end
+      after
+
+      @status
+    end
+
+    # :reek:ManualDispatch
+    def process
+      return report unless respond_to?(:call) && preconditions?
+
+      @status = :success
+      report[:status] = run
+      report
+    end
+
+    def before; end
+
+    def after; end
+
+    #
+    # Check applies to APKs
+    #
+    module APK
+      def self.all
+        @all
+      end
+
+      def self.included(klass)
+        @all ||= []
+        @all << klass
+        klass.include(Check)
+      end
+    end
+
+    #
+    # Check applies to IPAs
+    #
+    module IPA
+      def self.all
+        @all
+      end
+
+      def self.included(klass)
+        @all ||= []
+        @all << klass
+        klass.include(Check)
+      end
+    end
+
+    # :reek:ManualDispatch
+    def self.condition?(conditions, key)
+      condition = conditions.fetch(key, nil)
+      if !condition
+        false
+      elsif condition.respond_to? :call
+        condition.call
+      elsif %w[true false].include?(condition.to_s)
+        condition.to_s == 'true'
+      else
+        raise ArgumentError, 'fail_check and skip_check only accept truthy, falsy, nil, or Proc arguments'
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/checks/*.rb'].each { |file| require file }

data/lib/headdesk/checks/api26.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Headdesk
+  module Checks
+    #
+    # APKs should all target API 26+
+    #
+    # :reek:UncommunicativeModuleName
+    class Api26
+      include Check::APK
+
+      describe 'targetSdkVersion must be at least 26'
+      def call
+        fail_check unless: -> { apk.targets_sdk 26 }
+
+        klass_def = 'android/support/v4/app/NotificationCompat$Builder'
+        skip_check unless: -> { apk.class?(klass_def) }
+        klass = apk.find_class(klass_def)
+
+        describe 'support-v4 version is 26.1+'
+        fail_check unless: -> { klass.method?('setChannelId') }
+
+        # TODO: AndroidX/JetPack
+      end
+    end
+  end
+end