net-ssh 2.7.0 → 7.3.0

data/lib/net/ssh/transport/state.rb

@@ -2,205 +2,207 @@ require 'zlib'
 require 'net/ssh/transport/cipher_factory'
 require 'net/ssh/transport/hmac'
 
-module Net; module SSH; module Transport
-
-  # Encapsulates state information about one end of an SSH connection. Such
-  # state includes the packet sequence number, the algorithms in use, how
-  # many packets and blocks have been processed since the last reset, and so
-  # forth. This class will never be instantiated directly, but is used as
-  # part of the internal state of the PacketStream module.
-  class State
-    # The socket object that owns this state object.
-    attr_reader :socket
-
-    # The next packet sequence number for this socket endpoint.
-    attr_reader :sequence_number
-
-    # The hmac algorithm in use for this endpoint.
-    attr_reader :hmac
-
-    # The compression algorithm in use for this endpoint.
-    attr_reader :compression
-
-    # The compression level to use when compressing data (or nil, for the default).
-    attr_reader :compression_level
-
-    # The number of packets processed since the last call to #reset!
-    attr_reader :packets
-
-    # The number of data blocks processed since the last call to #reset!
-    attr_reader :blocks
-
-    # The cipher algorithm in use for this socket endpoint.
-    attr_reader :cipher
-
-    # The block size for the cipher
-    attr_reader :block_size
-
-    # The role that this state plays (either :client or :server)
-    attr_reader :role
-
-    # The maximum number of packets that this endpoint wants to process before
-    # needing a rekey.
-    attr_accessor :max_packets
-
-    # The maximum number of blocks that this endpoint wants to process before
-    # needing a rekey.
-    attr_accessor :max_blocks
-
-    # The user-specified maximum number of bytes that this endpoint ought to
-    # process before needing a rekey.
-    attr_accessor :rekey_limit
-
-    # Creates a new state object, belonging to the given socket. Initializes
-    # the algorithms to "none".
-    def initialize(socket, role)
-      @socket = socket
-      @role = role
-      @sequence_number = @packets = @blocks = 0
-      @cipher = CipherFactory.get("none")
-      @block_size = 8
-      @hmac = HMAC.get("none")
-      @compression = nil
-      @compressor = @decompressor = nil
-      @next_iv = ""
-    end
+module Net
+  module SSH
+    module Transport
+      # Encapsulates state information about one end of an SSH connection. Such
+      # state includes the packet sequence number, the algorithms in use, how
+      # many packets and blocks have been processed since the last reset, and so
+      # forth. This class will never be instantiated directly, but is used as
+      # part of the internal state of the PacketStream module.
+      class State
+        # The socket object that owns this state object.
+        attr_reader :socket
+
+        # The next packet sequence number for this socket endpoint.
+        attr_reader :sequence_number
+
+        # The hmac algorithm in use for this endpoint.
+        attr_reader :hmac
+
+        # The compression algorithm in use for this endpoint.
+        attr_reader :compression
+
+        # The compression level to use when compressing data (or nil, for the default).
+        attr_reader :compression_level
+
+        # The number of packets processed since the last call to #reset!
+        attr_reader :packets
+
+        # The number of data blocks processed since the last call to #reset!
+        attr_reader :blocks
+
+        # The cipher algorithm in use for this socket endpoint.
+        attr_reader :cipher
+
+        # The block size for the cipher
+        attr_reader :block_size
+
+        # The role that this state plays (either :client or :server)
+        attr_reader :role
+
+        # The maximum number of packets that this endpoint wants to process before
+        # needing a rekey.
+        attr_accessor :max_packets
+
+        # The maximum number of blocks that this endpoint wants to process before
+        # needing a rekey.
+        attr_accessor :max_blocks
+
+        # The user-specified maximum number of bytes that this endpoint ought to
+        # process before needing a rekey.
+        attr_accessor :rekey_limit
+
+        # Creates a new state object, belonging to the given socket. Initializes
+        # the algorithms to "none".
+        def initialize(socket, role)
+          @socket = socket
+          @role = role
+          @sequence_number = @packets = @blocks = 0
+          @cipher = CipherFactory.get("none")
+          @block_size = 8
+          @hmac = HMAC.get("none")
+          @compression = nil
+          @compressor = @decompressor = nil
+          @next_iv = String.new
+        end
 
