net-ssh 0.5.0

data/lib/net/ssh/util/openssl.rb

@@ -0,0 +1,146 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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 'base64'
+require 'openssl'
+require 'net/ssh/util/buffer'
+
+module OpenSSL
+
+  # This class is originally defined in the OpenSSL module. As needed, methods
+  # have been added to it by the Net::SSH module for convenience in dealing with
+  # SSH functionality.
+  class BN
+
+    # Converts a BN object to a string. The format used is that which is
+    # required by the SSH2 protocol.
+    def to_ssh
+      if zero?
+        return [ 0 ].pack( "N" )
+      else
+        buf = to_s( 2 )
+        if buf[0][7] == 1
+          return [ buf.length+1, 0, buf ].pack( "NCA*" )
+        else
+          return [ buf.length, buf ].pack( "NA*" )
+        end
+      end
+    end
+
+  end
+
+  module PKey
+
+    # This class is originally defined in the OpenSSL module. As needed, methods
+    # have been added to it by the Net::SSH module for convenience in dealing
+    # with SSH functionality.
+    class DH
+
+      # Determines whether the pub_key for this key is valid. (This algorithm
+      # lifted more-or-less directly from OpenSSH, dh.c, dh_pub_is_valid.)
+      def valid?
+        return false if pub_key < 0
+        bits_set = 0
+        pub_key.num_bits.times { |i| bits_set += 1 if pub_key.bit_set? i }
+        return ( bits_set > 1 && pub_key < p )
+      end
+
+    end
+
+    # This class is originally defined in the OpenSSL module. As needed, methods
+    # have been added to it by the Net::SSH module for convenience in dealing
+    # with SSH functionality.
+    class RSA
+
+      # Returns "ssh-rsa", which is the description of this key type used by the
+      # SSH2 protocol.
+      def ssh_type
+        "ssh-rsa"
+      end
+
+      # Converts the key to a blob, according to the SSH2 protocol.
+      def to_blob
+        buffer = Net::SSH::Util::WriterBuffer.new
+        buffer.write_bignum( e )
+        buffer.write_bignum( n )
+        return buffer.to_s
+      end
+
+      # Verifies the given signature matches the given data.
+      def ssh_do_verify( sig, data )
+        verify( OpenSSL::Digest::SHA1.new, sig, data )
+      end
+
+      # Returns the signature for the given data.
+      def ssh_do_sign( data )
+        sign( OpenSSL::Digest::SHA1.new, data )
+      end
+    end
+
+    # This class is originally defined in the OpenSSL module. As needed, methods
+    # have been added to it by the Net::SSH module for convenience in dealing
+    # with SSH functionality.
+    class DSA
+
+      # Returns "ssh-dss", which is the description of this key type used by the
+      # SSH2 protocol.
+      def ssh_type
+        "ssh-dss"
+      end
+
+      # Converts the key to a blob, according to the SSH2 protocol.
+      def to_blob
+        buffer = Net::SSH::Util::WriterBuffer.new
+        buffer.write_bignum( p )
+        buffer.write_bignum( q )
+        buffer.write_bignum( g )
+        buffer.write_bignum( pub_key )
+        return buffer.to_s
+      end
+
+      # Verifies the given signature matches the given data.
+      def ssh_do_verify( sig, data )
+        sig_r = sig[0,20].unpack("H*")[0].to_i(16)
+        sig_s = sig[20,20].unpack("H*")[0].to_i(16)
+        a1sig = OpenSSL::ASN1::Sequence([
+           OpenSSL::ASN1::Integer(sig_r),
+           OpenSSL::ASN1::Integer(sig_s)
+        ])
+        return verify(OpenSSL::Digest::DSS1.new, a1sig.to_der, data)
+      end
+
+      # Sigs the given data.
+      def ssh_do_sign( data )
+        sig = sign( OpenSSL::Digest::DSS1.new, data)
+        a1sig = OpenSSL::ASN1.decode( sig )
+
+        sig_r = a1sig.value[0].value.to_s(2)
+        sig_s = a1sig.value[1].value.to_s(2)
+
+        if sig_r.length > 20 || sig_s.length > 20
+          raise OpenSSL::PKey::DSAError, "bad sig size"
+        end
+
+        sig_r = "\0" * ( 20 - sig_r.length ) + sig_r if sig_r.length < 20
+        sig_s = "\0" * ( 20 - sig_s.length ) + sig_s if sig_s.length < 20
+
+        return sig_r + sig_s
+      end
+    end
+
+  end
+
+end

