pwntools 1.1.0 → 1.2.0

data/lib/pwnlib/shellcraft/generators/x86/linux/execve.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/common/pushstr'
 require 'pwnlib/shellcraft/generators/x86/common/pushstr_array'
@@ -34,6 +35,7 @@ module Pwnlib
             argv = case argv
                    when String
                      raise ArgumentError, "#{argv.inspect} is not a valid register name" unless register?(argv)
+
                      argv
                    when Array
                      cat Common.pushstr_array(abi.register_arguments[2], argv)
@@ -46,6 +48,7 @@ module Pwnlib
             envp = case envp
                    when String
                      raise ArgumentError, "#{envp.inspect} is not a valid register name" unless register?(envp)
+
                      envp
                    when Hash
                      cat Common.pushstr_array(abi.register_arguments[3], envp.map { |k, v| "#{k}=#{v}" })

data/lib/pwnlib/shellcraft/generators/x86/linux/exit.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/linux/linux'
 

data/lib/pwnlib/shellcraft/generators/x86/linux/linux.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pwnlib/shellcraft/generators/helper'
 
 module Pwnlib

data/lib/pwnlib/shellcraft/generators/x86/linux/ls.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/common/pushstr'
 require 'pwnlib/shellcraft/generators/x86/linux/linux'

data/lib/pwnlib/shellcraft/generators/x86/linux/open.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/linux/linux'
 

data/lib/pwnlib/shellcraft/generators/x86/linux/sh.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/linux/execve'
 require 'pwnlib/shellcraft/generators/x86/linux/linux'

data/lib/pwnlib/shellcraft/generators/x86/linux/sleep.rb

@@ -0,0 +1,52 @@
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
+
+require 'pwnlib/shellcraft/generators/x86/common/pushstr'
+require 'pwnlib/shellcraft/generators/x86/linux/linux'
+require 'pwnlib/shellcraft/generators/x86/linux/syscall'
+require 'pwnlib/util/packing'
+
+module Pwnlib
+  module Shellcraft
+    module Generators
+      module X86
+        module Linux
+          # Sleep for a specified number of seconds.
+          #
+          # @param [Float] seconds
+          #   The seconds to sleep.
+          #
+          # @example
+          #   context.arch = :amd64
+          #   puts shellcraft.sleep(1)
+          #   #  /* push "\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" */
+          #   #  push 1
+          #   #  dec byte ptr [rsp]
+          #   #  push 1
+          #   #  /* call nanosleep("rsp", 0) */
+          #   #  push 0x23 /* (SYS_nanosleep) */
+          #   #  pop rax
+          #   #  mov rdi, rsp
+          #   #  xor esi, esi /* 0 */
+          #   #  syscall
+          #   #  add rsp, 16 /* recover rsp */
+          #   #=> nil
+          #
+          # @note
+          #   Syscall +nanosleep+ accepts a data pointer as argument, the stack will be used for putting the data
+          #   needed. The generated assembly will use sizeof(struct timespec) = 16 bytes for putting data.
+          def sleep(seconds)
+            # pushes the data onto stack
+            tv_sec = seconds.to_i
+            tv_nsec = ((seconds - tv_sec) * 1e9).to_i
+            data = ::Pwnlib::Util::Packing.p64(tv_sec) + ::Pwnlib::Util::Packing.p64(tv_nsec)
+            cat Common.pushstr(data, append_null: false)
+            sp = ::Pwnlib::ABI::ABI.default.stack_pointer
+            cat Linux.syscall('SYS_nanosleep', sp, 0)
+            cat "add #{sp}, #{data.size} /* recover #{sp} */"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pwnlib/shellcraft/generators/x86/linux/syscall.rb

@@ -1,7 +1,9 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/shellcraft/generators/x86/common/setregs'
 require 'pwnlib/shellcraft/generators/x86/linux/linux'
+require 'pwnlib/util/ruby'
 
 module Pwnlib
   module Shellcraft
@@ -23,25 +25,23 @@ module Pwnlib
           #   #=> nil
           def syscall(*arguments)
             abi = ::Pwnlib::ABI::ABI.syscall
-            syscall, arg0, arg1, arg2, arg3, arg4, arg5 = arguments
-            if syscall.respond_to?(:to_s) && syscall.to_s.start_with?('SYS_')
-              syscall_repr = syscall.to_s[4..-1] + '(%s)'
+            registers = abi.register_arguments
+            reg_ctx = registers.zip(arguments).to_h
+            syscall = arguments.first
+            if syscall.to_s.start_with?('SYS_')
+              fmt = syscall.to_s[4..-1] + '(%s)'
               args = []
             else
