net-ssh 2.0.20 → 2.0.21

data/CHANGELOG.rdoc

@@ -1,4 +1,18 @@
 
+
+=== 2.0.21 / 20 Mar 2010
+
+* Fix for "IdentifyFile" in ~/.ssh/config does not work if no "Host" statement is given (http://net-ssh.lighthouseapp.com/projects/36253/tickets/9-identifyfile-in-sshconfig-does-not-work-if-no-host-statement-is-given#ticket-9-5) [xbaldauf, Delano Mandelbaum]
+
+* Fix for client closes a forwarded connection, but the server is reading, net-ssh terminates with IOError socket closed (http://net-ssh.lighthouseapp.com/projects/36253/tickets/7) [Miklós Fazekas]
+
+* Fix for client force closes (RST) a forwarded connection, but server is reading, net-ssh terminates with exception [Miklós Fazekas]
+
+* Fix for server closes the sending side, the on_eof is not handled. [Miklós Fazekas]
+
+* Removed Hanna dependency in Rakefile [Delano Mandelbaum]
+
+
 === 2.0.20 / 10 Feb 2010
 
 * Support "ProxyCommand none" directive [Andy Lo-A-Foe]
@@ -20,7 +34,9 @@
 === 2.0.16 / 28 Nov 2009
 
 * Fix for "multiple hosts are separated by whitespace" [Akinori MUSHA]
+
 * Add support for the ProxyCommand directive [Akinori MUSHA]
+
 * Switched from #recv(1) to #readpartial in lib/net/ssh/transport/server_version.rb, so that closed sockets are recognized [Alex Peuchert]
 
 

data/Rakefile

@@ -1,10 +1,16 @@
 require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
-require 'hanna/rdoctask'
 require 'fileutils'
 include FileUtils
- 
+
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+
 task :default => :package
  
 # CONFIG =============================================================

data/lib/net/ssh/buffered_io.rb

@@ -147,4 +147,52 @@ module Net; module SSH
       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

data/lib/net/ssh/config.rb

@@ -55,12 +55,14 @@ module Net; module SSH
       # ones. Returns a hash containing the OpenSSH options. (See
       # #translate for how to convert the OpenSSH options into Net::SSH
       # options.)
-      def load(file, host, settings={})
-        file = File.expand_path(file)
+      def load(path, host, settings={})
+        file = File.expand_path(path)
         return settings unless File.readable?(file)
         
+        globals = {}
         matched_host = nil
         multi_host = []
+        seen_host = false
         IO.foreach(file) do |line|
           next if line =~ /^\s*(?:#.*)?$/
           
@@ -75,29 +77,37 @@ module Net; module SSH
 
           key.downcase!
           value = $1 if value =~ /^"(.*)"$/
-
+          
           value = case value.strip
             when /^\d+$/ then value.to_i
             when /^no$/i then false
             when /^yes$/i then true
             else value
             end
-
+          
           if key == 'host'
             # Support "Host host1 host2 hostN".
             # See http://github.com/net-ssh/net-ssh/issues#issue/6
             multi_host = value.split(/\s+/)
             matched_host = multi_host.select { |h| host =~ pattern2regex(h) }.first
+            seen_host = true
+          elsif !seen_host
+            if key == 'identityfile'
+              (globals[key] ||= []) << value
+            else
+              globals[key] = value unless settings.key?(key)
+            end
           elsif !matched_host.nil?
             if key == 'identityfile'
-              settings[key] ||= []
-              settings[key] << value
+              (settings[key] ||= []) << value
             else
               settings[key] = value unless settings.key?(key)
             end
           end
         end
         
+        settings = globals.merge(settings) if globals
+        
         return settings
       end
 

data/lib/net/ssh/service/forward.rb

@@ -193,21 +193,42 @@ module Net; module SSH; module Service
     end
 
     private
-
+      
       # Perform setup operations that are common to all forwarded channels.
       # +client+ is a socket, +channel+ is the channel that was just created,
       # and +type+ is an arbitrary string describing the type of the channel.
       def prepare_client(client, channel, type)
         client.extend(Net::SSH::BufferedIo)
+        client.extend(Net::SSH::ForwardedBufferedIo)
         client.logger = logger
 
         session.listen_to(client)
         channel[:socket] = client
 
-        channel.on_data do |ch, data|
+        channel.on_data do |ch, data|  
+          debug { "data:#{data.length} on #{type} forwarded channel" }
           ch[:socket].enqueue(data)
         end
-
+        
+        # Handles server close on the sending side by Miklós Fazekas
+        channel.on_eof do |ch|
+          debug { "eof #{type} on #{type} forwarded channel" }
+          begin
+            ch[:socket].send_pending
+            ch[:socket].shutdown Socket::SHUT_WR
+          rescue IOError => e
+            if e.message =~ /closed/ then
+              debug { "epipe in on_eof => shallowing exception:#{e}" }
+            else
+              raise
+            end
+          rescue Errno::EPIPE => e
+            debug { "epipe in on_eof => shallowing exception:#{e}" }
+          rescue Errno::ENOTCONN => e
+            debug { "enotconn in on_eof => shallowing exception:#{e}" }
+          end
+        end
+        
         channel.on_close do |ch|
           debug { "closing #{type} forwarded channel" }
           ch[:socket].close if !client.closed?

data/lib/net/ssh/version.rb

@@ -51,7 +51,7 @@ module Net; module SSH
     MINOR = 0
 
     # The tiny component of this version of the Net::SSH library
-    TINY  = 20
+    TINY  = 21
 
     # The current version of the Net::SSH library as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/net-ssh.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "net-ssh"
         s.rubyforge_project = 'net-ssh'
-	s.version = "2.0.20"
+	s.version = "2.0.21"
 	s.summary = "Net::SSH: a pure-Ruby implementation of the SSH2 client protocol."
 	s.description = s.summary
 	s.authors = ["Jamis Buck", "Delano Mandelbaum"]
@@ -91,6 +91,7 @@
   setup.rb
   support/arcfour_check.rb
   support/ssh_tunnel_bug.rb
+  test/README.txt
   test/authentication/methods/common.rb
   test/authentication/methods/test_abstract.rb
   test/authentication/methods/test_hostbased.rb
@@ -105,9 +106,11 @@
   test/configs/exact_match
   test/configs/host_plus
   test/configs/multihost
+  test/configs/nohost
   test/configs/wild_cards
   test/connection/test_channel.rb
   test/connection/test_session.rb
+  test/manual/test_forward.rb
   test/test_all.rb
   test/test_buffer.rb
   test/test_buffered_io.rb

data/test/README.txt

@@ -0,0 +1,42 @@
+2010-03-16 
+
+RUNNING TESTS
+
+Run the test suite from the net-ssh directory with the following command:
+
+     ruby -Ilib -Itest -rrubygems test/test_all.rb
+     
+Run a single test file like this:
+
+     ruby -Ilib -Itest -rrubygems test/transport/test_server_version.rb
+
+
+EXPECTED RESULTS
+
+* Ruby 1.8: all tests pass
+
+* Ruby 1.9: all tests pass
+
+* JRuby 1.4: 96% tests pass (242 tests, 554 assertions, 0 failures, 8 errors)
+
+
+PORT FORWARDING TESTS
+
+     ruby -Ilib -Itest -rrubygems test/manual/test_forward.rb
+
+test_forward.rb must be run separately from the test suite because
+it requires authorizing your public SSH keys on you localhost. 
+
+If you already have keys you can do this:
+
+     cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
+
+If you don't have keys see:
+     
+     http://kimmo.suominen.com/docs/ssh/#ssh-keygen
+         
+You should now be able to login to your localhost with out 
+bring prompted for a password:
+
+     ssh localhost
+     

data/test/configs/nohost

@@ -0,0 +1,19 @@
+
+IdentityFile ~/.ssh/id_dsa
+IdentityFile ~/.ssh/id_rsa
+Port 1980
+
+Host test.host
+  Port 1985
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    

data/test/manual/test_forward.rb

@@ -0,0 +1,185 @@
+#     $ ruby -Ilib -Itest -rrubygems test/test_forward.rb
+
+# Tests for the following patch:
+#
+#   http://github.com/net-ssh/net-ssh/tree/portfwfix
+# 
+# It fixes 3 issues, regarding closing forwarded ports:
+# 
+# 1.) if client closes a forwarded connection, but the server is reading, net-ssh terminates with IOError socket closed.
+# 2.) if client force closes (RST) a forwarded connection, but server is reading, net-ssh terminates with
+# 3.) if server closes the sending side, the on_eof is not handled.
+# 
+# More info:
+# 
+# http://net-ssh.lighthouseapp.com/projects/36253/tickets/7
+
+require 'common'
+require 'net/ssh/buffer'
+require 'net/ssh'
+require 'timeout'
+
+class TestForward < Test::Unit::TestCase
+  
+  def localhost
+    'localhost'
+  end
+  
+  def ssh_start_params
+    [localhost ,ENV['USER']] #:verbose => :debug
+  end
+  
+  def find_free_port 
+    server = TCPServer.open(0)
+    server.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR,true)
+    port = server.addr[1]
+    server.close
+    port
+  end
+  
+  def start_server_sending_lot_of_data(exceptions)
+    server = TCPServer.open(0)
+    Thread.start do
+      loop do
+        Thread.start(server.accept) do |client|
+          begin
+            10000.times do |i| 
+              client.puts "item#{i}"
+            end
+            client.close
+          rescue 
+            exceptions << $!
+            raise
+          end
+        end
+      end
+    end
+    return server
+  end
+  
+  def start_server_closing_soon(exceptions=nil)
+    server = TCPServer.open(0)
+    Thread.start do
+      loop do
+        Thread.start(server.accept) do |client|
+          begin
+            client.recv(1024) 
+            client.setsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER, [1, 0].pack("ii"))
+            client.close
+          rescue
+            exceptions <<  $!
+            raise
+          end
+        end
+      end
+    end
+    return server
+  end
+  
+  def test_loop_should_not_abort_when_local_side_of_forward_is_closed
+    session = Net::SSH.start(*ssh_start_params) 
+    server_exc = Queue.new
+    server = start_server_sending_lot_of_data(server_exc)
+    remote_port = server.addr[1]
+    local_port = find_free_port
+    session.forward.local(local_port, localhost, remote_port)
+    client_done = Queue.new
+    Thread.start do
+      begin
+        client = TCPSocket.new(localhost, local_port)
+        client.recv(1024)
+        client.close
+        sleep(0.2)
+      ensure
+        client_done << true
+      end
+    end
+    session.loop(0.1) { client_done.empty? }
+    assert_equal "Broken pipe", "#{server_exc.pop}" unless server_exc.empty?
+  end
+  
+  def test_loop_should_not_abort_when_local_side_of_forward_is_reset
+    session = Net::SSH.start(*ssh_start_params)
+    server_exc = Queue.new    
+    server = start_server_sending_lot_of_data(server_exc)
+    remote_port = server.addr[1]
+    local_port = find_free_port
+    session.forward.local(local_port, localhost, remote_port)
+    client_done = Queue.new
+    Thread.start do
+      begin
+        client = TCPSocket.new(localhost, local_port)
+        client.recv(1024)
+        client.setsockopt(Socket::SOL_SOCKET, Socket::SO_LINGER, [1, 0].pack("ii"))
+        client.close
+        sleep(0.1)
+      ensure
+        client_done << true
+      end
+    end
+    session.loop(0.1) { client_done.empty? }
+    assert_equal "Broken pipe", "#{server_exc.pop}" unless server_exc.empty?
+  end
+  
+  def test_loop_should_not_abort_when_server_side_of_forward_is_closed
+    session = Net::SSH.start(*ssh_start_params)    
+    server = start_server_closing_soon
+    remote_port = server.addr[1]
+    local_port = find_free_port
+    session.forward.local(local_port, localhost, remote_port)
+    client_done = Queue.new
+    Thread.start do
+      begin
+        client = TCPSocket.new(localhost, local_port)
+        1.times do |i| 
+          client.puts "item#{i}"
+        end
+        client.close
+        sleep(0.1)
+      ensure                 
+        client_done << true
+      end
+    end
+    session.loop(0.1) { client_done.empty? }
+  end
+  
+  def start_server
+    server = TCPServer.open(0)
+    Thread.start do
+      loop do
+        Thread.start(server.accept) do |client|
+          yield(client)
+        end
+      end
+    end
+    return server
+  end
+  
+  def test_server_eof_should_be_handled
+    session = Net::SSH.start(*ssh_start_params)    
+    server = start_server do |client|
+      client.write "This is a small message!"
+      client.close
+    end
+    client_done = Queue.new
+    client_exception = Queue.new
+    client_data = Queue.new
+    remote_port = server.addr[1]
+    local_port = find_free_port
+    session.forward.local(local_port, localhost, remote_port)
+    Thread.start do
+      begin
+        client = TCPSocket.new(localhost, local_port)
+        data = client.read(4096)
+        client.close
+        client_done << data
+      rescue
+        client_done << $!
+      end
+    end
+    timeout(5) do
+      session.loop(0.1) { client_done.empty? }
+      assert_equal "This is a small message!", client_done.pop
+    end
+  end
+end

data/test/test_all.rb

@@ -2,6 +2,7 @@
 #     $ ruby -Ilib -Itest -rrubygems test/transport/test_server_version.rb
 Dir.chdir(File.dirname(__FILE__)) do
   test_files = Dir['**/test_*.rb']
+  test_files = test_files.reject { |f| f =~ /^manual/ }
   test_files = test_files.select { |f| f =~ Regexp.new(ENV['ONLY']) } if ENV['ONLY']
   test_files = test_files.reject { |f| f =~ Regexp.new(ENV['EXCEPT']) } if ENV['EXCEPT']
   test_files.each { |file| require(file) }

data/test/test_config.rb

@@ -38,6 +38,12 @@ class TestConfig < Test::Unit::TestCase
     assert !config.key?(:rekey_limit)
   end
   
+  def test_load_with_no_host
+    config = Net::SSH::Config.load(config(:nohost), "test.host")
+    assert_equal %w(~/.ssh/id_dsa ~/.ssh/id_rsa), config['identityfile']
+    assert_equal 1985, config['port']
+  end
+  
   def test_load_with_multiple_hosts
     config = Net::SSH::Config.load(config(:multihost), "test.host")
     assert config['compression']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: net-ssh
 version: !ruby/object:Gem::Version 
-  version: 2.0.20
+  version: 2.0.21
 platform: ruby
 authors: 
 - Jamis Buck
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-10 00:00:00 -05:00
+date: 2010-03-20 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -99,6 +99,7 @@ files:
 - setup.rb
 - support/arcfour_check.rb
 - support/ssh_tunnel_bug.rb
+- test/README.txt
 - test/authentication/methods/common.rb
 - test/authentication/methods/test_abstract.rb
 - test/authentication/methods/test_hostbased.rb
@@ -113,9 +114,11 @@ files:
 - test/configs/exact_match
 - test/configs/host_plus
 - test/configs/multihost
+- test/configs/nohost
 - test/configs/wild_cards
 - test/connection/test_channel.rb
 - test/connection/test_session.rb
+- test/manual/test_forward.rb
 - test/test_all.rb
 - test/test_buffer.rb
 - test/test_buffered_io.rb