net-ssh 1.1.4 → 2.0.0

data/test/test_all.rb

@@ -0,0 +1,6 @@
+Dir.chdir(File.dirname(__FILE__)) do
+  test_files = Dir['**/test_*.rb']
+  test_files = test_files.select { |f| f =~ Regexp.new(ENV['ONLY']) } if ENV['ONLY']
+  test_files = test_files.reject { |f| f =~ Regexp.new(ENV['EXCEPT']) } if ENV['EXCEPT']
+  test_files.each { |file| require(file) }
+end

data/test/test_buffer.rb

@@ -0,0 +1,336 @@
+require 'common'
+require 'net/ssh/buffer'
+
+class TestBuffer < Test::Unit::TestCase
+  def test_constructor_should_initialize_buffer_to_empty_by_default
+    buffer = new
+    assert buffer.empty?
+    assert_equal 0, buffer.position
+  end
+
+  def test_constructor_with_string_should_initialize_buffer_to_the_string
+    buffer = new("hello")
+    assert !buffer.empty?
+    assert_equal "hello", buffer.to_s
+    assert_equal 0, buffer.position
+  end
+
+  def test_from_should_require_an_even_number_of_arguments
+    assert_raises(ArgumentError) { Net::SSH::Buffer.from("this") }
+  end
+
+  def test_from_should_build_new_buffer_from_definition
+    buffer = Net::SSH::Buffer.from(:byte, 1, :long, 2, :int64, 3, :string, "4", :bool, true, :bool, false, :bignum, OpenSSL::BN.new("1234567890", 10), :raw, "something")
+    assert_equal "\1\0\0\0\2\0\0\0\0\0\0\0\3\0\0\0\0014\1\0\000\000\000\004I\226\002\322something", buffer.to_s
+  end
+
+  def test_from_with_array_argument_should_write_multiple_of_the_given_type
+    buffer = Net::SSH::Buffer.from(:byte, [1,2,3,4,5])
+    assert_equal "\1\2\3\4\5", buffer.to_s
+  end
+
+  def test_read_without_argument_should_read_to_end
+    buffer = new("hello world")
+    assert_equal "hello world", buffer.read
+    assert buffer.eof?
+    assert_equal 11, buffer.position
+  end
+
+  def test_read_with_argument_that_is_less_than_length_should_read_that_many_bytes
+    buffer = new "hello world"
+    assert_equal "hello", buffer.read(5)
+    assert_equal 5, buffer.position
+  end
+
+  def test_read_with_argument_that_is_more_than_length_should_read_no_more_than_length
+    buffer = new "hello world"
+    assert_equal "hello world", buffer.read(500)
+    assert_equal 11, buffer.position
+  end
+
+  def test_read_at_eof_should_return_empty_string
+    buffer = new "hello"
+    buffer.position = 5
+    assert_equal "", buffer.read
+  end
+
+  def test_consume_without_argument_should_resize_buffer_to_start_at_position
+    buffer = new "hello world"
+    buffer.read(5)
+    assert_equal 5, buffer.position
+    assert_equal 11, buffer.length
+    buffer.consume!
+    assert_equal 0, buffer.position
+    assert_equal 6, buffer.length
+    assert_equal " world", buffer.to_s
+  end
+
+  def test_consume_with_argument_should_resize_buffer_starting_at_n
+    buffer = new "hello world"
+    assert_equal 0, buffer.position
+    buffer.consume!(5)
+    assert_equal 0, buffer.position
+    assert_equal 6, buffer.length
+    assert_equal " world", buffer.to_s
+  end
+
+  def test_read_bang_should_read_and_consume_and_return_read_portion
+    buffer = new "hello world"
+    assert_equal "hello", buffer.read!(5)
+    assert_equal 0, buffer.position
+    assert_equal 6, buffer.length
+    assert_equal " world", buffer.to_s
+  end
+
+  def test_available_should_return_length_after_position_to_end_of_string
+    buffer = new "hello world"
+    buffer.read(5)
+    assert_equal 6, buffer.available
+  end
+
+  def test_clear_bang_should_reset_buffer_contents_and_counters
+    buffer = new "hello world"
+    buffer.read(5)
+    buffer.clear!
+    assert_equal 0, buffer.length
+    assert_equal 0, buffer.position
+    assert_equal "", buffer.to_s
+  end
+
+  def test_append_should_append_argument_without_changing_position_and_should_return_self
+    buffer = new "hello world"
+    buffer.read(5)
+    buffer.append(" again")
+    assert_equal 5, buffer.position
+    assert_equal 12, buffer.available
+    assert_equal 17, buffer.length
+    assert_equal "hello world again", buffer.to_s
+  end
+
+  def test_remainder_as_buffer_should_return_a_new_buffer_filled_with_the_text_after_the_current_position
+    buffer = new "hello world"
+    buffer.read(6)
+    b2 = buffer.remainder_as_buffer
+    assert_equal 6, buffer.position
+    assert_equal 0, b2.position
+    assert_equal "world", b2.to_s
+  end
+
+  def test_read_int64_should_return_8_byte_integer
+    buffer = new "\xff\xee\xdd\xcc\xbb\xaa\x99\x88"
+    assert_equal 0xffeeddccbbaa9988, buffer.read_int64
+    assert_equal 8, buffer.position
+  end
+
+  def test_read_int64_should_return_nil_on_partial_read
+    buffer = new "\0\0\0\0\0\0\0"
+    assert_nil buffer.read_int64
+    assert buffer.eof?
+  end
+
+  def test_read_long_should_return_4_byte_integer
+    buffer = new "\xff\xee\xdd\xcc\xbb\xaa\x99\x88"
+    assert_equal 0xffeeddcc, buffer.read_long
+    assert_equal 4, buffer.position
+  end
+
+  def test_read_long_should_return_nil_on_partial_read
+    buffer = new "\0\0\0"
+    assert_nil buffer.read_long
+    assert buffer.eof?
+  end
+
+  def test_read_byte_should_return_single_byte_integer
+    buffer = new "\xfe\xdc"
+    assert_equal 0xfe, buffer.read_byte
+    assert_equal 1, buffer.position
+  end
+
+  def test_read_byte_should_return_nil_at_eof
+    assert_nil new.read_byte
+  end
+
+  def test_read_string_should_read_length_and_data_from_buffer
+    buffer = new "\0\0\0\x0bhello world"
+    assert_equal "hello world", buffer.read_string
+  end
+
+  def test_read_string_should_return_nil_if_4_byte_length_cannot_be_read
+    assert_nil new("\0\1").read_string
+  end
+
+  def test_read_bool_should_return_true_if_non_zero_byte_is_read
+    buffer = new "\1\2\3\4\5\6"
+    6.times { assert_equal true, buffer.read_bool }
+  end
+
+  def test_read_bool_should_return_false_if_zero_byte_is_read
+    buffer = new "\0"
+    assert_equal false, buffer.read_bool
+  end
+
+  def test_read_bool_should_return_nil_at_eof
+    assert_nil new.read_bool
+  end
+
+  def test_read_bignum_should_read_openssl_formatted_bignum
+    buffer = new("\000\000\000\004I\226\002\322")
+    assert_equal OpenSSL::BN.new("1234567890", 10), buffer.read_bignum
+  end
+
+  def test_read_bignum_should_return_nil_if_length_cannot_be_read
+    assert_nil new("\0\1\2").read_bignum
+  end
+
+  def test_read_key_blob_should_read_dsa_keys
+    random_dss { |buffer| buffer.read_keyblob("ssh-dss") }
+  end
+
+  def test_read_key_blob_should_read_rsa_keys
+    random_rsa { |buffer| buffer.read_keyblob("ssh-rsa") }
+  end
+
+  def test_read_key_should_read_dsa_key_type_and_keyblob
+    random_dss do |buffer|
+      b2 = Net::SSH::Buffer.from(:string, "ssh-dss", :raw, buffer)
+      b2.read_key
+    end
+  end
+
+  def test_read_key_should_read_rsa_key_type_and_keyblob
+    random_rsa do |buffer|
+      b2 = Net::SSH::Buffer.from(:string, "ssh-rsa", :raw, buffer)
+      b2.read_key
+    end
+  end
+
+  def test_read_buffer_should_read_a_string_and_return_it_wrapped_in_a_buffer
+    buffer = new("\0\0\0\x0bhello world")
+    b2 = buffer.read_buffer
+    assert_equal 0, b2.position
+    assert_equal 11, b2.length
+    assert_equal "hello world", b2.read
+  end
+
+  def test_read_to_should_return_nil_if_pattern_does_not_exist_in_buffer
+    buffer = new("one two three")
+    assert_nil buffer.read_to("\n")
+  end
+
+  def test_read_to_should_grok_string_patterns
+    buffer = new("one two three")
+    assert_equal "one tw", buffer.read_to("tw")
+    assert_equal 6, buffer.position
+  end
+
+  def test_read_to_should_grok_regex_patterns
+    buffer = new("one two three")
+    assert_equal "one tw", buffer.read_to(/tw/)
+    assert_equal 6, buffer.position
+  end
+
+  def test_read_to_should_grok_fixnum_patterns
+    buffer = new("one two three")
+    assert_equal "one tw", buffer.read_to(?w)
+    assert_equal 6, buffer.position
+  end
+
+  def test_reset_bang_should_reset_position_to_0
+    buffer = new("hello world")
+    buffer.read(5)
+    assert_equal 5, buffer.position
+    buffer.reset!
+    assert_equal 0, buffer.position
+  end
+
+  def test_write_should_write_arguments_directly_to_end_buffer
+    buffer = new("start")
+    buffer.write "hello", " ", "world"
+    assert_equal "starthello world", buffer.to_s
+    assert_equal 0, buffer.position
+  end
+
+  def test_write_int64_should_write_arguments_as_8_byte_integers_to_end_of_buffer
+    buffer = new("start")
+    buffer.write_int64 0xffeeddccbbaa9988, 0x7766554433221100
+    assert_equal "start\xff\xee\xdd\xcc\xbb\xaa\x99\x88\x77\x66\x55\x44\x33\x22\x11\x00", buffer.to_s
+  end
+
+  def test_write_long_should_write_arguments_as_4_byte_integers_to_end_of_buffer
+    buffer = new("start")
+    buffer.write_long 0xffeeddcc, 0xbbaa9988
+    assert_equal "start\xff\xee\xdd\xcc\xbb\xaa\x99\x88", buffer.to_s
+  end
+
+  def test_write_byte_should_write_arguments_as_1_byte_integers_to_end_of_buffer
+    buffer = new("start")
+    buffer.write_byte 1, 2, 3, 4, 5
+    assert_equal "start\1\2\3\4\5", buffer.to_s
+  end
+
+  def test_write_bool_should_write_arguments_as_1_byte_boolean_values_to_end_of_buffer
+    buffer = new("start")
+    buffer.write_bool nil, false, true, 1, Object.new
+    assert_equal "start\0\0\1\1\1", buffer.to_s
+  end
+
+  def test_write_bignum_should_write_arguments_as_ssh_formatted_bignum_values_to_end_of_buffer
+    buffer = new("start")
+    buffer.write_bignum OpenSSL::BN.new('1234567890', 10)
+    assert_equal "start\000\000\000\004I\226\002\322", buffer.to_s
+  end
+
+  def test_write_dss_key_should_write_argument_to_end_of_buffer
+    buffer = new("start")
+
+    key = OpenSSL::PKey::DSA.new
+    key.p = 0xffeeddccbbaa9988
+    key.q = 0x7766554433221100
+    key.g = 0xffddbb9977553311
+    key.pub_key = 0xeeccaa8866442200
+
+    buffer.write_key(key)
+    assert_equal "start\0\0\0\7ssh-dss\0\0\0\011\0\xff\xee\xdd\xcc\xbb\xaa\x99\x88\0\0\0\010\x77\x66\x55\x44\x33\x22\x11\x00\0\0\0\011\0\xff\xdd\xbb\x99\x77\x55\x33\x11\0\0\0\011\0\xee\xcc\xaa\x88\x66\x44\x22\x00", buffer.to_s
+  end
+
+  def test_write_rsa_key_should_write_argument_to_end_of_buffer
+    buffer = new("start")
+
+    key = OpenSSL::PKey::RSA.new
+    key.e = 0xffeeddccbbaa9988
+    key.n = 0x7766554433221100
+
+    buffer.write_key(key)
+    assert_equal "start\0\0\0\7ssh-rsa\0\0\0\011\0\xff\xee\xdd\xcc\xbb\xaa\x99\x88\0\0\0\010\x77\x66\x55\x44\x33\x22\x11\x00", buffer.to_s
+  end
+
+  private
+
+    def random_rsa
+      n1 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      n2 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      buffer = Net::SSH::Buffer.from(:bignum, [n1, n2])
+      key = yield(buffer)
+      assert_equal "ssh-rsa", key.ssh_type
+      assert_equal n1, key.e
+      assert_equal n2, key.n
+    end
+
+    def random_dss
+      n1 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      n2 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      n3 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      n4 = OpenSSL::BN.new(rand(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF).to_s, 10)
+      buffer = Net::SSH::Buffer.from(:bignum, [n1, n2, n3, n4])
+      key = yield(buffer)
+      assert_equal "ssh-dss", key.ssh_type
+      assert_equal n1, key.p
+      assert_equal n2, key.q
+      assert_equal n3, key.g
+      assert_equal n4, key.pub_key
+    end
+
+    def new(*args)
+      Net::SSH::Buffer.new(*args)
+    end
+end