-              syscall_repr = 'syscall(%s)'
+              fmt = 'syscall(%s)'
               args = [syscall ? syscall.inspect : '?']
             end
             # arg0 to arg5
             1.upto(6) do |i|
               args.push(arguments[i] ? arguments[i].inspect : '?')
             end
-
             args.pop while args.last == '?'
-            syscall_repr = format(syscall_repr, args.join(', '))
-            registers = abi.register_arguments
-            arguments = [syscall, arg0, arg1, arg2, arg3, arg4, arg5]
-            reg_ctx = registers.zip(arguments).to_h
-            cat "/* call #{syscall_repr} */"
+
+            cat "/* call #{format(fmt, args.join(', '))} */"
             cat Common.setregs(reg_ctx) if arguments.any? { |v| !v.nil? }
             cat abi.syscall_str
           end

data/lib/pwnlib/shellcraft/registers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pwnlib/context'
 
 module Pwnlib
@@ -55,6 +57,7 @@ module Pwnlib
           @size = size
           X86_ORDERED.each do |row|
             next unless row.include?(name)
+
             @bigger = row[0, row.index(name)]
             @smaller = row[(row.index(name) + 1)..-1]
             @native64 = row[0]
@@ -122,6 +125,7 @@ module Pwnlib
       def get_register(name)
         return name if name.instance_of?(Register)
         return INTEL[name.to_s] if name.instance_of?(String) || name.instance_of?(Symbol)
+
         nil
       end
 
@@ -132,7 +136,7 @@ module Pwnlib
       def bits_required(value)
         bits = 0
         value = value.abs
-        while value > 0
+        while value.positive?
           bits += 8
           value >>= 8
         end

data/lib/pwnlib/shellcraft/shellcraft.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'singleton'
 
@@ -19,7 +20,7 @@ module Pwnlib
 
       # All files under generators/ will be required.
       def initialize
-        Dir[File.join(__dir__, 'generators', '**', '*.rb')].each do |f|
+        Dir[File.join(__dir__, 'generators', '**', '*.rb')].sort.each do |f|
           require f
         end
       end
@@ -29,15 +30,17 @@ module Pwnlib
       #
       # With this method, +context.local(arch: 'amd64') { shellcraft.sh }+ will invoke
       # {Shellcraft::Generators::Amd64::Linux#sh}.
-      def method_missing(method, *args, &block)
+      def method_missing(method, *args, **kwargs, &block)
         mod = find_module_for(method)
         return super if mod.nil?
-        mod.public_send(method, *args, &block)
+
+        mod.public_send(method, *args, **kwargs, &block)
       end
 
       # For +respond_to?+.
       def respond_to_missing?(method, include_private = false)
         return true if find_module_for(method)
+
         super
       end
 
@@ -55,9 +58,11 @@ module Pwnlib
         # try search in Common module
         common_module = arch_module.const_get(:Common)
         return common_module if common_module.singleton_methods.include?(method)
+
         # search in ${os} module
         os_module = arch_module.const_get(context.os.capitalize)
         return os_module if os_module.singleton_methods.include?(method)
+
         nil
       end
 

data/lib/pwnlib/timer.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'time'
 
@@ -29,11 +30,13 @@ module Pwnlib
 
     def timeout
       return @timeout || ::Pwnlib::Context.context.timeout unless started?
+
       @deadline == :forever ? :forever : [@deadline - Time.now, 0].max
     end
 
     def timeout=(timeout)
       raise "Can't change timeout when countdown" if started?
+
       @timeout = timeout
     end
 
@@ -41,13 +44,14 @@ module Pwnlib
     # NOTE(Darkpi): timeout = nil means default value for the first time, and nop after that.
     def countdown(timeout = nil)
       raise ArgumentError, 'Need a block for countdown' unless block_given?
+
       if started?
         return yield if timeout.nil?
+
         raise 'Nested countdown not permitted'
       end
 
-      timeout ||= @timeout
-      timeout ||= ::Pwnlib::Context.context.timeout
+      timeout ||= @timeout || ::Pwnlib::Context.context.timeout
 
       @deadline = timeout == :forever ? :forever : Time.now + timeout
 

data/lib/pwnlib/tubes/buffer.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 module Pwnlib
   module Tubes
@@ -35,6 +36,7 @@ module Pwnlib
         else
           data = data.to_s.dup
           return if data.empty?
+
           @data << data
         end
         @size += data.size
@@ -53,6 +55,7 @@ module Pwnlib
         else
           data = data.to_s.dup
           return if data.empty?
+
           @data.unshift(data)
         end
         @size += data.size
@@ -61,7 +64,7 @@ module Pwnlib
 
       # Retrieves bytes from the buffer.
       #
-      # @param [Integer] n
+      # @param [Integer?] n
       #   Maximum number of bytes to fetch.
       #
       # @return [String]

