pwntools 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8617d0c3ce0deb5ba38b0f4c2b4d11c26ff2c48
-  data.tar.gz: 22a859a445f8fb1fa84c9c164f2f093ccaf81bcb
+  metadata.gz: d329dcead1dc5c93633effddf3c627f5071cce80
+  data.tar.gz: b5bf6ed6299056cbd1fd93ad6a37e04a992ce3e1
 SHA512:
-  metadata.gz: dec0121c94efbe114141de88e820e7ab64c25e64938e44413293a9b61d325ac6dcd0239588b930326a7c7da49378deebcbf94154cc59411e22f8926b95954668
-  data.tar.gz: 34f90a6171b82df95d5c5a78252ae370cc6251da6deeac65f2bbd011efa251ebf65e7435046cb159e42740c2f072ac6dc5de80f429496ed7f3cd2afe0978b020
+  metadata.gz: 71594da6ddc2572a11e2d41c641f04d494d1ea2d3e81ef1a6fd82d92edb3af3599e7099bbdc3393d56a5955fcfd983416dd8be787087fb06d3a586286eb13079
+  data.tar.gz: b7cfba8de4134ea156f58244dff5d1a4e7431b376d1a75d9713503552c11911fb103187249e063baef93cac1f1ce651864f64815e5e2105fc539a6d8ef491df8

data/lib/pwnlib/context.rb

@@ -80,11 +80,19 @@ module Pwnlib
       # We use Logger#const_defined for pwnlib logger.
       LOG_LEVELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
 
+      # Instantiate a {Pwnlib::Context::ContextType} object.
       def initialize(**kwargs)
         @attrs = DEFAULT.dup
         update(**kwargs)
       end
 
+      # Convenience function, which is shorthand for setting multiple variables at once.
+      #
+      # @param [Hash] kwargs
+      #   Variables to be assigned in the environment.
+      #
+      # @example
+      #   context.update(arch: 'amd64', os: :linux)
       def update(**kwargs)
         kwargs.each do |k, v|
           next if v.nil?
@@ -96,12 +104,23 @@ module Pwnlib
       alias [] update
       alias call update
 
+      # Create a string representation of self.
       def to_s
         vals = @attrs.map { |k, v| "#{k} = #{v.inspect}" }
         "#{self.class}(#{vals.join(', ')})"
       end
 
-      # This would return what the block return.
+      # Create a context manager for a block.
+      #
+      # @param [Hash] kwargs
+      #   Variables to be assigned in the environment.
+      #
+      # @return
+      #   This would return what the block returned.
+      #
+      # @example
+      #   context.local(arch: 'amd64') { puts context.endian }
+      #   # little
       def local(**kwargs)
         raise ArgumentError, "Need a block for #{self.class}##{__callee__}" unless block_given?
         # XXX(Darkpi):
@@ -116,6 +135,13 @@ module Pwnlib
         end
       end
 
+      # Clear the contents of the context, which will set all values to their defaults.
+      #
+      # @example
+      #   context.arch = 'amd64'
+      #   context.clear
+      #   context.bits == 32
+      #   #=> true
       def clear
         @attrs = DEFAULT.dup
       end
@@ -125,42 +151,84 @@ module Pwnlib
         define_method(k) { @attrs[k] }
       end
 
+      # Set the newline.
+      #
+      # @param [String] newline
+      #   The newline.
+      #
+      # @example
+      #   context.newline = "\r\n"
       def newline=(newline)
         @attrs[:newline] = newline
       end
 
+      # Set the default amount of time to wait for a blocking operation before it times out.
+      #
+      # @param [Float, :forever] timeout
+      #   Any positive floating number, indicates timeout in seconds.
+      #
+      # @example
+      #   context.timeout = 5.14
       def timeout=(timeout)
         @attrs[:timeout] = timeout
       end
 
+      # Set the architecture of the target binary.
+      #
+      # @param [String, Symbol] arch
+      #   The architecture. Only values in {Pwnlib::Context::ContextType::ARCHS} are available.
+      #
       # @diff We always change +bits+ and +endian+ field whether user have already changed them.
       def arch=(arch)
-        arch = arch.downcase.gsub(/[[:punct:]]/, '')
+        arch = arch.to_s.downcase.gsub(/[[:punct:]]/, '')
         defaults = ARCHS[arch]
         raise ArgumentError, "arch must be one of #{ARCHS.keys.sort.inspect}" unless defaults
         defaults.each { |k, v| @attrs[k] = v }
         @attrs[:arch] = arch
       end
 
+      # Set the word size of the target machine in bits (i.e. the size of general purpose registers).
+      #
+      # @param [Integer] bits
+      #   The word size.
       def bits=(bits)
         raise ArgumentError, "bits must be > 0 (#{bits} given)" unless bits > 0
         @attrs[:bits] = bits
       end
 
