net-ssh-net-ssh 2.0.12
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +137 -0
- data/Manifest +104 -0
- data/README.rdoc +110 -0
- data/Rakefile +79 -0
- data/THANKS.rdoc +16 -0
- data/lib/net/ssh.rb +215 -0
- data/lib/net/ssh/authentication/agent.rb +176 -0
- data/lib/net/ssh/authentication/constants.rb +18 -0
- data/lib/net/ssh/authentication/key_manager.rb +193 -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 +183 -0
- data/lib/net/ssh/authentication/session.rb +134 -0
- data/lib/net/ssh/buffer.rb +340 -0
- data/lib/net/ssh/buffered_io.rb +149 -0
- data/lib/net/ssh/config.rb +181 -0
- data/lib/net/ssh/connection/channel.rb +625 -0
- data/lib/net/ssh/connection/constants.rb +33 -0
- data/lib/net/ssh/connection/session.rb +596 -0
- data/lib/net/ssh/connection/term.rb +178 -0
- data/lib/net/ssh/errors.rb +85 -0
- data/lib/net/ssh/key_factory.rb +102 -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 +14 -0
- data/lib/net/ssh/proxy/http.rb +94 -0
- data/lib/net/ssh/proxy/socks4.rb +70 -0
- data/lib/net/ssh/proxy/socks5.rb +129 -0
- data/lib/net/ssh/ruby_compat.rb +7 -0
- 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 +84 -0
- data/lib/net/ssh/transport/constants.rb +30 -0
- data/lib/net/ssh/transport/hmac.rb +31 -0
- data/lib/net/ssh/transport/hmac/abstract.rb +78 -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 +55 -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/transport/openssl.rb +128 -0
- data/lib/net/ssh/transport/packet_stream.rb +230 -0
- data/lib/net/ssh/transport/server_version.rb +69 -0
- data/lib/net/ssh/transport/session.rb +276 -0
- data/lib/net/ssh/transport/state.rb +206 -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 +62 -0
- data/net-ssh.gemspec +128 -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 +114 -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 +127 -0
- data/test/authentication/test_agent.rb +205 -0
- data/test/authentication/test_key_manager.rb +105 -0
- data/test/authentication/test_session.rb +93 -0
- data/test/common.rb +106 -0
- data/test/configs/eqsign +3 -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 +488 -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 +84 -0
- data/test/test_key_factory.rb +67 -0
- data/test/transport/hmac/test_md5.rb +39 -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 +171 -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 +435 -0
- data/test/transport/test_server_version.rb +68 -0
- data/test/transport/test_session.rb +315 -0
- data/test/transport/test_state.rb +173 -0
- metadata +162 -0
@@ -0,0 +1,267 @@
|
|
1
|
+
require 'net/ssh/loggable'
|
2
|
+
|
3
|
+
module Net; module SSH; module Service
|
4
|
+
|
5
|
+
# This class implements various port forwarding services for use by
|
6
|
+
# Net::SSH clients. The Forward class should never need to be instantiated
|
7
|
+
# directly; instead, it should be accessed via the singleton instance
|
8
|
+
# returned by Connection::Session#forward:
|
9
|
+
#
|
10
|
+
# ssh.forward.local(1234, "www.capify.org", 80)
|
11
|
+
class Forward
|
12
|
+
include Loggable
|
13
|
+
|
14
|
+
# The underlying connection service instance that the port-forwarding
|
15
|
+
# services employ.
|
16
|
+
attr_reader :session
|
17
|
+
|
18
|
+
# A simple class for representing a requested remote forwarded port.
|
19
|
+
Remote = Struct.new(:host, :port) #:nodoc:
|
20
|
+
|
21
|
+
# Instantiates a new Forward service instance atop the given connection
|
22
|
+
# service session. This will register new channel open handlers to handle
|
23
|
+
# the specialized channels that the SSH port forwarding protocols employ.
|
24
|
+
def initialize(session)
|
25
|
+
@session = session
|
26
|
+
self.logger = session.logger
|
27
|
+
@remote_forwarded_ports = {}
|
28
|
+
@local_forwarded_ports = {}
|
29
|
+
@agent_forwarded = false
|
30
|
+
|
31
|
+
session.on_open_channel('forwarded-tcpip', &method(:forwarded_tcpip))
|
32
|
+
session.on_open_channel('auth-agent', &method(:auth_agent_channel))
|
33
|
+
session.on_open_channel('auth-agent@openssh.com', &method(:auth_agent_channel))
|
34
|
+
end
|
35
|
+
|
36
|
+
# Starts listening for connections on the local host, and forwards them
|
37
|
+
# to the specified remote host/port via the SSH connection. This method
|
38
|
+
# accepts either three or four arguments. When four arguments are given,
|
39
|
+
# they are:
|
40
|
+
#
|
41
|
+
# * the local address to bind to
|
42
|
+
# * the local port to listen on
|
43
|
+
# * the remote host to forward connections to
|
44
|
+
# * the port on the remote host to connect to
|
45
|
+
#
|
46
|
+
# If three arguments are given, it is as if the local bind address is
|
47
|
+
# "127.0.0.1", and the rest are applied as above.
|
48
|
+
#
|
49
|
+
# ssh.forward.local(1234, "www.capify.org", 80)
|
50
|
+
# ssh.forward.local("0.0.0.0", 1234, "www.capify.org", 80)
|
51
|
+
def local(*args)
|
52
|
+
if args.length < 3 || args.length > 4
|
53
|
+
raise ArgumentError, "expected 3 or 4 parameters, got #{args.length}"
|
54
|
+
end
|
55
|
+
|
56
|
+
bind_address = "127.0.0.1"
|
57
|
+
bind_address = args.shift if args.first.is_a?(String) && args.first =~ /\D/
|
58
|
+
|
59
|
+
local_port = args.shift.to_i
|
60
|
+
remote_host = args.shift
|
61
|
+
remote_port = args.shift.to_i
|
62
|
+
|
63
|
+
socket = TCPServer.new(bind_address, local_port)
|
64
|
+
|
65
|
+
@local_forwarded_ports[[local_port, bind_address]] = socket
|
66
|
+
|
67
|
+
session.listen_to(socket) do |server|
|
68
|
+
client = server.accept
|
69
|
+
debug { "received connection on #{bind_address}:#{local_port}" }
|
70
|
+
|
71
|
+
channel = session.open_channel("direct-tcpip", :string, remote_host, :long, remote_port, :string, bind_address, :long, local_port) do |achannel|
|
72
|
+
achannel.info { "direct channel established" }
|
73
|
+
end
|
74
|
+
|
75
|
+
prepare_client(client, channel, :local)
|
76
|
+
|
77
|
+
channel.on_open_failed do |ch, code, description|
|
78
|
+
channel.error { "could not establish direct channel: #{description} (#{code})" }
|
79
|
+
channel[:socket].close
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# Terminates an active local forwarded port. If no such forwarded port
|
85
|
+
# exists, this will raise an exception. Otherwise, the forwarded connection
|
86
|
+
# is terminated.
|
87
|
+
#
|
88
|
+
# ssh.forward.cancel_local(1234)
|
89
|
+
# ssh.forward.cancel_local(1234, "0.0.0.0")
|
90
|
+
def cancel_local(port, bind_address="127.0.0.1")
|
91
|
+
socket = @local_forwarded_ports.delete([port, bind_address])
|
92
|
+
socket.shutdown rescue nil
|
93
|
+
socket.close rescue nil
|
94
|
+
session.stop_listening_to(socket)
|
95
|
+
end
|
96
|
+
|
97
|
+
# Returns a list of all active locally forwarded ports. The returned value
|
98
|
+
# is an array of arrays, where each element is a two-element tuple
|
99
|
+
# consisting of the local port and bind address corresponding to the
|
100
|
+
# forwarding port.
|
101
|
+
def active_locals
|
102
|
+
@local_forwarded_ports.keys
|
103
|
+
end
|
104
|
+
|
105
|
+
# Requests that all connections on the given remote-port be forwarded via
|
106
|
+
# the local host to the given port/host. The last argument describes the
|
107
|
+
# bind address on the remote host, and defaults to 127.0.0.1.
|
108
|
+
#
|
109
|
+
# This method will return immediately, but the port will not actually be
|
110
|
+
# forwarded immediately. If the remote server is not able to begin the
|
111
|
+
# listener for this request, an exception will be raised asynchronously.
|
112
|
+
#
|
113
|
+
# If you want to know when the connection is active, it will show up in the
|
114
|
+
# #active_remotes list. If you want to block until the port is active, you
|
115
|
+
# could do something like this:
|
116
|
+
#
|
117
|
+
# ssh.forward.remote(80, "www.google.com", 1234, "0.0.0.0")
|
118
|
+
# ssh.loop { !ssh.forward.active_remotes.include?([1234, "0.0.0.0"]) }
|
119
|
+
def remote(port, host, remote_port, remote_host="127.0.0.1")
|
120
|
+
session.send_global_request("tcpip-forward", :string, remote_host, :long, remote_port) do |success, response|
|
121
|
+
if success
|
122
|
+
debug { "remote forward from remote #{remote_host}:#{remote_port} to #{host}:#{port} established" }
|
123
|
+
@remote_forwarded_ports[[remote_port, remote_host]] = Remote.new(host, port)
|
124
|
+
else
|
125
|
+
error { "remote forwarding request failed" }
|
126
|
+
raise Net::SSH::Exception, "remote forwarding request failed"
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
# an alias, for token backwards compatibility with the 1.x API
|
132
|
+
alias :remote_to :remote
|
133
|
+
|
134
|
+
# Requests that a remote forwarded port be cancelled. The remote forwarded
|
135
|
+
# port on the remote host, bound to the given address on the remote host,
|
136
|
+
# will be terminated, but not immediately. This method returns immediately
|
137
|
+
# after queueing the request to be sent to the server. If for some reason
|
138
|
+
# the port cannot be cancelled, an exception will be raised (asynchronously).
|
139
|
+
#
|
140
|
+
# If you want to know when the connection has been cancelled, it will no
|
141
|
+
# longer be present in the #active_remotes list. If you want to block until
|
142
|
+
# the port is no longer active, you could do something like this:
|
143
|
+
#
|
144
|
+
# ssh.forward.cancel_remote(1234, "0.0.0.0")
|
145
|
+
# ssh.loop { ssh.forward.active_remotes.include?([1234, "0.0.0.0"]) }
|
146
|
+
def cancel_remote(port, host="127.0.0.1")
|
147
|
+
session.send_global_request("cancel-tcpip-forward", :string, host, :long, port) do |success, response|
|
148
|
+
if success
|
149
|
+
@remote_forwarded_ports.delete([port, host])
|
150
|
+
else
|
151
|
+
raise Net::SSH::Exception, "could not cancel remote forward request on #{host}:#{port}"
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
|
156
|
+
# Returns all active forwarded remote ports. The returned value is an
|
157
|
+
# array of two-element tuples, where the first element is the port on the
|
158
|
+
# remote host and the second is the bind address.
|
159
|
+
def active_remotes
|
160
|
+
@remote_forwarded_ports.keys
|
161
|
+
end
|
162
|
+
|
163
|
+
# Enables SSH agent forwarding on the given channel. The forwarded agent
|
164
|
+
# will remain active even after the channel closes--the channel is only
|
165
|
+
# used as the transport for enabling the forwarded connection. You should
|
166
|
+
# never need to call this directly--it is called automatically the first
|
167
|
+
# time a session channel is opened, when the connection was created with
|
168
|
+
# :forward_agent set to true:
|
169
|
+
#
|
170
|
+
# Net::SSH.start("remote.host", "me", :forwrd_agent => true) do |ssh|
|
171
|
+
# ssh.open_channel do |ch|
|
172
|
+
# # agent will be automatically forwarded by this point
|
173
|
+
# end
|
174
|
+
# ssh.loop
|
175
|
+
# end
|
176
|
+
def agent(channel)
|
177
|
+
return if @agent_forwarded
|
178
|
+
@agent_forwarded = true
|
179
|
+
|
180
|
+
channel.send_channel_request("auth-agent-req@openssh.com") do |achannel, success|
|
181
|
+
if success
|
182
|
+
debug { "authentication agent forwarding is active" }
|
183
|
+
else
|
184
|
+
achannel.send_channel_request("auth-agent-req") do |a2channel, success2|
|
185
|
+
if success2
|
186
|
+
debug { "authentication agent forwarding is active" }
|
187
|
+
else
|
188
|
+
error { "could not establish forwarding of authentication agent" }
|
189
|
+
end
|
190
|
+
end
|
191
|
+
end
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
private
|
196
|
+
|
197
|
+
# Perform setup operations that are common to all forwarded channels.
|
198
|
+
# +client+ is a socket, +channel+ is the channel that was just created,
|
199
|
+
# and +type+ is an arbitrary string describing the type of the channel.
|
200
|
+
def prepare_client(client, channel, type)
|
201
|
+
client.extend(Net::SSH::BufferedIo)
|
202
|
+
client.logger = logger
|
203
|
+
|
204
|
+
session.listen_to(client)
|
205
|
+
channel[:socket] = client
|
206
|
+
|
207
|
+
channel.on_data do |ch, data|
|
208
|
+
ch[:socket].enqueue(data)
|
209
|
+
end
|
210
|
+
|
211
|
+
channel.on_close do |ch|
|
212
|
+
debug { "closing #{type} forwarded channel" }
|
213
|
+
ch[:socket].close if !client.closed?
|
214
|
+
session.stop_listening_to(ch[:socket])
|
215
|
+
end
|
216
|
+
|
217
|
+
channel.on_process do |ch|
|
218
|
+
if ch[:socket].closed?
|
219
|
+
ch.info { "#{type} forwarded connection closed" }
|
220
|
+
ch.close
|
221
|
+
elsif ch[:socket].available > 0
|
222
|
+
data = ch[:socket].read_available(8192)
|
223
|
+
ch.debug { "read #{data.length} bytes from client, sending over #{type} forwarded connection" }
|
224
|
+
ch.send_data(data)
|
225
|
+
end
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
# The callback used when a new "forwarded-tcpip" channel is requested
|
230
|
+
# by the server. This will open a new socket to the host/port specified
|
231
|
+
# when the forwarded connection was first requested.
|
232
|
+
def forwarded_tcpip(session, channel, packet)
|
233
|
+
connected_address = packet.read_string
|
234
|
+
connected_port = packet.read_long
|
235
|
+
originator_address = packet.read_string
|
236
|
+
originator_port = packet.read_long
|
237
|
+
|
238
|
+
remote = @remote_forwarded_ports[[connected_port, connected_address]]
|
239
|
+
|
240
|
+
if remote.nil?
|
241
|
+
raise Net::SSH::ChannelOpenFailed.new(1, "unknown request from remote forwarded connection on #{connected_address}:#{connected_port}")
|
242
|
+
end
|
243
|
+
|
244
|
+
client = TCPSocket.new(remote.host, remote.port)
|
245
|
+
info { "connected #{connected_address}:#{connected_port} originator #{originator_address}:#{originator_port}" }
|
246
|
+
|
247
|
+
prepare_client(client, channel, :remote)
|
248
|
+
rescue SocketError => err
|
249
|
+
raise Net::SSH::ChannelOpenFailed.new(2, "could not connect to remote host (#{remote.host}:#{remote.port}): #{err.message}")
|
250
|
+
end
|
251
|
+
|
252
|
+
# The callback used when an auth-agent channel is requested by the server.
|
253
|
+
def auth_agent_channel(session, channel, packet)
|
254
|
+
info { "opening auth-agent channel" }
|
255
|
+
channel[:invisible] = true
|
256
|
+
|
257
|
+
begin
|
258
|
+
agent = Authentication::Agent.connect(logger)
|
259
|
+
prepare_client(agent.socket, channel, :agent)
|
260
|
+
rescue Exception => e
|
261
|
+
error { "attempted to connect to agent but failed: #{e.class.name} (#{e.message})" }
|
262
|
+
raise Net::SSH::ChannelOpenFailed.new(2, "could not connect to authentication agent")
|
263
|
+
end
|
264
|
+
end
|
265
|
+
end
|
266
|
+
|
267
|
+
end; end; end
|
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
|