data/lib/net/ssh/util/prompter.rb

@@ -0,0 +1,73 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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
+# =============================================================================
+#++
+
+unless defined?( HAS_TERMIOS )
+  begin
+    require 'termios'
+    HAS_TERMIOS = true
+  rescue LoadError
+    HAS_TERMIOS = false
+  end
+end
+
+module Net
+  module SSH
+    module Util
+
+      # A simple class for prompting a user for input.
+      class Prompter
+
+        # Displays the prompt and then waits for the user to enter a response.
+        # If the 'termios' library is available, the user's input will not be
+        # echoed to the terminal. The user's response will be returned, with
+        # any trailing newline chomped.
+        def password( prompt=nil )
+          if $stdin.tty?
+            echo false
+            print prompt if prompt
+          end
+
+          $stdin.gets.chomp
+        ensure
+          if $stdin.tty?
+            echo true
+            puts
+          end
+        end
+
+        if HAS_TERMIOS
+          def echo( enable )
+            term = Termios::getattr( $stdin )
+
+            if enable
+              term.c_lflag |= ( Termios::ECHO | Termios::ICANON )
+            else
+              term.c_lflag &= ~Termios::ECHO
+            end
+
+            Termios::setattr( $stdin, Termios::TCSANOW, term )
+          end
+        else
+          def echo( enable )
+          end
+        end
+        private :echo
+
+      end
+
+    end
+  end
+end

data/lib/net/ssh/version.rb

@@ -0,0 +1,29 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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
+# =============================================================================
+#++
+
+module Net
+  module SSH
+    module Version
+
+      MAJOR = 0
+      MINOR = 5
+      TINY  = 0
+
+      STRING = [ MAJOR, MINOR, TINY ].join( "." )
+
+    end
+  end
+end

data/test/ALL-TESTS.rb

@@ -0,0 +1,21 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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
+# =============================================================================
+#++
+
+$:.unshift "../lib"
+
+$run_integration_tests = ARGV.include?( "-i" )
+
+Dir["**/tc_*.rb"].each { |f| load f }

data/test/connection/tc_channel.rb

@@ -0,0 +1,136 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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
+# =============================================================================
+#++
+
+$:.unshift "../../lib"
+
+require 'test/unit'
+require 'net/ssh/connection/channel'
+require 'net/ssh/util/buffer'
+
+class TC_Channel < Test::Unit::TestCase
+
+  class Buffers
+    def writer
+      Net::SSH::Util::WriterBuffer.new
+    end
+  end
+
+  class Log
+    def debug?
+      false
+    end
+  end
+
+  class Connection
+    attr_reader :buffers
+    attr_reader :events
+
+    def initialize( buffers )
+      @events = []
+      @buffers = buffers
+    end
+
+    def send_message( msg )
+      @events << msg.to_s
+    end
+
+    def allocate_channel_id
+      events << :allocate_channel_id
+      1234
+    end
+
+    def remove_channel( channel )
+      events << :remove_channel
+    end
+  end
+
+  def setup
+    @connection = Connection.new( Buffers.new )
+  end
+
+  def test_open_no_data
+    channel = Net::SSH::Connection::Channel.open( @connection, Log.new,
+      Buffers.new, "test" )
+    assert_equal [ :allocate_channel_id,
+      "\132\0\0\0\4test\0\0\4\xd2\x7f\xff\xff\xff\x7f\xff\xff\xff" ],
+      @connection.events
+    assert_equal "test", channel.type
+  end
+
+  def test_open_with_data
+    channel = Net::SSH::Connection::Channel.open( @connection, Log.new,
+      Buffers.new, "test", "some data" )
+    assert_equal [ :allocate_channel_id,
+      "\132\0\0\0\4test\0\0\4\xd2\x7f\xff\xff\xff\x7f\xff\xff\xffsome data" ],
+      @connection.events
+    assert_equal "test", channel.type
+  end
+
+  def test_do_confirm_open
+    confirmed = nil
+    channel = Net::SSH::Connection::Channel.open( @connection, Log.new,
+      Buffers.new, "test" )
+    channel.on_confirm_open { |a| confirmed = a }
+    channel.do_confirm_open 1, 2, 3
+    assert_same channel, confirmed
+    assert_equal 1, channel.remote_id
+    assert_equal 2, channel.window_size
+    assert_equal 3, channel.maximum_packet_size
+  end
+
+  def create_channel
+    Net::SSH::Connection::Channel.create( @connection, Log.new, Buffers.new,
+      "test", 1, 2, 3 )
+  end
+
+  def test_create
+    channel = create_channel
+    assert_equal "test", channel.type
+    assert_equal [ :allocate_channel_id ], @connection.events
+    assert_equal 1234, channel.local_id
+    assert_equal 1, channel.remote_id
+    assert_equal 2, channel.window_size
+    assert_equal 3, channel.maximum_packet_size
+  end
+
+  def test_new
+    assert_raise( NoMethodError ) do
+      Net::SSH::Connection::Channel.new( @connection, "test" )
+    end
+  end
+
+  def self.test_callback( name, do_args=[], expect=do_args )
+    define_method( "test_#{name}".to_sym ) do
+      channel = create_channel
+
+      result = nil
+      channel.send( "on_#{name}".to_sym ) { |*a| result = a }
+      channel.send( "do_#{name}".to_sym, *do_args )
+
+      assert_equal [ channel, *expect ], result
+    end
+  end
+
+  test_callback :confirm_open, [ 1, 2, 3 ], []
+  test_callback :confirm_failed, [ 100, "b", "c" ]
+  test_callback :window_adjust, [ 14 ]
+  test_callback :data, [ "blah" ]
+  test_callback :extended_data, [ 1, "blah" ]
+  test_callback :eof
+  test_callback :request, [ true, "blah" ]
+  test_callback :success
+  test_callback :failure
+end