+      # The word size of the target machine.
       def bytes
         bits / 8
       end
 
+      # Set the word size of the target machine in bytes (i.e. the size of general purpose registers).
+      #
+      # @param [Integer] bytes
+      #   The word size.
       def bytes=(bytes)
         self.bits = bytes * 8
       end
 
+      # The endianness of the target machine.
+      #
+      # @param [String, Symbol] endian
+      #   The endianness. Only values in {Pwnlib::Context::ContextType::ENDIANNESSES} are available.
+      #
+      # @example
+      #   context.endian = :big
       def endian=(endian)
-        endian = ENDIANNESSES[endian.downcase]
+        endian = ENDIANNESSES[endian.to_s.downcase]
         raise ArgumentError, "endian must be one of #{ENDIANNESSES.sort.inspect}" if endian.nil?
         @attrs[:endian] = endian
       end
 
+      # Set the verbosity of the logger in +Pwnlib+.
+      #
+      # @param [String, Symbol] value
+      #   The verbosity. Only values in {Pwnlib::Context::ContextType::LOG_LEVELS} are available.
+      #
+      # @example
+      #   context.log_level = :debug
       def log_level=(value)
         log_level = nil
         case value
@@ -174,17 +242,35 @@ module Pwnlib
         @attrs[:log_level] = log_level
       end
 
+      # Set the operating system of the target machine.
+      #
+      # @param [String, Symbol] os
+      #   The name of the os. Only values in {Pwnlib::Context::ContextType::OSES} are available.
+      #
+      # @example
+      #   context.os = :windows
       def os=(os)
-        os = os.downcase
+        os = os.to_s.downcase
         raise ArgumentError, "os must be one of #{OSES.sort.inspect}" unless OSES.include?(os)
         @attrs[:os] = os
       end
 
+      # Set the signedness for packing opreation.
+      #
+      # @param [String, Symbol, true, false] value
+      #   The signedness. Only values in {Pwnlib::Context::ContextType::SIGNEDNESSES} are available.
+      #
+      # @example
+      #   context.signed == false
+      #   #=> true
+      #   context.signed = 'signed'
+      #   context.signed == true
+      #   #=> true
       def signed=(value)
         signed = nil
         case value
-        when String
-          signed = SIGNEDNESSES[value.downcase]
+        when String, Symbol
+          signed = SIGNEDNESSES[value.to_s.downcase]
         when true, false
           signed = value
         end

data/lib/pwnlib/elf/elf.rb

@@ -115,7 +115,7 @@ module Pwnlib
       #
       # @return [Boolean] Yes or not.
       def canary?
-        @got.respond_to?('__stack_chk_fail')
+        @got.respond_to?('__stack_chk_fail') || @symbols.respond_to?('__stack_chk_fail')
       end
 
       # Is stack executable?
@@ -133,9 +133,9 @@ module Pwnlib
       end
 
       # There's too many objects inside, let pry not so verbose.
-      # @return [nil]
+      # @return [String]
       def inspect
-        nil
+        "#<Pwnlib::ELF::ELF:#{::Pwnlib::Util::Fiddling.hex(__id__)}>"
       end
 
       # Yields the ELF's virtual address space for the specified string or regexp.
@@ -191,7 +191,7 @@ module Pwnlib
       # Get the dynamic tag with +type+.
       # @return [ELFTools::Dynamic::Tag, nil]
       def dynamic_tag(type)
-        dynamic = @elf_file.segment_by_type(:dynamic) || @elf.section_by_name('.dynamic')
+        dynamic = @elf_file.segment_by_type(:dynamic) || @elf_file.section_by_name('.dynamic')
         return nil if dynamic.nil? # No dynamic present, might be static-linked.
         dynamic.tag_by_type(type)
       end

data/lib/pwnlib/version.rb

@@ -2,5 +2,5 @@
 
 module Pwnlib
   # version of pwntools-ruby
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/context_test.rb

@@ -8,7 +8,7 @@ class ContextTest < MiniTest::Test
   include ::Pwnlib::Context
 
   def test_update
-    context.update(arch: 'arm', os: 'windows')
+    context.update(arch: :arm, os: 'windows')
     assert_equal('arm', context.arch)
     assert_equal('windows', context.os)
   end
@@ -49,7 +49,7 @@ class ContextTest < MiniTest::Test
 
     context.clear
     assert_equal(32, context.bits)
-    context.arch = 'powerpc64'
+    context.arch = :powerpc64
     assert_equal(64, context.bits)
     assert_equal('big', context.endian)
   end
@@ -75,7 +75,7 @@ class ContextTest < MiniTest::Test
     context.endian = 'le'
     assert_equal('little', context.endian)
 
