net-ssh 1.1.4 → 2.0.0

data/test/authentication/methods/common.rb

@@ -0,0 +1,28 @@
+module Authentication; module Methods
+
+  module Common
+    include Net::SSH::Authentication::Constants
+
+    private
+
+      def socket(options={})
+        @socket ||= stub("socket", :client_name => "me.ssh.test")
+      end
+
+      def transport(options={})
+        @transport ||= MockTransport.new(options.merge(:socket => socket))
+      end
+
+      def session(options={})
+        @session ||= begin
+          sess = stub("auth-session", :logger => nil, :transport => transport(options))
+          def sess.next_message
+            transport.next_message
+          end
+          sess
+        end
+      end
+
+  end
+
+end; end

data/test/authentication/methods/test_abstract.rb

@@ -0,0 +1,51 @@
+require 'common'
+require 'authentication/methods/common'
+require 'net/ssh/authentication/methods/abstract'
+
+module Authentication; module Methods
+
+  class TestAbstract < Test::Unit::TestCase
+    include Common
+
+    def test_constructor_should_set_defaults
+      assert_nil subject.key_manager
+    end
+
+    def test_constructor_should_honor_options
+      assert_equal :manager, subject(:key_manager => :manager).key_manager
+    end
+
+    def test_session_id_should_query_session_id_from_key_exchange
+      transport.stubs(:algorithms).returns(stub("algorithms", :session_id => "abcxyz123"))
+      assert_equal "abcxyz123", subject.session_id
+    end
+
+    def test_send_message_should_delegate_to_transport
+      transport.expects(:send_message).with("abcxyz123")
+      subject.send_message("abcxyz123")
+    end
+
+    def test_userauth_request_should_build_well_formed_userauth_packet
+      packet = subject.userauth_request("jamis", "ssh-connection", "password")
+      assert_equal "\062\0\0\0\005jamis\0\0\0\016ssh-connection\0\0\0\010password", packet.to_s
+    end
+
+    def test_userauth_request_should_translate_extra_booleans_onto_end
+      packet = subject.userauth_request("jamis", "ssh-connection", "password", true, false)
+      assert_equal "\062\0\0\0\005jamis\0\0\0\016ssh-connection\0\0\0\010password\1\0", packet.to_s
+    end
+
+    def test_userauth_request_should_translate_extra_strings_onto_end
+      packet = subject.userauth_request("jamis", "ssh-connection", "password", "foo", "bar")
+      assert_equal "\062\0\0\0\005jamis\0\0\0\016ssh-connection\0\0\0\010password\0\0\0\3foo\0\0\0\3bar", packet.to_s
+    end
+
+    private
+
+      def subject(options={})
+        @subject ||= Net::SSH::Authentication::Methods::Abstract.new(session(options), options)
+      end
+
+  end
+
+end; end

data/test/authentication/methods/test_hostbased.rb