-    # A convenience method for quickly setting multiple values in a single
-    # command.
-    def set(values)
-      values.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-      reset!
-    end
+        # A convenience method for quickly setting multiple values in a single
+        # command.
+        def set(values)
+          values.each do |key, value|
+            instance_variable_set("@#{key}", value)
+          end
+          reset!
+        end
 
-    def update_cipher(data)
-      result = cipher.update(data)
-      update_next_iv(role == :client ? result : data)
-      return result
-    end
+        def update_cipher(data)
+          result = cipher.update(data)
+          update_next_iv(role == :client ? result : data)
+          return result
+        end
 
-    def final_cipher
-      result = cipher.final
-      update_next_iv(role == :client ? result : "", true)
-      return result
-    end
+        def final_cipher
+          result = cipher.final
+          update_next_iv(role == :client ? result : "", true)
+          return result
+        end
 
-    # Increments the counters. The sequence number is incremented (and remapped
-    # so it always fits in a 32-bit integer). The number of packets and blocks
-    # are also incremented.
-    def increment(packet_length)
-      @sequence_number = (@sequence_number + 1) & 0xFFFFFFFF
-      @packets += 1
-      @blocks += (packet_length + 4) / @block_size
-    end
+        # Increments the counters. The sequence number is incremented (and remapped
+        # so it always fits in a 32-bit integer). The number of packets and blocks
+        # are also incremented.
+        def increment(packet_length)
+          @sequence_number = (@sequence_number + 1) & 0xFFFFFFFF
+          @packets += 1
+          @blocks += (packet_length + 4) / @block_size
+        end
 
-    # The compressor object to use when compressing data. This takes into account
-    # the desired compression level.
-    def compressor
-      @compressor ||= Zlib::Deflate.new(compression_level || Zlib::DEFAULT_COMPRESSION)
-    end
+        # The compressor object to use when compressing data. This takes into account
+        # the desired compression level.
+        def compressor
+          @compressor ||= Zlib::Deflate.new(compression_level || Zlib::DEFAULT_COMPRESSION)
+        end
 
-    # The decompressor object to use when decompressing data.
-    def decompressor
-      @decompressor ||= Zlib::Inflate.new(nil)
-    end
+        # The decompressor object to use when decompressing data.
+        def decompressor
+          @decompressor ||= Zlib::Inflate.new(nil)
+        end
 
-    # Returns true if data compression/decompression is enabled. This will
-    # return true if :standard compression is selected, or if :delayed
-    # compression is selected and the :authenticated hint has been received
-    # by the socket.
-    def compression?
-      compression == :standard || (compression == :delayed && socket.hints[:authenticated])
-    end
+        # Returns true if data compression/decompression is enabled. This will
+        # return true if :standard compression is selected, or if :delayed
+        # compression is selected and the :authenticated hint has been received
+        # by the socket.
+        def compression?
+          compression == :standard || (compression == :delayed && socket.hints[:authenticated])
+        end
 
-    # Compresses the data. If no compression is in effect, this will just return
-    # the data unmodified, otherwise it uses #compressor to compress the data.
-    def compress(data)
-      data = data.to_s
-      return data unless compression?
-      compressor.deflate(data, Zlib::SYNC_FLUSH)
-    end
+        # Compresses the data. If no compression is in effect, this will just return
+        # the data unmodified, otherwise it uses #compressor to compress the data.
+        def compress(data)
+          data = data.to_s
+          return data unless compression?
 
-    # Deompresses the data. If no compression is in effect, this will just return
-    # the data unmodified, otherwise it uses #decompressor to decompress the data.
-    def decompress(data)
-      data = data.to_s
-      return data unless compression?
-      decompressor.inflate(data)
-    end
+          compressor.deflate(data, Zlib::SYNC_FLUSH)
+        end
 
-    # Resets the counters on the state object, but leaves the sequence_number
-    # unchanged. It also sets defaults for and recomputes the max_packets and
-    # max_blocks values.
-    def reset!
-      @packets = @blocks = 0
+        # Decompresses the data. If no compression is in effect, this will just return
+        # the data unmodified, otherwise it uses #decompressor to decompress the data.
+        def decompress(data)
+          data = data.to_s
+          return data unless compression?
 
-      @max_packets ||= 1 << 31
+          decompressor.inflate(data)
+        end
 
-      @block_size = cipher.name == "RC4" ? 8 : cipher.block_size
+        # Resets the counters on the state object, but leaves the sequence_number
+        # unchanged. It also sets defaults for and recomputes the max_packets and
+        # max_blocks values.
+        def reset!
+          @packets = @blocks = 0
 
-      if max_blocks.nil?
-        # cargo-culted from openssh. the idea is that "the 2^(blocksize*2)
-        # limit is too expensive for 3DES, blowfish, etc., so enforce a 1GB
-        # limit for small blocksizes."
-        if @block_size >= 16
-          @max_blocks = 1 << (@block_size * 2)
-        else
-          @max_blocks = (1 << 30) / @block_size
-        end
+          @max_packets ||= 1 << 31
 
-        # if a limit on the # of bytes has been given, convert that into a
-        # minimum number of blocks processed.
+          @block_size = cipher.block_size
 
-        if rekey_limit
-          @max_blocks = [@max_blocks, rekey_limit / @block_size].min
-        end
-      end
+          if max_blocks.nil?
+            # cargo-culted from openssh. the idea is that "the 2^(blocksize*2)
+            # limit is too expensive for 3DES, blowfish, etc., so enforce a 1GB
+            # limit for small blocksizes."
+            if @block_size >= 16
+              @max_blocks = 1 << (@block_size * 2)
+            else
+              @max_blocks = (1 << 30) / @block_size
+            end
 
-      cleanup
-    end
+            # if a limit on the # of bytes has been given, convert that into a
+            # minimum number of blocks processed.
 
-    # Closes any the compressor and/or decompressor objects that have been
-    # instantiated.
-    def cleanup
-      if @compressor
-        @compressor.finish if !@compressor.finished?
-        @compressor.close
-      end
+            @max_blocks = [@max_blocks, rekey_limit / @block_size].min if rekey_limit
+          end
 
-      if @decompressor
-        # we call reset here so that we don't get warnings when we try to
-        # close the decompressor
-        @decompressor.reset
-        @decompressor.close
-      end
+          cleanup
+        end
 
-      @compressor = @decompressor = nil
-    end
+        # Closes any the compressor and/or decompressor objects that have been
+        # instantiated.
+        def cleanup
+          if @compressor
+            @compressor.finish if !@compressor.finished?
+            @compressor.close
+          end
+
+          if @decompressor
+            # we call reset here so that we don't get warnings when we try to
+            # close the decompressor
+            @decompressor.reset
+            @decompressor.close
+          end
+
+          @compressor = @decompressor = nil
+        end
 
-    # Returns true if the number of packets processed exceeds the maximum
-    # number of packets, or if the number of blocks processed exceeds the
-    # maximum number of blocks.
-    def needs_rekey?
-      max_packets && packets > max_packets ||
-      max_blocks && blocks > max_blocks
-    end
+        # Returns true if the number of packets processed exceeds the maximum
+        # number of packets, or if the number of blocks processed exceeds the
+        # maximum number of blocks.
+        def needs_rekey?
+          max_packets && packets > max_packets ||
+          max_blocks && blocks > max_blocks
+        end
 
-    private
+        private
 
-      def update_next_iv(data, reset=false)
-        @next_iv << data
-        @next_iv = @next_iv[-cipher.iv_len..-1]
+        def update_next_iv(data, reset = false)
+          @next_iv << data
+          @next_iv = @next_iv[@next_iv.size - cipher.iv_len..-1]
 
-        if reset
-          cipher.reset
-          cipher.iv = @next_iv
-        end
+          if reset
+            cipher.reset
+            cipher.iv = @next_iv
+          end
 
-        return data
+          return data
+        end
       end
+    end
   end
-
-end; end; end
+end

data/lib/net/ssh/verifiers/accept_new.rb

