sonixlabs-net-ssh 2.3.0

data/lib/net/ssh/buffer.rb

@@ -0,0 +1,340 @@
+require 'net/ssh/ruby_compat'
+require 'net/ssh/transport/openssl'
+
+module Net; module SSH
+
+  # Net::SSH::Buffer is a flexible class for building and parsing binary
+  # data packets. It provides a stream-like interface for sequentially
+  # reading data items from the buffer, as well as a useful helper method
+  # for building binary packets given a signature.
+  #
+  # Writing to a buffer always appends to the end, regardless of where the
+  # read cursor is. Reading, on the other hand, always begins at the first
+  # byte of the buffer and increments the read cursor, with subsequent reads
+  # taking up where the last left off.
+  #
+  # As a consumer of the Net::SSH library, you will rarely come into contact
+  # with these buffer objects directly, but it could happen. Also, if you
+  # are ever implementing a protocol on top of SSH (e.g. SFTP), this buffer
+  # class can be quite handy.
+  class Buffer
+    # This is a convenience method for creating and populating a new buffer
+    # from a single command. The arguments must be even in length, with the
+    # first of each pair of arguments being a symbol naming the type of the
+    # data that follows. If the type is :raw, the value is written directly
+    # to the hash.
+    #
+    #   b = Buffer.from(:byte, 1, :string, "hello", :raw, "\1\2\3\4")
+    #   #-> "\1\0\0\0\5hello\1\2\3\4"
+    #
+    # The supported data types are:
+    #
+    # * :raw => write the next value verbatim (#write)
+    # * :int64 => write an 8-byte integer (#write_int64)
+    # * :long => write a 4-byte integer (#write_long)
+    # * :byte => write a single byte (#write_byte)
+    # * :string => write a 4-byte length followed by character data (#write_string)
+    # * :bool => write a single byte, interpreted as a boolean (#write_bool)
+    # * :bignum => write an SSH-encoded bignum (#write_bignum)
+    # * :key => write an SSH-encoded key value (#write_key)
+    #
+    # Any of these, except for :raw, accepts an Array argument, to make it
+    # easier to write multiple values of the same type in a briefer manner.
+    def self.from(*args)
+      raise ArgumentError, "odd number of arguments given" unless args.length % 2 == 0
+
+      buffer = new
+      0.step(args.length-1, 2) do |index|
+        type = args[index]
+        value = args[index+1]
+        if type == :raw
+          buffer.append(value.to_s)
+        elsif Array === value
+          buffer.__send__("write_#{type}", *value)
+        else
+          buffer.__send__("write_#{type}", value)
+        end
+      end
+
+      buffer
+    end
+
+    # exposes the raw content of the buffer
+    attr_reader :content
+
+    # the current position of the pointer in the buffer
+    attr_accessor :position
+
+    # Creates a new buffer, initialized to the given content. The position
+    # is initialized to the beginning of the buffer.
+    def initialize(content="")
+      @content = content.to_s
+      @position = 0
+    end
+
+    # Returns the length of the buffer's content.
+    def length
+      @content.length
+    end
+
+    # Returns the number of bytes available to be read (e.g., how many bytes
+    # remain between the current position and the end of the buffer).
+    def available
+      length - position
+    end
+
+    # Returns a copy of the buffer's content.
+    def to_s
+      (@content || "").dup
+    end
+
+    # Compares the contents of the two buffers, returning +true+ only if they
+    # are identical in size and content.
+    def ==(buffer)
+      to_s == buffer.to_s
+    end
+
+    # Returns +true+ if the buffer contains no data (e.g., it is of zero length).
+    def empty?
+      @content.empty?
+    end
+
+    # Resets the pointer to the start of the buffer. Subsequent reads will
+    # begin at position 0.
+    def reset!
+      @position = 0
+    end
+
+    # Returns true if the pointer is at the end of the buffer. Subsequent
+    # reads will return nil, in this case.
+    def eof?
+      @position >= length
+    end
+
+    # Resets the buffer, making it empty. Also, resets the read position to
+    # 0.
+    def clear!
+      @content = ""
+      @position = 0
+    end
+
+    # Consumes n bytes from the buffer, where n is the current position
+    # unless otherwise specified. This is useful for removing data from the
+    # buffer that has previously been read, when you are expecting more data
+    # to be appended. It helps to keep the size of buffers down when they
+    # would otherwise tend to grow without bound.
+    #
+    # Returns the buffer object itself.
+    def consume!(n=position)
+      if n >= length
+        # optimize for a fairly common case
+        clear!
+      elsif n > 0
+        @content = @content[n..-1] || ""
+        @position -= n
+        @position = 0 if @position < 0
+      end
+      self
+    end
+
+    # Appends the given text to the end of the buffer. Does not alter the
+    # read position. Returns the buffer object itself.
+    def append(text)
+      @content << text
+      self
+    end
+
+    # Returns all text from the current pointer to the end of the buffer as
+    # a new Net::SSH::Buffer object.
+    def remainder_as_buffer
+      Buffer.new(@content[@position..-1])
+    end
+
+    # Reads all data up to and including the given pattern, which may be a
+    # String, Fixnum, or Regexp and is interpreted exactly as String#index
+    # does. Returns nil if nothing matches. Increments the position to point
+    # immediately after the pattern, if it does match. Returns all data up to
+    # and including the text that matched the pattern.
+    def read_to(pattern)
+      index = @content.index(pattern, @position) or return nil
+      length = case pattern
+        when String then pattern.length
+        when Fixnum then 1
+        when Regexp then $&.length
+      end
+      index && read(index+length)
+    end
+
+    # Reads and returns the next +count+ bytes from the buffer, starting from
+    # the read position. If +count+ is +nil+, this will return all remaining
+    # text in the buffer. This method will increment the pointer.
+    def read(count=nil)
+      count ||= length
+      count = length - @position if @position + count > length
+      @position += count
+      @content[@position-count, count]
+    end
+
+    # Reads (as #read) and returns the given number of bytes from the buffer,
+    # and then consumes (as #consume!) all data up to the new read position.
+    def read!(count=nil)
+      data = read(count)
+      consume!
+      data
+    end
+      
+    # Return the next 8 bytes as a 64-bit integer (in network byte order).
+    # Returns nil if there are less than 8 bytes remaining to be read in the
+    # buffer.
+    def read_int64
+      hi = read_long or return nil
+      lo = read_long or return nil
+      return (hi << 32) + lo
+    end
+
+    # Return the next four bytes as a long integer (in network byte order).
+    # Returns nil if there are less than 4 bytes remaining to be read in the
+    # buffer.
+    def read_long
+      b = read(4) or return nil
+      b.unpack("N").first
+    end
+
+    # Read and return the next byte in the buffer. Returns nil if called at
+    # the end of the buffer.
+    def read_byte
+      b = read(1) or return nil
+      b.getbyte(0)
+    end
+
+    # Read and return an SSH2-encoded string. The string starts with a long
+    # integer that describes the number of bytes remaining in the string.
+    # Returns nil if there are not enough bytes to satisfy the request.
+    def read_string
+      length = read_long or return nil
+      read(length)
+    end
+
+    # Read a single byte and convert it into a boolean, using 'C' rules
+    # (i.e., zero is false, non-zero is true).
+    def read_bool
+      b = read_byte or return nil
+      b != 0
+    end
+
+    # Read a bignum (OpenSSL::BN) from the buffer, in SSH2 format. It is
+    # essentially just a string, which is reinterpreted to be a bignum in
+    # binary format.
+    def read_bignum
+      data = read_string
+      return unless data
+      OpenSSL::BN.new(data, 2)
+    end
+
+    # Read a key from the buffer. The key will start with a string
+    # describing its type. The remainder of the key is defined by the
+    # type that was read.
+    def read_key
+      type = read_string
+      return (type ? read_keyblob(type) : nil)
+    end
+
+    # Read a keyblob of the given type from the buffer, and return it as
+    # a key. Only RSA and DSA keys are supported.
+    def read_keyblob(type)
+      case type
+        when "ssh-dss"
+          key = OpenSSL::PKey::DSA.new
+          key.p = read_bignum
+          key.q = read_bignum
+          key.g = read_bignum
+          key.pub_key = read_bignum
+
+        when "ssh-rsa"
+          key = OpenSSL::PKey::RSA.new
+          key.e = read_bignum
+          key.n = read_bignum
+
+        else
+          raise NotImplementedError, "unsupported key type `#{type}'"
+      end
+
+      return key
+    end
+
+    # Reads the next string from the buffer, and returns a new Buffer
+    # object that wraps it.
+    def read_buffer
+      Buffer.new(read_string)
+    end
+
+    # Writes the given data literally into the string. Does not alter the
+    # read position. Returns the buffer object.
+    def write(*data)
+      data.each { |datum| @content << datum }
+      self
+    end
+
+    # Writes each argument to the buffer as a network-byte-order-encoded
+    # 64-bit integer (8 bytes). Does not alter the read position. Returns the
+    # buffer object.
+    def write_int64(*n)
+      n.each do |i|
+        hi = (i >> 32) & 0xFFFFFFFF
+        lo = i & 0xFFFFFFFF
+        @content << [hi, lo].pack("N2")
+      end
+      self
+    end
+
+    # Writes each argument to the buffer as a network-byte-order-encoded
+    # long (4-byte) integer. Does not alter the read position. Returns the
+    # buffer object.
+    def write_long(*n)
+      @content << n.pack("N*")
+      self
+    end
+
+    # Writes each argument to the buffer as a byte. Does not alter the read
+    # position. Returns the buffer object.
+    def write_byte(*n)
+      n.each { |b| @content << b.chr }
+      self
+    end
+
+    # Writes each argument to the buffer as an SSH2-encoded string. Each
+    # string is prefixed by its length, encoded as a 4-byte long integer.
+    # Does not alter the read position. Returns the buffer object.
+    def write_string(*text)
+      text.each do |string|
+        s = string.to_s
+        write_long(s.length)
+        write(s)
+      end
+      self
+    end
+
+    # Writes each argument to the buffer as a (C-style) boolean, with 1
+    # meaning true, and 0 meaning false. Does not alter the read position.
+    # Returns the buffer object.
+    def write_bool(*b)
+      b.each { |v| @content << (v ? "\1" : "\0") }
+      self
+    end
+
+    # Writes each argument to the buffer as a bignum (SSH2-style). No
+    # checking is done to ensure that the arguments are, in fact, bignums.
+    # Does not alter the read position. Returns the buffer object.
+    def write_bignum(*n)
+      @content << n.map { |b| b.to_ssh }.join
+      self
+    end
+
+    # Writes the given arguments to the buffer as SSH2-encoded keys. Does not
+    # alter the read position. Returns the buffer object.
+    def write_key(*key)
+      key.each { |k| append(k.to_blob) }
+      self
+    end
+  end
+end; end;