@@ -0,0 +1,108 @@
+require 'common'
+require 'net/ssh/authentication/methods/hostbased'
+require 'authentication/methods/common'
+
+module Authentication; module Methods
+
+  class TestHostbased < Test::Unit::TestCase
+    include Common
+
+    def test_authenticate_should_return_false_when_no_key_manager_has_been_set
+      assert_equal false, subject(:key_manager => nil).authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_false_when_key_manager_has_no_keys
+      assert_equal false, subject(:keys => []).authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_false_if_no_keys_can_authenticate
+      key_manager.expects(:sign).with(&signature_parameters(keys.first)).returns("sig-one")
+      key_manager.expects(:sign).with(&signature_parameters(keys.last)).returns("sig-two")
+
+      transport.expect do |t, packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert verify_userauth_request_packet(packet, keys.first)
+        assert_equal "sig-one", packet.read_string
+        t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+
+        t.expect do |t, packet|
+          assert_equal USERAUTH_REQUEST, packet.type
+          assert verify_userauth_request_packet(packet, keys.last)
+          assert_equal "sig-two", packet.read_string
+          t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+        end
+      end
+
+      assert_equal false, subject.authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_true_if_any_key_can_authenticate
+      key_manager.expects(:sign).with(&signature_parameters(keys.first)).returns("sig-one")
+
+      transport.expect do |t, packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert verify_userauth_request_packet(packet, keys.first)
+        assert_equal "sig-one", packet.read_string
+        t.return(USERAUTH_SUCCESS)
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis")
+    end
+
+    private
+
+      def signature_parameters(key)
+        Proc.new do |given_key, data|
+          next false unless given_key.to_blob == key.to_blob
+          buffer = Net::SSH::Buffer.new(data)
+          buffer.read_string == "abcxyz123"      && # session-id
+          buffer.read_byte   == USERAUTH_REQUEST && # type
+          verify_userauth_request_packet(buffer, key)
+        end
+      end
+
+      def verify_userauth_request_packet(packet, key)
+        packet.read_string == "jamis"          && # user-name
+        packet.read_string == "ssh-connection" && # next service
+        packet.read_string == "hostbased"      && # auth-method
+        packet.read_string == key.ssh_type     && # key type
+        packet.read_buffer.read_key.to_blob == key.to_blob && # key
+        packet.read_string == "me.ssh.test."   && # client hostname
+        packet.read_string == "jamis"             # client username
+      end
+
+      @@keys = nil
+      def keys
+        @@keys ||= [OpenSSL::PKey::RSA.new(32), OpenSSL::PKey::DSA.new(32)]
+      end
+
+      def key_manager(options={})
+        @key_manager ||= stub("key_manager", :identities => options[:keys] || keys)
+      end
+
+      def subject(options={})
+        options[:key_manager] = key_manager(options) unless options.key?(:key_manager)
+        @subject ||= Net::SSH::Authentication::Methods::Hostbased.new(session(options), options)
+      end
+
+      def socket(options={})
+        @socket ||= stub("socket", :client_name => "me.ssh.test")
+      end
+
+      def transport(options={})
+        @transport ||= MockTransport.new(options.merge(:socket => socket))
+      end
+
+      def session(options={})
+        @session ||= begin
+          sess = stub("auth-session", :logger => nil, :transport => transport(options))
+          def sess.next_message
+            transport.next_message
+          end
+          sess
+        end
+      end
+
+  end
+
+end; end

data/test/authentication/methods/test_keyboard_interactive.rb

