net-ssh 0.6.0 → 0.9.0

data/lib/net/ssh/service/shell/sync.rb

@@ -0,0 +1,114 @@
+#--
+# =============================================================================
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SSH Secure Shell Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SSH
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-ssh website : http://net-ssh.rubyforge.org
+# project website: http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'stringio'
+
+module Net
+  module SSH
+    module Service
+      module Shell
+
+        # A version of Shell::Shell that acts synchronously, allowing clients
+        # to execute a command via a shell, wait for it to finish, and then
+        # inspect both the stdout and stderr from the command, as well as the
+        # exit status.
+        class SyncShell
+
+          # A struct representing the result of executing a command.
+          CommandOutput = Struct.new( :stdout, :stderr, :status )
+
+          # The unique confirmation string that is used to recognize the
+          # end of a command's execution.
+          CONFIRMATION = "2357foobarbazzabraboof7532"
+
+          # Create a new SyncShell that uses the given +shell+ factory to obtain
+          # a shell to wrap. The other parameters are used
+          def initialize( shell, log, pty_opts )
+            @log = log
+            @shell = shell.call( pty_opts )
+          end
+
+          # Delegates to Shell::Shell.open?
+          def open?
+            @shell.open?
+          end
+
+          # Attempts to invoke the given command, which must not be
+          # terminated with a newline. If +stdin+ is not nil, it will be sent
+          # to the shell immediately after sending the request to execute the
+          # command. It is expected that this will be used by the program that
+          # was just executed somehow, but this is not (cannot) be enforced.
+          def send_command( cmd, stdin=nil )
+            @log.debug "executing #{cmd.inspect}" if @log.debug?
+            send_data "#{cmd}; echo -n #{CONFIRMATION} $?\n"
+            send_data stdin if stdin
+
+            out = ""
+            err = ""
+
+            @log.debug "waiting for #{cmd.inspect}" if @log.debug?
+            loop do
+              sleep 0.01
+              out << @shell.stdout while @shell.open? && @shell.stdout?
+              err << @shell.stderr while @shell.open? && @shell.stderr?
+
+              break if !@shell.open? || out.index( CONFIRMATION + " " )
+            end
+
+            if @log.debug?
+              @log.debug "#{cmd.inspect} finished"
+              @log.debug " stdout --> #{out.inspect}"
+              @log.debug " stderr --> #{err.inspect}"
+            end
+
+            if @shell.open?
+              match = out.match( /#{CONFIRMATION} /o )
+              out = match.pre_match
+              status = match.post_match.strip.to_i
+            else
+              status = 0
+            end
+
+            CommandOutput.new( out, ( err.empty? ? nil : err ), status )
+          end
+
+          # Sends the given string directly to the shell, without waiting for
+          # any response.
+          def send_data( data )
+            @shell.send_data data
+          end
+
+          # Dends the given string directly to the shell as the given type of
+          # data, without waiting for any response.
+          def send_extended_data( type, data )
+            @shell.send_extended_data type, data
+          end
+
+          # Reinterprets missing methods as requests to execute commands. The
+          # parameters to the method are concatenated together with spaces
+          # and sent to the shell via #send_command.
+          def method_missing( sym, *args )
+            cmd = sym.to_s
+            cmd << " " << args.join( " " ) unless args.empty?
+            send_command cmd
+          end
+
+        end
+
+      end # SyncShell
+    end # Service
+  end # SSH
+end # Net

data/lib/net/ssh/session.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client
@@ -26,6 +26,12 @@ module Net
       # The dependency-injection registry used by this session.
       attr_reader :registry
 
+      # The name of the host that this session is connected to.
+      attr_reader :host
+
+      # The hash of options that were used to establish this session.
+      attr_reader :options
+
       # Create a new SSH session. This method polymorphically accepts a
       # variable number of parameters, as follows:
       #
@@ -231,6 +237,8 @@ module Net
         ].each do |i|
           @options.delete i
         end
+
+        @options.freeze
       end
       private :process_arguments
 

data/lib/net/ssh/transport/algorithm-negotiator.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/compressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/decompressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/none-compressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/none-decompressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/services.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/zlib-compressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/compress/zlib-decompressor.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

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

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

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

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/identity-cipher.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/kex/dh-gex.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/kex/dh.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/kex/services.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/buffer-factory.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/buffer.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/cipher-factory.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/digest-factory.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac-factory.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/hmac.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/md5-96.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/md5.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/none.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/services.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/sha1-96.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/hmac/sha1.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/ossl/key-factory.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client
@@ -101,7 +101,10 @@ module Net
 
             blob = Base64.decode64( blob )
             reader = @buffers.reader( blob )
-            return reader.read_key
+            key = reader.read_key or
+              raise OpenSSL::PKey::PKeyError,
+                "not a public key #{filename.inspect}"
+            return key
           end
 
         end

data/lib/net/ssh/transport/ossl/services.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

data/lib/net/ssh/transport/packet-stream.rb

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

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

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client

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

@@ -1,6 +1,6 @@
 #--
 # =============================================================================
-# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# Copyright (c) 2004,2005 Jamis Buck (jamis_buck@byu.edu)
 # All rights reserved.
 #
 # This source file is distributed as part of the Net::SSH Secure Shell Client
@@ -231,6 +231,8 @@ module Net
               end
 
               buffer = @packet_receiver.get
+              next unless buffer
+
               type = buffer.read_byte
               @logger.debug "got packet of type #{type}" if @logger.debug?
 
@@ -289,6 +291,13 @@ module Net
           @packet_sender.send message
         end
 
+        # Returns true if there are bytes to be read on the socket. Note that
+        # this only means there is an encrypted packet ready to be read, not
+        # that there is data available to any particular SSH channel.
+        def reader_ready?
+          IO.select([@socket],nil,nil,0) != nil
+        end
+
       end
 
     end