net-ssh 2.1.4 → 2.2.0

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
 
+=== 2.2.0 / 16 Aug 2011
+
+* Add support for forward a local UNIX domain socket to a remote TCP socket. [Mark Imbriaco]
+
 === 2.1.4 / 3 Apr 2011
 
 * Add ConnectionTimeout exception class. [Joel Watson]

data/Rakefile

@@ -7,7 +7,7 @@ include FileUtils
 begin
   require 'hanna/rdoctask'
 rescue LoadError
-  require 'rake/rdoctask'
+  require 'rdoc/task'
 end
 
 

data/lib/net/ssh.rb

@@ -61,10 +61,10 @@ module Net
     # This is the set of options that Net::SSH.start recognizes. See
     # Net::SSH.start for a description of each option.
     VALID_OPTIONS = [
-      :auth_methods, :compression, :compression_level, :config, :encryption,
-      :forward_agent, :hmac, :host_key, :kex, :keys, :key_data, :languages,
-      :logger, :paranoid, :password, :port, :proxy, :rekey_blocks_limit,
-      :rekey_limit, :rekey_packet_limit, :timeout, :verbose,
+      :auth_methods, :bind_address, :compression, :compression_level, :config, 
+      :encryption, :forward_agent, :hmac, :host_key, :kex, :keys, :key_data, 
+      :languages, :logger, :paranoid, :password, :port, :proxy, 
+      :rekey_blocks_limit,:rekey_limit, :rekey_packet_limit, :timeout, :verbose,
       :global_known_hosts_file, :user_known_hosts_file, :host_key_alias,
       :host_name, :user, :properties, :passphrase, :keys_only
     ]
@@ -98,6 +98,9 @@ module Net
     # This method accepts the following options (all are optional):
     #
     # * :auth_methods => an array of authentication methods to try
+    # * :bind_address => the IP address on the connecting machine to use in
+    #   establishing connection. (:bind_address is discarded if :proxy
+    #   is set.)
     # * :compression => the compression algorithm to use, or +true+ to use
     #   whatever is supported.
     # * :compression_level => the compression level to use when sending data

data/lib/net/ssh/config.rb

@@ -119,6 +119,8 @@ module Net; module SSH
       def translate(settings)
         settings.inject({}) do |hash, (key, value)|
           case key
+          when 'bindaddress' then
+            hash[:bind_address] = value
           when 'ciphers' then
             hash[:encryption] = value.split(/,/)
           when 'compression' then

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

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'net/ssh/loggable'
 
 module Net; module SSH; module Service
@@ -53,22 +54,31 @@ module Net; module SSH; module Service
         raise ArgumentError, "expected 3 or 4 parameters, got #{args.length}"
       end
 
-      bind_address = "127.0.0.1"
-      bind_address = args.shift if args.first.is_a?(String) && args.first =~ /\D/
+      local_port_type = :long
+
+      socket = begin
+        if args.first.class == UNIXServer
+          local_port_type = :string
+          args.shift
+        else
+          bind_address = "127.0.0.1"
+          bind_address = args.shift if args.first.is_a?(String) && args.first =~ /\D/
+          local_port = args.shift.to_i
+          local_port_type = :long
+          TCPServer.new(bind_address, local_port)
+        end
+      end
 
-      local_port = args.shift.to_i
       remote_host = args.shift
       remote_port = args.shift.to_i
 
-      socket = TCPServer.new(bind_address, local_port)
-
       @local_forwarded_ports[[local_port, bind_address]] = socket
 
       session.listen_to(socket) do |server|
         client = server.accept
-        debug { "received connection on #{bind_address}:#{local_port}" }
+        debug { "received connection on #{socket}" }
 
-        channel = session.open_channel("direct-tcpip", :string, remote_host, :long, remote_port, :string, bind_address, :long, local_port) do |achannel|
+        channel = session.open_channel("direct-tcpip", :string, remote_host, :long, remote_port, :string, bind_address, local_port_type, local_port) do |achannel|
           achannel.info { "direct channel established" }
         end
 
