net-ssh 3.0.2 → 3.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2590e090bc772588e579dbd10b4cdcb1b2915f8f
-  data.tar.gz: 942b5077890efb1b2c4df16cb78421f982ad5280
+  metadata.gz: 8014163f04248cb8c0d06a2b0f9eb99650c4ca1f
+  data.tar.gz: 4a3a4ffd2cc73052808781409b6be9bdf7a336a8
 SHA512:
-  metadata.gz: 2dcdca345ab73be73cc497f5a329f728c9829c60ed6ff8ef8ac6e44bbd53d114e5e271c166babccebe5ec20a7da2ec493cfaa48e0a05c61bccad44ab3e416296
-  data.tar.gz: bca132211cc2eebca0f2f760b18ef51d1215b23b8d43f53a248c8aa27b3256eab5c2fa7a5893de2196a9d5a87ac840c732d04f679b745d4cf6971afffb859ea9
+  metadata.gz: e70e296ef1844a744fcbb69304203e8e758f5eaf2e5ab89ec3a4352c6fefd12a59395800aecf3efc4ba34b3dfed3ae6f0a729542da1c48173b88c5b0b4d15884
+  data.tar.gz: 4c10b1d730425a42f606fc0119080894de291d6d7949854246b71bfe1a62d7056d59edce2e789ca7ef8355e4c6d2ff1c2a0158089f4213d8b8516e08f2dc4c23

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
   - jruby-head
   - jruby-19mode
   - rbx-2

data/CHANGES.txt

@@ -1,3 +1,12 @@
+=== 3.1.0.beta1
+
+* trying to execute something on a not yet opend channel throws nicer messag [Miklos Fazekas]
+* calling close on a not opened channel marks the channel for close [Miklos Fazekas]
+* read keepalive configuration from ssh config files [Miklos Fazekas]
+* send client version on hadshake before waiting for server to reduce handshake time [Miklos Fazekas]
+* allow custom Net::SSH::KnownHosts implementations [Jean Boussier]
+* memoize known host so we only search it once per session [Jean Boussier, Miklos Fazekas]
+
 === 3.0.2
 === 3.0.2.rc1
 

data/lib/net/ssh.rb

@@ -66,7 +66,7 @@ module Net
       :keepalive, :keepalive_interval, :keepalive_maxcount, :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,
+      :known_hosts, :global_known_hosts_file, :user_known_hosts_file, :host_key_alias,
       :host_name, :user, :properties, :passphrase, :keys_only, :max_pkt_size,
       :max_win_size, :send_env, :use_agent, :number_of_password_prompts,
       :append_supported_algorithms, :non_interactive
@@ -114,6 +114,8 @@ module Net
     # * :encryption => the encryption cipher (or ciphers) to use
     # * :forward_agent => set to true if you want the SSH agent connection to
     #   be forwarded
+    # * :known_hosts => a custom object holding known hosts records.
+    #   It must implement #search_for and add in a similiar manner as KnownHosts.
     # * :global_known_hosts_file => the location of the global known hosts
     #   file. Set to an array if you want to specify multiple global known
     #   hosts files. Defaults to %w(/etc/ssh/ssh_known_hosts /etc/ssh/ssh_known_hosts2).
@@ -132,6 +134,7 @@ module Net
     # * :keepalive_interval => the interval seconds for keepalive.
     #   Defaults to +300+ seconds.
     # * :keepalive_maxcount => the maximun number of keepalive packet miss allowed.
+    #   Defaults to 3
     # * :kex => the key exchange algorithm (or algorithms) to use
     # * :keys => an array of file names of private keys to use for publickey
     #   and hostbased authentication

data/lib/net/ssh/authentication/pageant.rb

@@ -12,8 +12,8 @@ else
 
   # For now map DL to Fiddler versus updating all the code below
   module DL
-    CPtr = Fiddle::Pointer
-    RUBY_FREE = Fiddle::RUBY_FREE
+    CPtr ||= Fiddle::Pointer
+    RUBY_FREE ||= Fiddle::RUBY_FREE
   end
 end
 

data/lib/net/ssh/config.rb

@@ -178,6 +178,15 @@ module Net; module SSH
             hash[:keys] = value
           when 'macs' then
             hash[:hmac] = value.split(/,/)
+          when 'serveralivecountmax'
+            hash[:keepalive_maxcount] = value.to_i if value
+          when 'serveraliveinterval'
+            if value && value.to_i > 0
+              hash[:keepalive] = true
+              hash[:keepalive_interval] = value.to_i
+            else
+              hash[:keepalive] = false
+            end
           when 'passwordauthentication'
             if value
               (hash[:auth_methods] << 'password').uniq!

