one_gadget 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8578d867b076e1c59b2b271879d5448fc2c985c94b67a5e3fc8febcabb01ef
-  data.tar.gz: 39c681c497cfb5bce05eb993fcb47aa0b6e0ef77aba6af2507d4184ccb23ef20
+  metadata.gz: 2e26da79b62658e7dd1ce9efcaeda04fbe805b98eb1fecf234948311d70553e3
+  data.tar.gz: 2ed832df9cffecaba987753e1ed9c9ebe8068e410c00da108c1348e80efe6637
 SHA512:
-  metadata.gz: 6aa7f7a80a3d0a096a02d40802df7d8014896ef15cba222610a334d80bab9d0fddf5db95fd2f1de47b86327d160b38eee65048f7300d40f6c6d69f0e4021aca7
-  data.tar.gz: adf5eaf2d3a70a3c17d5daddc0aa6f773911aea65eb82b633b73ef060d35073944d92a0feb440573f68c5badf522aba8b86b67fa51e89afd56a3c86e63980c5d
+  metadata.gz: 47732f230a683edcb699a21f3891812326b1a7d9b966c13fb3a50c8d07b7ffbb3ce4244d324c0f13907f8b5d64e6a16a824d44946d97f6f131df7cf0b1380b8e
+  data.tar.gz: 0a90f8f323ee47f78314eeb420eec22a36f8954b12806a47d493d8996128abb4ac40c2cb4ec25b236b3723a390391903e5082f1af6751a061645e4dfc442e8e0

data/lib/one_gadget.rb

@@ -4,70 +4,12 @@
 
 # Main module.
 module OneGadget
-  class << self
-    # The man entry of gem +one_gadget+.
-    # If want to find gadgets from file, it will search gadgets by its
-    # build id first.
-    #
-    # @param [String] file
-    #   The relative path of libc.so.6.
-    # @param [String] build_id
-    #   The BuildID of target libc.so.6.
-    # @param [Boolean] details
-    #   Return gadget objects or offset only.
-    # @param [Boolean] force_file
-    #   When +file+ is given, {OneGadget} will search gadgets according its
-    #   build id first. +force_file = true+ to disable this feature.
-    # @param [Integer] level
-    #   Output level.
-    #   If +level+ equals to zero, only gadgets with highest successful probability would be output.
-    # @return [Array<OneGadget::Gadget::Gadget>, Array<Integer>]
-    #   The gadgets found.
-    # @example
-    #   OneGadget.gadgets(file: './libc.so.6')
-    #   OneGadget.gadgets(build_id: '60131540dadc6796cab33388349e6e4e68692053')
-    def gadgets(file: nil, build_id: nil, details: false, force_file: false, level: 0)
-      ret = if build_id
-              OneGadget::Fetcher.from_build_id(build_id) || OneGadget::Logger.not_found(build_id)
-            else
-              from_file(OneGadget::Helper.abspath(file), force: force_file)
-            end
-      ret = refine_gadgets(ret, level)
-      ret.map!(&:offset) unless details
-      ret
-    rescue OneGadget::Error::Error => e
-      OneGadget::Logger.error("#{e.class.name.split('::').last}: #{e.message}")
-      []
-    end
-
-    private
-
-    # Try from build id first, then file
-    def from_file(path, force: false)
-      OneGadget::Helper.verify_elf_file!(path)
-      gadgets = try_from_build(path) unless force
-      gadgets || OneGadget::Fetcher.from_file(path)
-    end
-
-    def try_from_build(file)
-      build_id = OneGadget::Helper.build_id_of(file)
-      return unless build_id
-
-      OneGadget::Fetcher.from_build_id(build_id, remote: false)
-    end
-
-    # Remove hard-to-reach-constrains gadgets according to level
-    def refine_gadgets(gadgets, level)
-      return [] if gadgets.empty?
-      return gadgets if level > 0 # currently only supports level > 0 or not
-
-      # remain gadgets with the fewest constraints
-      best = gadgets.map { |g| g.constraints.size }.min
-      gadgets.select { |g| g.constraints.size == best }
-    end
-  end
 end
 