data/test/connection/tc_driver.rb

@@ -0,0 +1,287 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.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
+# =============================================================================
+#++
+
+$:.unshift "../../lib"
+
+require 'test/unit'
+require 'net/ssh/connection/driver'
+require 'net/ssh/errors'
+require 'net/ssh/util/buffer'
+
+class TC_Driver < Test::Unit::TestCase
+
+  class Buffers
+    def writer
+      Net::SSH::Util::WriterBuffer.new
+    end
+  end
+
+  class Log
+    attr_reader :messages
+
+    def initialize
+      @messages = []
+    end
+
+    def debug?
+      true
+    end
+
+    def debug( msg )
+      @messages << msg
+    end
+  end
+
+  class Session
+    attr_reader :events
+    attr_reader :script
+
+    def initialize
+      @events = []
+      @script = []
+    end
+
+    def send_message( msg )
+      @events << msg.to_s
+    end
+
+    def wait_for_message
+      @script.shift
+    end
+  end
+
+  class Channel
+    attr_reader :local_id
+    attr_reader :remote_id
+    attr_reader :data
+    attr_reader :window_size
+    attr_reader :packet_size
+    attr_reader :type
+    attr_reader :block
+    attr_reader :events
+
+    def self.open( type, data )
+      new( type, data, nil, nil, nil )
+    end
+
+    def self.create( type, remote_id, window_size, packet_size )
+      new( type, nil, remote_id, window_size, packet_size )
+    end
+
+    def initialize( type, data, remote_id, winsize, packsize )
+      @type = type
+      @data = data
+      @remote_id = remote_id
+      @window_size = winsize
+      @packet_size = packsize
+      @local_id = 1
+      @events = []
+    end
+
+    def close( value )
+      @events << [ :close, value ]
+    end
+
+    def on_confirm_open( &block )
+      @block = block
+    end
+
+    def self.event( name )
+      define_method( "do_#{name}".to_sym ) do |*args|
+        @events << [ name, *args ]
+      end
+    end
+
+    event :confirm_failed
+    event :confirm_open
+    event :window_adjust
+    event :data
+    event :extended_data
+    event :eof
+    event :request
+    event :success
+    event :failure
+  end
+
+  def reader( text )
+    Net::SSH::Util::ReaderBuffer.new( text )
+  end
+
+  def setup
+    @session = Session.new
+    @log = Log.new
+    @driver = Net::SSH::Connection::Driver.new( @session, @log,
+      Buffers.new,
+      :open => proc { |t,d| Channel.open(t,d) },
+      :create => proc { |t,r,w,p| Channel.create(t,r,w,p) } )
+  end
+
+  def test_open_channel
+    channel = @driver.open_channel( "test", "data" ) { |a| a }
+    assert_equal "hello", channel.block.call( "hello" )
+    assert_equal "test", channel.type
+    assert_equal "data", channel.data
+    assert_equal [ channel ], @driver.channels
+  end
+
+  def test_remove_channel
+    channel = @driver.open_channel( "test", "data" ) { |a| a }
+    assert_equal [channel], @driver.channels
+    @driver.remove_channel( channel )
+    assert_equal [], @driver.channels
+  end
+
+  def test_allocate_channel_id
+    assert_equal 1, @driver.allocate_channel_id
+    10.times { @driver.allocate_channel_id }
+    assert_equal 12, @driver.allocate_channel_id
+  end
+
+  def test_global_request
+    @driver.global_request "test", "foobar"
+    assert_equal [ "\120\0\0\0\4test\1foobar" ], @session.events
+  end
+
+  def test_request_success
+    @driver.global_request( "test", "foobar" ) do |a,b|
+      assert a
+      assert_equal "response", b
+    end
+
+    @driver.do_request_success "response"
+  end
+
+  def test_request_failure
+    @driver.global_request( "test", "foobar" ) do |a,b|
+      assert !a
+      assert_equal "response", b
+    end
+
+    @driver.do_request_failure "response"
+  end
+
+  def test_channel_open_no_handler
+    assert_raise( Net::SSH::Exception ) do
+      @driver.do_channel_open(
+        reader( "\0\0\0\4test\0\0\0\4\0\0\0\0\0\0\0\1" ) )
+    end
+  end
+
+  def test_channel_open_with_handler
+    @driver.add_channel_open_handler( "test" ) do |conn,chan,resp|
+      assert_equal @driver, conn
+      assert_equal "test", chan.type
+      assert_equal 4, chan.remote_id
+      assert_equal 0, chan.window_size
+      assert_equal 1, chan.packet_size
+      assert_equal "hello world", resp.read
+    end
+
+    @driver.do_channel_open(
+      reader( "\0\0\0\4test\0\0\0\4\0\0\0\0\0\0\0\1hello world" ) )
+
+    assert_equal 1, @driver.channels.length
+    assert_equal [ "\133\0\0\0\4\0\0\0\1\x7f\xff\xff\xff\x7f\xff\xff\xff" ],
+      @session.events
+  end
+
+  def test_channel_open_failure
+    channel = @driver.open_channel( "test", "data" )
+    assert_equal 1, @driver.channels.length
+    @driver.do_channel_open_failure(
+      reader( "\0\0\0\1\0\0\0\2\0\0\0\4test\0\0\0\2en" ) )
+    assert_equal 0, @driver.channels.length
+    assert_equal [ [ :confirm_failed, 2, "test", "en" ] ], channel.events
+  end
+
+  def test_channel_open_confirmation
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_open_confirmation(
+      reader( "\0\0\0\1\0\0\0\2\0\0\0\3\0\0\0\4" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :confirm_open, 2, 3, 4 ] ], channel.events
+  end
+
+  def test_channel_window_adjust
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_window_adjust( reader( "\0\0\0\1\0\0\0\12" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :window_adjust, 10 ] ], channel.events
+  end
+
+  def test_channel_data
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_data( reader( "\0\0\0\1\0\0\0\4test" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :data, "test" ] ], channel.events
+  end
+
+  def test_channel_extended_data
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_extended_data( reader( "\0\0\0\1\0\0\0\2\0\0\0\4test" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :extended_data, 2, "test" ] ], channel.events
+  end
+
+  def test_channel_eof
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_eof( reader( "\0\0\0\1" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :eof ] ], channel.events
+  end
+
+  def test_channel_close
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_close( reader( "\0\0\0\1" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :close, false ] ], channel.events
+  end
+
+  def test_channel_request
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_request( reader( "\0\0\0\1\0\0\0\4test\1foobarbaz" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :request, "test", true, reader("foobarbaz") ] ],
+      channel.events
+  end
+
+  def test_channel_success
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_success( reader( "\0\0\0\1" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :success ] ], channel.events
+  end
+
+  def test_channel_failure
+    channel = @driver.open_channel( "test", "data" )
+    @driver.do_channel_failure( reader( "\0\0\0\1" ) )
+    assert_equal 1, @driver.channels.length
+    assert_equal [ [ :failure ] ], channel.events
+  end
+
+  ProcessItem = Struct.new( :name, :script, :events )
+  def self.i( name, script, events )
+    ProcessItem.new( name, script, events )
+  end
+
+  def test_process_bad
+    @session.script << [ 0, reader("") ]
+    assert_raise( Net::SSH::Exception ) do
+      @driver.process
+    end
+  end
+
+end