data/test/test_buffered_io.rb

@@ -0,0 +1,63 @@
+require 'common'
+require 'net/ssh/buffered_io'
+
+class TestBufferedIo < Test::Unit::TestCase
+  def test_fill_should_pull_from_underlying_io
+    io.expects(:recv).with(8192).returns("here is some data")
+    assert_equal 17, io.fill
+    assert_equal 17, io.available
+    assert_equal "here is some data", io.read_available(20)
+  end
+
+  def test_enqueue_should_not_write_to_underlying_io
+    assert !io.pending_write?
+    io.expects(:send).never
+    io.enqueue("here is some data")
+    assert io.pending_write?
+  end
+
+  def test_send_pending_should_not_fail_when_no_writes_are_pending
+    assert !io.pending_write?
+    io.expects(:send).never
+    assert_nothing_raised { io.send_pending }
+  end
+
+  def test_send_pending_with_pending_writes_should_write_to_underlying_io
+    io.enqueue("here is some data")
+    io.expects(:send).with("here is some data", 0).returns(17)
+    assert io.pending_write?
+    assert_nothing_raised { io.send_pending }
+    assert !io.pending_write?
+  end
+
+  def test_wait_for_pending_sends_should_write_only_once_if_all_can_be_written_at_once
+    io.enqueue("here is some data")
+    io.expects(:send).with("here is some data", 0).returns(17)
+    assert io.pending_write?
+    assert_nothing_raised { io.wait_for_pending_sends }
+    assert !io.pending_write?
+  end
+
+  def test_wait_for_pending_sends_should_write_multiple_times_if_first_write_was_partial
+    io.enqueue("here is some data")
+
+    io.expects(:send).with("here is some data", 0).returns(10)
+    io.expects(:send).with("me data", 0).returns(4)
+    io.expects(:send).with("ata", 0).returns(3)
+
+    IO.expects(:select).times(2).with(nil, [io]).returns([[], [io]])
+
+    assert_nothing_raised { io.wait_for_pending_sends }
+    assert !io.pending_write?
+  end
+
+  private
+
+    def io
+      @io ||= begin
+        io = mock("io")
+        io.extend(Net::SSH::BufferedIo)
+        io
+      end
+    end
+end