@@ -285,4 +295,4 @@ module Net; module SSH; module Service
       end
   end
 
-end; end; end
+end; end; end

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

@@ -58,11 +58,12 @@ module Net; module SSH; module Transport
 
       @host = host
       @port = options[:port] || DEFAULT_PORT
+      @bind_address = options[:bind_address] || nil
       @options = options
 
       debug { "establishing connection to #{@host}:#{@port}" }
       factory = options[:proxy] || TCPSocket
-      @socket = timeout(options[:timeout] || 0) { factory.open(@host, @port) }
+      @socket = timeout(options[:timeout] || 0) { @bind_address.nil? || options[:proxy] ? factory.open(@host, @port) : factory.open(@host,@port,@bind_address) }
       @socket.extend(PacketStream)
       @socket.logger = @logger
 

data/lib/net/ssh/version.rb

@@ -48,10 +48,10 @@ module Net; module SSH
     MAJOR = 2
 
     # The minor component of this version of the Net::SSH library
-    MINOR = 1
+    MINOR = 2
 
     # The tiny component of this version of the Net::SSH library
-    TINY  = 4
+    TINY  = 0
 
     # 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.1.4"
+	s.version = "2.2.0"
 	s.summary = "Net::SSH: a pure-Ruby implementation of the SSH2 client protocol."
 	s.description = s.summary
 	s.authors = ["Jamis Buck", "Delano Mandelbaum"]

data/test/manual/test_forward.rb

@@ -18,6 +18,7 @@ require 'common'
 require 'net/ssh/buffer'
 require 'net/ssh'
 require 'timeout'
+require 'tempfile'
 
 class TestForward < Test::Unit::TestCase
   
@@ -120,7 +121,44 @@ class TestForward < Test::Unit::TestCase
     session.loop(0.1) { client_done.empty? }
     assert_equal "Broken pipe", "#{server_exc.pop}" unless server_exc.empty?
   end
+
+  def create_local_socket(&blk)
+    tempfile = Tempfile.new("net_ssh_forward_test")
+    path = tempfile.path
+    tempfile.delete
+    yield UNIXServer.open(path)
+    File.delete(path)
+  end
   
+  def test_forward_local_unix_socket_to_remote_port
+    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]
+    client_data = nil
+
+    create_local_socket do |local_socket|
+      session.forward.local(local_socket, localhost, remote_port)
+      client_done = Queue.new
+
+      Thread.start do
+        begin
+          client = UNIXSocket.new(local_socket.path)
+          client_data = client.recv(1024)
+          client.close
+          sleep(0.2)
+        ensure
+          client_done << true
+        end
+      end
+
+      session.loop(0.1) { client_done.empty? }
+    end
+
+    assert_not_nil(client_data, "client should have received data")
+    assert(client_data.match(/item\d/), 'client should have received the string item')
+  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
@@ -182,4 +220,4 @@ class TestForward < Test::Unit::TestCase
       assert_equal "This is a small message!", client_done.pop
     end
   end
-end
+end

data/test/test_config.rb

@@ -67,6 +67,7 @@ class TestConfig < Test::Unit::TestCase
 
   def test_translate_should_correctly_translate_from_openssh_to_net_ssh_names
     open_ssh = {
+      'bindaddress'             => "127.0.0.1",
       'ciphers'                 => "a,b,c",
       'compression'             => true,
       'compressionlevel'        => 6,
@@ -95,6 +96,7 @@ class TestConfig < Test::Unit::TestCase
     assert_equal %w(j k l), net_ssh[:hmac]
     assert_equal 1234,      net_ssh[:port]
     assert_equal 1024,      net_ssh[:rekey_limit]
+    assert_equal "127.0.0.1", net_ssh[:bind_address]
   end
   
   def test_load_with_plus_sign_hosts
@@ -114,4 +116,4 @@ class TestConfig < Test::Unit::TestCase
     def config(name)
       "test/configs/#{name}"
     end
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: net-ssh
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors: 
 - Jamis Buck
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-03 00:00:00 -04:00
+date: 2011-08-17 00:00:00 -04:00
 default_executable: 
 dependencies: []