data/lib/net/ssh/connection/channel.rb

@@ -291,15 +291,11 @@ module Net; module SSH; module Connection
       @remote_closed = true
     end
 
-    # Requests that the channel be closed. If the channel is already closing,
-    # this does nothing, nor does it do anything if the channel has not yet
-    # been confirmed open (see #do_open_confirmation). Otherwise, it sends a
-    # CHANNEL_CLOSE message and marks the channel as closing.
+    # Requests that the channel be closed. It only marks the channel to be closed
+    # the CHANNEL_CLOSE message will be sent from event loop
     def close
       return if @closing
-      if remote_id
-        @closing = true
-      end
+      @closing = true
     end
 
     # Returns true if the local end of the channel has declared that no more
@@ -486,6 +482,7 @@ module Net; module SSH; module Connection
     # convenient helper methods (see #exec and #subsystem).
     def send_channel_request(request_name, *data, &callback)
       info { "sending channel request #{request_name.inspect}" }
+      fail "Channel open not yet confirmed, please call send_channel_request(or exec) from block of open_channel" unless remote_id
       msg = Buffer.from(:byte, CHANNEL_REQUEST,
         :long, remote_id, :string, request_name,
         :bool, !callback.nil?, *data)
@@ -632,6 +629,12 @@ module Net; module SSH; module Connection
 
     private
 
+      # Runs the SSH event loop until the remote confirmed channel open
+      # experimental api
+      def wait_until_open_confirmed
+        connection.loop { !remote_id }
+      end
+
       # Updates the local window size by the given amount. If the window
       # size drops to less than half of the local maximum (an arbitrary
       # threshold), a CHANNEL_WINDOW_ADJUST message will be sent to the

data/lib/net/ssh/known_hosts.rb

@@ -5,6 +5,31 @@ require 'net/ssh/buffer'
 
 module Net; module SSH
 
+  class HostKeys
+    include Enumerable
+    attr_reader :host
+
+    def initialize(host_keys, host, known_hosts, options = {})
+       @host_keys = host_keys
+       @host = host
+       @known_hosts = known_hosts
+       @options = options
+    end
+
+    def add_host_key(key)
+       @known_hosts.add(@host, key, options)
+       push(key)
+    end
+
+    def each(&block)
+       @host_keys.each(&block)
+    end
+
+    def empty?
+      @host_keys.empty?
+    end
+  end
+
   # Searches an OpenSSH-style known-host file for a given host, and returns all
   # matching keys. This is used to implement host-key verification, as well as
   # to determine what key a user prefers to use for a given host.
@@ -28,7 +53,7 @@ module Net; module SSH
       # Searches all known host files (see KnownHosts.hostfiles) for all keys
       # of the given host. Returns an array of keys found.
       def search_for(host, options={})
-        search_in(hostfiles(options), host)
+        HostKeys.new(search_in(hostfiles(options), host), host, self, options)
       end
 
       # Search for all known keys for the given host, in every file given in

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

@@ -242,7 +242,7 @@ module Net; module SSH; module Transport
           # make sure the host keys are specified in preference order, where any
           # existing known key for the host has preference.
 
-          existing_keys = KnownHosts.search_for(options[:host_key_alias] || session.host_as_string, options)
+          existing_keys = session.host_keys
           host_keys = existing_keys.map { |key| key.ssh_type }.uniq
           algorithms[:host_key].each do |name|
             host_keys << name unless host_keys.include?(name)

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

@@ -40,6 +40,10 @@ module Net; module SSH; module Transport
       def negotiate!(socket, timeout)
         info { "negotiating protocol version" }
 
+        debug { "local is `#{PROTO_VERSION}'" }
+        socket.write "#{PROTO_VERSION}\r\n"
+        socket.flush
+
         if timeout && !IO.select([socket], nil, nil, timeout)
           raise Net::SSH::ConnectionTimeout, "timeout during server version negotiating"
         end
@@ -69,9 +73,6 @@ module Net; module SSH; module Transport
         if timeout && !IO.select(nil, [socket], nil, timeout)
           raise Net::SSH::ConnectionTimeout, "timeout during client version negotiating"
         end
-        debug { "local is `#{PROTO_VERSION}'" }
-        socket.write "#{PROTO_VERSION}\r\n"
-        socket.flush
       end
   end
 end; end; end

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

@@ -89,6 +89,13 @@ module Net; module SSH; module Transport
       raise Net::SSH::ConnectionTimeout
     end
 
