net-ssh-net-ssh 2.0.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. data/CHANGELOG.rdoc +137 -0
  2. data/Manifest +104 -0
  3. data/README.rdoc +110 -0
  4. data/Rakefile +79 -0
  5. data/THANKS.rdoc +16 -0
  6. data/lib/net/ssh.rb +215 -0
  7. data/lib/net/ssh/authentication/agent.rb +176 -0
  8. data/lib/net/ssh/authentication/constants.rb +18 -0
  9. data/lib/net/ssh/authentication/key_manager.rb +193 -0
  10. data/lib/net/ssh/authentication/methods/abstract.rb +60 -0
  11. data/lib/net/ssh/authentication/methods/hostbased.rb +71 -0
  12. data/lib/net/ssh/authentication/methods/keyboard_interactive.rb +66 -0
  13. data/lib/net/ssh/authentication/methods/password.rb +39 -0
  14. data/lib/net/ssh/authentication/methods/publickey.rb +92 -0
  15. data/lib/net/ssh/authentication/pageant.rb +183 -0
  16. data/lib/net/ssh/authentication/session.rb +134 -0
  17. data/lib/net/ssh/buffer.rb +340 -0
  18. data/lib/net/ssh/buffered_io.rb +149 -0
  19. data/lib/net/ssh/config.rb +181 -0
  20. data/lib/net/ssh/connection/channel.rb +625 -0
  21. data/lib/net/ssh/connection/constants.rb +33 -0
  22. data/lib/net/ssh/connection/session.rb +596 -0
  23. data/lib/net/ssh/connection/term.rb +178 -0
  24. data/lib/net/ssh/errors.rb +85 -0
  25. data/lib/net/ssh/key_factory.rb +102 -0
  26. data/lib/net/ssh/known_hosts.rb +129 -0
  27. data/lib/net/ssh/loggable.rb +61 -0
  28. data/lib/net/ssh/packet.rb +102 -0
  29. data/lib/net/ssh/prompt.rb +93 -0
  30. data/lib/net/ssh/proxy/errors.rb +14 -0
  31. data/lib/net/ssh/proxy/http.rb +94 -0
  32. data/lib/net/ssh/proxy/socks4.rb +70 -0
  33. data/lib/net/ssh/proxy/socks5.rb +129 -0
  34. data/lib/net/ssh/ruby_compat.rb +7 -0
  35. data/lib/net/ssh/service/forward.rb +267 -0
  36. data/lib/net/ssh/test.rb +89 -0
  37. data/lib/net/ssh/test/channel.rb +129 -0
  38. data/lib/net/ssh/test/extensions.rb +152 -0
  39. data/lib/net/ssh/test/kex.rb +44 -0
  40. data/lib/net/ssh/test/local_packet.rb +51 -0
  41. data/lib/net/ssh/test/packet.rb +81 -0
  42. data/lib/net/ssh/test/remote_packet.rb +38 -0
  43. data/lib/net/ssh/test/script.rb +157 -0
  44. data/lib/net/ssh/test/socket.rb +59 -0
  45. data/lib/net/ssh/transport/algorithms.rb +384 -0
  46. data/lib/net/ssh/transport/cipher_factory.rb +84 -0
  47. data/lib/net/ssh/transport/constants.rb +30 -0
  48. data/lib/net/ssh/transport/hmac.rb +31 -0
  49. data/lib/net/ssh/transport/hmac/abstract.rb +78 -0
  50. data/lib/net/ssh/transport/hmac/md5.rb +12 -0
  51. data/lib/net/ssh/transport/hmac/md5_96.rb +11 -0
  52. data/lib/net/ssh/transport/hmac/none.rb +15 -0
  53. data/lib/net/ssh/transport/hmac/sha1.rb +13 -0
  54. data/lib/net/ssh/transport/hmac/sha1_96.rb +11 -0
  55. data/lib/net/ssh/transport/identity_cipher.rb +55 -0
  56. data/lib/net/ssh/transport/kex.rb +13 -0
  57. data/lib/net/ssh/transport/kex/diffie_hellman_group1_sha1.rb +208 -0
  58. data/lib/net/ssh/transport/kex/diffie_hellman_group_exchange_sha1.rb +77 -0
  59. data/lib/net/ssh/transport/openssl.rb +128 -0
  60. data/lib/net/ssh/transport/packet_stream.rb +230 -0
  61. data/lib/net/ssh/transport/server_version.rb +69 -0
  62. data/lib/net/ssh/transport/session.rb +276 -0
  63. data/lib/net/ssh/transport/state.rb +206 -0
  64. data/lib/net/ssh/verifiers/lenient.rb +30 -0
  65. data/lib/net/ssh/verifiers/null.rb +12 -0
  66. data/lib/net/ssh/verifiers/strict.rb +53 -0
  67. data/lib/net/ssh/version.rb +62 -0
  68. data/net-ssh.gemspec +128 -0
  69. data/setup.rb +1585 -0
  70. data/test/authentication/methods/common.rb +28 -0
  71. data/test/authentication/methods/test_abstract.rb +51 -0
  72. data/test/authentication/methods/test_hostbased.rb +114 -0
  73. data/test/authentication/methods/test_keyboard_interactive.rb +98 -0
  74. data/test/authentication/methods/test_password.rb +50 -0
  75. data/test/authentication/methods/test_publickey.rb +127 -0
  76. data/test/authentication/test_agent.rb +205 -0
  77. data/test/authentication/test_key_manager.rb +105 -0
  78. data/test/authentication/test_session.rb +93 -0
  79. data/test/common.rb +106 -0
  80. data/test/configs/eqsign +3 -0
  81. data/test/configs/exact_match +8 -0
  82. data/test/configs/wild_cards +14 -0
  83. data/test/connection/test_channel.rb +452 -0
  84. data/test/connection/test_session.rb +488 -0
  85. data/test/test_all.rb +6 -0
  86. data/test/test_buffer.rb +336 -0
  87. data/test/test_buffered_io.rb +63 -0
  88. data/test/test_config.rb +84 -0
  89. data/test/test_key_factory.rb +67 -0
  90. data/test/transport/hmac/test_md5.rb +39 -0
  91. data/test/transport/hmac/test_md5_96.rb +25 -0
  92. data/test/transport/hmac/test_none.rb +34 -0
  93. data/test/transport/hmac/test_sha1.rb +34 -0
  94. data/test/transport/hmac/test_sha1_96.rb +25 -0
  95. data/test/transport/kex/test_diffie_hellman_group1_sha1.rb +146 -0
  96. data/test/transport/kex/test_diffie_hellman_group_exchange_sha1.rb +92 -0
  97. data/test/transport/test_algorithms.rb +302 -0
  98. data/test/transport/test_cipher_factory.rb +171 -0
  99. data/test/transport/test_hmac.rb +34 -0
  100. data/test/transport/test_identity_cipher.rb +40 -0
  101. data/test/transport/test_packet_stream.rb +435 -0
  102. data/test/transport/test_server_version.rb +68 -0
  103. data/test/transport/test_session.rb +315 -0
  104. data/test/transport/test_state.rb +173 -0
  105. metadata +162 -0