+require 'one_gadget/helper'
+require 'one_gadget/one_gadget'
+require 'one_gadget/version'
+
 # Shorter way to use one gadget.
 # @param [String?] arg
 #   Can be either +build_id+ or path to libc.
@@ -92,9 +34,3 @@ end
 
 require 'one_gadget/update'
 OneGadget::Update.check!
-
-require 'one_gadget/error'
-require 'one_gadget/fetcher'
-require 'one_gadget/helper'
-require 'one_gadget/logger'
-require 'one_gadget/version'

data/lib/one_gadget/emulators/x86.rb

@@ -46,8 +46,8 @@ module OneGadget
         false
       end
 
-      # Support instruction set.
-      # @return [Array<Instruction>] The support instructions.
+      # Supported instruction set.
+      # @return [Array<Instruction>] The supported instructions.
       def instructions
         [
           Instruction.new('add', 2),
@@ -72,6 +72,13 @@ module OneGadget
         end
       end
 
+      # To be inherited.
+      #
+      # @param [Integer] _idx
+      #   The idx-th argument.
+      #
+      # @return [Lambda, Integer]
+      #   Return value can be a {Lambda} or an +Integer+.
       def argument(_idx); raise NotImplementedError
       end
 

data/lib/one_gadget/error.rb

@@ -1,14 +1,19 @@
 module OneGadget
+  # OneGadget errors.
   module Error
+    # Generic error class.
     class Error < StandardError
     end
 
+    # Unsupported arguments of intructions.
     class UnsupportedInstructionArgumentsError < Error
     end
 
+    # Unsupported architecture.
     class UnsupportedArchitectureError < Error
     end
 
+    # Argument error of ruby methods.
     class ArgumentError < Error
     end
   end

data/lib/one_gadget/fetchers/amd64.rb

@@ -19,7 +19,7 @@ module OneGadget
 
           true
         end
-        cands + jmp_case_candidates # + sigaction_case_candidates
+        cands + jmp_case_candidates
       end
 
       # find gadgets in form:
@@ -30,7 +30,6 @@ module OneGadget
       #   ...
       #   call execve
       def jmp_case_candidates
-        bin_sh_hex = str_offset('/bin/sh').to_s(16)
         `#{objdump_cmd}|egrep 'rdi.*# #{bin_sh_hex}' -A 3`.split('--').map do |cand|
           cand = cand.lines.map(&:strip).reject(&:empty?)
           jmp_at = cand.index { |c| c.include?('jmp') }

data/lib/one_gadget/gadget.rb

@@ -60,7 +60,7 @@ module OneGadget
         return build_not_found if table.nil? # remote doesn't have this one either.
 
         # builds found in remote! Ask update gem and download remote gadgets.
-        OneGadget::Helper.ask_update(msg: 'The desired one-gadget can be found in lastest version!')
+        OneGadget::Logger.ask_update(msg: 'The desired one-gadget can be found in lastest version!')
         tmp_file = OneGadget::Helper.download_build(table)
         require tmp_file.path
         tmp_file.unlink

data/lib/one_gadget/helper.rb

@@ -6,7 +6,6 @@ require 'tempfile'
 require 'elftools'
 
 require 'one_gadget/error'
-require 'one_gadget/logger'
 
 module OneGadget
   # Define some helpful methods here.
@@ -103,7 +102,7 @@ module OneGadget
       #   True or false.
       def color_enabled?
         # if not set, use tty to check
-        return $stdout.tty? if @disable_color.nil?
+        return $stdout.tty? unless instance_variable_defined?(:@disable_color)
 
         !@disable_color
       end
@@ -184,14 +183,6 @@ module OneGadget
         nil
       end
 
-      # Show the message of ask user to update gem.
-      # @return [void]
-      def ask_update(msg: '')
-        name = 'one_gadget'
-        cmd = colorize("gem update #{name} && gem cleanup #{name}")
-        OneGadget::Logger.info(msg + "\n" + "Update with: $ #{cmd}" + "\n")
-      end
-
       # Fetch the file archiecture of +file+.
       # @param [String] file The target ELF filename.
       # @return [Symbol]

data/lib/one_gadget/logger.rb

@@ -31,6 +31,14 @@ module OneGadget
       []
     end
 
+    # Show the message of ask user to update gem.
+    # @return [void]
+    def ask_update(msg: '')
+      name = 'one_gadget'
+      cmd = OneGadget::Helper.colorize("gem update #{name} && gem cleanup #{name}")
+      OneGadget::Logger.info(msg + "\n" + "Update with: $ #{cmd}" + "\n")
+    end
+
     %i[info warn error].each do |sym|
       define_method(sym) do |msg|
         @logger.__send__(sym, msg)

data/lib/one_gadget/one_gadget.rb

@@ -0,0 +1,70 @@
+require 'one_gadget/error'
+require 'one_gadget/fetcher'
+require 'one_gadget/helper'
+require 'one_gadget/logger'
+
+# Main module.
+module OneGadget
+  class << self
+    # The man entry of gem +one_gadget+.
+    # If want to find gadgets from file, it will search gadgets by its
+    # build id first.
+    #
+    # @param [String] file
+    #   The relative path of libc.so.6.
+    # @param [String] build_id
+    #   The BuildID of target libc.so.6.
+    # @param [Boolean] details
+    #   Return gadget objects or offset only.
+    # @param [Boolean] force_file
+    #   When +file+ is given, {OneGadget} will search gadgets according its
+    #   build id first. +force_file = true+ to disable this feature.
+    # @param [Integer] level
+    #   Output level.
+    #   If +level+ equals to zero, only gadgets with highest successful probability would be output.
+    # @return [Array<OneGadget::Gadget::Gadget>, Array<Integer>]
+    #   The gadgets found.
+    # @example
+    #   OneGadget.gadgets(file: './libc.so.6')
+    #   OneGadget.gadgets(build_id: '60131540dadc6796cab33388349e6e4e68692053')
+    def gadgets(file: nil, build_id: nil, details: false, force_file: false, level: 0)
+      ret = if build_id
+              OneGadget::Fetcher.from_build_id(build_id) || OneGadget::Logger.not_found(build_id)
+            else
+              from_file(OneGadget::Helper.abspath(file), force: force_file)
+            end
+      ret = refine_gadgets(ret, level)
+      ret.map!(&:offset) unless details
+      ret
+    rescue OneGadget::Error::Error => e
+      OneGadget::Logger.error("#{e.class.name.split('::').last}: #{e.message}")
+      []
+    end
+
+    private
+
+    # Try from build id first, then file
+    def from_file(path, force: false)
+      OneGadget::Helper.verify_elf_file!(path)
+      gadgets = try_from_build(path) unless force
+      gadgets || OneGadget::Fetcher.from_file(path)
+    end
+
+    def try_from_build(file)
+      build_id = OneGadget::Helper.build_id_of(file)
+      return unless build_id
+
+      OneGadget::Fetcher.from_build_id(build_id, remote: false)
+    end
+
+    # Remove hard-to-reach-constrains gadgets according to level
+    def refine_gadgets(gadgets, level)
+      return [] if gadgets.empty?
+      return gadgets if level > 0 # currently only supports level > 0 or not
+
+      # remain gadgets with the fewest constraints
+      best = gadgets.map { |g| g.constraints.size }.min
+      gadgets.select { |g| g.constraints.size == best }
+    end
+  end
+end

data/lib/one_gadget/update.rb

@@ -29,7 +29,7 @@ module OneGadget
 
         # show update message
         msg = format('A newer version of OneGadget is available (%s --> %s).', OneGadget::VERSION, latest)
-        OneGadget::Helper.ask_update(msg: msg)
+        OneGadget::Logger.ask_update(msg: msg)
       end
 
       private

data/lib/one_gadget/version.rb

@@ -1,4 +1,4 @@
 module OneGadget
   # Current gem version.
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.6.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one_gadget
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - david942j
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elftools
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -796,6 +796,7 @@ files:
 - lib/one_gadget/gadget.rb
 - lib/one_gadget/helper.rb
 - lib/one_gadget/logger.rb
+- lib/one_gadget/one_gadget.rb
 - lib/one_gadget/update.rb
 - lib/one_gadget/version.rb
 homepage: https://github.com/david942j/one_gadget