net-ssh 2.9.2.beta → 2.9.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4b83671580de0bd2d63e112c605feaefe41a5b0
-  data.tar.gz: f29b3c1c885a9868b09f18d03d988683e1c351d5
+  metadata.gz: de2e4d03d9a33f009679b7da843529f74cfb49cf
+  data.tar.gz: 9e9d79e59836127851a007d06b315037784d1fd6
 SHA512:
-  metadata.gz: 97088cea6fb2f3b47c09e6911c2b52d0e79b97a1b1dc7e6033b44f44531dbef8751677acb7f03b63a0c4ff9978422c20beeafdb61ab8e36435e20e1aafbf0d5b
-  data.tar.gz: 228621bcee2649a0e05d38483ce4f74376116544e6db2a0edc326c63d9be9ea85e4a5e828f0a171382792cdda4763b9a5f3771ab480b8b5ae4b67a7572a7ced5
+  metadata.gz: c94eb4321f98a3e218818a44dc34c0b9444a7afbdcbd6f766ff73cb1882c2d748a5f39e73091be305a9a24a4aae90da23205bffff9a1a45053d3763bca65e252
+  data.tar.gz: c53db580ff1bc9ec76bc953aaabaa22aba4c65edec20bb82425a4aef4cc1388c3690775aa8d339c217ff6c690a8988dd637653a49c1f365434494e84a91717e3

data/CHANGES.txt

@@ -1,3 +1,7 @@
+=== 2.9.2-rc1
+
+* Documentation fixes and refactoring to keepalive [detiber, mfazekas]
+
 === 2.9.2-beta
 
 * Remove advertised algorithms that were not working (ssh-rsa-cert-* *ed25519 acm*-gcm@openssh.com) [mfazekas]

data/Rakefile

@@ -1,3 +1,10 @@
+# coding: UTF-8
+#
+# Also in your terminal environment run:
+#   $ export LANG=en_US.UTF-8
+#   $ export LANGUAGE=en_US.UTF-8
+#   $ export LC_ALL=en_US.UTF-8
+
 require "rubygems"
 require "rake"
 require "rake/clean"
@@ -21,7 +28,7 @@ begin
     s.description = s.summary + " It allows you to write programs that invoke and interact with processes on remote servers, via SSH2."
     s.email = "net-ssh@solutious.com"
     s.homepage = "https://github.com/net-ssh/net-ssh"
-    s.authors = ["Jamis Buck", "Delano Mandelbaum"]
+    s.authors = ["Jamis Buck", "Delano Mandelbaum", "Miklós Fazekas"]
 
     # Note: this is run at package time not install time so if you are
     # running on jruby, you need to install jruby-pageant manually.

data/lib/net/ssh.rb

@@ -125,12 +125,12 @@ module Net
     #   specified in an SSH configuration file. It lets you specify an
     #   "alias", similarly to adding an entry in /etc/hosts but without needing
     #   to modify /etc/hosts.
-    #   :keepalive => set to +true+ to send a keepalive packet to the SSH server
+    # * :keepalive => set to +true+ to send a keepalive packet to the SSH server
     #   when there's no traffic between the SSH server and Net::SSH client for
     #   the keepalive_interval seconds. Defaults to +false+.
-    #   :keepalive_interval => the interval seconds for keepalive.
+    # * :keepalive_interval => the interval seconds for keepalive.
     #   Defaults to +300+ seconds.
-    #   :keepalive_countmax => the maximun number of keepalive packet miss allowed.
+    # * :keepalive_maxcount => the maximun number of keepalive packet miss allowed.
     # * :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
@@ -147,7 +147,11 @@ module Net
     # * :max_win_size => maximum size we tell the other side that is supported for
     #   the window.
     # * :paranoid => either false, true, :very, or :secure specifying how
-    #   strict host-key verification should be (in increasing order here)
+    #   strict host-key verification should be (in increasing order here).
+    #   You can also provide an own Object which responds to +verify+. The argument
+    #   given to +verify+ is a hash consisting of the +:key+, the +:key_blob+,
+    #   the +:fingerprint+ and the +:session+. Returning true accepts the host key,
+    #   returning false declines it and closes the connection.
     # * :passphrase => the passphrase to use when loading a private key (default
     #   is +nil+, for no passphrase)
     # * :password => the password to use to login

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

@@ -523,7 +523,7 @@ module Net; module SSH; module Connection
           @on_open_failed.call(self, reason_code, description)
         else
           raise ChannelOpenFailed.new(reason_code, description)
-        end          
+        end
       end
 
       # Invoked when the server sends a CHANNEL_WINDOW_ADJUST packet, and

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

@@ -1,48 +1,55 @@
+require 'net/ssh/loggable'
 module Net; module SSH; module Connection
 
-module Keepalive
-  # Default IO.select timeout threshold
-  DEFAULT_IO_SELECT_TIMEOUT = 300
+class Keepalive
+  include Loggable
 
-  def initialize_keepalive
+  def initialize(session)
     @last_keepalive_sent_at = nil
     @unresponded_keepalive_count = 0