@@ -0,0 +1,33 @@
+require 'net/ssh/errors'
+require 'net/ssh/known_hosts'
+require 'net/ssh/verifiers/always'
+
+module Net
+  module SSH
+    module Verifiers
+      # Does a strict host verification, looking the server up in the known
+      # host files to see if a key has already been seen for this server. If this
+      # server does not appear in any host file, this will silently add the
+      # server. If the server does appear at least once, but the key given does
+      # not match any known for the server, an exception will be raised (HostKeyMismatch).
+      # Otherwise, this returns true.
+      class AcceptNew < Always
+        def verify(arguments)
+          begin
+            super
+          rescue HostKeyUnknown => err
+            err.remember_host!
+            return true
+          end
+        end
+
+        def verify_signature(&block)
+          yield
+        rescue HostKeyUnknown => err
+          err.remember_host!
+          return true
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/verifiers/accept_new_or_local_tunnel.rb

@@ -0,0 +1,33 @@
+require 'net/ssh/verifiers/accept_new'
+
+module Net
+  module SSH
+    module Verifiers
+      # Basically the same as the AcceptNew verifier, but does not try to actually
+      # verify a connection if the server is the localhost and the port is a
+      # nonstandard port number. Those two conditions will typically mean the
+      # connection is being tunnelled through a forwarded port, so the known-hosts
+      # file will not be helpful (in general).
+      class AcceptNewOrLocalTunnel < AcceptNew
+        # Tries to determine if the connection is being tunnelled, and if so,
+        # returns true. Otherwise, performs the standard strict verification.
+        def verify(arguments)
+          return true if tunnelled?(arguments)
+
+          super
+        end
+
+        private
+
+        # A connection is potentially being tunnelled if the port is not 22,
+        # and the ip refers to the localhost.
+        def tunnelled?(args)
+          return false if args[:session].port == Net::SSH::Transport::Session::DEFAULT_PORT
+
+          ip = args[:session].peer[:ip]
+          return ip == "127.0.0.1" || ip == "::1"
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/verifiers/always.rb

@@ -0,0 +1,58 @@
+require 'net/ssh/errors'
+require 'net/ssh/known_hosts'
+
+module Net
+  module SSH
+    module Verifiers
+      # Does a strict host verification, looking the server up in the known
+      # host files to see if a key has already been seen for this server. If this
+      # server does not appear in any host file, an exception will be raised
+      # (HostKeyUnknown). This is in contrast to the "Strict" class, which will
+      # silently add the key to your known_hosts file. If the server does appear at
+      # least once, but the key given does not match any known for the server, an
+      # exception will be raised (HostKeyMismatch).
+      # Otherwise, this returns true.
+      class Always
+        def verify(arguments)
+          host_keys = arguments[:session].host_keys
+
+          # We've never seen this host before, so raise an exception.
+          process_cache_miss(host_keys, arguments, HostKeyUnknown, "is unknown") if host_keys.empty?
+
+          # If we found any matches, check to see that the key type and
+          # blob also match.
+
+          found = host_keys.any? do |key|
+            if key.respond_to?(:matches_key?)
+              key.matches_key?(arguments[:key])
+            else
+              key.ssh_type == arguments[:key].ssh_type && key.to_blob == arguments[:key].to_blob
+            end
+          end
+
+          # If a match was found, return true. Otherwise, raise an exception
+          # indicating that the key was not recognized.
+          process_cache_miss(host_keys, arguments, HostKeyMismatch, "does not match") unless found
+
+          found
+        end
+
+        def verify_signature(&block)
+          yield
+        end
+
+        private
+
+        def process_cache_miss(host_keys, args, exc_class, message)
+          exception = exc_class.new("fingerprint #{args[:fingerprint]} " +
+                                    "#{message} for #{host_keys.host.inspect}")
+          exception.data = args
+          exception.callback = Proc.new do
+            host_keys.add_host_key(args[:key])
+          end
+          raise exception
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/verifiers/never.rb

@@ -0,0 +1,19 @@
+module Net
+  module SSH
+    module Verifiers
+      # This host key verifier simply allows every key it sees, without
+      # any verification. This is simple, but very insecure because it
+      # exposes you to MiTM attacks.
+      class Never
+        # Returns true.
+        def verify(arguments)
+          true
+        end
+
+        def verify_signature(&block)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/net/ssh/version.rb