@@ -0,0 +1,98 @@
+require 'common'
+require 'net/ssh/authentication/methods/keyboard_interactive'
+require 'authentication/methods/common'
+
+module Authentication; module Methods
+
+  class TestKeyboardInteractive < Test::Unit::TestCase
+    include Common
+
+    USERAUTH_INFO_REQUEST  = 60
+    USERAUTH_INFO_RESPONSE = 61
+
+    def test_authenticate_should_be_false_when_server_does_not_support_this_method
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert_equal "jamis", packet.read_string
+        assert_equal "ssh-connection", packet.read_string
+        assert_equal "keyboard-interactive", packet.read_string
+        assert_equal "", packet.read_string # language tags
+        assert_equal "", packet.read_string # submethods
+
+        t.return(USERAUTH_FAILURE, :string, "password")
+      end
+
+      assert_equal false, subject.authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_be_false_if_given_password_is_not_accepted
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_INFO_REQUEST, :string, "", :string, "", :string, "", :long, 1, :string, "Password:", :bool, false)
+        t.expect do |t,packet|
+          assert_equal USERAUTH_INFO_RESPONSE, packet.type
+          assert_equal 1, packet.read_long
+          assert_equal "the-password", packet.read_string
+          t.return(USERAUTH_FAILURE, :string, "publickey")
+        end
+      end
+
+      assert_equal false, subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    def test_authenticate_should_be_true_if_given_password_is_accepted
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_INFO_REQUEST, :string, "", :string, "", :string, "", :long, 1, :string, "Password:", :bool, false)
+        t.expect do |t,packet|
+          assert_equal USERAUTH_INFO_RESPONSE, packet.type
+          t.return(USERAUTH_SUCCESS)
+        end
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    def test_authenticate_should_duplicate_password_as_needed_to_fill_request
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_INFO_REQUEST, :string, "", :string, "", :string, "", :long, 2, :string, "Password:", :bool, false, :string, "Again:", :bool, false)
+        t.expect do |t,packet|
+          assert_equal USERAUTH_INFO_RESPONSE, packet.type
+          assert_equal 2, packet.read_long
+          assert_equal "the-password", packet.read_string
+          assert_equal "the-password", packet.read_string
+          t.return(USERAUTH_SUCCESS)
+        end
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    def test_authenticate_should_prompt_for_input_when_password_is_not_given
+      subject.expects(:prompt).with("Name:", true).returns("name")
+      subject.expects(:prompt).with("Password:", false).returns("password")
+
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_INFO_REQUEST, :string, "", :string, "", :string, "", :long, 2, :string, "Name:", :bool, true, :string, "Password:", :bool, false)
+        t.expect do |t,packet|
+          assert_equal USERAUTH_INFO_RESPONSE, packet.type
+          assert_equal 2, packet.read_long
+          assert_equal "name", packet.read_string
+          assert_equal "password", packet.read_string
+          t.return(USERAUTH_SUCCESS)
+        end
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis", nil)
+    end
+
+    private
+
+      def subject(options={})
+        @subject ||= Net::SSH::Authentication::Methods::KeyboardInteractive.new(session(options), options)
+      end
+  end
+
+end; end

data/test/authentication/methods/test_password.rb

@@ -0,0 +1,50 @@
+require 'common'
+require 'net/ssh/authentication/methods/password'
+require 'authentication/methods/common'
+
+module Authentication; module Methods
+
+  class TestPassword < Test::Unit::TestCase
+    include Common
+
+    def test_authenticate_when_password_is_unacceptible_should_return_false
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert_equal "jamis", packet.read_string
+        assert_equal "ssh-connection", packet.read_string
+        assert_equal "password", packet.read_string
+        assert_equal false, packet.read_bool
+        assert_equal "the-password", packet.read_string
+
+        t.return(USERAUTH_FAILURE, :string, "publickey")
+      end
+
+      assert !subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    def test_authenticate_when_password_is_acceptible_should_return_true
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_SUCCESS)
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    def test_authenticate_should_return_false_if_password_change_request_is_received
+      transport.expect do |t,packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        t.return(USERAUTH_PASSWD_CHANGEREQ, :string, "Change your password:", :string, "")
+      end
+
+      assert !subject.authenticate("ssh-connection", "jamis", "the-password")
+    end
+
+    private
+
+      def subject(options={})
+        @subject ||= Net::SSH::Authentication::Methods::Password.new(session(options), options)
+      end
+  end
+
+end; end

data/test/authentication/methods/test_publickey.rb