-    context.endian = 'big'
+    context.endian = :big
     assert_equal('big', context.endian)
 
     err = assert_raises(ArgumentError) { context.endian = 'SUPERBIG' }
@@ -86,6 +86,9 @@ class ContextTest < MiniTest::Test
     context.log_level = 'error'
     assert_equal(Logger::ERROR, context.log_level)
 
+    context.log_level = :fatal
+    assert_equal(Logger::FATAL, context.log_level)
+
     context.log_level = 514
     assert_equal(514, context.log_level)
 
@@ -97,6 +100,9 @@ class ContextTest < MiniTest::Test
     context.os = 'windows'
     assert_equal('windows', context.os)
 
+    context.os = :freebsd
+    assert_equal('freebsd', context.os)
+
     err = assert_raises(ArgumentError) { context.os = 'deepblue' }
     assert_match(/os must be one of/, err.message)
   end
@@ -108,6 +114,9 @@ class ContextTest < MiniTest::Test
     context.signed = 'unsigned'
     assert_equal(false, context.signed)
 
+    context.signed = :yes
+    assert_equal(true, context.signed)
+
     err = assert_raises(ArgumentError) { context.signed = 'partial' }
     assert_match(/signed must be boolean or one of/, err.message)
   end

data/test/data/elfs/Makefile

@@ -5,6 +5,7 @@ NOPIE_FLAGS=-no-pie
 FULL_RELRO_FLAGS=-Wl,-z,relro,-z,now
 PARTIAL_RELRO_FLAGS=-Wl,-z,relro
 NO_RELRO_FLAGS=-Wl,-z,norelro
+STATIC_FLAGS=-static
 TARGETS=amd64 i386
 .PHONY: clean
 all: ${TARGETS}
@@ -14,6 +15,7 @@ amd64: ${source}
 	g++ -m64 ${source} -o amd64.frelro.pie.elf ${FLAGS} ${FULL_RELRO_FLAGS} ${PIE_FLAGS}
 	g++ -m64 ${source} -o amd64.prelro.elf ${FLAGS} ${PARTIAL_RELRO_FLAGS} ${NOPIE_FLAGS}
 	g++ -m64 ${source} -o amd64.nrelro.elf ${FLAGS} ${NO_RELRO_FLAGS} ${NOPIE_FLAGS}
+	g++ -m64 ${source} -o amd64.static.elf ${FLAGS} ${STATIC_FLAGS} ${NOPIE_FLAGS}
 i386: ${source}
 	g++ -m32 ${source} -o i386.prelro.elf ${FLAGS} ${PARTIAL_RELRO_FLAGS} ${NOPIE_FLAGS}
 	g++ -m32 ${source} -o i386.frelro.pie.elf ${FLAGS} ${FULL_RELRO_FLAGS} ${PIE_FLAGS}

data/test/elf/elf_test.rb

@@ -60,6 +60,10 @@ PIE:      No PIE (0x400000)
     EOS
   end
 
+  def test_inspect
+    assert_match(/#<Pwnlib::ELF::ELF:0x[0-9a-f]+>/, @elf.inspect)
+  end
+
   def test_got
     assert_same(8, @elf.got.to_h.size)
     assert_same(0x8049ff8, @elf.got['__gmon_start__'])
@@ -94,6 +98,16 @@ PIE:      No PIE (0x400000)
     assert_equal(0xdeadbeef06c2, elf.symbols.main)
   end
 
+  def test_static
+    elf = ::Pwnlib::ELF::ELF.new(@path_of.call('amd64.static.elf'), checksec: false)
+    assert_equal(<<-EOS.strip, elf.checksec)
+RELRO:    Partial RELRO
+Stack:    Canary found
+NX:       NX enabled
+PIE:      No PIE (0x400000)
+    EOS
+  end
+
   def test_search
     elf = ::Pwnlib::ELF::ELF.new(File.join(__dir__, '..', 'data', 'lib32', 'libc.so.6'), checksec: false)
     assert_equal([0x1, 0x15e613], elf.search('ELF').to_a)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwntools
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - peter50216@gmail.com
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crabstone
@@ -291,6 +291,7 @@ files:
 - test/data/elfs/amd64.frelro.pie.elf
 - test/data/elfs/amd64.nrelro.elf
 - test/data/elfs/amd64.prelro.elf
+- test/data/elfs/amd64.static.elf
 - test/data/elfs/i386.frelro.pie.elf
 - test/data/elfs/i386.prelro.elf
 - test/data/elfs/source.cpp
@@ -368,6 +369,7 @@ test_files:
 - test/data/elfs/i386.frelro.pie.elf
 - test/data/elfs/amd64.nrelro.elf
 - test/data/elfs/i386.prelro.elf
+- test/data/elfs/amd64.static.elf
 - test/data/elfs/amd64.prelro.elf
 - test/data/elfs/source.cpp
 - test/data/victim32