+    def host_keys
+      @host_keys ||= begin
+        known_hosts = options.fetch(:known_hosts, KnownHosts)
+        known_hosts.search_for(options[:host_key_alias] || host_as_string, options)
+      end
+    end
+
     # Returns the host (and possibly IP address) in a format compatible with
     # SSH known-host files.
     def host_as_string

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

@@ -13,18 +13,16 @@ module Net; module SSH; module Verifiers
   # Otherwise, this returns true.
   class Secure
     def verify(arguments)
-      options = arguments[:session].options
-      host = options[:host_key_alias] || arguments[:session].host_as_string
-      matches = Net::SSH::KnownHosts.search_for(host, arguments[:session].options)
+      host_keys = arguments[:session].host_keys
 
       # We've never seen this host before, so raise an exception.
-      if matches.empty?
-        process_cache_miss(host, arguments, HostKeyUnknown, "is unknown")
+      if host_keys.empty?
+        process_cache_miss(host_keys, arguments, HostKeyUnknown, "is unknown")
       end
 
       # If we found any matches, check to see that the key type and
       # blob also match.
-      found = matches.any? do |key|
+      found = host_keys.any? do |key|
         key.ssh_type == arguments[:key].ssh_type &&
         key.to_blob  == arguments[:key].to_blob
       end
@@ -32,7 +30,7 @@ module Net; module SSH; module Verifiers
       # If a match was found, return true. Otherwise, raise an exception
       # indicating that the key was not recognized.
       unless found
-        process_cache_miss(host, arguments, HostKeyMismatch, "does not match")
+        process_cache_miss(host_keys, HostKeyMismatch, "does not match")
       end
 
       found
@@ -40,12 +38,12 @@ module Net; module SSH; module Verifiers
 
     private
 
-    def process_cache_miss(host, args, exc_class, message)
+    def process_cache_miss(host_keys, args, exc_class, message)
       exception = exc_class.new("fingerprint #{args[:fingerprint]} " +
-                                "#{message} for #{host.inspect}")
+                                "#{message} for #{host_keys.host.inspect}")
       exception.data = args
       exception.callback = Proc.new do
-        Net::SSH::KnownHosts.add(host, args[:key], args[:session].options)
+        host_keys.add_host_key(args[:key])
       end
       raise exception
     end

data/lib/net/ssh/version.rb

@@ -48,14 +48,14 @@ module Net; module SSH
     MAJOR = 3
 
     # The minor component of this version of the Net::SSH library
-    MINOR = 0
+    MINOR = 1
 
     # The tiny component of this version of the Net::SSH library
-    TINY  = 2
+    TINY  = 0
 
     # The prerelease component of this version of the Net::SSH library 
     # nil allowed
-    PRE   = nil
+    PRE   = "beta2"
 
     # The current version of the Net::SSH library as a Version instance
     CURRENT = new(*[MAJOR, MINOR, TINY, PRE].compact)

data/net-ssh.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: net-ssh 3.0.2 ruby lib
+# stub: net-ssh 3.1.0.beta2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "net-ssh"
-  s.version = "3.0.2"
+  s.version = "3.1.0.beta2"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jamis Buck", "Delano Mandelbaum", "Mikl\u{f3}s Fazekas"]
   s.cert_chain = ["net-ssh-public_cert.pem"]