data/lib/pwnlib/tubes/process.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/errors'
 require 'pwnlib/tubes/tube'
@@ -140,6 +141,7 @@ module Pwnlib
       def recv_raw(size)
         o, = IO.select([@o], [], [], @timeout)
         return if o.nil?
+
         @o.readpartial(size)
       rescue Errno::EIO, Errno::EPIPE, IOError
         raise ::Pwnlib::Errors::EndOfTubeError

data/lib/pwnlib/tubes/serialtube.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'rubyserial'
 
@@ -69,6 +70,7 @@ module Pwnlib
             while @serial_timer.active?
               data += @conn.read(numbytes - data.length)
               break unless data.empty?
+
               sleep 0.1
             end
             # XXX(JonathanBeverley): should we reverse @convert_newlines here?
@@ -94,7 +96,7 @@ module Pwnlib
 
         data.gsub!(context.newline, "\r\n") if @convert_newlines
         begin
-          return @conn.write(data)
+          @conn.write(data)
         rescue RubySerial::Error
           close
           raise ::Pwnlib::Errors::EndOfTubeError

data/lib/pwnlib/tubes/sock.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'socket'
 
@@ -42,6 +43,7 @@ module Pwnlib
       def close(direction = :both)
         if direction == :both
           return if @sock.closed?
+
           @closed[:read] = @closed[:write] = true
           @sock.close
         else
@@ -55,6 +57,7 @@ module Pwnlib
 
       def shutdown(direction)
         return if @closed[direction]
+
         @closed[direction] = true
 
         if direction.equal?(:read)
@@ -70,6 +73,7 @@ module Pwnlib
 
       def send_raw(data)
         raise ::Pwnlib::Errors::EndOfTubeError if @closed[:write]
+
         begin
           @sock.write(data)
         rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED
@@ -80,10 +84,12 @@ module Pwnlib
 
       def recv_raw(size)
         raise ::Pwnlib::Errors::EndOfTubeError if @closed[:read]
+
         begin
           rs, = IO.select([@sock], [], [], @timeout)
           return if rs.nil?
-          return @sock.readpartial(size)
+
+          @sock.readpartial(size)
         rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ECONNABORTED, EOFError
           shutdown(:read)
           raise ::Pwnlib::Errors::EndOfTubeError

data/lib/pwnlib/tubes/tube.rb

@@ -1,4 +1,5 @@
 # encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'pwnlib/context'
 require 'pwnlib/errors'
@@ -59,6 +60,7 @@ module Pwnlib
       # @!macro raise_timeout
       def recv(num_bytes = nil, timeout: nil)
         return '' if @buffer.empty? && !fillbuffer(timeout: timeout)
+
         @buffer.get(num_bytes)
       end
       alias read recv
@@ -99,8 +101,9 @@ module Pwnlib
       # @!macro raise_timeout
       def recvpred(timeout: nil)
         raise ArgumentError, 'Need a block for recvpred' unless block_given?
+
         @timer.countdown(timeout) do
-          data = ''
+          data = +''
           begin
             until yield(data)
               return '' unless @timer.active?
@@ -108,6 +111,7 @@ module Pwnlib
               c = recv(1)
 
               return '' if c.empty?
+
               data << c
             end
             data.slice!(0..-1)
@@ -161,12 +165,13 @@ module Pwnlib
         max_len = delims.map(&:size).max
         @timer.countdown(timeout) do
           data = Buffer.new
-          matching = ''
+          matching = +''
           begin
             while @timer.active?
               s = recv(1)
 
               return '' if s.empty?
+
               matching << s
 
               sidx = matching.size
@@ -174,6 +179,7 @@ module Pwnlib
               delims.each do |d|
                 idx = matching.index(d)
                 next unless idx
+
                 if idx + d.size <= sidx + match_len
                   sidx = idx
                   match_len = d.size
@@ -265,6 +271,19 @@ module Pwnlib
         recvpred(timeout: timeout) { |data| data =~ regex }
       end
 
+      # Receives data until reaching EOF or a timeout is occurred.
+      #
+      # @!macro timeout_definition
+      #
+      # @return [String]
+      #   Returns the data received.
+      def recvall(timeout: nil)
+        recvn(1 << 63, timeout: timeout)
+      rescue ::Pwnlib::Errors::EndOfTubeError, ::Pwnlib::Errors::TimeoutError
+        @buffer.get
+      end
+      alias readall recvall
+
       # Sends data.
       #
       # @param [String] data
@@ -323,8 +342,9 @@ module Pwnlib
       #   #=> nil
       def puts(*objs)
         return write(context.newline) if objs.empty?
+
         objs = *objs.flatten
-        s = ''
+        s = +''
         objs.map(&:to_s).each do |elem|
           s << elem
           s << context.newline unless elem.end_with?(context.newline)