@@ -0,0 +1,123 @@
+require 'common'
+require 'net/ssh/authentication/methods/publickey'
+require 'authentication/methods/common'
+
+module Authentication; module Methods
+
+  class TestPublickey < Test::Unit::TestCase
+    include Common
+
+    def test_authenticate_should_return_false_when_no_key_manager_has_been_set
+      assert_equal false, subject(:key_manager => nil).authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_false_when_key_manager_has_no_keys
+      assert_equal false, subject(:keys => []).authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_false_if_no_keys_can_authenticate
+      transport.expect do |t, packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert verify_userauth_request_packet(packet, keys.first, false)
+        t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+
+        t.expect do |t, packet|
+          assert_equal USERAUTH_REQUEST, packet.type
+          assert verify_userauth_request_packet(packet, keys.last, false)
+          t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+        end
+      end
+
+      assert_equal false, subject.authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_false_if_signature_exchange_fails
+      key_manager.expects(:sign).with(&signature_parameters(keys.first)).returns("sig-one")
+      key_manager.expects(:sign).with(&signature_parameters(keys.last)).returns("sig-two")
+
+      transport.expect do |t, packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert verify_userauth_request_packet(packet, keys.first, false)
+        t.return(USERAUTH_PK_OK, :string, keys.first.ssh_type, :string, Net::SSH::Buffer.from(:key, keys.first))
+
+        t.expect do |t,packet|
+          assert_equal USERAUTH_REQUEST, packet.type
+          assert verify_userauth_request_packet(packet, keys.first, true)
+          assert_equal "sig-one", packet.read_string
+          t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+
+          t.expect do |t, packet|
+            assert_equal USERAUTH_REQUEST, packet.type
+            assert verify_userauth_request_packet(packet, keys.last, false)
+            t.return(USERAUTH_PK_OK, :string, keys.last.ssh_type, :string, Net::SSH::Buffer.from(:key, keys.last))
+
+            t.expect do |t,packet|
+              assert_equal USERAUTH_REQUEST, packet.type
+              assert verify_userauth_request_packet(packet, keys.last, true)
+              assert_equal "sig-two", packet.read_string
+              t.return(USERAUTH_FAILURE, :string, "hostbased,password")
+            end
+          end
+        end
+      end
+
+      assert !subject.authenticate("ssh-connection", "jamis")
+    end
+
+    def test_authenticate_should_return_true_if_any_key_can_authenticate
+      key_manager.expects(:sign).with(&signature_parameters(keys.first)).returns("sig-one")
+
+      transport.expect do |t, packet|
+        assert_equal USERAUTH_REQUEST, packet.type
+        assert verify_userauth_request_packet(packet, keys.first, false)
+        t.return(USERAUTH_PK_OK, :string, keys.first.ssh_type, :string, Net::SSH::Buffer.from(:key, keys.first))
+
+        t.expect do |t,packet|
+          assert_equal USERAUTH_REQUEST, packet.type
+          assert verify_userauth_request_packet(packet, keys.first, true)
+          assert_equal "sig-one", packet.read_string
+          t.return(USERAUTH_SUCCESS)
+        end
+      end
+
+      assert subject.authenticate("ssh-connection", "jamis")
+    end
+
+    private
+
+      def signature_parameters(key)
+        Proc.new do |given_key, data|
+          next false unless given_key.to_blob == key.to_blob
+          buffer = Net::SSH::Buffer.new(data)
+          buffer.read_string == "abcxyz123"      && # session-id
+          buffer.read_byte   == USERAUTH_REQUEST && # type
+          verify_userauth_request_packet(buffer, key, true)
+        end
+      end
+
+      def verify_userauth_request_packet(packet, key, has_sig)
+        packet.read_string == "jamis"          && # user-name
+        packet.read_string == "ssh-connection" && # next service
+        packet.read_string == "publickey"      && # auth-method
+        packet.read_bool   == has_sig          && # whether a signature is appended
+        packet.read_string == key.ssh_type     && # ssh key type
+        packet.read_buffer.read_key.to_blob == key.to_blob # key
+      end
+
+      @@keys = nil
+      def keys
+        @@keys ||= [OpenSSL::PKey::RSA.new(32), OpenSSL::PKey::DSA.new(32)]
+      end
+
+      def key_manager(options={})
+        @key_manager ||= stub("key_manager", :identities => options[:keys] || keys)
+      end
+
+      def subject(options={})
+        options[:key_manager] = key_manager(options) unless options.key?(:key_manager)
+        @subject ||= Net::SSH::Authentication::Methods::Publickey.new(session(options), options)
+      end
+
+  end
+
+end; end