-  s.date = "2015-12-30"
+  s.date = "2016-03-05"
   s.description = "Net::SSH: a pure-Ruby implementation of the SSH2 client protocol. It allows you to write programs that invoke and interact with processes on remote servers, via SSH2."
   s.email = "net-ssh@solutious.com"
   s.extra_rdoc_files = [

data/test/common.rb

@@ -41,6 +41,7 @@ class MockTransport < Net::SSH::Transport::Session
   attr_accessor :mock_enqueue
 
   def initialize(options={})
+    @options = options
     self.logger = options[:logger]
     self.host_as_string = "net.ssh.test,127.0.0.1"
     self.server_version = OpenStruct.new(:version => "SSH-2.0-Ruby/Net::SSH::Test")

data/test/connection/test_channel.rb

@@ -63,10 +63,10 @@ module Connection
       assert_equal "helloworld", channel.output.to_s
     end
 
-    def test_close_before_channel_has_been_confirmed_should_do_nothing
+    def test_close_before_channel_has_been_confirmed_should_set_closing
       assert !channel.closing?
       channel.close
-      assert !channel.closing?
+      assert channel.closing?
     end
 
     def test_close_should_set_closing_and_send_message
@@ -261,6 +261,18 @@ module Connection
       assert channel.pending_requests.empty?
     end
 
+    def test_send_channel_request_should_wait_for_remote_id
+      channel.expects(:remote_id).times(1).returns(nil)
+      msg = nil
+      begin
+        channel.send_channel_request("exec", :string, "ls")
+      rescue RuntimeError => e
+        msg = e.message
+      end
+      assert_equal "Channel open not yet confirmed, please call send_channel_request(or exec) from block of open_channel", msg
+      assert channel.pending_requests.empty?
+    end
+
     def test_send_channel_request_with_callback_should_want_reply
       channel.do_open_confirmation(0, 100, 100)
       connection.expect do |t,p|
@@ -377,6 +389,11 @@ module Connection
       channel.wait
     end
 
+    def test_wait_until_open_confirmed_should_block_while_remote_id_nil
+      channel.expects(:remote_id).times(3).returns(nil,nil,3)
+      channel.send(:wait_until_open_confirmed)
+    end
+
     def test_eof_bang_should_send_eof_to_server
       channel.do_open_confirmation(0, 1000, 1000)
       connection.expect { |t,p| assert_equal CHANNEL_EOF, p.type }

data/test/test_config.rb

@@ -94,7 +94,9 @@ class TestConfig < Test::Unit::TestCase
       'pubkeyauthentication'    => true,
       'rekeylimit'              => 1024,
       'sendenv'                 => "LC_*",
-      'numberofpasswordprompts' => '123'
+      'numberofpasswordprompts' => '123',
+      'serveraliveinterval'     => '2',
+      'serveralivecountmax'     => '4'
     }
 
     net_ssh = Net::SSH::Config.translate(open_ssh)
@@ -113,6 +115,9 @@ class TestConfig < Test::Unit::TestCase
     assert_equal "127.0.0.1", net_ssh[:bind_address]
     assert_equal [/^LC_.*$/], net_ssh[:send_env]
     assert_equal 123,       net_ssh[:number_of_password_prompts]
+    assert_equal 4,         net_ssh[:keepalive_maxcount]
+    assert_equal 2,         net_ssh[:keepalive_interval]
+    assert_equal true,         net_ssh[:keepalive]
   end
 
   def test_translate_should_turn_off_authentication_methods

data/test/transport/test_packet_stream.rb

@@ -109,7 +109,7 @@ module Transport
     def test_next_packet_should_not_block_by_default
       IO.expects(:select).returns(nil)
       assert_nothing_raised do
-        timeout(1) { stream.next_packet }
+        Timeout.timeout(1) { stream.next_packet }
       end
     end
 
@@ -1701,7 +1701,7 @@ module Transport
         [false, :standard].each do |compress|
           cipher_method_name = cipher_name.gsub(/\W/, "_")
           hmac_method_name   = hmac_name.gsub(/\W/, "_")
-          
+
           define_method("test_next_packet_with_#{cipher_method_name}_and_#{hmac_method_name}_and_#{compress}_compression") do
             opts = { :shared => "123", :hash => "^&*", :digester => OpenSSL::Digest::SHA1  }
             cipher = Net::SSH::Transport::CipherFactory.get(cipher_name, opts.merge(:key => "ABC", :decrypt => true, :iv => "abc"))

data/test/transport/test_server_version.rb

@@ -47,6 +47,9 @@ module Transport
       def socket(good, version_header, raise_eot=false)
         socket = mock("socket")
 
+        socket.expects(:write).with("#{Net::SSH::Transport::ServerVersion::PROTO_VERSION}\r\n")
+        socket.expects(:flush)
+
         data = version_header.split('')
         recv_times = data.length
         recv_times += 1 if data[-1] != "\n"
@@ -60,13 +63,6 @@ module Transport
           socket.expects(:readpartial).with(1).times(recv_times+1).returns(*data).then.raises(EOFError, "end of file reached")
         end
 
-        if good
-          socket.expects(:write).with("#{Net::SSH::Transport::ServerVersion::PROTO_VERSION}\r\n")
-          socket.expects(:flush)
-        else
-          socket.expects(:write).never
-        end
-
         socket
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0.beta2
 platform: ruby
 authors:
 - Jamis Buck
@@ -31,7 +31,7 @@ cert_chain:
   s/ZUKye79ELwFYKJOhjW5g725OL3hy+llhEleytwKRwgXFQBPTC4f5UkdxZVVWGH
   e2C9M1m/2odPZo8h
   -----END CERTIFICATE-----
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -251,9 +251,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: net-ssh
 rubygems_version: 2.4.6