data/test/test_config.rb

@@ -0,0 +1,78 @@
+require 'common'
+require 'net/ssh/config'
+
+class TestConfig < Test::Unit::TestCase
+  def test_load_for_non_existant_file_should_return_empty_hash
+    File.expects(:readable?).with("/bogus/file").returns(false)
+    assert_equal({}, Net::SSH::Config.load("/bogus/file", "host.name"))
+  end
+
+  def test_load_should_expand_path
+    expected = File.expand_path("~/.ssh/config")
+    File.expects(:readable?).with(expected).returns(false)
+    Net::SSH::Config.load("~/.ssh/config", "host.name")
+  end
+
+  def test_load_with_exact_host_match_should_load_that_section
+    config = Net::SSH::Config.load(config(:exact_match), "test.host")
+    assert config['compression']
+    assert config['forwardagent']
+    assert_equal 1234, config['port']
+  end
+
+  def test_load_with_wild_card_matches_should_load_all_matches_with_first_match_taking_precedence
+    config = Net::SSH::Config.load(config(:wild_cards), "test.host")
+    assert_equal 1234, config['port']
+    assert !config['compression']
+    assert config['forwardagent']
+    assert_equal %w(~/.ssh/id_dsa), config['identityfile']
+    assert !config.key?('rekeylimit')
+  end
+
+  def test_for_should_load_all_files_and_translate_to_net_ssh_options
+    config = Net::SSH::Config.for("test.host", [config(:exact_match), config(:wild_cards)])
+    assert_equal 1234, config[:port]
+    assert config[:compression]
+    assert config[:forward_agent]
+    assert_equal %w(~/.ssh/id_dsa), config[:keys]
+    assert !config.key?(:rekey_limit)
+  end
+
+  def test_translate_should_correctly_translate_from_openssh_to_net_ssh_names
+    open_ssh = {
+      'ciphers'                 => "a,b,c",
+      'compression'             => true,
+      'compressionlevel'        => 6,
+      'connecttimeout'          => 100,
+      'forwardagent'            => true,
+      'hostbasedauthentication' => true,
+      'hostkeyalgorithms'       => "d,e,f",
+      'identityfile'            => %w(g h i),
+      'macs'                    => "j,k,l",
+      'passwordauthentication'  => true,
+      'port'                    => 1234,
+      'pubkeyauthentication'    => true,
+      'rekeylimit'              => 1024
+    }
+
+    net_ssh = Net::SSH::Config.translate(open_ssh)
+
+    assert_equal %w(a b c), net_ssh[:encryption]
+    assert_equal true,      net_ssh[:compression]
+    assert_equal 6,         net_ssh[:compression_level]
+    assert_equal 100,       net_ssh[:timeout]
+    assert_equal true,      net_ssh[:forward_agent]
+    assert_equal %w(hostbased password publickey), net_ssh[:auth_methods].sort
+    assert_equal %w(d e f), net_ssh[:host_key]
+    assert_equal %w(g h i), net_ssh[:keys]
+    assert_equal %w(j k l), net_ssh[:hmac]
+    assert_equal 1234,      net_ssh[:port]
+    assert_equal 1024,      net_ssh[:rekey_limit]
+  end
+
+  private
+
+    def config(name)
+      "test/configs/#{name}"
+    end
+end