data/lib/net/ssh/buffered_io.rb

@@ -0,0 +1,198 @@
+require 'net/ssh/buffer'
+require 'net/ssh/loggable'
+require 'net/ssh/ruby_compat'
+
+module Net; module SSH
+
+  # This module is used to extend sockets and other IO objects, to allow
+  # them to be buffered for both read and write. This abstraction makes it
+  # quite easy to write a select-based event loop
+  # (see Net::SSH::Connection::Session#listen_to).
+  #
+  # The general idea is that instead of calling #read directly on an IO that
+  # has been extended with this module, you call #fill (to add pending input
+  # to the internal read buffer), and then #read_available (to read from that
+  # buffer). Likewise, you don't call #write directly, you call #enqueue to
+  # add data to the write buffer, and then #send_pending or #wait_for_pending_sends
+  # to actually send the data across the wire.
+  #
+  # In this way you can easily use the object as an argument to IO.select,
+  # calling #fill when it is available for read, or #send_pending when it is
+  # available for write, and then call #enqueue and #read_available during
+  # the idle times.
+  #
+  #   socket = TCPSocket.new(address, port)
+  #   socket.extend(Net::SSH::BufferedIo)
+  #
+  #   ssh.listen_to(socket)
+  #
+  #   ssh.loop do
+  #     if socket.available > 0
+  #       puts socket.read_available
+  #       socket.enqueue("response\n")
+  #     end
+  #   end
+  #
+  # Note that this module must be used to extend an instance, and should not
+  # be included in a class. If you do want to use it via an include, then you
+  # must make sure to invoke the private #initialize_buffered_io method in
+  # your class' #initialize method:
+  #
+  #   class Foo < IO
+  #     include Net::SSH::BufferedIo
+  #
+  #     def initialize
+  #       initialize_buffered_io
+  #       # ...
+  #     end
+  #   end
+  module BufferedIo
+    include Loggable
+
+    # Called when the #extend is called on an object, with this module as the
+    # argument. It ensures that the modules instance variables are all properly
+    # initialized.
+    def self.extended(object) #:nodoc:
+      # need to use __send__ because #send is overridden in Socket
+      object.__send__(:initialize_buffered_io)
+    end
+
+    # Tries to read up to +n+ bytes of data from the remote end, and appends
+    # the data to the input buffer. It returns the number of bytes read, or 0
+    # if no data was available to be read.
+    def fill(n=8192)
+      input.consume!
+      data = recv(n)
+      debug { "read #{data.length} bytes" }
+      input.append(data)
+      return data.length
+    end
+
+    # Read up to +length+ bytes from the input buffer. If +length+ is nil,
+    # all available data is read from the buffer. (See #available.)
+    def read_available(length=nil)
+      input.read(length || available)
+    end
+
+    # Returns the number of bytes available to be read from the input buffer.
+    # (See #read_available.)
+    def available
+      input.available
+    end
+
+    # Enqueues data in the output buffer, to be written when #send_pending
+    # is called. Note that the data is _not_ sent immediately by this method!
+    def enqueue(data)
+      output.append(data)
+    end
+
+    # Returns +true+ if there is data waiting in the output buffer, and
+    # +false+ otherwise.
+    def pending_write?
+      output.length > 0
+    end
+
+    # Sends as much of the pending output as possible. Returns +true+ if any
+    # data was sent, and +false+ otherwise.
+    def send_pending
+      if output.length > 0
+        sent = send(output.to_s, 0)
+        debug { "sent #{sent} bytes" }
+        output.consume!(sent)
+        return sent > 0
+      else
+        return false
+      end
+    end
+
+    # Calls #send_pending repeatedly, if necessary, blocking until the output
+    # buffer is empty.
+    def wait_for_pending_sends
+      send_pending
+      while output.length > 0
+        result = Net::SSH::Compat.io_select(nil, [self]) or next
+        next unless result[1].any?
+        send_pending
+      end
+    end
+
+    public # these methods are primarily for use in tests
+
+      def write_buffer #:nodoc:
+        output.to_s
+      end
+
+      def read_buffer #:nodoc:
+        input.to_s
+      end
+
+    private
+
+      #--
+      # Can't use attr_reader here (after +private+) without incurring the
+      # wrath of "ruby -w". We hates it.
+      #++
+
+      def input; @input; end
+      def output; @output; end
+
+      # Initializes the intput and output buffers for this object. This method
+      # is called automatically when the module is mixed into an object via
+      # Object#extend (see Net::SSH::BufferedIo.extended), but must be called
+      # explicitly in the +initialize+ method of any class that uses
+      # Module#include to add this module.
+      def initialize_buffered_io
+        @input = Net::SSH::Buffer.new
+        @output = Net::SSH::Buffer.new
+      end
+  end
+
+
+  
+  # Fixes for two issues by Miklós Fazekas:
+  #
+  #   * if client closes a forwarded connection, but the server is 
+  #     reading, net-ssh terminates with IOError socket closed.
+  #   * if client force closes (RST) a forwarded connection, but 
+  #     server is reading, net-ssh terminates with [an exception]
+  #
+  # See: 
+  # 
+  #    http://net-ssh.lighthouseapp.com/projects/36253/tickets/7
+  #    http://github.com/net-ssh/net-ssh/tree/portfwfix
+  #
+  module ForwardedBufferedIo
+    def fill(n=8192)
+      begin
+        super(n)
+      rescue Errno::ECONNRESET => e
+        debug { "connection was reset => shallowing exception:#{e}" }
+        return 0
+      rescue IOError => e                                 
+        if e.message =~ /closed/ then 
+          debug { "connection was reset => shallowing exception:#{e}" }
+          return 0
+        else
+          raise
+        end 
+      end
+    end
+    
+    def send_pending
+      begin
+        super                                                          
+      rescue Errno::ECONNRESET => e
+        debug { "connection was reset => shallowing exception:#{e}" }
+        return 0
+      rescue IOError => e
+        if e.message =~ /closed/ then 
+          debug { "connection was reset => shallowing exception:#{e}" }
+          return 0
+        else
+          raise
+        end
+      end
+    end
+  end
+  
+end; end