@@ -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
@@ -0,0 +1,81 @@
1
+ require 'net/ssh/connection/constants'
2
+ require 'net/ssh/transport/constants'
3
+
4
+ module Net; module SSH; module Test
5
+
6
+ # This is an abstract class, not to be instantiated directly, subclassed by
7
+ # Net::SSH::Test::LocalPacket and Net::SSH::Test::RemotePacket. It implements
8
+ # functionality common to those subclasses.
9
+ #
10
+ # These packets are not true packets, in that they don't represent what was
11
+ # actually sent between the hosst; rather, they represent what was expected
12
+ # to be sent, as dictated by the script (Net::SSH::Test::Script). Thus,
13
+ # though they are defined with data elements, these data elements are used
14
+ # to either validate data that was sent by the local host (Net::SSH::Test::LocalPacket)
15
+ # or to mimic the sending of data by the remote host (Net::SSH::Test::RemotePacket).
16
+ class Packet
17
+ include Net::SSH::Transport::Constants
18
+ include Net::SSH::Connection::Constants
19
+
20
+ # Ceate a new packet of the given +type+, and with +args+ being a list of
21
+ # data elements in the order expected for packets of the given +type+
22
+ # (see #types).
23
+ def initialize(type, *args)
24
+ @type = self.class.const_get(type.to_s.upcase)
25
+ @data = args
26
+ end
27
+
28
+ # The default for +remote?+ is false. Subclasses should override as necessary.
29
+ def remote?
30
+ false
31
+ end
32
+
33
+ # The default for +local?+ is false. Subclasses should override as necessary.
34
+ def local?
35
+ false
36
+ end
37
+
38
+ # Instantiates the packets data elements. When the packet was first defined,
39
+ # some elements may not have been fully realized, and were described as
40
+ # Proc objects rather than atomic types. This invokes those Proc objects
41
+ # and replaces them with their returned values. This allows for values
42
+ # like Net::SSH::Test::Channel#remote_id to be used in scripts before
43
+ # the remote_id is known (since it is only known after a channel has been
44
+ # confirmed open).
45
+ def instantiate!
46
+ @data.map! { |i| i.respond_to?(:call) ? i.call : i }
47
+ end
48
+
49
+ # Returns an array of symbols describing the data elements for packets of
50
+ # the same type as this packet. These types are used to either validate
51
+ # sent packets (Net::SSH::Test::LocalPacket) or build received packets
52
+ # (Net::SSH::Test::RemotePacket).
53
+ #
54
+ # Not all packet types are defined here. As new packet types are required
55
+ # (e.g., a unit test needs to test that the remote host sent a packet that
56
+ # is not implemented here), the description of that packet should be
57
+ # added. Unsupported packet types will otherwise raise an exception.
58
+ def types
59
+ @types ||= case @type
60
+ when KEXINIT then
61
+ [:long, :long, :long, :long,
62
+ :string, :string, :string, :string, :string, :string, :string, :string, :string, :string,
63
+ :bool]
64
+ when NEWKEYS then []
65
+ when CHANNEL_OPEN then [:string, :long, :long, :long]
66
+ when CHANNEL_OPEN_CONFIRMATION then [:long, :long, :long, :long]
67
+ when CHANNEL_DATA then [:long, :string]
68
+ when CHANNEL_EOF, CHANNEL_CLOSE, CHANNEL_SUCCESS, CHANNEL_FAILURE then [:long]
69
+ when CHANNEL_REQUEST
70
+ parts = [:long, :string, :bool]
71
+ case @data[1]
72
+ when "exec", "subsystem" then parts << :string
73
+ when "exit-status" then parts << :long
74
+ else raise "don't know what to do about #{@data[1]} channel request"
75
+ end
76
+ else raise "don't know how to parse packet type #{@type}"
77
+ end
78
+ end
79
+ end
80
+
81
+ end; end; end
@@ -0,0 +1,38 @@
1
+ require 'net/ssh/buffer'
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 received by the local (client) host. These are created
8
+ # automatically by Net::SSH::Test::Script and Net::SSH::Test::Channel by any
9
+ # of the gets_* methods.
10
+ class RemotePacket < Packet
11
+ # Returns +true+; this is a remote packet.
12
+ def remote?
13
+ true
14
+ end
15
+
16
+ # The #process method should only be called on Net::SSH::Test::LocalPacket
17
+ # packets; if it is attempted on a remote packet, then it is an expectation
18
+ # mismatch (a remote packet was received when a local packet was expected
19
+ # to be sent). This will happen when either your test script
20
+ # (Net::SSH::Test::Script) or your program are wrong.
21
+ def process(packet)
22
+ raise "received packet type #{packet.read_byte} and was not expecting any packet"
23
+ end
24
+
25
+ # Returns this remote packet as a string, suitable for parsing by
26
+ # Net::SSH::Transport::PacketStream and friends. When a remote packet is
27
+ # received, this method is called and the result concatenated onto the
28
+ # input buffer for the packet stream.
29
+ def to_s
30
+ @to_s ||= begin
31
+ instantiate!
32
+ string = Net::SSH::Buffer.from(:byte, @type, *types.zip(@data).flatten).to_s
33
+ [string.length, string].pack("NA*")
34
+ end
35
+ end
36
+ end
37
+
38
+ end; end; end
@@ -0,0 +1,157 @@
1
+ require 'net/ssh/test/channel'
2
+ require 'net/ssh/test/local_packet'
3
+ require 'net/ssh/test/remote_packet'
4
+
5
+ module Net; module SSH; module Test
6
+
7
+ # Represents a sequence of scripted events that identify the behavior that
8
+ # a test expects. Methods named "sends_*" create events for packets being
9
+ # sent from the local to the remote host, and methods named "gets_*" create
10
+ # events for packets being received by the local from the remote host.
11
+ #
12
+ # A reference to a script. is generally obtained in a unit test via the
13
+ # Net::SSH::Test#story helper method:
14
+ #
15
+ # story do |script|
16
+ # channel = script.opens_channel
17
+ # ...
18
+ # end
19
+ class Script
20
+ # The list of scripted events. These will be Net::SSH::Test::LocalPacket
21
+ # and Net::SSH::Test::RemotePacket instances.
22
+ attr_reader :events
23
+
24
+ # Create a new, empty script.
25
+ def initialize
26
+ @events = []
27
+ end
28
+
29
+ # Scripts the opening of a channel by adding a local packet sending the
30
+ # channel open request, and if +confirm+ is true (the default), also
31
+ # adding a remote packet confirming the new channel.
32
+ #
33
+ # A new Net::SSH::Test::Channel instance is returned, which can be used
34
+ # to script additional channel operations.
35
+ def opens_channel(confirm=true)
36
+ channel = Channel.new(self)
37
+ channel.remote_id = 5555
38
+
39
+ events << LocalPacket.new(:channel_open) { |p| channel.local_id = p[:remote_id] }
40
+
41
+ if confirm
42
+ events << RemotePacket.new(:channel_open_confirmation, channel.local_id, channel.remote_id, 0x20000, 0x10000)
43
+ end
44
+
45
+ channel
46
+ end
47
+
48
+ # A convenience method for adding an arbitrary local packet to the events
49
+ # list.
50
+ def sends(type, *args, &block)
51
+ events << LocalPacket.new(type, *args, &block)
52
+ end
53
+
54
+ # A convenience method for adding an arbitrary remote packet to the events
55
+ # list.
56
+ def gets(type, *args)
57
+ events << RemotePacket.new(type, *args)
58
+ end
59
+
60
+ # Scripts the sending of a new channel request packet to the remote host.
61
+ # +channel+ should be an instance of Net::SSH::Test::Channel. +request+
62
+ # is a string naming the request type to send, +reply+ is a boolean
63
+ # indicating whether a response to this packet is required , and +data+
64
+ # is any additional request-specific data that this packet should send.
65
+ # +success+ indicates whether the response (if one is required) should be
66
+ # success or failure.
67
+ #
68
+ # If a reply is desired, a remote packet will also be queued, :channel_success
69
+ # if +success+ is true, or :channel_failure if +success+ is false.
70
+ #
71
+ # This will typically be called via Net::SSH::Test::Channel#sends_exec or
72
+ # Net::SSH::Test::Channel#sends_subsystem.
73
+ def sends_channel_request(channel, request, reply, data, success=true)
74
+ events << LocalPacket.new(:channel_request, channel.remote_id, request, reply, data)
75
+ if reply
76
+ if success
77
+ events << RemotePacket.new(:channel_success, channel.local_id)
78
+ else
79
+ events << RemotePacket.new(:channel_failure, channel.local_id)
80
+ end
81
+ end
82
+ end
83
+
84
+ # Scripts the sending of a channel data packet. +channel+ must be a
85
+ # Net::SSH::Test::Channel object, and +data+ is the (string) data to
86
+ # expect will be sent.
87
+ #
88
+ # This will typically be called via Net::SSH::Test::Channel#sends_data.
89
+ def sends_channel_data(channel, data)
90
+ events << LocalPacket.new(:channel_data, channel.remote_id, data)
91
+ end
92
+
93
+ # Scripts the sending of a channel EOF packet from the given
94
+ # Net::SSH::Test::Channel +channel+. This will typically be called via
95
+ # Net::SSH::Test::Channel#sends_eof.
96
+ def sends_channel_eof(channel)
97
+ events << LocalPacket.new(:channel_eof, channel.remote_id)
98
+ end
99
+
100
+ # Scripts the sending of a channel close packet from the given
101
+ # Net::SSH::Test::Channel +channel+. This will typically be called via
102
+ # Net::SSH::Test::Channel#sends_close.
103
+ def sends_channel_close(channel)
104
+ events << LocalPacket.new(:channel_close, channel.remote_id)
105
+ end
106
+
107
+ # Scripts the reception of a channel data packet from the remote host by
108
+ # the given Net::SSH::Test::Channel +channel+. This will typically be
109
+ # called via Net::SSH::Test::Channel#gets_data.
110
+ def gets_channel_data(channel, data)
111
+ events << RemotePacket.new(:channel_data, channel.local_id, data)
112
+ end
113
+
114
+ # Scripts the reception of a channel request packet from the remote host by
115
+ # the given Net::SSH::Test::Channel +channel+. This will typically be
116
+ # called via Net::SSH::Test::Channel#gets_exit_status.
117
+ def gets_channel_request(channel, request, reply, data)
118
+ events << RemotePacket.new(:channel_request, channel.local_id, request, reply, data)
119
+ end
120
+
121
+ # Scripts the reception of a channel EOF packet from the remote host by
122
+ # the given Net::SSH::Test::Channel +channel+. This will typically be
123
+ # called via Net::SSH::Test::Channel#gets_eof.
124
+ def gets_channel_eof(channel)
125
+ events << RemotePacket.new(:channel_eof, channel.local_id)
126
+ end
127
+
128
+ # Scripts the reception of a channel close packet from the remote host by
129
+ # the given Net::SSH::Test::Channel +channel+. This will typically be
130
+ # called via Net::SSH::Test::Channel#gets_close.
131
+ def gets_channel_close(channel)
132
+ events << RemotePacket.new(:channel_close, channel.local_id)
133
+ end
134
+
135
+ # By default, removes the next event in the list and returns it. However,
136
+ # this can also be used to non-destructively peek at the next event in the
137
+ # list, by passing :first as the argument.
138
+ #
139
+ # # remove the next event and return it
140
+ # event = script.next
141
+ #
142
+ # # peek at the next event
143
+ # event = script.next(:first)
144
+ def next(mode=:shift)
145
+ events.send(mode)
146
+ end
147
+
148
+ # Compare the given packet against the next event in the list. If there is
149
+ # no next event, an exception will be raised. This is called by
150
+ # Net::SSH::Test::Extensions::PacketStream#test_enqueue_packet.
151
+ def process(packet)
152
+ event = events.shift or raise "end of script reached, but got a packet type #{packet.read_byte}"
153
+ event.process(packet)
154
+ end
155
+ end
156
+
157
+ end; end; end