net-ssh 1.1.4 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +37 -0
- data/Manifest +101 -0
- data/README.rdoc +110 -0
- data/Rakefile +26 -0
- data/{THANKS → THANKS.rdoc} +2 -5
- data/lib/net/ssh.rb +189 -57
- data/lib/net/ssh/authentication/agent.rb +175 -0
- data/lib/net/ssh/authentication/constants.rb +18 -0
- data/lib/net/ssh/authentication/key_manager.rb +166 -0
- data/lib/net/ssh/authentication/methods/abstract.rb +60 -0
- data/lib/net/ssh/authentication/methods/hostbased.rb +71 -0
- data/lib/net/ssh/authentication/methods/keyboard_interactive.rb +66 -0
- data/lib/net/ssh/authentication/methods/password.rb +39 -0
- data/lib/net/ssh/authentication/methods/publickey.rb +92 -0
- data/lib/net/ssh/authentication/pageant.rb +176 -0
- data/lib/net/ssh/authentication/session.rb +116 -0
- data/lib/net/ssh/buffer.rb +339 -0
- data/lib/net/ssh/buffered_io.rb +149 -0
- data/lib/net/ssh/config.rb +173 -0
- data/lib/net/ssh/connection/channel.rb +575 -454
- data/lib/net/ssh/connection/constants.rb +31 -45
- data/lib/net/ssh/connection/session.rb +569 -0
- data/lib/net/ssh/connection/term.rb +176 -88
- data/lib/net/ssh/errors.rb +83 -61
- data/lib/net/ssh/key_factory.rb +85 -0
- data/lib/net/ssh/known_hosts.rb +129 -0
- data/lib/net/ssh/loggable.rb +61 -0
- data/lib/net/ssh/packet.rb +102 -0
- data/lib/net/ssh/prompt.rb +93 -0
- data/lib/net/ssh/proxy/errors.rb +8 -28
- data/lib/net/ssh/proxy/http.rb +75 -107
- data/lib/net/ssh/proxy/socks4.rb +35 -48
- data/lib/net/ssh/proxy/socks5.rb +76 -108
- data/lib/net/ssh/service/forward.rb +267 -0
- data/lib/net/ssh/test.rb +89 -0
- data/lib/net/ssh/test/channel.rb +129 -0
- data/lib/net/ssh/test/extensions.rb +152 -0
- data/lib/net/ssh/test/kex.rb +44 -0
- data/lib/net/ssh/test/local_packet.rb +51 -0
- data/lib/net/ssh/test/packet.rb +81 -0
- data/lib/net/ssh/test/remote_packet.rb +38 -0
- data/lib/net/ssh/test/script.rb +157 -0
- data/lib/net/ssh/test/socket.rb +59 -0
- data/lib/net/ssh/transport/algorithms.rb +384 -0
- data/lib/net/ssh/transport/cipher_factory.rb +72 -0
- data/lib/net/ssh/transport/constants.rb +22 -58
- data/lib/net/ssh/transport/hmac.rb +31 -0
- data/lib/net/ssh/transport/hmac/abstract.rb +48 -0
- data/lib/net/ssh/transport/hmac/md5.rb +12 -0
- data/lib/net/ssh/transport/hmac/md5_96.rb +11 -0
- data/lib/net/ssh/transport/hmac/none.rb +15 -0
- data/lib/net/ssh/transport/hmac/sha1.rb +13 -0
- data/lib/net/ssh/transport/hmac/sha1_96.rb +11 -0
- data/lib/net/ssh/transport/identity_cipher.rb +40 -0
- data/lib/net/ssh/transport/kex.rb +13 -0
- data/lib/net/ssh/transport/kex/diffie_hellman_group1_sha1.rb +208 -0
- data/lib/net/ssh/transport/kex/diffie_hellman_group_exchange_sha1.rb +77 -0
- data/lib/net/ssh/{util → transport}/openssl.rb +22 -40
- data/lib/net/ssh/transport/packet_stream.rb +230 -0
- data/lib/net/ssh/transport/server_version.rb +61 -0
- data/lib/net/ssh/transport/session.rb +225 -303
- data/lib/net/ssh/transport/state.rb +170 -0
- data/lib/net/ssh/verifiers/lenient.rb +30 -0
- data/lib/net/ssh/verifiers/null.rb +12 -0
- data/lib/net/ssh/verifiers/strict.rb +53 -0
- data/lib/net/ssh/version.rb +57 -26
- data/net-ssh.gemspec +54 -0
- data/setup.rb +1585 -0
- data/test/authentication/methods/common.rb +28 -0
- data/test/authentication/methods/test_abstract.rb +51 -0
- data/test/authentication/methods/test_hostbased.rb +108 -0
- data/test/authentication/methods/test_keyboard_interactive.rb +98 -0
- data/test/authentication/methods/test_password.rb +50 -0
- data/test/authentication/methods/test_publickey.rb +123 -0
- data/test/authentication/test_agent.rb +205 -0
- data/test/authentication/test_key_manager.rb +100 -0
- data/test/authentication/test_session.rb +93 -0
- data/test/common.rb +106 -0
- data/test/configs/exact_match +8 -0
- data/test/configs/wild_cards +14 -0
- data/test/connection/test_channel.rb +452 -0
- data/test/connection/test_session.rb +483 -0
- data/test/test_all.rb +6 -0
- data/test/test_buffer.rb +336 -0
- data/test/test_buffered_io.rb +63 -0
- data/test/test_config.rb +78 -0
- data/test/test_key_factory.rb +67 -0
- data/test/transport/hmac/test_md5.rb +34 -0
- data/test/transport/hmac/test_md5_96.rb +25 -0
- data/test/transport/hmac/test_none.rb +34 -0
- data/test/transport/hmac/test_sha1.rb +34 -0
- data/test/transport/hmac/test_sha1_96.rb +25 -0
- data/test/transport/kex/test_diffie_hellman_group1_sha1.rb +146 -0
- data/test/transport/kex/test_diffie_hellman_group_exchange_sha1.rb +92 -0
- data/test/transport/test_algorithms.rb +302 -0
- data/test/transport/test_cipher_factory.rb +163 -0
- data/test/transport/test_hmac.rb +34 -0
- data/test/transport/test_identity_cipher.rb +40 -0
- data/test/transport/test_packet_stream.rb +433 -0
- data/test/transport/test_server_version.rb +55 -0
- data/test/transport/test_session.rb +312 -0
- data/test/transport/test_state.rb +173 -0
- metadata +102 -253
- data/ChangeLog +0 -560
- data/LICENSE +0 -7
- data/NEWS +0 -152
- data/README +0 -14
- data/bin/rb-keygen +0 -210
- data/doc/LICENSE-BSD +0 -27
- data/doc/LICENSE-GPL +0 -280
- data/doc/LICENSE-RUBY +0 -56
- data/doc/manual-html/chapter-1.html +0 -388
- data/doc/manual-html/chapter-2.html +0 -552
- data/doc/manual-html/chapter-3.html +0 -470
- data/doc/manual-html/chapter-4.html +0 -413
- data/doc/manual-html/chapter-5.html +0 -525
- data/doc/manual-html/chapter-6.html +0 -456
- data/doc/manual-html/chapter-7.html +0 -343
- data/doc/manual-html/index.html +0 -235
- data/doc/manual-html/stylesheets/manual.css +0 -270
- data/doc/manual-html/stylesheets/ruby.css +0 -17
- data/doc/manual/chapter.erb +0 -38
- data/doc/manual/example.erb +0 -18
- data/doc/manual/index.erb +0 -29
- data/doc/manual/manual.rb +0 -311
- data/doc/manual/manual.yml +0 -73
- data/doc/manual/page.erb +0 -87
- data/doc/manual/parts/0000.txt +0 -5
- data/doc/manual/parts/0001.txt +0 -3
- data/doc/manual/parts/0002.txt +0 -40
- data/doc/manual/parts/0003.txt +0 -6
- data/doc/manual/parts/0004.txt +0 -7
- data/doc/manual/parts/0005.txt +0 -1
- data/doc/manual/parts/0006.txt +0 -49
- data/doc/manual/parts/0007.txt +0 -67
- data/doc/manual/parts/0008.txt +0 -43
- data/doc/manual/parts/0009.txt +0 -14
- data/doc/manual/parts/0010.txt +0 -7
- data/doc/manual/parts/0011.txt +0 -14
- data/doc/manual/parts/0012.txt +0 -3
- data/doc/manual/parts/0013.txt +0 -20
- data/doc/manual/parts/0014.txt +0 -32
- data/doc/manual/parts/0015.txt +0 -14
- data/doc/manual/parts/0016.txt +0 -28
- data/doc/manual/parts/0017.txt +0 -50
- data/doc/manual/parts/0018.txt +0 -35
- data/doc/manual/parts/0019.txt +0 -7
- data/doc/manual/parts/0020.txt +0 -72
- data/doc/manual/parts/0021.txt +0 -50
- data/doc/manual/parts/0022.txt +0 -42
- data/doc/manual/parts/0023.txt +0 -51
- data/doc/manual/parts/0024.txt +0 -18
- data/doc/manual/parts/0025.txt +0 -18
- data/doc/manual/parts/0026.txt +0 -15
- data/doc/manual/parts/0027.txt +0 -37
- data/doc/manual/parts/0028.txt +0 -16
- data/doc/manual/parts/0029.txt +0 -1
- data/doc/manual/parts/0030.txt +0 -52
- data/doc/manual/parts/0031.txt +0 -25
- data/doc/manual/stylesheets/manual.css +0 -270
- data/doc/manual/stylesheets/ruby.css +0 -17
- data/doc/manual/tutorial.erb +0 -30
- data/examples/auth-forward.rb +0 -41
- data/examples/channel-demo.rb +0 -81
- data/examples/port-forward.rb +0 -51
- data/examples/process-demo.rb +0 -91
- data/examples/remote-net-port-forward.rb +0 -45
- data/examples/remote-port-forward.rb +0 -80
- data/examples/shell-demo.rb +0 -46
- data/examples/ssh-client.rb +0 -67
- data/examples/sync-shell-demo.rb +0 -69
- data/examples/tail-demo.rb +0 -49
- data/lib/net/ssh/connection/driver.rb +0 -446
- data/lib/net/ssh/connection/services.rb +0 -72
- data/lib/net/ssh/host-key-verifier.rb +0 -52
- data/lib/net/ssh/known-hosts.rb +0 -96
- data/lib/net/ssh/lenient-host-key-verifier.rb +0 -25
- data/lib/net/ssh/null-host-key-verifier.rb +0 -14
- data/lib/net/ssh/service/agentforward/driver.rb +0 -78
- data/lib/net/ssh/service/agentforward/services.rb +0 -41
- data/lib/net/ssh/service/forward/driver.rb +0 -319
- data/lib/net/ssh/service/forward/local-network-handler.rb +0 -71
- data/lib/net/ssh/service/forward/remote-network-handler.rb +0 -83
- data/lib/net/ssh/service/forward/services.rb +0 -76
- data/lib/net/ssh/service/process/driver.rb +0 -153
- data/lib/net/ssh/service/process/open.rb +0 -193
- data/lib/net/ssh/service/process/popen3.rb +0 -178
- data/lib/net/ssh/service/process/services.rb +0 -66
- data/lib/net/ssh/service/services.rb +0 -60
- data/lib/net/ssh/service/shell/driver.rb +0 -86
- data/lib/net/ssh/service/shell/services.rb +0 -54
- data/lib/net/ssh/service/shell/shell.rb +0 -222
- data/lib/net/ssh/service/shell/sync.rb +0 -114
- data/lib/net/ssh/session.rb +0 -305
- data/lib/net/ssh/transport/algorithm-negotiator.rb +0 -275
- data/lib/net/ssh/transport/compress/compressor.rb +0 -53
- data/lib/net/ssh/transport/compress/decompressor.rb +0 -53
- data/lib/net/ssh/transport/compress/none-compressor.rb +0 -39
- data/lib/net/ssh/transport/compress/none-decompressor.rb +0 -39
- data/lib/net/ssh/transport/compress/services.rb +0 -68
- data/lib/net/ssh/transport/compress/zlib-compressor.rb +0 -60
- data/lib/net/ssh/transport/compress/zlib-decompressor.rb +0 -52
- data/lib/net/ssh/transport/errors.rb +0 -47
- data/lib/net/ssh/transport/identity-cipher.rb +0 -61
- data/lib/net/ssh/transport/kex/dh-gex.rb +0 -106
- data/lib/net/ssh/transport/kex/dh.rb +0 -249
- data/lib/net/ssh/transport/kex/services.rb +0 -62
- data/lib/net/ssh/transport/ossl/buffer-factory.rb +0 -52
- data/lib/net/ssh/transport/ossl/buffer.rb +0 -87
- data/lib/net/ssh/transport/ossl/cipher-factory.rb +0 -98
- data/lib/net/ssh/transport/ossl/digest-factory.rb +0 -51
- data/lib/net/ssh/transport/ossl/hmac-factory.rb +0 -71
- data/lib/net/ssh/transport/ossl/hmac/hmac.rb +0 -62
- data/lib/net/ssh/transport/ossl/hmac/md5-96.rb +0 -44
- data/lib/net/ssh/transport/ossl/hmac/md5.rb +0 -46
- data/lib/net/ssh/transport/ossl/hmac/none.rb +0 -46
- data/lib/net/ssh/transport/ossl/hmac/services.rb +0 -68
- data/lib/net/ssh/transport/ossl/hmac/sha1-96.rb +0 -44
- data/lib/net/ssh/transport/ossl/hmac/sha1.rb +0 -45
- data/lib/net/ssh/transport/ossl/key-factory.rb +0 -116
- data/lib/net/ssh/transport/ossl/services.rb +0 -149
- data/lib/net/ssh/transport/packet-stream.rb +0 -236
- data/lib/net/ssh/transport/services.rb +0 -146
- data/lib/net/ssh/transport/version-negotiator.rb +0 -73
- data/lib/net/ssh/userauth/agent.rb +0 -222
- data/lib/net/ssh/userauth/constants.rb +0 -35
- data/lib/net/ssh/userauth/driver.rb +0 -183
- data/lib/net/ssh/userauth/methods/hostbased.rb +0 -119
- data/lib/net/ssh/userauth/methods/keyboard-interactive.rb +0 -104
- data/lib/net/ssh/userauth/methods/password.rb +0 -70
- data/lib/net/ssh/userauth/methods/publickey.rb +0 -137
- data/lib/net/ssh/userauth/methods/services.rb +0 -90
- data/lib/net/ssh/userauth/pageant.rb +0 -197
- data/lib/net/ssh/userauth/services.rb +0 -141
- data/lib/net/ssh/userauth/userkeys.rb +0 -258
- data/lib/net/ssh/util/buffer.rb +0 -274
- data/lib/net/ssh/util/prompter.rb +0 -73
- data/test/ALL-TESTS.rb +0 -18
- data/test/connection/tc_channel.rb +0 -136
- data/test/connection/tc_driver.rb +0 -287
- data/test/connection/tc_integration.rb +0 -87
- data/test/proxy/tc_http.rb +0 -209
- data/test/proxy/tc_socks4.rb +0 -148
- data/test/proxy/tc_socks5.rb +0 -214
- data/test/service/agentforward/tc_driver.rb +0 -138
- data/test/service/forward/tc_driver.rb +0 -289
- data/test/service/forward/tc_local_network_handler.rb +0 -123
- data/test/service/forward/tc_remote_network_handler.rb +0 -111
- data/test/service/process/tc_driver.rb +0 -79
- data/test/service/process/tc_integration.rb +0 -119
- data/test/service/process/tc_open.rb +0 -179
- data/test/service/process/tc_popen3.rb +0 -164
- data/test/tc_integration.rb +0 -80
- data/test/transport/compress/tc_none_compress.rb +0 -41
- data/test/transport/compress/tc_none_decompress.rb +0 -45
- data/test/transport/compress/tc_zlib_compress.rb +0 -61
- data/test/transport/compress/tc_zlib_decompress.rb +0 -48
- data/test/transport/kex/tc_dh.rb +0 -312
- data/test/transport/kex/tc_dh_gex.rb +0 -71
- data/test/transport/ossl/fixtures/dsa-encrypted +0 -15
- data/test/transport/ossl/fixtures/dsa-encrypted-bad +0 -15
- data/test/transport/ossl/fixtures/dsa-unencrypted +0 -12
- data/test/transport/ossl/fixtures/dsa-unencrypted-bad +0 -12
- data/test/transport/ossl/fixtures/dsa-unencrypted.pub +0 -1
- data/test/transport/ossl/fixtures/not-a-private-key +0 -4
- data/test/transport/ossl/fixtures/not-supported +0 -2
- data/test/transport/ossl/fixtures/rsa-encrypted +0 -18
- data/test/transport/ossl/fixtures/rsa-encrypted-bad +0 -18
- data/test/transport/ossl/fixtures/rsa-unencrypted +0 -15
- data/test/transport/ossl/fixtures/rsa-unencrypted-bad +0 -15
- data/test/transport/ossl/fixtures/rsa-unencrypted.pub +0 -1
- data/test/transport/ossl/hmac/tc_hmac.rb +0 -58
- data/test/transport/ossl/hmac/tc_md5.rb +0 -50
- data/test/transport/ossl/hmac/tc_md5_96.rb +0 -50
- data/test/transport/ossl/hmac/tc_none.rb +0 -50
- data/test/transport/ossl/hmac/tc_sha1.rb +0 -50
- data/test/transport/ossl/hmac/tc_sha1_96.rb +0 -50
- data/test/transport/ossl/tc_buffer.rb +0 -97
- data/test/transport/ossl/tc_buffer_factory.rb +0 -67
- data/test/transport/ossl/tc_cipher_factory.rb +0 -84
- data/test/transport/ossl/tc_digest_factory.rb +0 -39
- data/test/transport/ossl/tc_hmac_factory.rb +0 -72
- data/test/transport/ossl/tc_key_factory.rb +0 -199
- data/test/transport/tc_algorithm_negotiator.rb +0 -170
- data/test/transport/tc_identity_cipher.rb +0 -52
- data/test/transport/tc_integration.rb +0 -115
- data/test/transport/tc_packet_stream.rb +0 -184
- data/test/transport/tc_session.rb +0 -296
- data/test/transport/tc_version_negotiator.rb +0 -86
- data/test/userauth/methods/tc_hostbased.rb +0 -136
- data/test/userauth/methods/tc_password.rb +0 -89
- data/test/userauth/methods/tc_publickey.rb +0 -167
- data/test/userauth/tc_agent.rb +0 -223
- data/test/userauth/tc_driver.rb +0 -190
- data/test/userauth/tc_integration.rb +0 -97
- data/test/userauth/tc_userkeys.rb +0 -265
- data/test/util/tc_buffer.rb +0 -217
data/lib/net/ssh/test.rb
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
require 'net/ssh/transport/session'
|
2
|
+
require 'net/ssh/connection/session'
|
3
|
+
require 'net/ssh/test/kex'
|
4
|
+
require 'net/ssh/test/socket'
|
5
|
+
|
6
|
+
module Net; module SSH
|
7
|
+
|
8
|
+
# This module may be used in unit tests, for when you want to test that your
|
9
|
+
# SSH state machines are really doing what you expect they are doing. You will
|
10
|
+
# typically include this module in your unit test class, and then build a
|
11
|
+
# "story" of expected sends and receives:
|
12
|
+
#
|
13
|
+
# require 'test/unit'
|
14
|
+
# require 'net/ssh/test'
|
15
|
+
#
|
16
|
+
# class MyTest < Test::Unit::TestCase
|
17
|
+
# include Net::SSH::Test
|
18
|
+
#
|
19
|
+
# def test_exec_via_channel_works
|
20
|
+
# story do |session|
|
21
|
+
# channel = session.opens_channel
|
22
|
+
# channel.sends_exec "ls"
|
23
|
+
# channel.gets_data "result of ls"
|
24
|
+
# channel.gets_close
|
25
|
+
# channel.sends_close
|
26
|
+
# end
|
27
|
+
#
|
28
|
+
# assert_scripted do
|
29
|
+
# result = nil
|
30
|
+
#
|
31
|
+
# connection.open_channel do |ch|
|
32
|
+
# ch.exec("ls") do |success|
|
33
|
+
# ch.on_data { |c, data| result = data }
|
34
|
+
# ch.on_close { |c| c.close }
|
35
|
+
# end
|
36
|
+
# end
|
37
|
+
#
|
38
|
+
# connection.loop
|
39
|
+
# assert_equal "result of ls", result
|
40
|
+
# end
|
41
|
+
# end
|
42
|
+
# end
|
43
|
+
#
|
44
|
+
# See Net::SSH::Test::Channel and Net::SSH::Test::Script for more options.
|
45
|
+
#
|
46
|
+
# Note that the Net::SSH::Test system is rather finicky yet, and can be kind
|
47
|
+
# of frustrating to get working. Any suggestions for improvement will be
|
48
|
+
# welcome!
|
49
|
+
module Test
|
50
|
+
# If a block is given, yields the script for the test socket (#socket).
|
51
|
+
# Otherwise, simply returns the socket's script. See Net::SSH::Test::Script.
|
52
|
+
def story
|
53
|
+
yield socket.script if block_given?
|
54
|
+
return socket.script
|
55
|
+
end
|
56
|
+
|
57
|
+
# Returns the test socket instance to use for these tests (see
|
58
|
+
# Net::SSH::Test::Socket).
|
59
|
+
def socket(options={})
|
60
|
+
@socket ||= Net::SSH::Test::Socket.new
|
61
|
+
end
|
62
|
+
|
63
|
+
# Returns the connection session (Net::SSH::Connection::Session) for use
|
64
|
+
# in these tests. It is a fully functional SSH session, operating over
|
65
|
+
# a mock socket (#socket).
|
66
|
+
def connection(options={})
|
67
|
+
@connection ||= Net::SSH::Connection::Session.new(transport(options), options)
|
68
|
+
end
|
69
|
+
|
70
|
+
# Returns the transport session (Net::SSH::Transport::Session) for use
|
71
|
+
# in these tests. It is a fully functional SSH transport session, operating
|
72
|
+
# over a mock socket (#socket).
|
73
|
+
def transport(options={})
|
74
|
+
@transport ||= Net::SSH::Transport::Session.new(options[:host] || "localhost", options.merge(:kex => "test", :host_key => "ssh-rsa", :paranoid => false, :proxy => socket(options)))
|
75
|
+
end
|
76
|
+
|
77
|
+
# First asserts that a story has been described (see #story). Then yields,
|
78
|
+
# and then asserts that all items described in the script have been
|
79
|
+
# processed. Typically, this is called immediately after a story has
|
80
|
+
# been built, and the SSH commands being tested are then executed within
|
81
|
+
# the block passed to this assertion.
|
82
|
+
def assert_scripted
|
83
|
+
raise "there is no script to be processed" if socket.script.events.empty?
|
84
|
+
yield
|
85
|
+
assert socket.script.events.empty?, "there should not be any remaining scripted events, but there are still #{socket.script.events.length} pending"
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
end; end
|
@@ -0,0 +1,129 @@
|
|
1
|
+
module Net; module SSH; module Test
|
2
|
+
|
3
|
+
# A mock channel, used for scripting actions in tests. It wraps a
|
4
|
+
# Net::SSH::Test::Script instance, and delegates to it for the most part.
|
5
|
+
# This class has little real functionality on its own, but rather acts as
|
6
|
+
# a convenience for scripting channel-related activity for later comparison
|
7
|
+
# in a unit test.
|
8
|
+
#
|
9
|
+
# story do |session|
|
10
|
+
# channel = session.opens_channel
|
11
|
+
# channel.sends_exec "ls"
|
12
|
+
# channel.gets_data "result of ls"
|
13
|
+
# channel.gets_close
|
14
|
+
# channel.sends_close
|
15
|
+
# end
|
16
|
+
class Channel
|
17
|
+
# The Net::SSH::Test::Script instance employed by this mock channel.
|
18
|
+
attr_reader :script
|
19
|
+
|
20
|
+
# Sets the local-id of this channel object (the id assigned by the client).
|
21
|
+
attr_writer :local_id
|
22
|
+
|
23
|
+
# Sets the remote-id of this channel object (the id assigned by the mock-server).
|
24
|
+
attr_writer :remote_id
|
25
|
+
|
26
|
+
# Creates a new Test::Channel instance on top of the given +script+ (which
|
27
|
+
# must be a Net::SSH::Test::Script instance).
|
28
|
+
def initialize(script)
|
29
|
+
@script = script
|
30
|
+
@local_id = @remote_id = nil
|
31
|
+
end
|
32
|
+
|
33
|
+
# Returns the local (client-assigned) id for this channel, or a Proc object
|
34
|
+
# that will return the local-id later if the local id has not yet been set.
|
35
|
+
# (See Net::SSH::Test::Packet#instantiate!.)
|
36
|
+
def local_id
|
37
|
+
@local_id || Proc.new { @local_id or raise "local-id has not been set yet!" }
|
38
|
+
end
|
39
|
+
|
40
|
+
# Returns the remote (server-assigned) id for this channel, or a Proc object
|
41
|
+
# that will return the remote-id later if the remote id has not yet been set.
|
42
|
+
# (See Net::SSH::Test::Packet#instantiate!.)
|
43
|
+
def remote_id
|
44
|
+
@remote_id || Proc.new { @remote_id or raise "remote-id has not been set yet!" }
|
45
|
+
end
|
46
|
+
|
47
|
+
# Because adjacent calls to #gets_data will sometimes cause the data packets
|
48
|
+
# to be concatenated (causing expectations in tests to fail), you may
|
49
|
+
# need to separate those calls with calls to #inject_remote_delay! (which
|
50
|
+
# essentially just mimics receiving an empty data packet):
|
51
|
+
#
|
52
|
+
# channel.gets_data "abcdefg"
|
53
|
+
# channel.inject_remote_delay!
|
54
|
+
# channel.gets_data "hijklmn"
|
55
|
+
def inject_remote_delay!
|
56
|
+
gets_data("")
|
57
|
+
end
|
58
|
+
|
59
|
+
# Scripts the sending of an "exec" channel request packet to the mock
|
60
|
+
# server. If +reply+ is true, then the server is expected to reply to the
|
61
|
+
# request, otherwise no response to this request will be sent. If +success+
|
62
|
+
# is +true+, then the request will be successful, otherwise a failure will
|
63
|
+
# be scripted.
|
64
|
+
#
|
65
|
+
# channel.sends_exec "ls -l"
|
66
|
+
def sends_exec(command, reply=true, success=true)
|
67
|
+
script.sends_channel_request(self, "exec", reply, command, success)
|
68
|
+
end
|
69
|
+
|
70
|
+
# Scripts the sending of a "subsystem" channel request packet to the mock
|
71
|
+
# server. See #sends_exec for a discussion of the meaning of the +reply+
|
72
|
+
# and +success+ arguments.
|
73
|
+
#
|
74
|
+
# channel.sends_subsystem "sftp"
|
75
|
+
def sends_subsystem(subsystem, reply=true, success=true)
|
76
|
+
script.sends_channel_request(self, "subsystem", reply, subsystem, success)
|
77
|
+
end
|
78
|
+
|
79
|
+
# Scripts the sending of a data packet across the channel.
|
80
|
+
#
|
81
|
+
# channel.sends_data "foo"
|
82
|
+
def sends_data(data)
|
83
|
+
script.sends_channel_data(self, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# Scripts the sending of an EOF packet across the channel.
|
87
|
+
#
|
88
|
+
# channel.sends_eof
|
89
|
+
def sends_eof
|
90
|
+
script.sends_channel_eof(self)
|
91
|
+
end
|
92
|
+
|
93
|
+
# Scripts the sending of a "channel close" packet across the channel.
|
94
|
+
#
|
95
|
+
# channel.sends_close
|
96
|
+
def sends_close
|
97
|
+
script.sends_channel_close(self)
|
98
|
+
end
|
99
|
+
|
100
|
+
# Scripts the reception of a channel data packet from the remote end.
|
101
|
+
#
|
102
|
+
# channel.gets_data "bar"
|
103
|
+
def gets_data(data)
|
104
|
+
script.gets_channel_data(self, data)
|
105
|
+
end
|
106
|
+
|
107
|
+
# Scripts the reception of an "exit-status" channel request packet.
|
108
|
+
#
|
109
|
+
# channel.gets_exit_status(127)
|
110
|
+
def gets_exit_status(status=0)
|
111
|
+
script.gets_channel_request(self, "exit-status", false, status)
|
112
|
+
end
|
113
|
+
|
114
|
+
# Scripts the reception of an EOF packet from the remote end.
|
115
|
+
#
|
116
|
+
# channel.gets_eof
|
117
|
+
def gets_eof
|
118
|
+
script.gets_channel_eof(self)
|
119
|
+
end
|
120
|
+
|
121
|
+
# Scripts the reception of a "channel close" packet from the remote end.
|
122
|
+
#
|
123
|
+
# channel.gets_close
|
124
|
+
def gets_close
|
125
|
+
script.gets_channel_close(self)
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
end; end; end
|
@@ -0,0 +1,152 @@
|
|
1
|
+
require 'net/ssh/buffer'
|
2
|
+
require 'net/ssh/packet'
|
3
|
+
require 'net/ssh/buffered_io'
|
4
|
+
require 'net/ssh/connection/channel'
|
5
|
+
require 'net/ssh/connection/constants'
|
6
|
+
require 'net/ssh/transport/constants'
|
7
|
+
require 'net/ssh/transport/packet_stream'
|
8
|
+
|
9
|
+
module Net; module SSH; module Test
|
10
|
+
|
11
|
+
# A collection of modules used to extend/override the default behavior of
|
12
|
+
# Net::SSH internals for ease of testing. As a consumer of Net::SSH, you'll
|
13
|
+
# never need to use this directly--they're all used under the covers by
|
14
|
+
# the Net::SSH::Test system.
|
15
|
+
module Extensions
|
16
|
+
|
17
|
+
# An extension to Net::SSH::BufferedIo (assumes that the underlying IO
|
18
|
+
# is actually a StringIO). Facilitates unit testing.
|
19
|
+
module BufferedIo
|
20
|
+
# Returns +true+ if the position in the stream is less than the total
|
21
|
+
# length of the stream.
|
22
|
+
def select_for_read?
|
23
|
+
pos < size
|
24
|
+
end
|
25
|
+
|
26
|
+
# Set this to +true+ if you want the IO to pretend to be available for writing
|
27
|
+
attr_accessor :select_for_write
|
28
|
+
|
29
|
+
# Set this to +true+ if you want the IO to pretend to be in an error state
|
30
|
+
attr_accessor :select_for_error
|
31
|
+
|
32
|
+
alias select_for_write? select_for_write
|
33
|
+
alias select_for_error? select_for_error
|
34
|
+
end
|
35
|
+
|
36
|
+
# An extension to Net::SSH::Transport::PacketStream (assumes that the
|
37
|
+
# underlying IO is actually a StringIO). Facilitates unit testing.
|
38
|
+
module PacketStream
|
39
|
+
include BufferedIo # make sure we get the extensions here, too
|
40
|
+
|
41
|
+
def self.included(base) #:nodoc:
|
42
|
+
base.send :alias_method, :real_available_for_read?, :available_for_read?
|
43
|
+
base.send :alias_method, :available_for_read?, :test_available_for_read?
|
44
|
+
|
45
|
+
base.send :alias_method, :real_enqueue_packet, :enqueue_packet
|
46
|
+
base.send :alias_method, :enqueue_packet, :test_enqueue_packet
|
47
|
+
|
48
|
+
base.send :alias_method, :real_poll_next_packet, :poll_next_packet
|
49
|
+
base.send :alias_method, :poll_next_packet, :test_poll_next_packet
|
50
|
+
end
|
51
|
+
|
52
|
+
# Called when another packet should be inspected from the current
|
53
|
+
# script. If the next packet is a remote packet, it pops it off the
|
54
|
+
# script and shoves it onto this IO object, making it available to
|
55
|
+
# be read.
|
56
|
+
def idle!
|
57
|
+
return false unless script.next(:first)
|
58
|
+
|
59
|
+
if script.next(:first).remote?
|
60
|
+
self.string << script.next.to_s
|
61
|
+
self.pos = pos
|
62
|
+
end
|
63
|
+
|
64
|
+
return true
|
65
|
+
end
|
66
|
+
|
67
|
+
# The testing version of Net::SSH::Transport::PacketStream#available_for_read?.
|
68
|
+
# Returns true if there is data pending to be read. Otherwise calls #idle!.
|
69
|
+
def test_available_for_read?
|
70
|
+
return true if select_for_read?
|
71
|
+
idle!
|
72
|
+
false
|
73
|
+
end
|
74
|
+
|
75
|
+
# The testing version of Net::SSH::Transport::PacketStream#enqueued_packet.
|
76
|
+
# Simply calls Net::SSH::Test::Script#process on the packet.
|
77
|
+
def test_enqueue_packet(payload)
|
78
|
+
packet = Net::SSH::Buffer.new(payload.to_s)
|
79
|
+
script.process(packet)
|
80
|
+
end
|
81
|
+
|
82
|
+
# The testing version of Net::SSH::Transport::PacketStream#poll_next_packet.
|
83
|
+
# Reads the next available packet from the IO object and returns it.
|
84
|
+
def test_poll_next_packet
|
85
|
+
return nil if available <= 0
|
86
|
+
packet = Net::SSH::Buffer.new(read_available(4))
|
87
|
+
length = packet.read_long
|
88
|
+
Net::SSH::Packet.new(read_available(length))
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
# An extension to Net::SSH::Connection::Channel. Facilitates unit testing.
|
93
|
+
module Channel
|
94
|
+
def self.included(base) #:nodoc:
|
95
|
+
base.send :alias_method, :send_data_for_real, :send_data
|
96
|
+
base.send :alias_method, :send_data, :send_data_for_test
|
97
|
+
end
|
98
|
+
|
99
|
+
# The testing version of Net::SSH::Connection::Channel#send_data. Calls
|
100
|
+
# the original implementation, and then immediately enqueues the data for
|
101
|
+
# output so that scripted sends are properly interpreted as discrete
|
102
|
+
# (rather than concatenated) data packets.
|
103
|
+
def send_data_for_test(data)
|
104
|
+
send_data_for_real(data)
|
105
|
+
enqueue_pending_output
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
# An extension to the built-in ::IO class. Simply redefines IO.select
|
110
|
+
# so that it can be scripted in Net::SSH unit tests.
|
111
|
+
module IO
|
112
|
+
def self.included(base) #:nodoc:
|
113
|
+
base.extend(ClassMethods)
|
114
|
+
end
|
115
|
+
|
116
|
+
module ClassMethods
|
117
|
+
def self.extended(obj) #:nodoc:
|
118
|
+
class <<obj
|
119
|
+
alias_method :select_for_real, :select
|
120
|
+
alias_method :select, :select_for_test
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
# The testing version of ::IO.select. Assumes that all readers,
|
125
|
+
# writers, and errors arrays are either nil, or contain only objects
|
126
|
+
# that mix in Net::SSH::Test::Extensions::BufferedIo.
|
127
|
+
def select_for_test(readers=nil, writers=nil, errors=nil, wait=nil)
|
128
|
+
ready_readers = Array(readers).select { |r| r.select_for_read? }
|
129
|
+
ready_writers = Array(writers).select { |r| r.select_for_write? }
|
130
|
+
ready_errors = Array(errors).select { |r| r.select_for_error? }
|
131
|
+
|
132
|
+
if ready_readers.any? || ready_writers.any? || ready_errors.any?
|
133
|
+
return [ready_readers, ready_writers, ready_errors]
|
134
|
+
end
|
135
|
+
|
136
|
+
processed = 0
|
137
|
+
Array(readers).each do |reader|
|
138
|
+
processed += 1 if reader.idle!
|
139
|
+
end
|
140
|
+
|
141
|
+
raise "no readers were ready for reading, and none had any incoming packets" if processed == 0
|
142
|
+
end
|
143
|
+
end
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
end; end; end
|
148
|
+
|
149
|
+
Net::SSH::BufferedIo.send(:include, Net::SSH::Test::Extensions::BufferedIo)
|
150
|
+
Net::SSH::Transport::PacketStream.send(:include, Net::SSH::Test::Extensions::PacketStream)
|
151
|
+
Net::SSH::Connection::Channel.send(:include, Net::SSH::Test::Extensions::Channel)
|
152
|
+
IO.send(:include, Net::SSH::Test::Extensions::IO)
|
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'openssl'
|
2
|
+
|
3
|
+
require 'net/ssh/errors'
|
4
|
+
require 'net/ssh/transport/algorithms'
|
5
|
+
require 'net/ssh/transport/constants'
|
6
|
+
require 'net/ssh/transport/kex'
|
7
|
+
|
8
|
+
module Net; module SSH; module Test
|
9
|
+
|
10
|
+
# An implementation of a key-exchange strategy specifically for unit tests.
|
11
|
+
# (This strategy would never really work against a real SSH server--it makes
|
12
|
+
# too many assumptions about the server's response.)
|
13
|
+
#
|
14
|
+
# This registers itself with the transport key-exchange system as the
|
15
|
+
# "test" algorithm.
|
16
|
+
class Kex
|
17
|
+
include Net::SSH::Transport::Constants
|
18
|
+
|
19
|
+
# Creates a new instance of the testing key-exchange algorithm with the
|
20
|
+
# given arguments.
|
21
|
+
def initialize(algorithms, connection, data)
|
22
|
+
@connection = connection
|
23
|
+
end
|
24
|
+
|
25
|
+
# Exchange keys with the server. This returns a hash of constant values,
|
26
|
+
# and does not actually exchange keys.
|
27
|
+
def exchange_keys
|
28
|
+
result = Net::SSH::Buffer.from(:byte, NEWKEYS)
|
29
|
+
@connection.send_message(result)
|
30
|
+
|
31
|
+
buffer = @connection.next_message
|
32
|
+
raise Net::SSH::Exception, "expected NEWKEYS" unless buffer.type == NEWKEYS
|
33
|
+
|
34
|
+
{ :session_id => "abc-xyz",
|
35
|
+
:server_key => OpenSSL::PKey::RSA.new(32),
|
36
|
+
:shared_secret => OpenSSL::BN.new("1234567890", 10),
|
37
|
+
:hashing_algorithm => OpenSSL::Digest::SHA1 }
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
end; end; end
|
42
|
+
|
43
|
+
Net::SSH::Transport::Algorithms::ALGORITHMS[:kex] << "test"
|
44
|
+
Net::SSH::Transport::Kex::MAP["test"] = Net::SSH::Test::Kex
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require 'net/ssh/packet'
|
2
|
+
require 'net/ssh/test/packet'
|
3
|
+
|
4
|
+
module Net; module SSH; module Test
|
5
|
+
|
6
|
+
# This is a specialization of Net::SSH::Test::Packet for representing mock
|
7
|
+
# packets that are sent from the local (client) host. These are created
|
8
|
+
# automatically by Net::SSH::Test::Script and Net::SSH::Test::Channel by any
|
9
|
+
# of the sends_* methods.
|
10
|
+
class LocalPacket < Packet
|
11
|
+
attr_reader :init
|
12
|
+
|
13
|
+
# Extend the default Net::SSH::Test::Packet constructor to also accept an
|
14
|
+
# optional block, which is used to finalize the initialization of the
|
15
|
+
# packet when #process is first called.
|
16
|
+
def initialize(type, *args, &block)
|
17
|
+
super(type, *args)
|
18
|
+
@init = block
|
19
|
+
end
|
20
|
+
|
21
|
+
# Returns +true+; this is a local packet.
|
22
|
+
def local?
|
23
|
+
true
|
24
|
+
end
|
25
|
+
|
26
|
+
# Called by Net::SSH::Test::Extensions::PacketStream#test_enqueue_packet
|
27
|
+
# to mimic remote processing of a locally-sent packet. It compares the
|
28
|
+
# packet it was given with the contents of this LocalPacket's data, to see
|
29
|
+
# if what was sent matches what was scripted. If it differs in any way,
|
30
|
+
# an exception is raised.
|
31
|
+
def process(packet)
|
32
|
+
@init.call(Net::SSH::Packet.new(packet.to_s)) if @init
|
33
|
+
type = packet.read_byte
|
34
|
+
raise "expected #{@type}, but got #{type}" if @type != type
|
35
|
+
|
36
|
+
@data.zip(types).each do |expected, type|
|
37
|
+
type ||= case expected
|
38
|
+
when nil then break
|
39
|
+
when Numeric then :long
|
40
|
+
when String then :string
|
41
|
+
when TrueClass, FalseClass then :bool
|
42
|
+
end
|
43
|
+
|
44
|
+
actual = packet.send("read_#{type}")
|
45
|
+
next if expected.nil?
|
46
|
+
raise "expected #{type} #{expected.inspect} but got #{actual.inspect}" unless expected == actual
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
end; end; end
|