@@ -1,62 +1,68 @@
-module Net; module SSH
-  # A class for describing the current version of a library. The version
-  # consists of three parts: the +major+ number, the +minor+ number, and the
-  # +tiny+ (or +patch+) number.
-  #
-  # Two Version instances may be compared, so that you can test that a version
-  # of a library is what you require:
-  #
-  #   require 'net/ssh/version'
-  #
-  #   if Net::SSH::Version::CURRENT < Net::SSH::Version[2,1,0]
-  #     abort "your software is too old!"
-  #   end
-  class Version
-    include Comparable
-
-    # A convenience method for instantiating a new Version instance with the
-    # given +major+, +minor+, and +tiny+ components.
-    def self.[](major, minor, tiny)
-      new(major, minor, tiny)
-    end
+module Net
+  module SSH
+    # A class for describing the current version of a library. The version
+    # consists of three parts: the +major+ number, the +minor+ number, and the
+    # +tiny+ (or +patch+) number.
+    #
+    # Two Version instances may be compared, so that you can test that a version
+    # of a library is what you require:
+    #
+    #   require 'net/ssh/version'
+    #
+    #   if Net::SSH::Version::CURRENT < Net::SSH::Version[2,1,0]
+    #     abort "your software is too old!"
+    #   end
+    class Version
+      include Comparable
 
-    attr_reader :major, :minor, :tiny
+      # A convenience method for instantiating a new Version instance with the
+      # given +major+, +minor+, and +tiny+ components.
+      def self.[](major, minor, tiny, pre = nil)
+        new(major, minor, tiny, pre)
+      end
 
-    # Create a new Version object with the given components.
-    def initialize(major, minor, tiny)
-      @major, @minor, @tiny = major, minor, tiny
-    end
+      attr_reader :major, :minor, :tiny
 
-    # Compare this version to the given +version+ object.
-    def <=>(version)
-      to_i <=> version.to_i
-    end
+      # Create a new Version object with the given components.
+      def initialize(major, minor, tiny, pre = nil)
+        @major, @minor, @tiny, @pre = major, minor, tiny, pre
+      end
 
-    # Converts this version object to a string, where each of the three
-    # version components are joined by the '.' character. E.g., 2.0.0.
-    def to_s
-      @to_s ||= [@major, @minor, @tiny].join(".")
-    end
+      # Compare this version to the given +version+ object.
+      def <=>(version)
+        to_i <=> version.to_i
+      end
 
-    # Converts this version to a canonical integer that may be compared
-    # against other version objects.
-    def to_i
-      @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
-    end
+      # Converts this version object to a string, where each of the three
+      # version components are joined by the '.' character. E.g., 2.0.0.
+      def to_s
+        @to_s ||= [@major, @minor, @tiny, @pre].compact.join(".")
+      end
+
+      # Converts this version to a canonical integer that may be compared
+      # against other version objects.
+      def to_i
+        @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+      end
 
-    # The major component of this version of the Net::SSH library
-    MAJOR = 2
+      # The major component of this version of the Net::SSH library
+      MAJOR = 7
 
-    # The minor component of this version of the Net::SSH library
-    MINOR = 7
+      # The minor component of this version of the Net::SSH library
+      MINOR = 3
 
-    # The tiny component of this version of the Net::SSH library
-    TINY  = 0
+      # The tiny component of this version of the Net::SSH library
+      TINY  = 0
 
-    # The current version of the Net::SSH library as a Version instance
-    CURRENT = new(MAJOR, MINOR, TINY)
+      # The prerelease component of this version of the Net::SSH library
+      # nil allowed
+      PRE   = nil
 
-    # The current version of the Net::SSH library as a String
-    STRING = CURRENT.to_s
+      # The current version of the Net::SSH library as a Version instance
+      CURRENT = new(*[MAJOR, MINOR, TINY, PRE].compact)
+
+      # The current version of the Net::SSH library as a String
+      STRING = CURRENT.to_s
+    end
   end
-end; end
+end