+    @session = session
+    self.logger = session.logger
   end
 
-  def keepalive_enabled?
+  def options
+    @session.options
+  end
+
+  def enabled?
     options[:keepalive]
   end
 
-  def keepalive_interval
-    options[:keepalive_interval] || DEFAULT_IO_SELECT_TIMEOUT
+  def interval
+    options[:keepalive_interval] || Session::DEFAULT_IO_SELECT_TIMEOUT
   end
 
-  def should_send_keepalive?
-    return false unless keepalive_enabled?
+  def should_send?
+    return false unless enabled?
     return true unless @last_keepalive_sent_at
-    Time.now - @last_keepalive_sent_at >= keepalive_interval
+    Time.now - @last_keepalive_sent_at >= interval
   end
 
   def keepalive_maxcount
     (options[:keepalive_maxcount] || 3).to_i
   end
 
-  def send_keepalive_as_needed(readers, writers)
+  def send_as_needed(readers, writers)
     return unless readers.nil? && writers.nil?
-    return unless should_send_keepalive?
+    return unless should_send?
     info { "sending keepalive #{@unresponded_keepalive_count}" }
 
     @unresponded_keepalive_count += 1
-    send_global_request("keepalive@openssh.com") { |success, response|
-      puts "before zero => #{@unresponded_keepalive_count}"
+    @session.send_global_request("keepalive@openssh.com") { |success, response|
+      debug { "keepalive response successful. Missed #{@unresponded_keepalive_count-1} keepalives" }
       @unresponded_keepalive_count = 0
     }
     @last_keepalive_sent_at = Time.now
     if keepalive_maxcount > 0 && @unresponded_keepalive_count > keepalive_maxcount
-      error { "Timeout, server #{host} not responding. Missed #{@unresponded_keepalive_count-1} timeouts." }
-      raise Net::SSH::Timeout, "Timeout, server #{host} not responding."
+      error { "Timeout, server #{@session.host} not responding. Missed #{@unresponded_keepalive_count-1} timeouts." }
+      @unresponded_keepalive_count = 0
+      raise Net::SSH::Timeout, "Timeout, server #{@session.host} not responding."
     end
   end
 end
 
-end; end; end
+end; end; end

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

@@ -24,7 +24,10 @@ module Net; module SSH; module Connection
   #     ssh.exec! "/etc/init.d/some_process start"
   #   end
   class Session
-    include Constants, Loggable, Keepalive
+    include Constants, Loggable
+
+    # Default IO.select timeout threshold
+    DEFAULT_IO_SELECT_TIMEOUT = 300
 
     # The underlying transport layer abstraction (see Net::SSH::Transport::Session).
     attr_reader :transport
@@ -77,7 +80,7 @@ module Net; module SSH; module Connection
       @max_pkt_size = (options.has_key?(:max_pkt_size) ? options[:max_pkt_size] : 0x8000)
       @max_win_size = (options.has_key?(:max_win_size) ? options[:max_win_size] : 0x20000)
 
-      initialize_keepalive
+      @keepalive = Keepalive.new(self)
     end
 
     # Retrieves a custom property from this instance. This can be used to
@@ -242,7 +245,7 @@ module Net; module SSH; module Connection
         writer.send_pending
       end
 
-      send_keepalive_as_needed(readers, writers)
+      @keepalive.send_as_needed(readers, writers)
       transport.rekey_as_needed
 
       return true
@@ -596,8 +599,8 @@ module Net; module SSH; module Connection
 
       def io_select_wait(wait)
         return wait if wait
-        return wait unless keepalive_enabled?
-        keepalive_interval
+        return wait unless @keepalive.enabled?
+        @keepalive.interval
       end
 
       MAP = Constants.constants.inject({}) do |memo, name|

data/lib/net/ssh/version.rb

@@ -55,7 +55,7 @@ module Net; module SSH
 
     # The prerelease component of this version of the Net::SSH library 
     # nil allowed
-    PRE   = "beta"
+    PRE   = "rc1"
 
     # 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 2.9.2.beta ruby lib
+# stub: net-ssh 2.9.2.rc1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "net-ssh"
-  s.version = "2.9.2.beta"
+  s.version = "2.9.2.rc1"
 
   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"]
+  s.authors = ["Jamis Buck", "Delano Mandelbaum", "Mikl\u{f3}s Fazekas"]
   s.cert_chain = ["net-ssh-public_cert.pem"]
-  s.date = "2014-12-02"
+  s.date = "2014-12-24"
   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 = [

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh
 version: !ruby/object:Gem::Version
-  version: 2.9.2.beta
+  version: 2.9.2.rc1
 platform: ruby
 authors:
 - Jamis Buck
 - Delano Mandelbaum
+- Miklós Fazekas
 autorequire: 
 bindir: bin
 cert_chain:
@@ -30,7 +31,7 @@ cert_chain:
   MbvRpzgROzyfw1qYi4dnIyMwTtXFFcZ0a2jpxHPkcTYFK6TzvFgDLAP0Y/u9jqUQ
   eZ7/3CdSi/isZHEw
   -----END CERTIFICATE-----
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit